3 Git - Perl interface to the Git version control system
17 our ($VERSION, @ISA, @EXPORT, @EXPORT_OK);
19 # Totally unstable API.
27 my $version = Git::command_oneline('version');
29 git_cmd_try { Git::command_noisy('update-server-info') }
30 '%s failed w/ code %d';
32 my $repo = Git->repository (Directory => '/srv/git/cogito.git');
35 my @revs = $repo->command('rev-list', '--since=last monday', '--all');
37 my ($fh, $c) = $repo->command_output_pipe('rev-list', '--since=last monday', '--all');
38 my $lastrev = <$fh>; chomp $lastrev;
39 $repo->command_close_pipe($fh, $c);
41 my $lastrev = $repo->command_oneline( [ 'rev-list', '--all' ],
44 my $sha1 = $repo->hash_and_insert_object('file.txt');
45 my $tempfile = tempfile();
46 my $size = $repo->cat_blob($sha1, $tempfile);
55 @EXPORT = qw(git_cmd_try);
57 # Methods which can be called as standalone functions as well:
58 @EXPORT_OK = qw(command command_oneline command_noisy
59 command_output_pipe command_input_pipe command_close_pipe
60 command_bidi_pipe command_close_bidi_pipe
61 version exec_path html_path hash_object git_cmd_try
63 get_tz_offset get_record
64 credential credential_read credential_write
65 temp_acquire temp_is_locked temp_release temp_reset temp_path
71 This module provides Perl scripts easy way to interface the Git version control
72 system. The modules have an easy and well-tested way to call arbitrary Git
73 commands; in the future, the interface will also provide specialized methods
74 for doing easily operations which are not totally trivial to do over
75 the generic command interface.
77 While some commands can be executed outside of any context (e.g. 'version'
78 or 'init'), most operations require a repository context, which in practice
79 means getting an instance of the Git object using the repository() constructor.
80 (In the future, we will also get a new_repository() constructor.) All commands
81 called as methods of the object are then executed in the context of the
84 Part of the "repository state" is also information about path to the attached
85 working copy (unless you work with a bare repository). You can also navigate
86 inside of the working copy using the C<wc_chdir()> method. (Note that
87 the repository object is self-contained and will not change working directory
90 TODO: In the future, we might also do
92 my $remoterepo = $repo->remote_repository (Name => 'cogito', Branch => 'master');
93 $remoterepo ||= Git->remote_repository ('http://git.or.cz/cogito.git/');
94 my @refs = $remoterepo->refs();
96 Currently, the module merely wraps calls to external Git tools. In the future,
97 it will provide a much faster way to interact with Git by linking directly
98 to libgit. This should be completely opaque to the user, though (performance
99 increase notwithstanding).
104 use Carp
qw(carp croak); # but croak is bad - throw instead
105 use Git
::Error
qw(:try);
106 use Cwd
qw(abs_path cwd);
107 use IPC
::Open2
qw(open2);
108 use Fcntl
qw(SEEK_SET SEEK_CUR);
109 use Time
::Local
qw(timegm);
117 =item repository ( OPTIONS )
119 =item repository ( DIRECTORY )
123 Construct a new repository object.
124 C<OPTIONS> are passed in a hash like fashion, using key and value pairs.
125 Possible options are:
127 B<Repository> - Path to the Git repository.
129 B<WorkingCopy> - Path to the associated working copy; not strictly required
130 as many commands will happily crunch on a bare repository.
132 B<WorkingSubdir> - Subdirectory in the working copy to work inside.
133 Just left undefined if you do not want to limit the scope of operations.
135 B<Directory> - Path to the Git working directory in its usual setup.
136 The C<.git> directory is searched in the directory and all the parent
137 directories; if found, C<WorkingCopy> is set to the directory containing
138 it and C<Repository> to the C<.git> directory itself. If no C<.git>
139 directory was found, the C<Directory> is assumed to be a bare repository,
140 C<Repository> is set to point at it and C<WorkingCopy> is left undefined.
141 If the C<$GIT_DIR> environment variable is set, things behave as expected
144 You should not use both C<Directory> and either of C<Repository> and
145 C<WorkingCopy> - the results of that are undefined.
147 Alternatively, a directory path may be passed as a single scalar argument
148 to the constructor; it is equivalent to setting only the C<Directory> option
151 Calling the constructor with no options whatsoever is equivalent to
152 calling it with C<< Directory => '.' >>. In general, if you are building
153 a standard porcelain command, simply doing C<< Git->repository() >> should
154 do the right thing and setup the object to reflect exactly where the user
165 if (defined $args[0]) {
166 if ($#args % 2 != 1) {
168 $#args == 0 or throw Error
::Simple
("bad usage");
169 %opts = ( Directory
=> $args[0] );
175 if (not defined $opts{Repository
} and not defined $opts{WorkingCopy
}
176 and not defined $opts{Directory
}) {
177 $opts{Directory
} = '.';
180 if (defined $opts{Directory
}) {
181 -d
$opts{Directory
} or throw Error
::Simple
("Directory not found: $opts{Directory} $!");
183 my $search = Git
->repository(WorkingCopy
=> $opts{Directory
});
186 $dir = $search->command_oneline(['rev-parse', '--git-dir'],
188 } catch Git
::Error
::Command with
{
194 File
::Spec
->file_name_is_absolute($dir) or $dir = $opts{Directory
} . '/' . $dir;
195 $opts{Repository
} = abs_path
($dir);
197 # If --git-dir went ok, this shouldn't die either.
198 my $prefix = $search->command_oneline('rev-parse', '--show-prefix');
199 $dir = abs_path
($opts{Directory
}) . '/';
201 if (substr($dir, -length($prefix)) ne $prefix) {
202 throw Error
::Simple
("rev-parse confused me - $dir does not have trailing $prefix");
204 substr($dir, -length($prefix)) = '';
206 $opts{WorkingCopy
} = $dir;
207 $opts{WorkingSubdir
} = $prefix;
210 # A bare repository? Let's see...
211 $dir = $opts{Directory
};
213 unless (-d
"$dir/refs" and -d
"$dir/objects" and -e
"$dir/HEAD") {
214 # Mimic git-rev-parse --git-dir error message:
215 throw Error
::Simple
("fatal: Not a git repository: $dir");
217 my $search = Git
->repository(Repository
=> $dir);
219 $search->command('symbolic-ref', 'HEAD');
220 } catch Git
::Error
::Command with
{
221 # Mimic git-rev-parse --git-dir error message:
222 throw Error
::Simple
("fatal: Not a git repository: $dir");
225 $opts{Repository
} = abs_path
($dir);
228 delete $opts{Directory
};
231 $self = { opts
=> \
%opts };
241 =item command ( COMMAND [, ARGUMENTS... ] )
243 =item command ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
245 Execute the given Git C<COMMAND> (specify it without the 'git-'
246 prefix), optionally with the specified extra C<ARGUMENTS>.
248 The second more elaborate form can be used if you want to further adjust
249 the command execution. Currently, only one option is supported:
251 B<STDERR> - How to deal with the command's error output. By default (C<undef>)
252 it is delivered to the caller's C<STDERR>. A false value (0 or '') will cause
253 it to be thrown away. If you want to process it, you can get it in a filehandle
254 you specify, but you must be extremely careful; if the error output is not
255 very short and you want to read it in the same process as where you called
256 C<command()>, you are set up for a nice deadlock!
258 The method can be called without any instance or on a specified Git repository
259 (in that case the command will be run in the repository context).
261 In scalar context, it returns all the command output in a single string
264 In array context, it returns an array containing lines printed to the
265 command's stdout (without trailing newlines).
267 In both cases, the command's stdin and stderr are the same as the caller's.
272 my ($fh, $ctx) = command_output_pipe
(@_);
274 if (not defined wantarray) {
275 # Nothing to pepper the possible exception with.
276 _cmd_close
($ctx, $fh);
278 } elsif (not wantarray) {
282 _cmd_close
($ctx, $fh);
283 } catch Git
::Error
::Command with
{
284 # Pepper with the output:
286 $E->{'-outputref'} = \
$text;
293 defined and chomp for @lines;
295 _cmd_close
($ctx, $fh);
296 } catch Git
::Error
::Command with
{
298 $E->{'-outputref'} = \
@lines;
306 =item command_oneline ( COMMAND [, ARGUMENTS... ] )
308 =item command_oneline ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
310 Execute the given C<COMMAND> in the same way as command()
311 does but always return a scalar string containing the first line
312 of the command's standard output.
316 sub command_oneline
{
317 my ($fh, $ctx) = command_output_pipe
(@_);
320 defined $line and chomp $line;
322 _cmd_close
($ctx, $fh);
323 } catch Git
::Error
::Command with
{
324 # Pepper with the output:
326 $E->{'-outputref'} = \
$line;
333 =item command_output_pipe ( COMMAND [, ARGUMENTS... ] )
335 =item command_output_pipe ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
337 Execute the given C<COMMAND> in the same way as command()
338 does but return a pipe filehandle from which the command output can be
341 The function can return C<($pipe, $ctx)> in array context.
342 See C<command_close_pipe()> for details.
346 sub command_output_pipe
{
347 _command_common_pipe
('-|', @_);
351 =item command_input_pipe ( COMMAND [, ARGUMENTS... ] )
353 =item command_input_pipe ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
355 Execute the given C<COMMAND> in the same way as command_output_pipe()
356 does but return an input pipe filehandle instead; the command output
359 The function can return C<($pipe, $ctx)> in array context.
360 See C<command_close_pipe()> for details.
364 sub command_input_pipe
{
365 _command_common_pipe
('|-', @_);
369 =item command_close_pipe ( PIPE [, CTX ] )
371 Close the C<PIPE> as returned from C<command_*_pipe()>, checking
372 whether the command finished successfully. The optional C<CTX> argument
373 is required if you want to see the command name in the error message,
374 and it is the second value returned by C<command_*_pipe()> when
375 called in array context. The call idiom is:
377 my ($fh, $ctx) = $r->command_output_pipe('status');
378 while (<$fh>) { ... }
379 $r->command_close_pipe($fh, $ctx);
381 Note that you should not rely on whatever actually is in C<CTX>;
382 currently it is simply the command name but in future the context might
383 have more complicated structure.
387 sub command_close_pipe
{
388 my ($self, $fh, $ctx) = _maybe_self
(@_);
389 $ctx ||= '<unknown>';
390 _cmd_close
($ctx, $fh);
393 =item command_bidi_pipe ( COMMAND [, ARGUMENTS... ] )
395 Execute the given C<COMMAND> in the same way as command_output_pipe()
396 does but return both an input pipe filehandle and an output pipe filehandle.
398 The function will return C<($pid, $pipe_in, $pipe_out, $ctx)>.
399 See C<command_close_bidi_pipe()> for details.
403 sub command_bidi_pipe
{
404 my ($pid, $in, $out);
405 my ($self) = _maybe_self
(@_);
407 my $cwd_save = undef;
411 _setup_git_cmd_env
($self);
413 $pid = open2
($in, $out, 'git', @_);
414 chdir($cwd_save) if $cwd_save;
415 return ($pid, $in, $out, join(' ', @_));
418 =item command_close_bidi_pipe ( PID, PIPE_IN, PIPE_OUT [, CTX] )
420 Close the C<PIPE_IN> and C<PIPE_OUT> as returned from C<command_bidi_pipe()>,
421 checking whether the command finished successfully. The optional C<CTX>
422 argument is required if you want to see the command name in the error message,
423 and it is the fourth value returned by C<command_bidi_pipe()>. The call idiom
426 my ($pid, $in, $out, $ctx) = $r->command_bidi_pipe('cat-file --batch-check');
427 print $out "000000000\n";
428 while (<$in>) { ... }
429 $r->command_close_bidi_pipe($pid, $in, $out, $ctx);
431 Note that you should not rely on whatever actually is in C<CTX>;
432 currently it is simply the command name but in future the context might
433 have more complicated structure.
435 C<PIPE_IN> and C<PIPE_OUT> may be C<undef> if they have been closed prior to
436 calling this function. This may be useful in a query-response type of
437 commands where caller first writes a query and later reads response, eg:
439 my ($pid, $in, $out, $ctx) = $r->command_bidi_pipe('cat-file --batch-check');
440 print $out "000000000\n";
442 while (<$in>) { ... }
443 $r->command_close_bidi_pipe($pid, $in, undef, $ctx);
445 This idiom may prevent potential dead locks caused by data sent to the output
446 pipe not being flushed and thus not reaching the executed command.
450 sub command_close_bidi_pipe
{
452 my ($self, $pid, $in, $out, $ctx) = _maybe_self
(@_);
453 _cmd_close
($ctx, (grep { defined } ($in, $out)));
456 throw Git
::Error
::Command
($ctx, $?
>>8);
461 =item command_noisy ( COMMAND [, ARGUMENTS... ] )
463 Execute the given C<COMMAND> in the same way as command() does but do not
464 capture the command output - the standard output is not redirected and goes
465 to the standard output of the caller application.
467 While the method is called command_noisy(), you might want to as well use
468 it for the most silent Git commands which you know will never pollute your
469 stdout but you want to avoid the overhead of the pipe setup when calling them.
471 The function returns only after the command has finished running.
476 my ($self, $cmd, @args) = _maybe_self
(@_);
477 _check_valid_cmd
($cmd);
480 if (not defined $pid) {
481 throw Error
::Simple
("fork failed: $!");
482 } elsif ($pid == 0) {
483 _cmd_exec
($self, $cmd, @args);
485 if (waitpid($pid, 0) > 0 and $?
>>8 != 0) {
486 throw Git
::Error
::Command
(join(' ', $cmd, @args), $?
>> 8);
493 Return the Git version in use.
498 my $verstr = command_oneline
('--version');
499 $verstr =~ s/^git version //;
506 Return path to the Git sub-command executables (the same as
507 C<git --exec-path>). Useful mostly only internally.
511 sub exec_path
{ command_oneline
('--exec-path') }
516 Return path to the Git html documentation (the same as
517 C<git --html-path>). Useful mostly only internally.
521 sub html_path
{ command_oneline
('--html-path') }
524 =item get_tz_offset ( TIME )
526 Return the time zone offset from GMT in the form +/-HHMM where HH is
527 the number of hours from GMT and MM is the number of minutes. This is
528 the equivalent of what strftime("%z", ...) would provide on a GNU
531 If TIME is not supplied, the current local time is used.
536 # some systems don't handle or mishandle %z, so be creative.
537 my $t = shift || time;
538 my $gm = timegm
(localtime($t));
539 my $sign = qw( + + - )[ $gm <=> $t ];
540 return sprintf("%s%02d%02d", $sign, (gmtime(abs($t - $gm)))[2,1]);
543 =item get_record ( FILEHANDLE, INPUT_RECORD_SEPARATOR )
545 Read one record from FILEHANDLE delimited by INPUT_RECORD_SEPARATOR,
546 removing any trailing INPUT_RECORD_SEPARATOR.
554 chomp $rec if defined $rs;
558 =item prompt ( PROMPT , ISPASSWORD )
560 Query user C<PROMPT> and return answer from user.
562 Honours GIT_ASKPASS and SSH_ASKPASS environment variables for querying
563 the user. If no *_ASKPASS variable is set or an error occoured,
564 the terminal is tried as a fallback.
565 If C<ISPASSWORD> is set and true, the terminal disables echo.
570 my ($prompt, $isPassword) = @_;
572 if (exists $ENV{'GIT_ASKPASS'}) {
573 $ret = _prompt
($ENV{'GIT_ASKPASS'}, $prompt);
575 if (!defined $ret && exists $ENV{'SSH_ASKPASS'}) {
576 $ret = _prompt
($ENV{'SSH_ASKPASS'}, $prompt);
579 print STDERR
$prompt;
581 if (defined $isPassword && $isPassword) {
582 require Term
::ReadKey
;
583 Term
::ReadKey
::ReadMode
('noecho');
585 while (defined(my $key = Term
::ReadKey
::ReadKey
(0))) {
586 last if $key =~ /[\012\015]/; # \n\r
589 Term
::ReadKey
::ReadMode
('restore');
593 chomp($ret = <STDIN
>);
600 my ($askpass, $prompt) = @_;
601 return unless length $askpass;
604 open my $fh, "-|", $askpass, $prompt or return;
606 $ret =~ s/[\015\012]//g; # strip \r\n, chomp does not work on all systems (i.e. windows) as expected
613 Return path to the git repository. Must be called on a repository instance.
617 sub repo_path
{ $_[0]->{opts
}->{Repository
} }
622 Return path to the working copy. Must be called on a repository instance.
626 sub wc_path
{ $_[0]->{opts
}->{WorkingCopy
} }
631 Return path to the subdirectory inside of a working copy. Must be called
632 on a repository instance.
636 sub wc_subdir
{ $_[0]->{opts
}->{WorkingSubdir
} ||= '' }
639 =item wc_chdir ( SUBDIR )
641 Change the working copy subdirectory to work within. The C<SUBDIR> is
642 relative to the working copy root directory (not the current subdirectory).
643 Must be called on a repository instance attached to a working copy
644 and the directory must exist.
649 my ($self, $subdir) = @_;
651 or throw Error
::Simple
("bare repository");
653 -d
$self->wc_path().'/'.$subdir
654 or throw Error
::Simple
("subdir not found: $subdir $!");
655 # Of course we will not "hold" the subdirectory so anyone
656 # can delete it now and we will never know. But at least we tried.
658 $self->{opts
}->{WorkingSubdir
} = $subdir;
662 =item config ( VARIABLE )
664 Retrieve the configuration C<VARIABLE> in the same manner as C<config>
665 does. In scalar context requires the variable to be set only one time
666 (exception is thrown otherwise), in array context returns allows the
667 variable to be set multiple times and returns all the values.
672 return _config_common
({}, @_);
676 =item config_bool ( VARIABLE )
678 Retrieve the bool configuration C<VARIABLE>. The return value
679 is usable as a boolean in perl (and C<undef> if it's not defined,
685 my $val = scalar _config_common
({'kind' => '--bool'}, @_);
687 # Do not rewrite this as return (defined $val && $val eq 'true')
688 # as some callers do care what kind of falsehood they receive.
692 return $val eq 'true';
697 =item config_path ( VARIABLE )
699 Retrieve the path configuration C<VARIABLE>. The return value
700 is an expanded path or C<undef> if it's not defined.
705 return _config_common
({'kind' => '--path'}, @_);
709 =item config_int ( VARIABLE )
711 Retrieve the integer configuration C<VARIABLE>. The return value
712 is simple decimal number. An optional value suffix of 'k', 'm',
713 or 'g' in the config file will cause the value to be multiplied
714 by 1024, 1048576 (1024^2), or 1073741824 (1024^3) prior to output.
715 It would return C<undef> if configuration variable is not defined.
720 return scalar _config_common
({'kind' => '--int'}, @_);
723 # Common subroutine to implement bulk of what the config* family of methods
724 # do. This currently wraps command('config') so it is not so fast.
726 my ($opts) = shift @_;
727 my ($self, $var) = _maybe_self
(@_);
730 my @cmd = ('config', $opts->{'kind'} ?
$opts->{'kind'} : ());
731 unshift @cmd, $self if $self;
733 return command
(@cmd, '--get-all', $var);
735 return command_oneline
(@cmd, '--get', $var);
737 } catch Git
::Error
::Command with
{
739 if ($E->value() == 1) {
748 =item get_colorbool ( NAME )
750 Finds if color should be used for NAMEd operation from the configuration,
751 and returns boolean (true for "use color", false for "do not use color").
756 my ($self, $var) = @_;
757 my $stdout_to_tty = (-t STDOUT
) ?
"true" : "false";
758 my $use_color = $self->command_oneline('config', '--get-colorbool',
759 $var, $stdout_to_tty);
760 return ($use_color eq 'true');
763 =item get_color ( SLOT, COLOR )
765 Finds color for SLOT from the configuration, while defaulting to COLOR,
766 and returns the ANSI color escape sequence:
768 print $repo->get_color("color.interactive.prompt", "underline blue white");
770 print $repo->get_color("", "normal");
775 my ($self, $slot, $default) = @_;
776 my $color = $self->command_oneline('config', '--get-color', $slot, $default);
777 if (!defined $color) {
783 =item remote_refs ( REPOSITORY [, GROUPS [, REFGLOBS ] ] )
785 This function returns a hashref of refs stored in a given remote repository.
786 The hash is in the format C<refname =\> hash>. For tags, the C<refname> entry
787 contains the tag object while a C<refname^{}> entry gives the tagged objects.
789 C<REPOSITORY> has the same meaning as the appropriate C<git-ls-remote>
790 argument; either a URL or a remote name (if called on a repository instance).
791 C<GROUPS> is an optional arrayref that can contain 'tags' to return all the
792 tags and/or 'heads' to return all the heads. C<REFGLOB> is an optional array
793 of strings containing a shell-like glob to further limit the refs returned in
794 the hash; the meaning is again the same as the appropriate C<git-ls-remote>
797 This function may or may not be called on a repository instance. In the former
798 case, remote names as defined in the repository are recognized as repository
804 my ($self, $repo, $groups, $refglobs) = _maybe_self
(@_);
806 if (ref $groups eq 'ARRAY') {
809 push (@args, '--heads');
810 } elsif ($_ eq 'tags') {
811 push (@args, '--tags');
813 # Ignore unknown groups for future
819 if (ref $refglobs eq 'ARRAY') {
820 push (@args, @
$refglobs);
823 my @self = $self ?
($self) : (); # Ultra trickery
824 my ($fh, $ctx) = Git
::command_output_pipe
(@self, 'ls-remote', @args);
828 my ($hash, $ref) = split(/\t/, $_, 2);
831 Git
::command_close_pipe
(@self, $fh, $ctx);
836 =item ident ( TYPE | IDENTSTR )
838 =item ident_person ( TYPE | IDENTSTR | IDENTARRAY )
840 This suite of functions retrieves and parses ident information, as stored
841 in the commit and tag objects or produced by C<var GIT_type_IDENT> (thus
842 C<TYPE> can be either I<author> or I<committer>; case is insignificant).
844 The C<ident> method retrieves the ident information from C<git var>
845 and either returns it as a scalar string or as an array with the fields parsed.
846 Alternatively, it can take a prepared ident string (e.g. from the commit
847 object) and just parse it.
849 C<ident_person> returns the person part of the ident - name and email;
850 it can take the same arguments as C<ident> or the array returned by C<ident>.
852 The synopsis is like:
854 my ($name, $email, $time_tz) = ident('author');
855 "$name <$email>" eq ident_person('author');
856 "$name <$email>" eq ident_person($name);
857 $time_tz =~ /^\d+ [+-]\d{4}$/;
862 my ($self, $type) = _maybe_self
(@_);
864 if (lc $type eq lc 'committer' or lc $type eq lc 'author') {
865 my @cmd = ('var', 'GIT_'.uc($type).'_IDENT');
866 unshift @cmd, $self if $self;
867 $identstr = command_oneline
(@cmd);
872 return $identstr =~ /^(.*) <(.*)> (\d+ [+-]\d{4})$/;
879 my ($self, @ident) = _maybe_self
(@_);
880 $#ident == 0 and @ident = $self ?
$self->ident($ident[0]) : ident
($ident[0]);
881 return "$ident[0] <$ident[1]>";
884 =item hash_object ( TYPE, FILENAME )
886 Compute the SHA1 object id of the given C<FILENAME> considering it is
887 of the C<TYPE> object type (C<blob>, C<commit>, C<tree>).
889 The method can be called without any instance or on a specified Git repository,
890 it makes zero difference.
892 The function returns the SHA1 hash.
896 # TODO: Support for passing FILEHANDLE instead of FILENAME
898 my ($self, $type, $file) = _maybe_self
(@_);
899 command_oneline
('hash-object', '-t', $type, $file);
903 =item hash_and_insert_object ( FILENAME )
905 Compute the SHA1 object id of the given C<FILENAME> and add the object to the
908 The function returns the SHA1 hash.
912 # TODO: Support for passing FILEHANDLE instead of FILENAME
913 sub hash_and_insert_object
{
914 my ($self, $filename) = @_;
916 carp
"Bad filename \"$filename\"" if $filename =~ /[\r\n]/;
918 $self->_open_hash_and_insert_object_if_needed();
919 my ($in, $out) = ($self->{hash_object_in
}, $self->{hash_object_out
});
921 unless (print $out $filename, "\n") {
922 $self->_close_hash_and_insert_object();
923 throw Error
::Simple
("out pipe went bad");
926 chomp(my $hash = <$in>);
927 unless (defined($hash)) {
928 $self->_close_hash_and_insert_object();
929 throw Error
::Simple
("in pipe went bad");
935 sub _open_hash_and_insert_object_if_needed
{
938 return if defined($self->{hash_object_pid
});
940 ($self->{hash_object_pid
}, $self->{hash_object_in
},
941 $self->{hash_object_out
}, $self->{hash_object_ctx
}) =
942 $self->command_bidi_pipe(qw(hash-object -w --stdin-paths --no-filters));
945 sub _close_hash_and_insert_object
{
948 return unless defined($self->{hash_object_pid
});
950 my @vars = map { 'hash_object_' . $_ } qw(pid in out ctx);
952 command_close_bidi_pipe
(@
$self{@vars});
953 delete @
$self{@vars};
956 =item cat_blob ( SHA1, FILEHANDLE )
958 Prints the contents of the blob identified by C<SHA1> to C<FILEHANDLE> and
959 returns the number of bytes printed.
964 my ($self, $sha1, $fh) = @_;
966 $self->_open_cat_blob_if_needed();
967 my ($in, $out) = ($self->{cat_blob_in
}, $self->{cat_blob_out
});
969 unless (print $out $sha1, "\n") {
970 $self->_close_cat_blob();
971 throw Error
::Simple
("out pipe went bad");
974 my $description = <$in>;
975 if ($description =~ / missing$/) {
976 carp
"$sha1 doesn't exist in the repository";
980 if ($description !~ /^[0-9a-fA-F]{40} \S+ (\d+)$/) {
981 carp
"Unexpected result returned from git cat-file";
988 my $bytesLeft = $size;
991 last unless $bytesLeft;
993 my $bytesToRead = $bytesLeft < 1024 ?
$bytesLeft : 1024;
994 my $read = read($in, $blob, $bytesToRead);
995 unless (defined($read)) {
996 $self->_close_cat_blob();
997 throw Error
::Simple
("in pipe went bad");
999 unless (print $fh $blob) {
1000 $self->_close_cat_blob();
1001 throw Error
::Simple
("couldn't write to passed in filehandle");
1003 $bytesLeft -= $read;
1006 # Skip past the trailing newline.
1008 my $read = read($in, $newline, 1);
1009 unless (defined($read)) {
1010 $self->_close_cat_blob();
1011 throw Error
::Simple
("in pipe went bad");
1013 unless ($read == 1 && $newline eq "\n") {
1014 $self->_close_cat_blob();
1015 throw Error
::Simple
("didn't find newline after blob");
1021 sub _open_cat_blob_if_needed
{
1024 return if defined($self->{cat_blob_pid
});
1026 ($self->{cat_blob_pid
}, $self->{cat_blob_in
},
1027 $self->{cat_blob_out
}, $self->{cat_blob_ctx
}) =
1028 $self->command_bidi_pipe(qw(cat-file --batch));
1031 sub _close_cat_blob
{
1034 return unless defined($self->{cat_blob_pid
});
1036 my @vars = map { 'cat_blob_' . $_ } qw(pid in out ctx);
1038 command_close_bidi_pipe
(@
$self{@vars});
1039 delete @
$self{@vars};
1043 =item credential_read( FILEHANDLE )
1045 Reads credential key-value pairs from C<FILEHANDLE>. Reading stops at EOF or
1046 when an empty line is encountered. Each line must be of the form C<key=value>
1047 with a non-empty key. Function returns hash with all read values. Any white
1048 space (other than new-line character) is preserved.
1052 sub credential_read
{
1053 my ($self, $reader) = _maybe_self
(@_);
1059 } elsif (!/^([^=]+)=(.*)$/) {
1060 throw Error
::Simple
("unable to parse git credential data:\n$_");
1062 $credential{$1} = $2;
1067 =item credential_write( FILEHANDLE, CREDENTIAL_HASHREF )
1069 Writes credential key-value pairs from hash referenced by
1070 C<CREDENTIAL_HASHREF> to C<FILEHANDLE>. Keys and values cannot contain
1071 new-lines or NUL bytes characters, and key cannot contain equal signs nor be
1072 empty (if they do Error::Simple is thrown). Any white space is preserved. If
1073 value for a key is C<undef>, it will be skipped.
1075 If C<'url'> key exists it will be written first. (All the other key-value
1076 pairs are written in sorted order but you should not depend on that). Once
1077 all lines are written, an empty line is printed.
1081 sub credential_write
{
1082 my ($self, $writer, $credential) = _maybe_self
(@_);
1085 # Check if $credential is valid prior to writing anything
1086 while (($key, $value) = each %$credential) {
1087 if (!defined $key || !length $key) {
1088 throw Error
::Simple
("credential key empty or undefined");
1089 } elsif ($key =~ /[=\n\0]/) {
1090 throw Error
::Simple
("credential key contains invalid characters: $key");
1091 } elsif (defined $value && $value =~ /[\n\0]/) {
1092 throw Error
::Simple
("credential value for key=$key contains invalid characters: $value");
1097 # url overwrites other fields, so it must come first
1098 return -1 if $a eq 'url';
1099 return 1 if $b eq 'url';
1101 } keys %$credential) {
1102 if (defined $credential->{$key}) {
1103 print $writer $key, '=', $credential->{$key}, "\n";
1109 sub _credential_run
{
1110 my ($self, $credential, $op) = _maybe_self
(@_);
1111 my ($pid, $reader, $writer, $ctx) = command_bidi_pipe
('credential', $op);
1113 credential_write
$writer, $credential;
1116 if ($op eq "fill") {
1117 %$credential = credential_read
$reader;
1120 throw Error
::Simple
("unexpected output from git credential $op response:\n$_\n");
1123 command_close_bidi_pipe
($pid, $reader, undef, $ctx);
1126 =item credential( CREDENTIAL_HASHREF [, OPERATION ] )
1128 =item credential( CREDENTIAL_HASHREF, CODE )
1130 Executes C<git credential> for a given set of credentials and specified
1131 operation. In both forms C<CREDENTIAL_HASHREF> needs to be a reference to
1132 a hash which stores credentials. Under certain conditions the hash can
1135 In the first form, C<OPERATION> can be C<'fill'>, C<'approve'> or C<'reject'>,
1136 and function will execute corresponding C<git credential> sub-command. If
1137 it's omitted C<'fill'> is assumed. In case of C<'fill'> the values stored in
1138 C<CREDENTIAL_HASHREF> will be changed to the ones returned by the C<git
1139 credential fill> command. The usual usage would look something like:
1142 'protocol' => 'https',
1143 'host' => 'example.com',
1146 Git::credential \%cred;
1147 if (try_to_authenticate($cred{'username'}, $cred{'password'})) {
1148 Git::credential \%cred, 'approve';
1149 ... do more stuff ...
1151 Git::credential \%cred, 'reject';
1154 In the second form, C<CODE> needs to be a reference to a subroutine. The
1155 function will execute C<git credential fill> to fill the provided credential
1156 hash, then call C<CODE> with C<CREDENTIAL_HASHREF> as the sole argument. If
1157 C<CODE>'s return value is defined, the function will execute C<git credential
1158 approve> (if return value yields true) or C<git credential reject> (if return
1159 value is false). If the return value is undef, nothing at all is executed;
1160 this is useful, for example, if the credential could neither be verified nor
1161 rejected due to an unrelated network error. The return value is the same as
1162 what C<CODE> returns. With this form, the usage might look as follows:
1164 if (Git::credential {
1165 'protocol' => 'https',
1166 'host' => 'example.com',
1170 return !!try_to_authenticate($cred->{'username'},
1171 $cred->{'password'});
1173 ... do more stuff ...
1179 my ($self, $credential, $op_or_code) = (_maybe_self
(@_), 'fill');
1181 if ('CODE' eq ref $op_or_code) {
1182 _credential_run
$credential, 'fill';
1183 my $ret = $op_or_code->($credential);
1185 _credential_run
$credential, $ret ?
'approve' : 'reject';
1189 _credential_run
$credential, $op_or_code;
1193 { # %TEMP_* Lexical Context
1195 my (%TEMP_FILEMAP, %TEMP_FILES);
1197 =item temp_acquire ( NAME )
1199 Attempts to retrieve the temporary file mapped to the string C<NAME>. If an
1200 associated temp file has not been created this session or was closed, it is
1201 created, cached, and set for autoflush and binmode.
1203 Internally locks the file mapped to C<NAME>. This lock must be released with
1204 C<temp_release()> when the temp file is no longer needed. Subsequent attempts
1205 to retrieve temporary files mapped to the same C<NAME> while still locked will
1206 cause an error. This locking mechanism provides a weak guarantee and is not
1207 threadsafe. It does provide some error checking to help prevent temp file refs
1208 writing over one another.
1210 In general, the L<File::Handle> returned should not be closed by consumers as
1211 it defeats the purpose of this caching mechanism. If you need to close the temp
1212 file handle, then you should use L<File::Temp> or another temp file faculty
1213 directly. If a handle is closed and then requested again, then a warning will
1219 my $temp_fd = _temp_cache
(@_);
1221 $TEMP_FILES{$temp_fd}{locked
} = 1;
1225 =item temp_is_locked ( NAME )
1227 Returns true if the internal lock created by a previous C<temp_acquire()>
1228 call with C<NAME> is still in effect.
1230 When temp_acquire is called on a C<NAME>, it internally locks the temporary
1231 file mapped to C<NAME>. That lock will not be released until C<temp_release()>
1232 is called with either the original C<NAME> or the L<File::Handle> that was
1233 returned from the original call to temp_acquire.
1235 Subsequent attempts to call C<temp_acquire()> with the same C<NAME> will fail
1236 unless there has been an intervening C<temp_release()> call for that C<NAME>
1237 (or its corresponding L<File::Handle> that was returned by the original
1238 C<temp_acquire()> call).
1240 If true is returned by C<temp_is_locked()> for a C<NAME>, an attempt to
1241 C<temp_acquire()> the same C<NAME> will cause an error unless
1242 C<temp_release> is first called on that C<NAME> (or its corresponding
1243 L<File::Handle> that was returned by the original C<temp_acquire()> call).
1247 sub temp_is_locked
{
1248 my ($self, $name) = _maybe_self
(@_);
1249 my $temp_fd = \
$TEMP_FILEMAP{$name};
1251 defined $$temp_fd && $$temp_fd->opened && $TEMP_FILES{$$temp_fd}{locked
};
1254 =item temp_release ( NAME )
1256 =item temp_release ( FILEHANDLE )
1258 Releases a lock acquired through C<temp_acquire()>. Can be called either with
1259 the C<NAME> mapping used when acquiring the temp file or with the C<FILEHANDLE>
1260 referencing a locked temp file.
1262 Warns if an attempt is made to release a file that is not locked.
1264 The temp file will be truncated before being released. This can help to reduce
1265 disk I/O where the system is smart enough to detect the truncation while data
1266 is in the output buffers. Beware that after the temp file is released and
1267 truncated, any operations on that file may fail miserably until it is
1268 re-acquired. All contents are lost between each release and acquire mapped to
1274 my ($self, $temp_fd, $trunc) = _maybe_self
(@_);
1276 if (exists $TEMP_FILEMAP{$temp_fd}) {
1277 $temp_fd = $TEMP_FILES{$temp_fd};
1279 unless ($TEMP_FILES{$temp_fd}{locked
}) {
1280 carp
"Attempt to release temp file '",
1281 $temp_fd, "' that has not been locked";
1283 temp_reset
($temp_fd) if $trunc and $temp_fd->opened;
1285 $TEMP_FILES{$temp_fd}{locked
} = 0;
1290 my ($self, $name) = _maybe_self
(@_);
1294 my $temp_fd = \
$TEMP_FILEMAP{$name};
1295 if (defined $$temp_fd and $$temp_fd->opened) {
1296 if ($TEMP_FILES{$$temp_fd}{locked
}) {
1297 throw Error
::Simple
("Temp file with moniker '" .
1298 $name . "' already in use");
1301 if (defined $$temp_fd) {
1302 # then we're here because of a closed handle.
1303 carp
"Temp file '", $name,
1304 "' was closed. Opening replacement.";
1309 if (defined $self) {
1310 $tmpdir = $self->repo_path();
1314 $n =~ s/\W/_/g; # no strange chars
1316 ($$temp_fd, $fname) = File
::Temp
::tempfile
(
1317 "Git_${n}_XXXXXX", UNLINK
=> 1, DIR
=> $tmpdir,
1318 ) or throw Error
::Simple
("couldn't open new temp file");
1320 $$temp_fd->autoflush;
1322 $TEMP_FILES{$$temp_fd}{fname
} = $fname;
1327 sub _verify_require
{
1328 eval { require File
::Temp
; require File
::Spec
; };
1329 $@
and throw Error
::Simple
($@
);
1332 =item temp_reset ( FILEHANDLE )
1334 Truncates and resets the position of the C<FILEHANDLE>.
1339 my ($self, $temp_fd) = _maybe_self
(@_);
1341 truncate $temp_fd, 0
1342 or throw Error
::Simple
("couldn't truncate file");
1343 sysseek($temp_fd, 0, SEEK_SET
) and seek($temp_fd, 0, SEEK_SET
)
1344 or throw Error
::Simple
("couldn't seek to beginning of file");
1345 sysseek($temp_fd, 0, SEEK_CUR
) == 0 and tell($temp_fd) == 0
1346 or throw Error
::Simple
("expected file position to be reset");
1349 =item temp_path ( NAME )
1351 =item temp_path ( FILEHANDLE )
1353 Returns the filename associated with the given tempfile.
1358 my ($self, $temp_fd) = _maybe_self
(@_);
1360 if (exists $TEMP_FILEMAP{$temp_fd}) {
1361 $temp_fd = $TEMP_FILEMAP{$temp_fd};
1363 $TEMP_FILES{$temp_fd}{fname
};
1367 unlink values %TEMP_FILEMAP if %TEMP_FILEMAP;
1370 } # %TEMP_* Lexical Context
1372 =item prefix_lines ( PREFIX, STRING [, STRING... ])
1374 Prefixes lines in C<STRING> with C<PREFIX>.
1380 my $string = join("\n", @_);
1381 $string =~ s/^/$prefix/mg;
1385 =item unquote_path ( PATH )
1387 Unquote a quoted path containing c-escapes as returned by ls-files etc.
1388 when not using -z or when parsing the output of diff -u.
1407 my ($retval, $remainder);
1408 if (!/^\042(.*)\042$/) {
1411 ($_, $retval) = ($1, "");
1412 while (/^([^\\]*)\\(.*)$/) {
1416 if (/^([0-3][0-7][0-7])(.*)$/) {
1417 $retval .= chr(oct($1));
1421 if (/^([\\\042abtnvfr])(.*)$/) {
1422 $retval .= $cquote_map{$1};
1427 throw Error
::Simple
("invalid quoted path $_[0]");
1436 =item get_comment_line_char ( )
1438 Gets the core.commentchar configuration value.
1439 The value falls-back to '#' if core.commentchar is set to 'auto'.
1443 sub get_comment_line_char
{
1444 my $comment_line_char = config
("core.commentchar") || '#';
1445 $comment_line_char = '#' if ($comment_line_char eq 'auto');
1446 $comment_line_char = '#' if (length($comment_line_char) != 1);
1447 return $comment_line_char;
1450 =item comment_lines ( STRING [, STRING... ])
1452 Comments lines following core.commentchar configuration.
1457 my $comment_line_char = get_comment_line_char
;
1458 return prefix_lines
("$comment_line_char ", @_);
1463 =head1 ERROR HANDLING
1465 All functions are supposed to throw Perl exceptions in case of errors.
1466 See the L<Error> module on how to catch those. Most exceptions are mere
1467 L<Error::Simple> instances.
1469 However, the C<command()>, C<command_oneline()> and C<command_noisy()>
1470 functions suite can throw C<Git::Error::Command> exceptions as well: those are
1471 thrown when the external command returns an error code and contain the error
1472 code as well as access to the captured command's output. The exception class
1473 provides the usual C<stringify> and C<value> (command's exit code) methods and
1474 in addition also a C<cmd_output> method that returns either an array or a
1475 string with the captured command output (depending on the original function
1476 call context; C<command_noisy()> returns C<undef>) and $<cmdline> which
1477 returns the command and its arguments (but without proper quoting).
1479 Note that the C<command_*_pipe()> functions cannot throw this exception since
1480 it has no idea whether the command failed or not. You will only find out
1481 at the time you C<close> the pipe; if you want to have that automated,
1482 use C<command_close_pipe()>, which can throw the exception.
1487 package Git
::Error
::Command
;
1489 @Git::Error
::Command
::ISA
= qw(Error);
1493 my $cmdline = '' . shift;
1494 my $value = 0 + shift;
1495 my $outputref = shift;
1498 local $Error::Depth
= $Error::Depth
+ 1;
1500 push(@args, '-cmdline', $cmdline);
1501 push(@args, '-value', $value);
1502 push(@args, '-outputref', $outputref);
1504 $self->SUPER::new
(-text
=> 'command returned error', @args);
1509 my $text = $self->SUPER::stringify
;
1510 $self->cmdline() . ': ' . $text . ': ' . $self->value() . "\n";
1515 $self->{'-cmdline'};
1520 my $ref = $self->{'-outputref'};
1521 defined $ref or undef;
1522 if (ref $ref eq 'ARRAY') {
1532 =item git_cmd_try { CODE } ERRMSG
1534 This magical statement will automatically catch any C<Git::Error::Command>
1535 exceptions thrown by C<CODE> and make your program die with C<ERRMSG>
1536 on its lips; the message will have %s substituted for the command line
1537 and %d for the exit status. This statement is useful mostly for producing
1538 more user-friendly error messages.
1540 In case of no exception caught the statement returns C<CODE>'s return value.
1542 Note that this is the only auto-exported function.
1546 sub git_cmd_try
(&$) {
1547 my ($code, $errmsg) = @_;
1550 my $array = wantarray;
1555 $result[0] = &$code;
1557 } catch Git
::Error
::Command with
{
1560 $err =~ s/\%s/$E->cmdline()/ge;
1561 $err =~ s/\%d/$E->value()/ge;
1562 # We can't croak here since Error.pm would mangle
1563 # that to Error::Simple.
1565 $err and croak
$err;
1566 return $array ?
@result : $result[0];
1574 Copyright 2006 by Petr Baudis E<lt>pasky@suse.czE<gt>.
1576 This module is free software; it may be used, copied, modified
1577 and distributed under the terms of the GNU General Public Licence,
1578 either version 2, or (at your option) any later version.
1583 # Take raw method argument list and return ($obj, @args) in case
1584 # the method was called upon an instance and (undef, @args) if
1585 # it was called directly.
1587 UNIVERSAL
::isa
($_[0], 'Git') ?
@_ : (undef, @_);
1590 # Check if the command id is something reasonable.
1591 sub _check_valid_cmd
{
1593 $cmd =~ /^[a-z0-9A-Z_-]+$/ or throw Error
::Simple
("bad command: $cmd");
1596 # Common backend for the pipe creators.
1597 sub _command_common_pipe
{
1598 my $direction = shift;
1599 my ($self, @p) = _maybe_self
(@_);
1600 my (%opts, $cmd, @args);
1602 ($cmd, @args) = @
{shift @p};
1603 %opts = ref $p[0] ?
%{$p[0]} : @p;
1607 _check_valid_cmd
($cmd);
1610 if ($^O
eq 'MSWin32') {
1612 #defined $opts{STDERR} and
1613 # warn 'ignoring STDERR option - running w/ ActiveState';
1614 $direction eq '-|' or
1615 die 'input pipe for ActiveState not implemented';
1616 # the strange construction with *ACPIPE is just to
1617 # explain the tie below that we want to bind to
1618 # a handle class, not scalar. It is not known if
1619 # it is something specific to ActiveState Perl or
1620 # just a Perl quirk.
1621 tie
(*ACPIPE
, 'Git::activestate_pipe', $cmd, @args);
1625 my $pid = open($fh, $direction);
1626 if (not defined $pid) {
1627 throw Error
::Simple
("open failed: $!");
1628 } elsif ($pid == 0) {
1629 if ($opts{STDERR
}) {
1630 open (STDERR
, '>&', $opts{STDERR
})
1631 or die "dup failed: $!";
1632 } elsif (defined $opts{STDERR
}) {
1633 open (STDERR
, '>', '/dev/null')
1634 or die "opening /dev/null failed: $!";
1636 _cmd_exec
($self, $cmd, @args);
1639 return wantarray ?
($fh, join(' ', $cmd, @args)) : $fh;
1642 # When already in the subprocess, set up the appropriate state
1643 # for the given repository and execute the git command.
1645 my ($self, @args) = @_;
1646 _setup_git_cmd_env
($self);
1647 _execv_git_cmd
(@args);
1648 die qq[exec "@args" failed
: $!];
1651 # set up the appropriate state for git command
1652 sub _setup_git_cmd_env
{
1655 $self->repo_path() and $ENV{'GIT_DIR'} = $self->repo_path();
1656 $self->repo_path() and $self->wc_path()
1657 and $ENV{'GIT_WORK_TREE'} = $self->wc_path();
1658 $self->wc_path() and chdir($self->wc_path());
1659 $self->wc_subdir() and chdir($self->wc_subdir());
1663 # Execute the given Git command ($_[0]) with arguments ($_[1..])
1664 # by searching for it at proper places.
1665 sub _execv_git_cmd
{ exec('git', @_); }
1667 # Close pipe to a subprocess.
1670 foreach my $fh (@_) {
1674 # It's just close, no point in fatalities
1675 carp
"error closing pipe: $!";
1677 # The caller should pepper this.
1678 throw Git
::Error
::Command
($ctx, $?
>> 8);
1680 # else we might e.g. closed a live stream; the command
1681 # dying of SIGPIPE would drive us here.
1688 $self->_close_hash_and_insert_object();
1689 $self->_close_cat_blob();
1693 # Pipe implementation for ActiveState Perl.
1695 package Git
::activestate_pipe
;
1698 my ($class, @params) = @_;
1699 # FIXME: This is probably horrible idea and the thing will explode
1700 # at the moment you give it arguments that require some quoting,
1701 # but I have no ActiveState clue... --pasky
1702 # Let's just hope ActiveState Perl does at least the quoting
1704 my @data = qx{git
@params};
1705 bless { i
=> 0, data
=> \
@data }, $class;
1710 if ($self->{i
} >= scalar @
{$self->{data
}}) {
1715 $self->{i
} = $#{$self->{'data'}} + 1;
1716 return splice(@
{$self->{'data'}}, $i);
1718 $self->{i
} = $i + 1;
1719 return $self->{'data'}->[ $i ];
1724 delete $self->{data
};
1730 return ($self->{i
} >= scalar @
{$self->{data
}});
1734 1; # Famous last words