3 Git - Perl interface to the Git version control system
16 our ($VERSION, @ISA, @EXPORT, @EXPORT_OK);
18 # Totally unstable API.
26 my $version = Git::command_oneline('version');
28 git_cmd_try { Git::command_noisy('update-server-info') }
29 '%s failed w/ code %d';
31 my $repo = Git->repository (Directory => '/srv/git/cogito.git');
34 my @revs = $repo->command('rev-list', '--since=last monday', '--all');
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);
40 my $lastrev = $repo->command_oneline( [ 'rev-list', '--all' ],
43 my $sha1 = $repo->hash_and_insert_object('file.txt');
44 my $tempfile = tempfile();
45 my $size = $repo->cat_blob($sha1, $tempfile);
54 @EXPORT = qw(git_cmd_try);
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
62 temp_acquire temp_release temp_reset temp_path);
67 This module provides Perl scripts easy way to interface the Git version control
68 system. The modules have an easy and well-tested way to call arbitrary Git
69 commands; in the future, the interface will also provide specialized methods
70 for doing easily operations which are not totally trivial to do over
71 the generic command interface.
73 While some commands can be executed outside of any context (e.g. 'version'
74 or 'init'), most operations require a repository context, which in practice
75 means 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
77 called as methods of the object are then executed in the context of the
80 Part of the "repository state" is also information about path to the attached
81 working copy (unless you work with a bare repository). You can also navigate
82 inside of the working copy using the C<wc_chdir()> method. (Note that
83 the repository object is self-contained and will not change working directory
86 TODO: In the future, we might also do
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();
92 Currently, the module merely wraps calls to external Git tools. In the future,
93 it will provide a much faster way to interact with Git by linking directly
94 to libgit. This should be completely opaque to the user, though (performance
95 increase notwithstanding).
100 use Carp qw(carp croak); # but croak is bad - throw instead
102 use Cwd qw(abs_path cwd);
103 use IPC::Open2 qw(open2);
104 use Fcntl qw(SEEK_SET SEEK_CUR);
112 =item repository ( OPTIONS )
114 =item repository ( DIRECTORY )
118 Construct a new repository object.
119 C<OPTIONS> are passed in a hash like fashion, using key and value pairs.
120 Possible options are:
122 B<Repository> - Path to the Git repository.
124 B<WorkingCopy> - Path to the associated working copy; not strictly required
125 as many commands will happily crunch on a bare repository.
127 B<WorkingSubdir> - Subdirectory in the working copy to work inside.
128 Just left undefined if you do not want to limit the scope of operations.
130 B<Directory> - Path to the Git working directory in its usual setup.
131 The C<.git> directory is searched in the directory and all the parent
132 directories; if found, C<WorkingCopy> is set to the directory containing
133 it and C<Repository> to the C<.git> directory itself. If no C<.git>
134 directory was found, the C<Directory> is assumed to be a bare repository,
135 C<Repository> is set to point at it and C<WorkingCopy> is left undefined.
136 If the C<$GIT_DIR> environment variable is set, things behave as expected
139 You should not use both C<Directory> and either of C<Repository> and
140 C<WorkingCopy> - the results of that are undefined.
142 Alternatively, a directory path may be passed as a single scalar argument
143 to the constructor; it is equivalent to setting only the C<Directory> option
146 Calling the constructor with no options whatsoever is equivalent to
147 calling it with C<< Directory => '.' >>. In general, if you are building
148 a standard porcelain command, simply doing C<< Git->repository() >> should
149 do the right thing and setup the object to reflect exactly where the user
160 if (defined $args[0]) {
161 if ($#args % 2 != 1) {
163 $#args == 0 or throw Error::Simple("bad usage");
164 %opts = ( Directory => $args[0] );
170 if (not defined $opts{Repository} and not defined $opts{WorkingCopy}
171 and not defined $opts{Directory}) {
172 $opts{Directory} = '.';
175 if (defined $opts{Directory}) {
176 -d $opts{Directory} or throw Error::Simple("Directory not found: $opts{Directory} $!");
178 my $search = Git->repository(WorkingCopy => $opts{Directory});
181 $dir = $search->command_oneline(['rev-parse', '--git-dir'],
183 } catch Git::Error::Command with {
188 $dir =~ m#^/# or $dir = $opts{Directory} . '/' . $dir;
189 $opts{Repository} = abs_path($dir);
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}) . '/';
195 if (substr($dir, -length($prefix)) ne $prefix) {
196 throw Error::Simple("rev-parse confused me - $dir does not have trailing $prefix");
198 substr($dir, -length($prefix)) = '';
200 $opts{WorkingCopy} = $dir;
201 $opts{WorkingSubdir} = $prefix;
204 # A bare repository? Let's see...
205 $dir = $opts{Directory};
207 unless (-d "$dir/refs" and -d "$dir/objects" and -e "$dir/HEAD") {
208 # Mimic git-rev-parse --git-dir error message:
209 throw Error::Simple("fatal: Not a git repository: $dir");
211 my $search = Git->repository(Repository => $dir);
213 $search->command('symbolic-ref', 'HEAD');
214 } catch Git::Error::Command with {
215 # Mimic git-rev-parse --git-dir error message:
216 throw Error::Simple("fatal: Not a git repository: $dir");
219 $opts{Repository} = abs_path($dir);
222 delete $opts{Directory};
225 $self = { opts => \%opts };
235 =item command ( COMMAND [, ARGUMENTS... ] )
237 =item command ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
239 Execute the given Git C<COMMAND> (specify it without the 'git-'
240 prefix), optionally with the specified extra C<ARGUMENTS>.
242 The second more elaborate form can be used if you want to further adjust
243 the command execution. Currently, only one option is supported:
245 B<STDERR> - How to deal with the command's error output. By default (C<undef>)
246 it is delivered to the caller's C<STDERR>. A false value (0 or '') will cause
247 it to be thrown away. If you want to process it, you can get it in a filehandle
248 you specify, but you must be extremely careful; if the error output is not
249 very short and you want to read it in the same process as where you called
250 C<command()>, you are set up for a nice deadlock!
252 The 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).
255 In scalar context, it returns all the command output in a single string
258 In array context, it returns an array containing lines printed to the
259 command's stdout (without trailing newlines).
261 In both cases, the command's stdin and stderr are the same as the caller's.
266 my ($fh, $ctx) = command_output_pipe(@_);
268 if (not defined wantarray) {
269 # Nothing to pepper the possible exception with.
270 _cmd_close($fh, $ctx);
272 } elsif (not wantarray) {
276 _cmd_close($fh, $ctx);
277 } catch Git::Error::Command with {
278 # Pepper with the output:
280 $E->{'-outputref'} = \$text;
287 defined and chomp for @lines;
289 _cmd_close($fh, $ctx);
290 } catch Git::Error::Command with {
292 $E->{'-outputref'} = \@lines;
300 =item command_oneline ( COMMAND [, ARGUMENTS... ] )
302 =item command_oneline ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
304 Execute the given C<COMMAND> in the same way as command()
305 does but always return a scalar string containing the first line
306 of the command's standard output.
310 sub command_oneline {
311 my ($fh, $ctx) = command_output_pipe(@_);
314 defined $line and chomp $line;
316 _cmd_close($fh, $ctx);
317 } catch Git::Error::Command with {
318 # Pepper with the output:
320 $E->{'-outputref'} = \$line;
327 =item command_output_pipe ( COMMAND [, ARGUMENTS... ] )
329 =item command_output_pipe ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
331 Execute the given C<COMMAND> in the same way as command()
332 does but return a pipe filehandle from which the command output can be
335 The function can return C<($pipe, $ctx)> in array context.
336 See C<command_close_pipe()> for details.
340 sub command_output_pipe {
341 _command_common_pipe('-|', @_);
345 =item command_input_pipe ( COMMAND [, ARGUMENTS... ] )
347 =item command_input_pipe ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
349 Execute the given C<COMMAND> in the same way as command_output_pipe()
350 does but return an input pipe filehandle instead; the command output
353 The function can return C<($pipe, $ctx)> in array context.
354 See C<command_close_pipe()> for details.
358 sub command_input_pipe {
359 _command_common_pipe('|-', @_);
363 =item command_close_pipe ( PIPE [, CTX ] )
365 Close the C<PIPE> as returned from C<command_*_pipe()>, checking
366 whether the command finished successfully. The optional C<CTX> argument
367 is required if you want to see the command name in the error message,
368 and it is the second value returned by C<command_*_pipe()> when
369 called in array context. The call idiom is:
371 my ($fh, $ctx) = $r->command_output_pipe('status');
372 while (<$fh>) { ... }
373 $r->command_close_pipe($fh, $ctx);
375 Note that you should not rely on whatever actually is in C<CTX>;
376 currently it is simply the command name but in future the context might
377 have more complicated structure.
381 sub command_close_pipe {
382 my ($self, $fh, $ctx) = _maybe_self(@_);
383 $ctx ||= '<unknown>';
384 _cmd_close($fh, $ctx);
387 =item command_bidi_pipe ( COMMAND [, ARGUMENTS... ] )
389 Execute the given C<COMMAND> in the same way as command_output_pipe()
390 does but return both an input pipe filehandle and an output pipe filehandle.
392 The function will return return C<($pid, $pipe_in, $pipe_out, $ctx)>.
393 See C<command_close_bidi_pipe()> for details.
397 sub command_bidi_pipe {
398 my ($pid, $in, $out);
399 my ($self) = _maybe_self(@_);
401 my $cwd_save = undef;
405 _setup_git_cmd_env($self);
407 $pid = open2($in, $out, 'git', @_);
408 chdir($cwd_save) if $cwd_save;
409 return ($pid, $in, $out, join(' ', @_));
412 =item command_close_bidi_pipe ( PID, PIPE_IN, PIPE_OUT [, CTX] )
414 Close the C<PIPE_IN> and C<PIPE_OUT> as returned from C<command_bidi_pipe()>,
415 checking whether the command finished successfully. The optional C<CTX>
416 argument is required if you want to see the command name in the error message,
417 and it is the fourth value returned by C<command_bidi_pipe()>. The call idiom
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);
425 Note that you should not rely on whatever actually is in C<CTX>;
426 currently it is simply the command name but in future the context might
427 have more complicated structure.
431 sub command_close_bidi_pipe {
433 my ($pid, $in, $out, $ctx) = @_;
434 foreach my $fh ($in, $out) {
437 carp "error closing pipe: $!";
439 throw Git::Error::Command($ctx, $? >>8);
447 throw Git::Error::Command($ctx, $? >>8);
452 =item command_noisy ( COMMAND [, ARGUMENTS... ] )
454 Execute the given C<COMMAND> in the same way as command() does but do not
455 capture the command output - the standard output is not redirected and goes
456 to the standard output of the caller application.
458 While the method is called command_noisy(), you might want to as well use
459 it for the most silent Git commands which you know will never pollute your
460 stdout but you want to avoid the overhead of the pipe setup when calling them.
462 The function returns only after the command has finished running.
467 my ($self, $cmd, @args) = _maybe_self(@_);
468 _check_valid_cmd($cmd);
471 if (not defined $pid) {
472 throw Error::Simple("fork failed: $!");
473 } elsif ($pid == 0) {
474 _cmd_exec($self, $cmd, @args);
476 if (waitpid($pid, 0) > 0 and $?>>8 != 0) {
477 throw Git::Error::Command(join(' ', $cmd, @args), $? >> 8);
484 Return the Git version in use.
489 my $verstr = command_oneline('--version');
490 $verstr =~ s/^git version //;
497 Return path to the Git sub-command executables (the same as
498 C<git --exec-path>). Useful mostly only internally.
502 sub exec_path { command_oneline('--exec-path') }
507 Return path to the Git html documentation (the same as
508 C<git --html-path>). Useful mostly only internally.
512 sub html_path { command_oneline('--html-path') }
514 =item prompt ( PROMPT )
516 Query user C<PROMPT> and return answer from user.
518 Honours GIT_ASKPASS and SSH_ASKPASS environment variables for querying
519 the user. If no *_ASKPASS variable is set or an error occoured,
520 the terminal is tried as a fallback.
527 if (exists $ENV{'GIT_ASKPASS'}) {
528 $ret = _prompt($ENV{'GIT_ASKPASS'}, $prompt);
530 if (!defined $ret && exists $ENV{'SSH_ASKPASS'}) {
531 $ret = _prompt($ENV{'SSH_ASKPASS'}, $prompt);
534 print STDERR $prompt;
536 require Term::ReadKey;
537 Term::ReadKey::ReadMode('noecho');
539 while (defined(my $key = Term::ReadKey::ReadKey(0))) {
540 last if $key =~ /[\012\015]/; # \n\r
543 Term::ReadKey::ReadMode('restore');
551 my ($askpass, $prompt) = @_;
552 return unless length $askpass;
554 open my $fh, "-|", $askpass, $prompt or return;
556 $ret =~ s/[\015\012]//g; # strip \r\n, chomp does not work on all systems (i.e. windows) as expected
563 Return path to the git repository. Must be called on a repository instance.
567 sub repo_path { $_[0]->{opts}->{Repository} }
572 Return path to the working copy. Must be called on a repository instance.
576 sub wc_path { $_[0]->{opts}->{WorkingCopy} }
581 Return path to the subdirectory inside of a working copy. Must be called
582 on a repository instance.
586 sub wc_subdir { $_[0]->{opts}->{WorkingSubdir} ||= '' }
589 =item wc_chdir ( SUBDIR )
591 Change the working copy subdirectory to work within. The C<SUBDIR> is
592 relative to the working copy root directory (not the current subdirectory).
593 Must be called on a repository instance attached to a working copy
594 and the directory must exist.
599 my ($self, $subdir) = @_;
601 or throw Error::Simple("bare repository");
603 -d $self->wc_path().'/'.$subdir
604 or throw Error::Simple("subdir not found: $subdir $!");
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.
608 $self->{opts}->{WorkingSubdir} = $subdir;
612 =item config ( VARIABLE )
614 Retrieve the configuration C<VARIABLE> in the same manner as C<config>
615 does. In scalar context requires the variable to be set only one time
616 (exception is thrown otherwise), in array context returns allows the
617 variable to be set multiple times and returns all the values.
622 return _config_common({}, @_);
626 =item config_bool ( VARIABLE )
628 Retrieve the bool configuration C<VARIABLE>. The return value
629 is usable as a boolean in perl (and C<undef> if it's not defined,
635 my $val = scalar _config_common({'kind' => '--bool'}, @_);
637 # Do not rewrite this as return (defined $val && $val eq 'true')
638 # as some callers do care what kind of falsehood they receive.
642 return $val eq 'true';
647 =item config_path ( VARIABLE )
649 Retrieve the path configuration C<VARIABLE>. The return value
650 is an expanded path or C<undef> if it's not defined.
655 return _config_common({'kind' => '--path'}, @_);
659 =item config_int ( VARIABLE )
661 Retrieve the integer configuration C<VARIABLE>. The return value
662 is simple decimal number. An optional value suffix of 'k', 'm',
663 or 'g' in the config file will cause the value to be multiplied
664 by 1024, 1048576 (1024^2), or 1073741824 (1024^3) prior to output.
665 It would return C<undef> if configuration variable is not defined,
670 return scalar _config_common({'kind' => '--int'}, @_);
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.
676 my ($opts) = shift @_;
677 my ($self, $var) = _maybe_self(@_);
680 my @cmd = ('config', $opts->{'kind'} ? $opts->{'kind'} : ());
681 unshift @cmd, $self if $self;
683 return command(@cmd, '--get-all', $var);
685 return command_oneline(@cmd, '--get', $var);
687 } catch Git::Error::Command with {
689 if ($E->value() == 1) {
698 =item get_colorbool ( NAME )
700 Finds if color should be used for NAMEd operation from the configuration,
701 and returns boolean (true for "use color", false for "do not use color").
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');
713 =item get_color ( SLOT, COLOR )
715 Finds color for SLOT from the configuration, while defaulting to COLOR,
716 and returns the ANSI color escape sequence:
718 print $repo->get_color("color.interactive.prompt", "underline blue white");
720 print $repo->get_color("", "normal");
725 my ($self, $slot, $default) = @_;
726 my $color = $self->command_oneline('config', '--get-color', $slot, $default);
727 if (!defined $color) {
733 =item remote_refs ( REPOSITORY [, GROUPS [, REFGLOBS ] ] )
735 This function returns a hashref of refs stored in a given remote repository.
736 The hash is in the format C<refname =\> hash>. For tags, the C<refname> entry
737 contains the tag object while a C<refname^{}> entry gives the tagged objects.
739 C<REPOSITORY> has the same meaning as the appropriate C<git-ls-remote>
740 argument; either a URL or a remote name (if called on a repository instance).
741 C<GROUPS> is an optional arrayref that can contain 'tags' to return all the
742 tags and/or 'heads' to return all the heads. C<REFGLOB> is an optional array
743 of strings containing a shell-like glob to further limit the refs returned in
744 the hash; the meaning is again the same as the appropriate C<git-ls-remote>
747 This function may or may not be called on a repository instance. In the former
748 case, remote names as defined in the repository are recognized as repository
754 my ($self, $repo, $groups, $refglobs) = _maybe_self(@_);
756 if (ref $groups eq 'ARRAY') {
759 push (@args, '--heads');
760 } elsif ($_ eq 'tags') {
761 push (@args, '--tags');
763 # Ignore unknown groups for future
769 if (ref $refglobs eq 'ARRAY') {
770 push (@args, @$refglobs);
773 my @self = $self ? ($self) : (); # Ultra trickery
774 my ($fh, $ctx) = Git::command_output_pipe(@self, 'ls-remote', @args);
778 my ($hash, $ref) = split(/\t/, $_, 2);
781 Git::command_close_pipe(@self, $fh, $ctx);
786 =item ident ( TYPE | IDENTSTR )
788 =item ident_person ( TYPE | IDENTSTR | IDENTARRAY )
790 This suite of functions retrieves and parses ident information, as stored
791 in the commit and tag objects or produced by C<var GIT_type_IDENT> (thus
792 C<TYPE> can be either I<author> or I<committer>; case is insignificant).
794 The C<ident> method retrieves the ident information from C<git var>
795 and either returns it as a scalar string or as an array with the fields parsed.
796 Alternatively, it can take a prepared ident string (e.g. from the commit
797 object) and just parse it.
799 C<ident_person> returns the person part of the ident - name and email;
800 it can take the same arguments as C<ident> or the array returned by C<ident>.
802 The synopsis is like:
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}$/;
812 my ($self, $type) = _maybe_self(@_);
814 if (lc $type eq lc 'committer' or lc $type eq lc 'author') {
815 my @cmd = ('var', 'GIT_'.uc($type).'_IDENT');
816 unshift @cmd, $self if $self;
817 $identstr = command_oneline(@cmd);
822 return $identstr =~ /^(.*) <(.*)> (\d+ [+-]\d{4})$/;
829 my ($self, @ident) = _maybe_self(@_);
830 $#ident == 0 and @ident = $self ? $self->ident($ident[0]) : ident($ident[0]);
831 return "$ident[0] <$ident[1]>";
835 =item hash_object ( TYPE, FILENAME )
837 Compute the SHA1 object id of the given C<FILENAME> considering it is
838 of the C<TYPE> object type (C<blob>, C<commit>, C<tree>).
840 The method can be called without any instance or on a specified Git repository,
841 it makes zero difference.
843 The function returns the SHA1 hash.
847 # TODO: Support for passing FILEHANDLE instead of FILENAME
849 my ($self, $type, $file) = _maybe_self(@_);
850 command_oneline('hash-object', '-t', $type, $file);
854 =item hash_and_insert_object ( FILENAME )
856 Compute the SHA1 object id of the given C<FILENAME> and add the object to the
859 The function returns the SHA1 hash.
863 # TODO: Support for passing FILEHANDLE instead of FILENAME
864 sub hash_and_insert_object {
865 my ($self, $filename) = @_;
867 carp "Bad filename \"$filename\"" if $filename =~ /[\r\n]/;
869 $self->_open_hash_and_insert_object_if_needed();
870 my ($in, $out) = ($self->{hash_object_in}, $self->{hash_object_out});
872 unless (print $out $filename, "\n") {
873 $self->_close_hash_and_insert_object();
874 throw Error::Simple("out pipe went bad");
877 chomp(my $hash = <$in>);
878 unless (defined($hash)) {
879 $self->_close_hash_and_insert_object();
880 throw Error::Simple("in pipe went bad");
886 sub _open_hash_and_insert_object_if_needed {
889 return if defined($self->{hash_object_pid});
891 ($self->{hash_object_pid}, $self->{hash_object_in},
892 $self->{hash_object_out}, $self->{hash_object_ctx}) =
893 $self->command_bidi_pipe(qw(hash-object -w --stdin-paths --no-filters));
896 sub _close_hash_and_insert_object {
899 return unless defined($self->{hash_object_pid});
901 my @vars = map { 'hash_object_' . $_ } qw(pid in out ctx);
903 command_close_bidi_pipe(@$self{@vars});
904 delete @$self{@vars};
907 =item cat_blob ( SHA1, FILEHANDLE )
909 Prints the contents of the blob identified by C<SHA1> to C<FILEHANDLE> and
910 returns the number of bytes printed.
915 my ($self, $sha1, $fh) = @_;
917 $self->_open_cat_blob_if_needed();
918 my ($in, $out) = ($self->{cat_blob_in}, $self->{cat_blob_out});
920 unless (print $out $sha1, "\n") {
921 $self->_close_cat_blob();
922 throw Error::Simple("out pipe went bad");
925 my $description = <$in>;
926 if ($description =~ / missing$/) {
927 carp "$sha1 doesn't exist in the repository";
931 if ($description !~ /^[0-9a-fA-F]{40} \S+ (\d+)$/) {
932 carp "Unexpected result returned from git cat-file";
942 my $bytesLeft = $size - $bytesRead;
943 last unless $bytesLeft;
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");
955 # Skip past the trailing 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");
962 unless ($read == 1 && $newline eq "\n") {
963 $self->_close_cat_blob();
964 throw Error::Simple("didn't find newline after blob");
967 unless (print $fh $blob) {
968 $self->_close_cat_blob();
969 throw Error::Simple("couldn't write to passed in filehandle");
975 sub _open_cat_blob_if_needed {
978 return if defined($self->{cat_blob_pid});
980 ($self->{cat_blob_pid}, $self->{cat_blob_in},
981 $self->{cat_blob_out}, $self->{cat_blob_ctx}) =
982 $self->command_bidi_pipe(qw(cat-file --batch));
985 sub _close_cat_blob {
988 return unless defined($self->{cat_blob_pid});
990 my @vars = map { 'cat_blob_' . $_ } qw(pid in out ctx);
992 command_close_bidi_pipe(@$self{@vars});
993 delete @$self{@vars};
997 { # %TEMP_* Lexical Context
999 my (%TEMP_FILEMAP, %TEMP_FILES);
1001 =item temp_acquire ( NAME )
1003 Attempts to retreive the temporary file mapped to the string C<NAME>. If an
1004 associated temp file has not been created this session or was closed, it is
1005 created, cached, and set for autoflush and binmode.
1007 Internally locks the file mapped to C<NAME>. This lock must be released with
1008 C<temp_release()> when the temp file is no longer needed. Subsequent attempts
1009 to retrieve temporary files mapped to the same C<NAME> while still locked will
1010 cause an error. This locking mechanism provides a weak guarantee and is not
1011 threadsafe. It does provide some error checking to help prevent temp file refs
1012 writing over one another.
1014 In general, the L<File::Handle> returned should not be closed by consumers as
1015 it defeats the purpose of this caching mechanism. If you need to close the temp
1016 file handle, then you should use L<File::Temp> or another temp file faculty
1017 directly. If a handle is closed and then requested again, then a warning will
1023 my $temp_fd = _temp_cache(@_);
1025 $TEMP_FILES{$temp_fd}{locked} = 1;
1029 =item temp_release ( NAME )
1031 =item temp_release ( FILEHANDLE )
1033 Releases a lock acquired through C<temp_acquire()>. Can be called either with
1034 the C<NAME> mapping used when acquiring the temp file or with the C<FILEHANDLE>
1035 referencing a locked temp file.
1037 Warns if an attempt is made to release a file that is not locked.
1039 The temp file will be truncated before being released. This can help to reduce
1040 disk I/O where the system is smart enough to detect the truncation while data
1041 is in the output buffers. Beware that after the temp file is released and
1042 truncated, any operations on that file may fail miserably until it is
1043 re-acquired. All contents are lost between each release and acquire mapped to
1049 my ($self, $temp_fd, $trunc) = _maybe_self(@_);
1051 if (exists $TEMP_FILEMAP{$temp_fd}) {
1052 $temp_fd = $TEMP_FILES{$temp_fd};
1054 unless ($TEMP_FILES{$temp_fd}{locked}) {
1055 carp "Attempt to release temp file '",
1056 $temp_fd, "' that has not been locked";
1058 temp_reset($temp_fd) if $trunc and $temp_fd->opened;
1060 $TEMP_FILES{$temp_fd}{locked} = 0;
1065 my ($self, $name) = _maybe_self(@_);
1069 my $temp_fd = \$TEMP_FILEMAP{$name};
1070 if (defined $$temp_fd and $$temp_fd->opened) {
1071 if ($TEMP_FILES{$$temp_fd}{locked}) {
1072 throw Error::Simple("Temp file with moniker '" .
1073 $name . "' already in use");
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.";
1084 if (defined $self) {
1085 $tmpdir = $self->repo_path();
1088 ($$temp_fd, $fname) = File::Temp->tempfile(
1089 'Git_XXXXXX', UNLINK => 1, DIR => $tmpdir,
1090 ) or throw Error::Simple("couldn't open new temp file");
1092 $$temp_fd->autoflush;
1094 $TEMP_FILES{$$temp_fd}{fname} = $fname;
1099 sub _verify_require {
1100 eval { require File::Temp; require File::Spec; };
1101 $@ and throw Error::Simple($@);
1104 =item temp_reset ( FILEHANDLE )
1106 Truncates and resets the position of the C<FILEHANDLE>.
1111 my ($self, $temp_fd) = _maybe_self(@_);
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");
1121 =item temp_path ( NAME )
1123 =item temp_path ( FILEHANDLE )
1125 Returns the filename associated with the given tempfile.
1130 my ($self, $temp_fd) = _maybe_self(@_);
1132 if (exists $TEMP_FILEMAP{$temp_fd}) {
1133 $temp_fd = $TEMP_FILEMAP{$temp_fd};
1135 $TEMP_FILES{$temp_fd}{fname};
1139 unlink values %TEMP_FILEMAP if %TEMP_FILEMAP;
1142 } # %TEMP_* Lexical Context
1146 =head1 ERROR HANDLING
1148 All functions are supposed to throw Perl exceptions in case of errors.
1149 See the L<Error> module on how to catch those. Most exceptions are mere
1150 L<Error::Simple> instances.
1152 However, the C<command()>, C<command_oneline()> and C<command_noisy()>
1153 functions suite can throw C<Git::Error::Command> exceptions as well: those are
1154 thrown when the external command returns an error code and contain the error
1155 code as well as access to the captured command's output. The exception class
1156 provides the usual C<stringify> and C<value> (command's exit code) methods and
1157 in addition also a C<cmd_output> method that returns either an array or a
1158 string with the captured command output (depending on the original function
1159 call context; C<command_noisy()> returns C<undef>) and $<cmdline> which
1160 returns the command and its arguments (but without proper quoting).
1162 Note that the C<command_*_pipe()> functions cannot throw this exception since
1163 it has no idea whether the command failed or not. You will only find out
1164 at the time you C<close> the pipe; if you want to have that automated,
1165 use C<command_close_pipe()>, which can throw the exception.
1170 package Git::Error::Command;
1172 @Git::Error::Command::ISA = qw(Error);
1176 my $cmdline = '' . shift;
1177 my $value = 0 + shift;
1178 my $outputref = shift;
1181 local $Error::Depth = $Error::Depth + 1;
1183 push(@args, '-cmdline', $cmdline);
1184 push(@args, '-value', $value);
1185 push(@args, '-outputref', $outputref);
1187 $self->SUPER::new(-text => 'command returned error', @args);
1192 my $text = $self->SUPER::stringify;
1193 $self->cmdline() . ': ' . $text . ': ' . $self->value() . "\n";
1198 $self->{'-cmdline'};
1203 my $ref = $self->{'-outputref'};
1204 defined $ref or undef;
1205 if (ref $ref eq 'ARRAY') {
1215 =item git_cmd_try { CODE } ERRMSG
1217 This magical statement will automatically catch any C<Git::Error::Command>
1218 exceptions thrown by C<CODE> and make your program die with C<ERRMSG>
1219 on its lips; the message will have %s substituted for the command line
1220 and %d for the exit status. This statement is useful mostly for producing
1221 more user-friendly error messages.
1223 In case of no exception caught the statement returns C<CODE>'s return value.
1225 Note that this is the only auto-exported function.
1229 sub git_cmd_try(&$) {
1230 my ($code, $errmsg) = @_;
1233 my $array = wantarray;
1238 $result[0] = &$code;
1240 } catch Git::Error::Command with {
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.
1248 $err and croak $err;
1249 return $array ? @result : $result[0];
1257 Copyright 2006 by Petr Baudis E<lt>pasky@suse.czE<gt>.
1259 This module is free software; it may be used, copied, modified
1260 and distributed under the terms of the GNU General Public Licence,
1261 either version 2, or (at your option) any later version.
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.
1270 UNIVERSAL::isa($_[0], 'Git') ? @_ : (undef, @_);
1273 # Check if the command id is something reasonable.
1274 sub _check_valid_cmd {
1276 $cmd =~ /^[a-z0-9A-Z_-]+$/ or throw Error::Simple("bad command: $cmd");
1279 # Common backend for the pipe creators.
1280 sub _command_common_pipe {
1281 my $direction = shift;
1282 my ($self, @p) = _maybe_self(@_);
1283 my (%opts, $cmd, @args);
1285 ($cmd, @args) = @{shift @p};
1286 %opts = ref $p[0] ? %{$p[0]} : @p;
1290 _check_valid_cmd($cmd);
1293 if ($^O eq 'MSWin32') {
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';
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);
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}) {
1315 if ($opts{STDERR}) {
1316 open (STDERR, '>&', $opts{STDERR})
1317 or die "dup failed: $!";
1319 _cmd_exec($self, $cmd, @args);
1322 return wantarray ? ($fh, join(' ', $cmd, @args)) : $fh;
1325 # When already in the subprocess, set up the appropriate state
1326 # for the given repository and execute the git command.
1328 my ($self, @args) = @_;
1329 _setup_git_cmd_env($self);
1330 _execv_git_cmd(@args);
1331 die qq[exec "@args" failed: $!];
1334 # set up the appropriate state for git command
1335 sub _setup_git_cmd_env {
1338 $self->repo_path() and $ENV{'GIT_DIR'} = $self->repo_path();
1339 $self->repo_path() and $self->wc_path()
1340 and $ENV{'GIT_WORK_TREE'} = $self->wc_path();
1341 $self->wc_path() and chdir($self->wc_path());
1342 $self->wc_subdir() and chdir($self->wc_subdir());
1346 # Execute the given Git command ($_[0]) with arguments ($_[1..])
1347 # by searching for it at proper places.
1348 sub _execv_git_cmd { exec('git', @_); }
1350 # Close pipe to a subprocess.
1352 my ($fh, $ctx) = @_;
1353 if (not close $fh) {
1355 # It's just close, no point in fatalities
1356 carp "error closing pipe: $!";
1358 # The caller should pepper this.
1359 throw Git::Error::Command($ctx, $? >> 8);
1361 # else we might e.g. closed a live stream; the command
1362 # dying of SIGPIPE would drive us here.
1369 $self->_close_hash_and_insert_object();
1370 $self->_close_cat_blob();
1374 # Pipe implementation for ActiveState Perl.
1376 package Git::activestate_pipe;
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
1384 # Let's just hope ActiveState Perl does at least the quoting
1386 my @data = qx{git @params};
1387 bless { i => 0, data => \@data }, $class;
1392 if ($self->{i} >= scalar @{$self->{data}}) {
1397 $self->{i} = $#{$self->{'data'}} + 1;
1398 return splice(@{$self->{'data'}}, $i);
1400 $self->{i} = $i + 1;
1401 return $self->{'data'}->[ $i ];
1406 delete $self->{data};
1412 return ($self->{i} >= scalar @{$self->{data}});
1416 1; # Famous last words