3 Git - Perl interface to the Git version control system
15 our ($VERSION, @ISA, @EXPORT, @EXPORT_OK);
17 # Totally unstable API.
25 my $version = Git::command_oneline('version');
27 git_cmd_try { Git::command_noisy('update-server-info') }
28 '%s failed w/ code %d';
30 my $repo = Git->repository (Directory => '/srv/git/cogito.git');
33 my @revs = $repo->command('rev-list', '--since=last monday', '--all');
35 my ($fh, $c) = $repo->command_output_pipe('rev-list', '--since=last monday', '--all');
36 my $lastrev = <$fh>; chomp $lastrev;
37 $repo->command_close_pipe($fh, $c);
39 my $lastrev = $repo->command_oneline( [ 'rev-list', '--all' ],
49 @EXPORT = qw(git_cmd_try);
51 # Methods which can be called as standalone functions as well:
52 @EXPORT_OK = qw(command command_oneline command_noisy
53 command_output_pipe command_input_pipe command_close_pipe
54 version exec_path hash_object git_cmd_try);
59 This module provides Perl scripts easy way to interface the Git version control
60 system. The modules have an easy and well-tested way to call arbitrary Git
61 commands; in the future, the interface will also provide specialized methods
62 for doing easily operations which are not totally trivial to do over
63 the generic command interface.
65 While some commands can be executed outside of any context (e.g. 'version'
66 or 'init-db'), most operations require a repository context, which in practice
67 means 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
69 called as methods of the object are then executed in the context of the
72 Part of the "repository state" is also information about path to the attached
73 working copy (unless you work with a bare repository). You can also navigate
74 inside of the working copy using the C<wc_chdir()> method. (Note that
75 the repository object is self-contained and will not change working directory
78 TODO: In the future, we might also do
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();
84 Currently, the module merely wraps calls to external Git tools. In the future,
85 it will provide a much faster way to interact with Git by linking directly
86 to libgit. This should be completely opaque to the user, though (performance
87 increate nonwithstanding).
92 use Carp
qw(carp croak); # but croak is bad - throw instead
97 XSLoader
::load
('Git', $VERSION);
108 =item repository ( OPTIONS )
110 =item repository ( DIRECTORY )
114 Construct a new repository object.
115 C<OPTIONS> are passed in a hash like fashion, using key and value pairs.
116 Possible options are:
118 B<Repository> - Path to the Git repository.
120 B<WorkingCopy> - Path to the associated working copy; not strictly required
121 as many commands will happily crunch on a bare repository.
123 B<WorkingSubdir> - Subdirectory in the working copy to work inside.
124 Just left undefined if you do not want to limit the scope of operations.
126 B<Directory> - Path to the Git working directory in its usual setup.
127 The C<.git> directory is searched in the directory and all the parent
128 directories; if found, C<WorkingCopy> is set to the directory containing
129 it and C<Repository> to the C<.git> directory itself. If no C<.git>
130 directory was found, the C<Directory> is assumed to be a bare repository,
131 C<Repository> is set to point at it and C<WorkingCopy> is left undefined.
132 If the C<$GIT_DIR> environment variable is set, things behave as expected
135 You should not use both C<Directory> and either of C<Repository> and
136 C<WorkingCopy> - the results of that are undefined.
138 Alternatively, a directory path may be passed as a single scalar argument
139 to the constructor; it is equivalent to setting only the C<Directory> option
142 Calling the constructor with no options whatsoever is equivalent to
143 calling it with C<< Directory => '.' >>. In general, if you are building
144 a standard porcelain command, simply doing C<< Git->repository() >> should
145 do the right thing and setup the object to reflect exactly where the user
156 if (defined $args[0]) {
157 if ($#args % 2 != 1) {
159 $#args == 0 or throw Error
::Simple
("bad usage");
160 %opts = ( Directory
=> $args[0] );
166 if (not defined $opts{Repository
} and not defined $opts{WorkingCopy
}) {
167 $opts{Directory
} ||= '.';
170 if ($opts{Directory
}) {
171 -d
$opts{Directory
} or throw Error
::Simple
("Directory not found: $!");
173 my $search = Git
->repository(WorkingCopy
=> $opts{Directory
});
176 $dir = $search->command_oneline(['rev-parse', '--git-dir'],
178 } catch Git
::Error
::Command with
{
183 $dir =~ m
#^/# or $dir = $opts{Directory} . '/' . $dir;
184 $opts{Repository
} = $dir;
186 # If --git-dir went ok, this shouldn't die either.
187 my $prefix = $search->command_oneline('rev-parse', '--show-prefix');
188 $dir = abs_path
($opts{Directory
}) . '/';
190 if (substr($dir, -length($prefix)) ne $prefix) {
191 throw Error
::Simple
("rev-parse confused me - $dir does not have trailing $prefix");
193 substr($dir, -length($prefix)) = '';
195 $opts{WorkingCopy
} = $dir;
196 $opts{WorkingSubdir
} = $prefix;
199 # A bare repository? Let's see...
200 $dir = $opts{Directory
};
202 unless (-d
"$dir/refs" and -d
"$dir/objects" and -e
"$dir/HEAD") {
203 # Mimick git-rev-parse --git-dir error message:
204 throw Error
::Simple
('fatal: Not a git repository');
206 my $search = Git
->repository(Repository
=> $dir);
208 $search->command('symbolic-ref', 'HEAD');
209 } catch Git
::Error
::Command with
{
210 # Mimick git-rev-parse --git-dir error message:
211 throw Error
::Simple
('fatal: Not a git repository');
214 $opts{Repository
} = abs_path
($dir);
217 delete $opts{Directory
};
220 $self = { opts
=> \
%opts, id
=> $instance_id++ };
231 =item command ( COMMAND [, ARGUMENTS... ] )
233 =item command ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
235 Execute the given Git C<COMMAND> (specify it without the 'git-'
236 prefix), optionally with the specified extra C<ARGUMENTS>.
238 The second more elaborate form can be used if you want to further adjust
239 the command execution. Currently, only one option is supported:
241 B<STDERR> - How to deal with the command's error output. By default (C<undef>)
242 it is delivered to the caller's C<STDERR>. A false value (0 or '') will cause
243 it to be thrown away. If you want to process it, you can get it in a filehandle
244 you specify, but you must be extremely careful; if the error output is not
245 very short and you want to read it in the same process as where you called
246 C<command()>, you are set up for a nice deadlock!
248 The method can be called without any instance or on a specified Git repository
249 (in that case the command will be run in the repository context).
251 In scalar context, it returns all the command output in a single string
254 In array context, it returns an array containing lines printed to the
255 command's stdout (without trailing newlines).
257 In both cases, the command's stdin and stderr are the same as the caller's.
262 my ($fh, $ctx) = command_output_pipe
(@_);
264 if (not defined wantarray) {
265 # Nothing to pepper the possible exception with.
266 _cmd_close
($fh, $ctx);
268 } elsif (not wantarray) {
272 _cmd_close
($fh, $ctx);
273 } catch Git
::Error
::Command with
{
274 # Pepper with the output:
276 $E->{'-outputref'} = \
$text;
285 _cmd_close
($fh, $ctx);
286 } catch Git
::Error
::Command with
{
288 $E->{'-outputref'} = \
@lines;
296 =item command_oneline ( COMMAND [, ARGUMENTS... ] )
298 =item command_oneline ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
300 Execute the given C<COMMAND> in the same way as command()
301 does but always return a scalar string containing the first line
302 of the command's standard output.
306 sub command_oneline
{
307 my ($fh, $ctx) = command_output_pipe
(@_);
310 defined $line and chomp $line;
312 _cmd_close
($fh, $ctx);
313 } catch Git
::Error
::Command with
{
314 # Pepper with the output:
316 $E->{'-outputref'} = \
$line;
323 =item command_output_pipe ( COMMAND [, ARGUMENTS... ] )
325 =item command_output_pipe ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
327 Execute the given C<COMMAND> in the same way as command()
328 does but return a pipe filehandle from which the command output can be
331 The function can return C<($pipe, $ctx)> in array context.
332 See C<command_close_pipe()> for details.
336 sub command_output_pipe
{
337 _command_common_pipe
('-|', @_);
341 =item command_input_pipe ( COMMAND [, ARGUMENTS... ] )
343 =item command_input_pipe ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
345 Execute the given C<COMMAND> in the same way as command_output_pipe()
346 does but return an input pipe filehandle instead; the command output
349 The function can return C<($pipe, $ctx)> in array context.
350 See C<command_close_pipe()> for details.
354 sub command_input_pipe
{
355 _command_common_pipe
('|-', @_);
359 =item command_close_pipe ( PIPE [, CTX ] )
361 Close the C<PIPE> as returned from C<command_*_pipe()>, checking
362 whether the command finished successfuly. The optional C<CTX> argument
363 is required if you want to see the command name in the error message,
364 and it is the second value returned by C<command_*_pipe()> when
365 called in array context. The call idiom is:
367 my ($fh, $ctx) = $r->command_output_pipe('status');
368 while (<$fh>) { ... }
369 $r->command_close_pipe($fh, $ctx);
371 Note that you should not rely on whatever actually is in C<CTX>;
372 currently it is simply the command name but in future the context might
373 have more complicated structure.
377 sub command_close_pipe
{
378 my ($self, $fh, $ctx) = _maybe_self
(@_);
379 $ctx ||= '<unknown>';
380 _cmd_close
($fh, $ctx);
384 =item command_noisy ( COMMAND [, ARGUMENTS... ] )
386 Execute the given C<COMMAND> in the same way as command() does but do not
387 capture the command output - the standard output is not redirected and goes
388 to the standard output of the caller application.
390 While the method is called command_noisy(), you might want to as well use
391 it for the most silent Git commands which you know will never pollute your
392 stdout but you want to avoid the overhead of the pipe setup when calling them.
394 The function returns only after the command has finished running.
399 my ($self, $cmd, @args) = _maybe_self
(@_);
400 _check_valid_cmd
($cmd);
403 if (not defined $pid) {
404 throw Error
::Simple
("fork failed: $!");
405 } elsif ($pid == 0) {
406 _cmd_exec
($self, $cmd, @args);
408 if (waitpid($pid, 0) > 0 and $?
>>8 != 0) {
409 throw Git
::Error
::Command
(join(' ', $cmd, @args), $?
>> 8);
416 Return the Git version in use.
418 Implementation of this function is very fast; no external command calls
423 # Implemented in Git.xs.
428 Return path to the Git sub-command executables (the same as
429 C<git --exec-path>). Useful mostly only internally.
431 Implementation of this function is very fast; no external command calls
436 # Implemented in Git.xs.
441 Return path to the git repository. Must be called on a repository instance.
445 sub repo_path
{ $_[0]->{opts
}->{Repository
} }
450 Return path to the working copy. Must be called on a repository instance.
454 sub wc_path
{ $_[0]->{opts
}->{WorkingCopy
} }
459 Return path to the subdirectory inside of a working copy. Must be called
460 on a repository instance.
464 sub wc_subdir
{ $_[0]->{opts
}->{WorkingSubdir
} ||= '' }
467 =item wc_chdir ( SUBDIR )
469 Change the working copy subdirectory to work within. The C<SUBDIR> is
470 relative to the working copy root directory (not the current subdirectory).
471 Must be called on a repository instance attached to a working copy
472 and the directory must exist.
477 my ($self, $subdir) = @_;
479 or throw Error
::Simple
("bare repository");
481 -d
$self->wc_path().'/'.$subdir
482 or throw Error
::Simple
("subdir not found: $!");
483 # Of course we will not "hold" the subdirectory so anyone
484 # can delete it now and we will never know. But at least we tried.
486 $self->{opts
}->{WorkingSubdir
} = $subdir;
490 =item config ( VARIABLE )
492 Retrieve the configuration C<VARIABLE> in the same manner as C<repo-config>
493 does. In scalar context requires the variable to be set only one time
494 (exception is thrown otherwise), in array context returns allows the
495 variable to be set multiple times and returns all the values.
497 Must be called on a repository instance.
499 This currently wraps command('repo-config') so it is not so fast.
504 my ($self, $var) = @_;
506 or throw Error
::Simple
("not a repository");
510 return $self->command('repo-config', '--get-all', $var);
512 return $self->command_oneline('repo-config', '--get', $var);
514 } catch Git
::Error
::Command with
{
516 if ($E->value() == 1) {
526 =item ident ( TYPE | IDENTSTR )
528 =item ident_person ( TYPE | IDENTSTR | IDENTARRAY )
530 This suite of functions retrieves and parses ident information, as stored
531 in the commit and tag objects or produced by C<var GIT_type_IDENT> (thus
532 C<TYPE> can be either I<author> or I<committer>; case is insignificant).
534 The C<ident> method retrieves the ident information from C<git-var>
535 and either returns it as a scalar string or as an array with the fields parsed.
536 Alternatively, it can take a prepared ident string (e.g. from the commit
537 object) and just parse it.
539 C<ident_person> returns the person part of the ident - name and email;
540 it can take the same arguments as C<ident> or the array returned by C<ident>.
542 The synopsis is like:
544 my ($name, $email, $time_tz) = ident('author');
545 "$name <$email>" eq ident_person('author');
546 "$name <$email>" eq ident_person($name);
547 $time_tz =~ /^\d+ [+-]\d{4}$/;
549 Both methods must be called on a repository instance.
554 my ($self, $type) = @_;
556 if (lc $type eq lc 'committer' or lc $type eq lc 'author') {
557 $identstr = $self->command_oneline('var', 'GIT_'.uc($type).'_IDENT');
562 return $identstr =~ /^(.*) <(.*)> (\d+ [+-]\d{4})$/;
569 my ($self, @ident) = @_;
570 $#ident == 0 and @ident = $self->ident($ident[0]);
571 return "$ident[0] <$ident[1]>";
575 =item hash_object ( TYPE, FILENAME )
577 =item hash_object ( TYPE, FILEHANDLE )
579 Compute the SHA1 object id of the given C<FILENAME> (or data waiting in
580 C<FILEHANDLE>) considering it is of the C<TYPE> object type (C<blob>,
583 In case of C<FILEHANDLE> passed instead of file name, all the data
584 available are read and hashed, and the filehandle is automatically
585 closed. The file handle should be freshly opened - if you have already
586 read anything from the file handle, the results are undefined (since
587 this function works directly with the file descriptor and internal
588 PerlIO buffering might have messed things up).
590 The method can be called without any instance or on a specified Git repository,
591 it makes zero difference.
593 The function returns the SHA1 hash.
595 Implementation of this function is very fast; no external command calls
601 my ($self, $type, $file) = _maybe_self
(@_);
603 # hash_object_* implemented in Git.xs.
605 if (ref($file) eq 'GLOB') {
606 my $hash = hash_object_pipe
($type, fileno($file));
610 hash_object_file
($type, $file);
618 =head1 ERROR HANDLING
620 All functions are supposed to throw Perl exceptions in case of errors.
621 See the L<Error> module on how to catch those. Most exceptions are mere
622 L<Error::Simple> instances.
624 However, the C<command()>, C<command_oneline()> and C<command_noisy()>
625 functions suite can throw C<Git::Error::Command> exceptions as well: those are
626 thrown when the external command returns an error code and contain the error
627 code as well as access to the captured command's output. The exception class
628 provides the usual C<stringify> and C<value> (command's exit code) methods and
629 in addition also a C<cmd_output> method that returns either an array or a
630 string with the captured command output (depending on the original function
631 call context; C<command_noisy()> returns C<undef>) and $<cmdline> which
632 returns the command and its arguments (but without proper quoting).
634 Note that the C<command_*_pipe()> functions cannot throw this exception since
635 it has no idea whether the command failed or not. You will only find out
636 at the time you C<close> the pipe; if you want to have that automated,
637 use C<command_close_pipe()>, which can throw the exception.
642 package Git
::Error
::Command
;
644 @Git::Error
::Command
::ISA
= qw(Error);
648 my $cmdline = '' . shift;
649 my $value = 0 + shift;
650 my $outputref = shift;
653 local $Error::Depth
= $Error::Depth
+ 1;
655 push(@args, '-cmdline', $cmdline);
656 push(@args, '-value', $value);
657 push(@args, '-outputref', $outputref);
659 $self->SUPER::new
(-text
=> 'command returned error', @args);
664 my $text = $self->SUPER::stringify
;
665 $self->cmdline() . ': ' . $text . ': ' . $self->value() . "\n";
675 my $ref = $self->{'-outputref'};
676 defined $ref or undef;
677 if (ref $ref eq 'ARRAY') {
687 =item git_cmd_try { CODE } ERRMSG
689 This magical statement will automatically catch any C<Git::Error::Command>
690 exceptions thrown by C<CODE> and make your program die with C<ERRMSG>
691 on its lips; the message will have %s substituted for the command line
692 and %d for the exit status. This statement is useful mostly for producing
693 more user-friendly error messages.
695 In case of no exception caught the statement returns C<CODE>'s return value.
697 Note that this is the only auto-exported function.
701 sub git_cmd_try
(&$) {
702 my ($code, $errmsg) = @_;
705 my $array = wantarray;
712 } catch Git
::Error
::Command with
{
715 $err =~ s/\%s/$E->cmdline()/ge;
716 $err =~ s/\%d/$E->value()/ge;
717 # We can't croak here since Error.pm would mangle
718 # that to Error::Simple.
721 return $array ?
@result : $result[0];
729 Copyright 2006 by Petr Baudis E<lt>pasky@suse.czE<gt>.
731 This module is free software; it may be used, copied, modified
732 and distributed under the terms of the GNU General Public Licence,
733 either version 2, or (at your option) any later version.
738 # Take raw method argument list and return ($obj, @args) in case
739 # the method was called upon an instance and (undef, @args) if
740 # it was called directly.
742 # This breaks inheritance. Oh well.
743 ref $_[0] eq 'Git' ?
@_ : (undef, @_);
746 # Check if the command id is something reasonable.
747 sub _check_valid_cmd
{
749 $cmd =~ /^[a-z0-9A-Z_-]+$/ or throw Error
::Simple
("bad command: $cmd");
752 # Common backend for the pipe creators.
753 sub _command_common_pipe
{
754 my $direction = shift;
755 my ($self, @p) = _maybe_self
(@_);
756 my (%opts, $cmd, @args);
758 ($cmd, @args) = @
{shift @p};
759 %opts = ref $p[0] ?
%{$p[0]} : @p;
763 _check_valid_cmd
($cmd);
766 if ($^O
eq '##INSERT_ACTIVESTATE_STRING_HERE##') {
768 #defined $opts{STDERR} and
769 # warn 'ignoring STDERR option - running w/ ActiveState';
770 $direction eq '-|' or
771 die 'input pipe for ActiveState not implemented';
772 tie
($fh, 'Git::activestate_pipe', $cmd, @args);
775 my $pid = open($fh, $direction);
776 if (not defined $pid) {
777 throw Error
::Simple
("open failed: $!");
778 } elsif ($pid == 0) {
779 if (defined $opts{STDERR
}) {
783 open (STDERR
, '>&', $opts{STDERR
})
784 or die "dup failed: $!";
786 _cmd_exec
($self, $cmd, @args);
789 return wantarray ?
($fh, join(' ', $cmd, @args)) : $fh;
792 # When already in the subprocess, set up the appropriate state
793 # for the given repository and execute the git command.
795 my ($self, @args) = @_;
797 $self->repo_path() and $ENV{'GIT_DIR'} = $self->repo_path();
798 $self->wc_path() and chdir($self->wc_path());
799 $self->wc_subdir() and chdir($self->wc_subdir());
801 _execv_git_cmd
(@args);
802 die "exec failed: $!";
805 # Execute the given Git command ($_[0]) with arguments ($_[1..])
806 # by searching for it at proper places.
807 # _execv_git_cmd(), implemented in Git.xs.
809 # Close pipe to a subprocess.
814 # It's just close, no point in fatalities
815 carp
"error closing pipe: $!";
817 # The caller should pepper this.
818 throw Git
::Error
::Command
($ctx, $?
>> 8);
820 # else we might e.g. closed a live stream; the command
821 # dying of SIGPIPE would drive us here.
826 # Trickery for .xs routines: In order to avoid having some horrid
827 # C code trying to do stuff with undefs and hashes, we gate all
828 # xs calls through the following and in case we are being ran upon
829 # an instance call a C part of the gate which will set up the
830 # environment properly.
833 my ($self, @args) = _maybe_self
(@_);
836 # XXX: We ignore the WorkingCopy! To properly support
837 # that will require heavy changes in libgit.
838 # For now, when we will need to do it we could temporarily
839 # chdir() there and then chdir() back after the call is done.
841 xs__call_gate
($self->{id
}, $self->repo_path());
844 # Having to call throw from the C code is a sure path to insanity.
845 local $SIG{__DIE__
} = sub { throw Error
::Simple
("@_"); };
852 ($xsname = $AUTOLOAD) =~ s/.*:://;
853 throw Error
::Simple
("&Git::$xsname not defined") if $xsname =~ /^xs_/;
854 $xsname = 'xs_'.$xsname;
855 _call_gate
(\
&$xsname, @_);
861 # Pipe implementation for ActiveState Perl.
863 package Git
::activestate_pipe
;
867 my ($class, @params) = @_;
868 # FIXME: This is probably horrible idea and the thing will explode
869 # at the moment you give it arguments that require some quoting,
870 # but I have no ActiveState clue... --pasky
871 my $cmdline = join " ", @params;
872 my @data = qx{$cmdline};
873 bless { i
=> 0, data
=> \
@data }, $class;
878 if ($self->{i
} >= scalar @
{$self->{data
}}) {
881 return $self->{'data'}->[ $self->{i
}++ ];
886 delete $self->{data
};
892 return ($self->{i
} >= scalar @
{$self->{data
}});
896 1; # Famous last words