🌐 AI搜索 & 代理 主页
Google Git
Sign in
chromium / external / github.com / git / git / refs/tags/v2.10.4 / . / perl / Git.pm
blob: 864123fe8e61f7469b58fef06a04edeb561edd53 [file] [log] [blame]
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]1=head1 NAME
2
3Git - Perl interface to the Git version control system
4
5=cut
6
7
8package Git;
9
Ævar Arnfjörð Bjarmasond48b2842010-09-24 20:00:52[diff] [blame]10use 5.008;
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]11use strict;
12
13
14BEGIN {
15
16our ($VERSION, @ISA, @EXPORT, @EXPORT_OK);
17
18# Totally unstable API.
19$VERSION = '0.01';
20
21
22=head1 SYNOPSIS
23
24 use Git;
25
26 my $version = Git::command_oneline('version');
27
Petr Baudis8b9150e2006-06-24 02:34:44[diff] [blame]28 git_cmd_try { Git::command_noisy('update-server-info') }
29 '%s failed w/ code %d';
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]30
31 my $repo = Git->repository (Directory => '/srv/git/cogito.git');
32
33
34 my @revs = $repo->command('rev-list', '--since=last monday', '--all');
35
Petr Baudisd79850e2006-06-24 02:34:47[diff] [blame]36 my ($fh, $c) = $repo->command_output_pipe('rev-list', '--since=last monday', '--all');
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]37 my $lastrev = <$fh>; chomp $lastrev;
Petr Baudis8b9150e2006-06-24 02:34:44[diff] [blame]38 $repo->command_close_pipe($fh, $c);
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]39
Petr Baudisd43ba462006-06-24 02:34:49[diff] [blame]40 my $lastrev = $repo->command_oneline( [ 'rev-list', '--all' ],
41 STDERR => 0 );
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]42
Adam Roben71825302008-05-23 14:19:40[diff] [blame]43 my $sha1 = $repo->hash_and_insert_object('file.txt');
44 my $tempfile = tempfile();
45 my $size = $repo->cat_blob($sha1, $tempfile);
46
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]47=cut
48
49
50require Exporter;
51
52@ISA = qw(Exporter);
53
Petr Baudis8b9150e2006-06-24 02:34:44[diff] [blame]54@EXPORT = qw(git_cmd_try);
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]55
56# Methods which can be called as standalone functions as well:
Petr Baudisd79850e2006-06-24 02:34:47[diff] [blame]57@EXPORT_OK = qw(command command_oneline command_noisy
58 command_output_pipe command_input_pipe command_close_pipe
Adam Robend1a29af2008-05-23 14:19:39[diff] [blame]59 command_bidi_pipe command_close_bidi_pipe
Markus Heidelberg89a56bf2009-04-05 02:15:16[diff] [blame]60 version exec_path html_path hash_object git_cmd_try
Sven Strickroth38ecf3a2012-12-18 00:28:45[diff] [blame]61 remote_refs prompt
Ben Walton68868ff2013-02-09 21:46:56[diff] [blame]62 get_tz_offset
Michal Nazarewicz52dce6d2013-02-12 14:02:32[diff] [blame]63 credential credential_read credential_write
Kyle J. McKay4e63dcc2013-07-07 04:20:48[diff] [blame]64 temp_acquire temp_is_locked temp_release temp_reset temp_path);
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]65
66
67=head1 DESCRIPTION
68
69This module provides Perl scripts easy way to interface the Git version control
70system. The modules have an easy and well-tested way to call arbitrary Git
71commands; in the future, the interface will also provide specialized methods
72for doing easily operations which are not totally trivial to do over
73the generic command interface.
74
75While some commands can be executed outside of any context (e.g. 'version'
Nicolas Pitre5c94f872007-01-12 21:01:46[diff] [blame]76or 'init'), most operations require a repository context, which in practice
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]77means getting an instance of the Git object using the repository() constructor.
78(In the future, we will also get a new_repository() constructor.) All commands
79called as methods of the object are then executed in the context of the
80repository.
81
Petr Baudisd5c77212006-06-24 02:34:51[diff] [blame]82Part of the "repository state" is also information about path to the attached
83working copy (unless you work with a bare repository). You can also navigate
84inside of the working copy using the C<wc_chdir()> method. (Note that
85the repository object is self-contained and will not change working directory
86of your process.)
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]87
Petr Baudisd5c77212006-06-24 02:34:51[diff] [blame]88TODO: In the future, we might also do
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]89
90 my $remoterepo = $repo->remote_repository (Name => 'cogito', Branch => 'master');
91 $remoterepo ||= Git->remote_repository ('http://git.or.cz/cogito.git/');
92 my @refs = $remoterepo->refs();
93
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]94Currently, the module merely wraps calls to external Git tools. In the future,
95it will provide a much faster way to interact with Git by linking directly
96to libgit. This should be completely opaque to the user, though (performance
Abhijit Menon-Sen9751a322008-08-05 02:06:16[diff] [blame]97increase notwithstanding).
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]98
99=cut
100
101
Petr Baudis8b9150e2006-06-24 02:34:44[diff] [blame]102use Carp qw(carp croak); # but croak is bad - throw instead
Petr Baudis97b16c02006-06-24 02:34:42[diff] [blame]103use Error qw(:try);
Masatake Osanai48d9e6a2011-02-14 22:13:04[diff] [blame]104use Cwd qw(abs_path cwd);
Adam Robend1a29af2008-05-23 14:19:39[diff] [blame]105use IPC::Open2 qw(open2);
Marcus Griepe41352b2008-08-12 16:00:18[diff] [blame]106use Fcntl qw(SEEK_SET SEEK_CUR);
Ben Walton75f7b5d2013-02-09 21:46:57[diff] [blame]107use Time::Local qw(timegm);
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]108}
109
110
111=head1 CONSTRUCTORS
112
113=over 4
114
115=item repository ( OPTIONS )
116
117=item repository ( DIRECTORY )
118
119=item repository ()
120
121Construct a new repository object.
122C<OPTIONS> are passed in a hash like fashion, using key and value pairs.
123Possible options are:
124
125B<Repository> - Path to the Git repository.
126
127B<WorkingCopy> - Path to the associated working copy; not strictly required
128as many commands will happily crunch on a bare repository.
129
Petr Baudisd5c77212006-06-24 02:34:51[diff] [blame]130B<WorkingSubdir> - Subdirectory in the working copy to work inside.
131Just left undefined if you do not want to limit the scope of operations.
132
133B<Directory> - Path to the Git working directory in its usual setup.
134The C<.git> directory is searched in the directory and all the parent
135directories; if found, C<WorkingCopy> is set to the directory containing
136it and C<Repository> to the C<.git> directory itself. If no C<.git>
137directory was found, the C<Directory> is assumed to be a bare repository,
138C<Repository> is set to point at it and C<WorkingCopy> is left undefined.
139If the C<$GIT_DIR> environment variable is set, things behave as expected
140as well.
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]141
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]142You should not use both C<Directory> and either of C<Repository> and
143C<WorkingCopy> - the results of that are undefined.
144
145Alternatively, a directory path may be passed as a single scalar argument
146to the constructor; it is equivalent to setting only the C<Directory> option
147field.
148
149Calling the constructor with no options whatsoever is equivalent to
Petr Baudisd5c77212006-06-24 02:34:51[diff] [blame]150calling it with C<< Directory => '.' >>. In general, if you are building
151a standard porcelain command, simply doing C<< Git->repository() >> should
152do the right thing and setup the object to reflect exactly where the user
153is right now.
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]154
155=cut
156
157sub repository {
158 my $class = shift;
159 my @args = @_;
160 my %opts = ();
161 my $self;
162
163 if (defined $args[0]) {
164 if ($#args % 2 != 1) {
165 # Not a hash.
Petr Baudis97b16c02006-06-24 02:34:42[diff] [blame]166 $#args == 0 or throw Error::Simple("bad usage");
167 %opts = ( Directory => $args[0] );
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]168 } else {
169 %opts = @args;
170 }
Petr Baudisd5c77212006-06-24 02:34:51[diff] [blame]171 }
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]172
Philippe Bruhat (BooK)11b8a412008-12-29 00:25:00[diff] [blame]173 if (not defined $opts{Repository} and not defined $opts{WorkingCopy}
174 and not defined $opts{Directory}) {
175 $opts{Directory} = '.';
Petr Baudisd5c77212006-06-24 02:34:51[diff] [blame]176 }
177
Philippe Bruhat (BooK)11b8a412008-12-29 00:25:00[diff] [blame]178 if (defined $opts{Directory}) {
Philippe Bruhat (BooK)64abcc42010-06-17 23:47:31[diff] [blame]179 -d $opts{Directory} or throw Error::Simple("Directory not found: $opts{Directory} $!");
Petr Baudisd5c77212006-06-24 02:34:51[diff] [blame]180
181 my $search = Git->repository(WorkingCopy => $opts{Directory});
182 my $dir;
183 try {
184 $dir = $search->command_oneline(['rev-parse', '--git-dir'],
185 STDERR => 0);
186 } catch Git::Error::Command with {
187 $dir = undef;
188 };
189
190 if ($dir) {
Johannes Schindelin888ab712016-01-26 14:34:35[diff] [blame]191 _verify_require();
192 File::Spec->file_name_is_absolute($dir) or $dir = $opts{Directory} . '/' . $dir;
Frank Lichtenheldfe53bbc2009-05-07 13:41:28[diff] [blame]193 $opts{Repository} = abs_path($dir);
Petr Baudisd5c77212006-06-24 02:34:51[diff] [blame]194
195 # If --git-dir went ok, this shouldn't die either.
196 my $prefix = $search->command_oneline('rev-parse', '--show-prefix');
197 $dir = abs_path($opts{Directory}) . '/';
198 if ($prefix) {
199 if (substr($dir, -length($prefix)) ne $prefix) {
200 throw Error::Simple("rev-parse confused me - $dir does not have trailing $prefix");
201 }
202 substr($dir, -length($prefix)) = '';
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]203 }
Petr Baudisd5c77212006-06-24 02:34:51[diff] [blame]204 $opts{WorkingCopy} = $dir;
205 $opts{WorkingSubdir} = $prefix;
206
207 } else {
208 # A bare repository? Let's see...
209 $dir = $opts{Directory};
210
211 unless (-d "$dir/refs" and -d "$dir/objects" and -e "$dir/HEAD") {
Junio C Hamano9517e6b2010-02-04 05:23:18[diff] [blame]212 # Mimic git-rev-parse --git-dir error message:
Richard Hartmannf66bc5f2008-12-21 23:17:32[diff] [blame]213 throw Error::Simple("fatal: Not a git repository: $dir");
Petr Baudisd5c77212006-06-24 02:34:51[diff] [blame]214 }
215 my $search = Git->repository(Repository => $dir);
216 try {
217 $search->command('symbolic-ref', 'HEAD');
218 } catch Git::Error::Command with {
Junio C Hamano9517e6b2010-02-04 05:23:18[diff] [blame]219 # Mimic git-rev-parse --git-dir error message:
Richard Hartmannf66bc5f2008-12-21 23:17:32[diff] [blame]220 throw Error::Simple("fatal: Not a git repository: $dir");
Petr Baudisd5c77212006-06-24 02:34:51[diff] [blame]221 }
222
223 $opts{Repository} = abs_path($dir);
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]224 }
Petr Baudisd5c77212006-06-24 02:34:51[diff] [blame]225
226 delete $opts{Directory};
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]227 }
228
Junio C Hamano81a71732006-09-03 05:58:48[diff] [blame]229 $self = { opts => \%opts };
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]230 bless $self, $class;
231}
232
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]233=back
234
235=head1 METHODS
236
237=over 4
238
239=item command ( COMMAND [, ARGUMENTS... ] )
240
Petr Baudisd43ba462006-06-24 02:34:49[diff] [blame]241=item command ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
242
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]243Execute the given Git C<COMMAND> (specify it without the 'git-'
244prefix), optionally with the specified extra C<ARGUMENTS>.
245
Petr Baudisd43ba462006-06-24 02:34:49[diff] [blame]246The second more elaborate form can be used if you want to further adjust
247the command execution. Currently, only one option is supported:
248
249B<STDERR> - How to deal with the command's error output. By default (C<undef>)
250it is delivered to the caller's C<STDERR>. A false value (0 or '') will cause
251it to be thrown away. If you want to process it, you can get it in a filehandle
252you specify, but you must be extremely careful; if the error output is not
253very short and you want to read it in the same process as where you called
254C<command()>, you are set up for a nice deadlock!
255
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]256The method can be called without any instance or on a specified Git repository
257(in that case the command will be run in the repository context).
258
259In scalar context, it returns all the command output in a single string
260(verbatim).
261
262In array context, it returns an array containing lines printed to the
263command's stdout (without trailing newlines).
264
265In both cases, the command's stdin and stderr are the same as the caller's.
266
267=cut
268
269sub command {
Petr Baudisd79850e2006-06-24 02:34:47[diff] [blame]270 my ($fh, $ctx) = command_output_pipe(@_);
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]271
272 if (not defined wantarray) {
Petr Baudis8b9150e2006-06-24 02:34:44[diff] [blame]273 # Nothing to pepper the possible exception with.
Michal Nazarewicz1323dba2013-02-12 14:02:30[diff] [blame]274 _cmd_close($ctx, $fh);
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]275
276 } elsif (not wantarray) {
277 local $/;
278 my $text = <$fh>;
Petr Baudis8b9150e2006-06-24 02:34:44[diff] [blame]279 try {
Michal Nazarewicz1323dba2013-02-12 14:02:30[diff] [blame]280 _cmd_close($ctx, $fh);
Petr Baudis8b9150e2006-06-24 02:34:44[diff] [blame]281 } catch Git::Error::Command with {
282 # Pepper with the output:
283 my $E = shift;
284 $E->{'-outputref'} = \$text;
285 throw $E;
286 };
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]287 return $text;
288
289 } else {
290 my @lines = <$fh>;
Alex Riesen67e4baf2007-01-22 14:58:03[diff] [blame]291 defined and chomp for @lines;
Petr Baudis8b9150e2006-06-24 02:34:44[diff] [blame]292 try {
Michal Nazarewicz1323dba2013-02-12 14:02:30[diff] [blame]293 _cmd_close($ctx, $fh);
Petr Baudis8b9150e2006-06-24 02:34:44[diff] [blame]294 } catch Git::Error::Command with {
295 my $E = shift;
296 $E->{'-outputref'} = \@lines;
297 throw $E;
298 };
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]299 return @lines;
300 }
301}
302
303
304=item command_oneline ( COMMAND [, ARGUMENTS... ] )
305
Petr Baudisd43ba462006-06-24 02:34:49[diff] [blame]306=item command_oneline ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
307
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]308Execute the given C<COMMAND> in the same way as command()
309does but always return a scalar string containing the first line
310of the command's standard output.
311
312=cut
313
314sub command_oneline {
Petr Baudisd79850e2006-06-24 02:34:47[diff] [blame]315 my ($fh, $ctx) = command_output_pipe(@_);
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]316
317 my $line = <$fh>;
Petr Baudisd5c77212006-06-24 02:34:51[diff] [blame]318 defined $line and chomp $line;
Petr Baudis8b9150e2006-06-24 02:34:44[diff] [blame]319 try {
Michal Nazarewicz1323dba2013-02-12 14:02:30[diff] [blame]320 _cmd_close($ctx, $fh);
Petr Baudis8b9150e2006-06-24 02:34:44[diff] [blame]321 } catch Git::Error::Command with {
322 # Pepper with the output:
323 my $E = shift;
324 $E->{'-outputref'} = \$line;
325 throw $E;
326 };
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]327 return $line;
328}
329
330
Petr Baudisd79850e2006-06-24 02:34:47[diff] [blame]331=item command_output_pipe ( COMMAND [, ARGUMENTS... ] )
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]332
Petr Baudisd43ba462006-06-24 02:34:49[diff] [blame]333=item command_output_pipe ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
334
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]335Execute the given C<COMMAND> in the same way as command()
336does but return a pipe filehandle from which the command output can be
337read.
338
Petr Baudisd79850e2006-06-24 02:34:47[diff] [blame]339The function can return C<($pipe, $ctx)> in array context.
340See C<command_close_pipe()> for details.
341
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]342=cut
343
Petr Baudisd79850e2006-06-24 02:34:47[diff] [blame]344sub command_output_pipe {
345 _command_common_pipe('-|', @_);
346}
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]347
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]348
Petr Baudisd79850e2006-06-24 02:34:47[diff] [blame]349=item command_input_pipe ( COMMAND [, ARGUMENTS... ] )
350
Petr Baudisd43ba462006-06-24 02:34:49[diff] [blame]351=item command_input_pipe ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } )
352
Petr Baudisd79850e2006-06-24 02:34:47[diff] [blame]353Execute the given C<COMMAND> in the same way as command_output_pipe()
354does but return an input pipe filehandle instead; the command output
355is not captured.
356
357The function can return C<($pipe, $ctx)> in array context.
358See C<command_close_pipe()> for details.
359
360=cut
361
362sub command_input_pipe {
363 _command_common_pipe('|-', @_);
Petr Baudis8b9150e2006-06-24 02:34:44[diff] [blame]364}
365
366
367=item command_close_pipe ( PIPE [, CTX ] )
368
Petr Baudisd79850e2006-06-24 02:34:47[diff] [blame]369Close the C<PIPE> as returned from C<command_*_pipe()>, checking
Pavel Roskin3dff5372007-02-04 04:49:16[diff] [blame]370whether the command finished successfully. The optional C<CTX> argument
Petr Baudis8b9150e2006-06-24 02:34:44[diff] [blame]371is required if you want to see the command name in the error message,
Petr Baudisd79850e2006-06-24 02:34:47[diff] [blame]372and it is the second value returned by C<command_*_pipe()> when
Petr Baudis8b9150e2006-06-24 02:34:44[diff] [blame]373called in array context. The call idiom is:
374
Petr Baudisd79850e2006-06-24 02:34:47[diff] [blame]375 my ($fh, $ctx) = $r->command_output_pipe('status');
376 while (<$fh>) { ... }
377 $r->command_close_pipe($fh, $ctx);
Petr Baudis8b9150e2006-06-24 02:34:44[diff] [blame]378
379Note that you should not rely on whatever actually is in C<CTX>;
380currently it is simply the command name but in future the context might
381have more complicated structure.
382
383=cut
384
385sub command_close_pipe {
386 my ($self, $fh, $ctx) = _maybe_self(@_);
387 $ctx ||= '<unknown>';
Michal Nazarewicz1323dba2013-02-12 14:02:30[diff] [blame]388 _cmd_close($ctx, $fh);
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]389}
390
Adam Robend1a29af2008-05-23 14:19:39[diff] [blame]391=item command_bidi_pipe ( COMMAND [, ARGUMENTS... ] )
392
393Execute the given C<COMMAND> in the same way as command_output_pipe()
394does but return both an input pipe filehandle and an output pipe filehandle.
395
Li Peng832c0e52016-05-06 12:36:46[diff] [blame]396The function will return C<($pid, $pipe_in, $pipe_out, $ctx)>.
Adam Robend1a29af2008-05-23 14:19:39[diff] [blame]397See C<command_close_bidi_pipe()> for details.
398
399=cut
400
401sub command_bidi_pipe {
402 my ($pid, $in, $out);
Masatake Osanai48d9e6a2011-02-14 22:13:04[diff] [blame]403 my ($self) = _maybe_self(@_);
404 local %ENV = %ENV;
405 my $cwd_save = undef;
406 if ($self) {
407 shift;
408 $cwd_save = cwd();
409 _setup_git_cmd_env($self);
410 }
Adam Robend1a29af2008-05-23 14:19:39[diff] [blame]411 $pid = open2($in, $out, 'git', @_);
Masatake Osanai48d9e6a2011-02-14 22:13:04[diff] [blame]412 chdir($cwd_save) if $cwd_save;
Adam Robend1a29af2008-05-23 14:19:39[diff] [blame]413 return ($pid, $in, $out, join(' ', @_));
414}
415
416=item command_close_bidi_pipe ( PID, PIPE_IN, PIPE_OUT [, CTX] )
417
418Close the C<PIPE_IN> and C<PIPE_OUT> as returned from C<command_bidi_pipe()>,
419checking whether the command finished successfully. The optional C<CTX>
420argument is required if you want to see the command name in the error message,
421and it is the fourth value returned by C<command_bidi_pipe()>. The call idiom
422is:
423
424 my ($pid, $in, $out, $ctx) = $r->command_bidi_pipe('cat-file --batch-check');
Michal Nazarewicz8a2cc512013-02-07 14:01:18[diff] [blame]425 print $out "000000000\n";
Adam Robend1a29af2008-05-23 14:19:39[diff] [blame]426 while (<$in>) { ... }
427 $r->command_close_bidi_pipe($pid, $in, $out, $ctx);
428
429Note that you should not rely on whatever actually is in C<CTX>;
430currently it is simply the command name but in future the context might
431have more complicated structure.
432
Michal Nazarewiczf4c00352013-02-12 14:02:31[diff] [blame]433C<PIPE_IN> and C<PIPE_OUT> may be C<undef> if they have been closed prior to
434calling this function. This may be useful in a query-response type of
435commands where caller first writes a query and later reads response, eg:
436
437 my ($pid, $in, $out, $ctx) = $r->command_bidi_pipe('cat-file --batch-check');
438 print $out "000000000\n";
439 close $out;
440 while (<$in>) { ... }
441 $r->command_close_bidi_pipe($pid, $in, undef, $ctx);
442
443This idiom may prevent potential dead locks caused by data sent to the output
444pipe not being flushed and thus not reaching the executed command.
445
Adam Robend1a29af2008-05-23 14:19:39[diff] [blame]446=cut
447
448sub command_close_bidi_pipe {
Abhijit Menon-Sen108c2aa2008-08-04 11:38:27[diff] [blame]449 local $?;
Michal Nazarewicz1bc760a2013-02-07 14:01:17[diff] [blame]450 my ($self, $pid, $in, $out, $ctx) = _maybe_self(@_);
Michal Nazarewiczf4c00352013-02-12 14:02:31[diff] [blame]451 _cmd_close($ctx, (grep { defined } ($in, $out)));
Adam Robend1a29af2008-05-23 14:19:39[diff] [blame]452 waitpid $pid, 0;
Adam Robend1a29af2008-05-23 14:19:39[diff] [blame]453 if ($? >> 8) {
454 throw Git::Error::Command($ctx, $? >>8);
455 }
456}
457
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]458
459=item command_noisy ( COMMAND [, ARGUMENTS... ] )
460
461Execute the given C<COMMAND> in the same way as command() does but do not
462capture the command output - the standard output is not redirected and goes
463to the standard output of the caller application.
464
465While the method is called command_noisy(), you might want to as well use
466it for the most silent Git commands which you know will never pollute your
467stdout but you want to avoid the overhead of the pipe setup when calling them.
468
469The function returns only after the command has finished running.
470
471=cut
472
473sub command_noisy {
474 my ($self, $cmd, @args) = _maybe_self(@_);
Petr Baudisd79850e2006-06-24 02:34:47[diff] [blame]475 _check_valid_cmd($cmd);
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]476
477 my $pid = fork;
478 if (not defined $pid) {
Petr Baudis97b16c02006-06-24 02:34:42[diff] [blame]479 throw Error::Simple("fork failed: $!");
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]480 } elsif ($pid == 0) {
481 _cmd_exec($self, $cmd, @args);
482 }
Petr Baudis8b9150e2006-06-24 02:34:44[diff] [blame]483 if (waitpid($pid, 0) > 0 and $?>>8 != 0) {
484 throw Git::Error::Command(join(' ', $cmd, @args), $? >> 8);
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]485 }
486}
487
488
Petr Baudis63df97a2006-06-24 02:34:36[diff] [blame]489=item version ()
490
491Return the Git version in use.
492
Petr Baudis63df97a2006-06-24 02:34:36[diff] [blame]493=cut
494
Petr Baudis18b0fc12006-09-23 18:20:47[diff] [blame]495sub version {
496 my $verstr = command_oneline('--version');
497 $verstr =~ s/^git version //;
498 $verstr;
499}
Petr Baudis63df97a2006-06-24 02:34:36[diff] [blame]500
501
Petr Baudiseca1f6f2006-06-24 02:34:31[diff] [blame]502=item exec_path ()
503
Petr Baudisd5c77212006-06-24 02:34:51[diff] [blame]504Return path to the Git sub-command executables (the same as
Petr Baudiseca1f6f2006-06-24 02:34:31[diff] [blame]505C<git --exec-path>). Useful mostly only internally.
506
Petr Baudiseca1f6f2006-06-24 02:34:31[diff] [blame]507=cut
508
Petr Baudis18b0fc12006-09-23 18:20:47[diff] [blame]509sub exec_path { command_oneline('--exec-path') }
Petr Baudiseca1f6f2006-06-24 02:34:31[diff] [blame]510
511
Markus Heidelberg89a56bf2009-04-05 02:15:16[diff] [blame]512=item html_path ()
513
514Return path to the Git html documentation (the same as
515C<git --html-path>). Useful mostly only internally.
516
517=cut
518
519sub html_path { command_oneline('--html-path') }
520
Ben Walton68868ff2013-02-09 21:46:56[diff] [blame]521
522=item get_tz_offset ( TIME )
523
524Return the time zone offset from GMT in the form +/-HHMM where HH is
525the number of hours from GMT and MM is the number of minutes. This is
526the equivalent of what strftime("%z", ...) would provide on a GNU
527platform.
528
529If TIME is not supplied, the current local time is used.
530
531=cut
532
533sub get_tz_offset {
534 # some systmes don't handle or mishandle %z, so be creative.
535 my $t = shift || time;
Ben Walton75f7b5d2013-02-09 21:46:57[diff] [blame]536 my $gm = timegm(localtime($t));
537 my $sign = qw( + + - )[ $gm <=> $t ];
Ben Walton68868ff2013-02-09 21:46:56[diff] [blame]538 return sprintf("%s%02d%02d", $sign, (gmtime(abs($t - $gm)))[2,1]);
539}
540
541
Sven Strickrothe9263e42012-12-18 00:28:48[diff] [blame]542=item prompt ( PROMPT , ISPASSWORD )
Sven Strickroth38ecf3a2012-12-18 00:28:45[diff] [blame]543
544Query user C<PROMPT> and return answer from user.
545
Sven Strickroth8f3cab22012-12-18 00:28:47[diff] [blame]546Honours GIT_ASKPASS and SSH_ASKPASS environment variables for querying
547the user. If no *_ASKPASS variable is set or an error occoured,
Sven Strickroth38ecf3a2012-12-18 00:28:45[diff] [blame]548the terminal is tried as a fallback.
Sven Strickrothe9263e42012-12-18 00:28:48[diff] [blame]549If C<ISPASSWORD> is set and true, the terminal disables echo.
Sven Strickroth38ecf3a2012-12-18 00:28:45[diff] [blame]550
551=cut
552
553sub prompt {
Sven Strickrothe9263e42012-12-18 00:28:48[diff] [blame]554 my ($prompt, $isPassword) = @_;
Sven Strickroth38ecf3a2012-12-18 00:28:45[diff] [blame]555 my $ret;
556 if (exists $ENV{'GIT_ASKPASS'}) {
557 $ret = _prompt($ENV{'GIT_ASKPASS'}, $prompt);
558 }
Sven Strickroth8f3cab22012-12-18 00:28:47[diff] [blame]559 if (!defined $ret && exists $ENV{'SSH_ASKPASS'}) {
560 $ret = _prompt($ENV{'SSH_ASKPASS'}, $prompt);
561 }
Sven Strickroth38ecf3a2012-12-18 00:28:45[diff] [blame]562 if (!defined $ret) {
563 print STDERR $prompt;
564 STDERR->flush;
Sven Strickrothe9263e42012-12-18 00:28:48[diff] [blame]565 if (defined $isPassword && $isPassword) {
566 require Term::ReadKey;
567 Term::ReadKey::ReadMode('noecho');
568 $ret = '';
569 while (defined(my $key = Term::ReadKey::ReadKey(0))) {
570 last if $key =~ /[\012\015]/; # \n\r
571 $ret .= $key;
572 }
573 Term::ReadKey::ReadMode('restore');
574 print STDERR "\n";
575 STDERR->flush;
576 } else {
577 chomp($ret = <STDIN>);
Sven Strickroth38ecf3a2012-12-18 00:28:45[diff] [blame]578 }
Sven Strickroth38ecf3a2012-12-18 00:28:45[diff] [blame]579 }
580 return $ret;
581}
582
583sub _prompt {
584 my ($askpass, $prompt) = @_;
585 return unless length $askpass;
Sven Strickrothe9263e42012-12-18 00:28:48[diff] [blame]586 $prompt =~ s/\n/ /g;
Sven Strickroth38ecf3a2012-12-18 00:28:45[diff] [blame]587 my $ret;
588 open my $fh, "-|", $askpass, $prompt or return;
589 $ret = <$fh>;
590 $ret =~ s/[\015\012]//g; # strip \r\n, chomp does not work on all systems (i.e. windows) as expected
591 close ($fh);
592 return $ret;
593}
Markus Heidelberg89a56bf2009-04-05 02:15:16[diff] [blame]594
Petr Baudisd5c77212006-06-24 02:34:51[diff] [blame]595=item repo_path ()
596
597Return path to the git repository. Must be called on a repository instance.
598
599=cut
600
601sub repo_path { $_[0]->{opts}->{Repository} }
602
603
604=item wc_path ()
605
606Return path to the working copy. Must be called on a repository instance.
607
608=cut
609
610sub wc_path { $_[0]->{opts}->{WorkingCopy} }
611
612
613=item wc_subdir ()
614
615Return path to the subdirectory inside of a working copy. Must be called
616on a repository instance.
617
618=cut
619
620sub wc_subdir { $_[0]->{opts}->{WorkingSubdir} ||= '' }
621
622
623=item wc_chdir ( SUBDIR )
624
625Change the working copy subdirectory to work within. The C<SUBDIR> is
626relative to the working copy root directory (not the current subdirectory).
627Must be called on a repository instance attached to a working copy
628and the directory must exist.
629
630=cut
631
632sub wc_chdir {
633 my ($self, $subdir) = @_;
Petr Baudisd5c77212006-06-24 02:34:51[diff] [blame]634 $self->wc_path()
635 or throw Error::Simple("bare repository");
636
637 -d $self->wc_path().'/'.$subdir
Philippe Bruhat (BooK)64abcc42010-06-17 23:47:31[diff] [blame]638 or throw Error::Simple("subdir not found: $subdir $!");
Petr Baudisd5c77212006-06-24 02:34:51[diff] [blame]639 # Of course we will not "hold" the subdirectory so anyone
640 # can delete it now and we will never know. But at least we tried.
641
642 $self->{opts}->{WorkingSubdir} = $subdir;
643}
644
645
Petr Baudisdc2613d2006-07-03 20:47:55[diff] [blame]646=item config ( VARIABLE )
647
Tom Princee0d10e12007-01-29 00:16:53[diff] [blame]648Retrieve the configuration C<VARIABLE> in the same manner as C<config>
Petr Baudisdc2613d2006-07-03 20:47:55[diff] [blame]649does. In scalar context requires the variable to be set only one time
650(exception is thrown otherwise), in array context returns allows the
651variable to be set multiple times and returns all the values.
652
Petr Baudisdc2613d2006-07-03 20:47:55[diff] [blame]653=cut
654
655sub config {
Junio C Hamano6942a3d2011-10-18 09:47:01[diff] [blame]656 return _config_common({}, @_);
657}
658
659
660=item config_bool ( VARIABLE )
661
662Retrieve the bool configuration C<VARIABLE>. The return value
663is usable as a boolean in perl (and C<undef> if it's not defined,
664of course).
665
666=cut
667
668sub config_bool {
669 my $val = scalar _config_common({'kind' => '--bool'}, @_);
670
671 # Do not rewrite this as return (defined $val && $val eq 'true')
672 # as some callers do care what kind of falsehood they receive.
673 if (!defined $val) {
674 return undef;
675 } else {
676 return $val eq 'true';
677 }
678}
679
680
681=item config_path ( VARIABLE )
682
683Retrieve the path configuration C<VARIABLE>. The return value
684is an expanded path or C<undef> if it's not defined.
685
686=cut
687
688sub config_path {
689 return _config_common({'kind' => '--path'}, @_);
690}
691
692
693=item config_int ( VARIABLE )
694
695Retrieve the integer configuration C<VARIABLE>. The return value
696is simple decimal number. An optional value suffix of 'k', 'm',
697or 'g' in the config file will cause the value to be multiplied
698by 1024, 1048576 (1024^2), or 1073741824 (1024^3) prior to output.
Alexander Kuleshovef2956a2015-02-18 17:32:20[diff] [blame]699It would return C<undef> if configuration variable is not defined.
Junio C Hamano6942a3d2011-10-18 09:47:01[diff] [blame]700
701=cut
702
703sub config_int {
704 return scalar _config_common({'kind' => '--int'}, @_);
705}
706
707# Common subroutine to implement bulk of what the config* family of methods
Alexander Kuleshovef2956a2015-02-18 17:32:20[diff] [blame]708# do. This currently wraps command('config') so it is not so fast.
Junio C Hamano6942a3d2011-10-18 09:47:01[diff] [blame]709sub _config_common {
710 my ($opts) = shift @_;
Frank Lichtenheldc2e357c2008-03-14 17:29:28[diff] [blame]711 my ($self, $var) = _maybe_self(@_);
Petr Baudisdc2613d2006-07-03 20:47:55[diff] [blame]712
713 try {
Junio C Hamano6942a3d2011-10-18 09:47:01[diff] [blame]714 my @cmd = ('config', $opts->{'kind'} ? $opts->{'kind'} : ());
Frank Lichtenheldc2e357c2008-03-14 17:29:28[diff] [blame]715 unshift @cmd, $self if $self;
Petr Baudisdc2613d2006-07-03 20:47:55[diff] [blame]716 if (wantarray) {
Frank Lichtenheldc2e357c2008-03-14 17:29:28[diff] [blame]717 return command(@cmd, '--get-all', $var);
Petr Baudisdc2613d2006-07-03 20:47:55[diff] [blame]718 } else {
Frank Lichtenheldc2e357c2008-03-14 17:29:28[diff] [blame]719 return command_oneline(@cmd, '--get', $var);
Petr Baudisdc2613d2006-07-03 20:47:55[diff] [blame]720 }
721 } catch Git::Error::Command with {
722 my $E = shift;
723 if ($E->value() == 1) {
724 # Key not found.
Lea Wiemann32d80502008-06-01 20:34:47[diff] [blame]725 return;
Petr Baudisdc2613d2006-07-03 20:47:55[diff] [blame]726 } else {
727 throw $E;
728 }
729 };
730}
731
Junio C Hamanob4c61ed2007-12-05 08:50:23[diff] [blame]732=item get_colorbool ( NAME )
733
734Finds if color should be used for NAMEd operation from the configuration,
735and returns boolean (true for "use color", false for "do not use color").
736
737=cut
738
739sub get_colorbool {
740 my ($self, $var) = @_;
741 my $stdout_to_tty = (-t STDOUT) ? "true" : "false";
742 my $use_color = $self->command_oneline('config', '--get-colorbool',
743 $var, $stdout_to_tty);
744 return ($use_color eq 'true');
745}
746
747=item get_color ( SLOT, COLOR )
748
749Finds color for SLOT from the configuration, while defaulting to COLOR,
750and returns the ANSI color escape sequence:
751
752 print $repo->get_color("color.interactive.prompt", "underline blue white");
753 print "some text";
754 print $repo->get_color("", "normal");
755
756=cut
757
758sub get_color {
759 my ($self, $slot, $default) = @_;
760 my $color = $self->command_oneline('config', '--get-color', $slot, $default);
761 if (!defined $color) {
762 $color = "";
763 }
764 return $color;
765}
766
Petr Baudis31a92f62008-07-08 17:48:04[diff] [blame]767=item remote_refs ( REPOSITORY [, GROUPS [, REFGLOBS ] ] )
768
769This function returns a hashref of refs stored in a given remote repository.
770The hash is in the format C<refname =\> hash>. For tags, the C<refname> entry
771contains the tag object while a C<refname^{}> entry gives the tagged objects.
772
773C<REPOSITORY> has the same meaning as the appropriate C<git-ls-remote>
Jim Meyeringa7793a72012-03-28 08:41:54[diff] [blame]774argument; either a URL or a remote name (if called on a repository instance).
Petr Baudis31a92f62008-07-08 17:48:04[diff] [blame]775C<GROUPS> is an optional arrayref that can contain 'tags' to return all the
776tags and/or 'heads' to return all the heads. C<REFGLOB> is an optional array
777of strings containing a shell-like glob to further limit the refs returned in
778the hash; the meaning is again the same as the appropriate C<git-ls-remote>
779argument.
780
781This function may or may not be called on a repository instance. In the former
782case, remote names as defined in the repository are recognized as repository
783specifiers.
784
785=cut
786
787sub remote_refs {
788 my ($self, $repo, $groups, $refglobs) = _maybe_self(@_);
789 my @args;
790 if (ref $groups eq 'ARRAY') {
791 foreach (@$groups) {
792 if ($_ eq 'heads') {
793 push (@args, '--heads');
794 } elsif ($_ eq 'tags') {
795 push (@args, '--tags');
796 } else {
797 # Ignore unknown groups for future
798 # compatibility
799 }
800 }
801 }
802 push (@args, $repo);
803 if (ref $refglobs eq 'ARRAY') {
804 push (@args, @$refglobs);
805 }
806
807 my @self = $self ? ($self) : (); # Ultra trickery
808 my ($fh, $ctx) = Git::command_output_pipe(@self, 'ls-remote', @args);
809 my %refs;
810 while (<$fh>) {
811 chomp;
812 my ($hash, $ref) = split(/\t/, $_, 2);
813 $refs{$ref} = $hash;
814 }
815 Git::command_close_pipe(@self, $fh, $ctx);
816 return \%refs;
817}
818
819
Petr Baudisc7a30e52006-07-03 20:48:01[diff] [blame]820=item ident ( TYPE | IDENTSTR )
821
822=item ident_person ( TYPE | IDENTSTR | IDENTARRAY )
823
824This suite of functions retrieves and parses ident information, as stored
825in the commit and tag objects or produced by C<var GIT_type_IDENT> (thus
826C<TYPE> can be either I<author> or I<committer>; case is insignificant).
827
Todd Zullinger5354a562008-07-30 17:48:33[diff] [blame]828The C<ident> method retrieves the ident information from C<git var>
Petr Baudisc7a30e52006-07-03 20:48:01[diff] [blame]829and either returns it as a scalar string or as an array with the fields parsed.
830Alternatively, it can take a prepared ident string (e.g. from the commit
831object) and just parse it.
832
833C<ident_person> returns the person part of the ident - name and email;
834it can take the same arguments as C<ident> or the array returned by C<ident>.
835
836The synopsis is like:
837
838 my ($name, $email, $time_tz) = ident('author');
839 "$name <$email>" eq ident_person('author');
840 "$name <$email>" eq ident_person($name);
841 $time_tz =~ /^\d+ [+-]\d{4}$/;
842
Petr Baudisc7a30e52006-07-03 20:48:01[diff] [blame]843=cut
844
845sub ident {
Frank Lichtenheld44617922008-03-14 17:29:29[diff] [blame]846 my ($self, $type) = _maybe_self(@_);
Petr Baudisc7a30e52006-07-03 20:48:01[diff] [blame]847 my $identstr;
848 if (lc $type eq lc 'committer' or lc $type eq lc 'author') {
Frank Lichtenheld44617922008-03-14 17:29:29[diff] [blame]849 my @cmd = ('var', 'GIT_'.uc($type).'_IDENT');
850 unshift @cmd, $self if $self;
851 $identstr = command_oneline(@cmd);
Petr Baudisc7a30e52006-07-03 20:48:01[diff] [blame]852 } else {
853 $identstr = $type;
854 }
855 if (wantarray) {
856 return $identstr =~ /^(.*) <(.*)> (\d+ [+-]\d{4})$/;
857 } else {
858 return $identstr;
859 }
860}
861
862sub ident_person {
Frank Lichtenheld44617922008-03-14 17:29:29[diff] [blame]863 my ($self, @ident) = _maybe_self(@_);
864 $#ident == 0 and @ident = $self ? $self->ident($ident[0]) : ident($ident[0]);
Petr Baudisc7a30e52006-07-03 20:48:01[diff] [blame]865 return "$ident[0] <$ident[1]>";
866}
867
Remi Lespinet8d314d72015-07-07 13:38:15[diff] [blame]868=item parse_mailboxes
869
870Return an array of mailboxes extracted from a string.
871
872=cut
873
Matthieu Moydcfafc52016-10-21 09:20:24[diff] [blame]874# Very close to Mail::Address's parser, but we still have minor
875# differences in some cases (see t9000 for examples).
Remi Lespinet8d314d72015-07-07 13:38:15[diff] [blame]876sub parse_mailboxes {
877 my $re_comment = qr/\((?:[^)]*)\)/;
878 my $re_quote = qr/"(?:[^\"\\]|\\.)*"/;
879 my $re_word = qr/(?:[^]["\s()<>:;@\\,.]|\\.)+/;
880
881 # divide the string in tokens of the above form
882 my $re_token = qr/(?:$re_quote|$re_word|$re_comment|\S)/;
883 my @tokens = map { $_ =~ /\s*($re_token)\s*/g } @_;
Matthieu Moye3fdbcc2016-10-13 05:47:27[diff] [blame]884 my $end_of_addr_seen = 0;
Remi Lespinet8d314d72015-07-07 13:38:15[diff] [blame]885
886 # add a delimiter to simplify treatment for the last mailbox
887 push @tokens, ",";
888
889 my (@addr_list, @phrase, @address, @comment, @buffer) = ();
890 foreach my $token (@tokens) {
891 if ($token =~ /^[,;]$/) {
892 # if buffer still contains undeterminated strings
893 # append it at the end of @address or @phrase
Matthieu Moye3fdbcc2016-10-13 05:47:27[diff] [blame]894 if ($end_of_addr_seen) {
Remi Lespinet8d314d72015-07-07 13:38:15[diff] [blame]895 push @phrase, @buffer;
Matthieu Moye3fdbcc2016-10-13 05:47:27[diff] [blame]896 } else {
897 push @address, @buffer;
Remi Lespinet8d314d72015-07-07 13:38:15[diff] [blame]898 }
899
900 my $str_phrase = join ' ', @phrase;
901 my $str_address = join '', @address;
902 my $str_comment = join ' ', @comment;
903
904 # quote are necessary if phrase contains
905 # special characters
906 if ($str_phrase =~ /[][()<>:;@\\,.\000-\037\177]/) {
907 $str_phrase =~ s/(^|[^\\])"/$1/g;
908 $str_phrase = qq["$str_phrase"];
909 }
910
911 # add "<>" around the address if necessary
912 if ($str_address ne "" && $str_phrase ne "") {
913 $str_address = qq[<$str_address>];
914 }
915
916 my $str_mailbox = "$str_phrase $str_address $str_comment";
917 $str_mailbox =~ s/^\s*|\s*$//g;
918 push @addr_list, $str_mailbox if ($str_mailbox);
919
920 @phrase = @address = @comment = @buffer = ();
Matthieu Moye3fdbcc2016-10-13 05:47:27[diff] [blame]921 $end_of_addr_seen = 0;
Remi Lespinet8d314d72015-07-07 13:38:15[diff] [blame]922 } elsif ($token =~ /^\(/) {
923 push @comment, $token;
924 } elsif ($token eq "<") {
925 push @phrase, (splice @address), (splice @buffer);
926 } elsif ($token eq ">") {
Matthieu Moye3fdbcc2016-10-13 05:47:27[diff] [blame]927 $end_of_addr_seen = 1;
Remi Lespinet8d314d72015-07-07 13:38:15[diff] [blame]928 push @address, (splice @buffer);
Matthieu Moye3fdbcc2016-10-13 05:47:27[diff] [blame]929 } elsif ($token eq "@" && !$end_of_addr_seen) {
Remi Lespinet8d314d72015-07-07 13:38:15[diff] [blame]930 push @address, (splice @buffer), "@";
Remi Lespinet8d314d72015-07-07 13:38:15[diff] [blame]931 } else {
932 push @buffer, $token;
933 }
934 }
935
936 return @addr_list;
937}
Petr Baudisc7a30e52006-07-03 20:48:01[diff] [blame]938
Petr Baudis24c4b712006-06-25 01:54:26[diff] [blame]939=item hash_object ( TYPE, FILENAME )
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]940
Lea Wiemann58c8dd22008-06-01 20:26:25[diff] [blame]941Compute the SHA1 object id of the given C<FILENAME> considering it is
942of the C<TYPE> object type (C<blob>, C<commit>, C<tree>).
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]943
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]944The method can be called without any instance or on a specified Git repository,
945it makes zero difference.
946
947The function returns the SHA1 hash.
948
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]949=cut
950
Petr Baudis18b0fc12006-09-23 18:20:47[diff] [blame]951# TODO: Support for passing FILEHANDLE instead of FILENAME
Petr Baudise6634ac2006-07-01 23:38:56[diff] [blame]952sub hash_object {
953 my ($self, $type, $file) = _maybe_self(@_);
Petr Baudis18b0fc12006-09-23 18:20:47[diff] [blame]954 command_oneline('hash-object', '-t', $type, $file);
Petr Baudise6634ac2006-07-01 23:38:56[diff] [blame]955}
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]956
957
Adam Roben71825302008-05-23 14:19:40[diff] [blame]958=item hash_and_insert_object ( FILENAME )
959
960Compute the SHA1 object id of the given C<FILENAME> and add the object to the
961object database.
962
963The function returns the SHA1 hash.
964
965=cut
966
967# TODO: Support for passing FILEHANDLE instead of FILENAME
968sub hash_and_insert_object {
969 my ($self, $filename) = @_;
970
971 carp "Bad filename \"$filename\"" if $filename =~ /[\r\n]/;
972
973 $self->_open_hash_and_insert_object_if_needed();
974 my ($in, $out) = ($self->{hash_object_in}, $self->{hash_object_out});
975
976 unless (print $out $filename, "\n") {
977 $self->_close_hash_and_insert_object();
978 throw Error::Simple("out pipe went bad");
979 }
980
981 chomp(my $hash = <$in>);
982 unless (defined($hash)) {
983 $self->_close_hash_and_insert_object();
984 throw Error::Simple("in pipe went bad");
985 }
986
987 return $hash;
988}
989
990sub _open_hash_and_insert_object_if_needed {
991 my ($self) = @_;
992
993 return if defined($self->{hash_object_pid});
994
995 ($self->{hash_object_pid}, $self->{hash_object_in},
996 $self->{hash_object_out}, $self->{hash_object_ctx}) =
Masatake Osanai48d9e6a2011-02-14 22:13:04[diff] [blame]997 $self->command_bidi_pipe(qw(hash-object -w --stdin-paths --no-filters));
Adam Roben71825302008-05-23 14:19:40[diff] [blame]998}
999
1000sub _close_hash_and_insert_object {
1001 my ($self) = @_;
1002
1003 return unless defined($self->{hash_object_pid});
1004
1005 my @vars = map { 'hash_object_' . $_ } qw(pid in out ctx);
1006
Abhijit Menon-Sen452d36b2008-08-04 05:02:47[diff] [blame]1007 command_close_bidi_pipe(@$self{@vars});
1008 delete @$self{@vars};
Adam Roben71825302008-05-23 14:19:40[diff] [blame]1009}
1010
1011=item cat_blob ( SHA1, FILEHANDLE )
1012
1013Prints the contents of the blob identified by C<SHA1> to C<FILEHANDLE> and
1014returns the number of bytes printed.
1015
1016=cut
1017
1018sub cat_blob {
1019 my ($self, $sha1, $fh) = @_;
1020
1021 $self->_open_cat_blob_if_needed();
1022 my ($in, $out) = ($self->{cat_blob_in}, $self->{cat_blob_out});
1023
1024 unless (print $out $sha1, "\n") {
1025 $self->_close_cat_blob();
1026 throw Error::Simple("out pipe went bad");
1027 }
1028
1029 my $description = <$in>;
1030 if ($description =~ / missing$/) {
1031 carp "$sha1 doesn't exist in the repository";
Junio C Hamanod683a0e2008-05-28 06:33:22[diff] [blame]1032 return -1;
Adam Roben71825302008-05-23 14:19:40[diff] [blame]1033 }
1034
1035 if ($description !~ /^[0-9a-fA-F]{40} \S+ (\d+)$/) {
1036 carp "Unexpected result returned from git cat-file";
Junio C Hamanod683a0e2008-05-28 06:33:22[diff] [blame]1037 return -1;
Adam Roben71825302008-05-23 14:19:40[diff] [blame]1038 }
1039
1040 my $size = $1;
1041
1042 my $blob;
Joshua Clayton712c6ad2013-02-22 21:01:18[diff] [blame]1043 my $bytesLeft = $size;
Adam Roben71825302008-05-23 14:19:40[diff] [blame]1044
1045 while (1) {
Adam Roben71825302008-05-23 14:19:40[diff] [blame]1046 last unless $bytesLeft;
1047
1048 my $bytesToRead = $bytesLeft < 1024 ? $bytesLeft : 1024;
Joshua Clayton712c6ad2013-02-22 21:01:18[diff] [blame]1049 my $read = read($in, $blob, $bytesToRead);
Adam Roben71825302008-05-23 14:19:40[diff] [blame]1050 unless (defined($read)) {
1051 $self->_close_cat_blob();
1052 throw Error::Simple("in pipe went bad");
1053 }
Joshua Clayton712c6ad2013-02-22 21:01:18[diff] [blame]1054 unless (print $fh $blob) {
1055 $self->_close_cat_blob();
1056 throw Error::Simple("couldn't write to passed in filehandle");
1057 }
1058 $bytesLeft -= $read;
Adam Roben71825302008-05-23 14:19:40[diff] [blame]1059 }
1060
1061 # Skip past the trailing newline.
1062 my $newline;
1063 my $read = read($in, $newline, 1);
1064 unless (defined($read)) {
1065 $self->_close_cat_blob();
1066 throw Error::Simple("in pipe went bad");
1067 }
1068 unless ($read == 1 && $newline eq "\n") {
1069 $self->_close_cat_blob();
1070 throw Error::Simple("didn't find newline after blob");
1071 }
1072
Adam Roben71825302008-05-23 14:19:40[diff] [blame]1073 return $size;
1074}
1075
1076sub _open_cat_blob_if_needed {
1077 my ($self) = @_;
1078
1079 return if defined($self->{cat_blob_pid});
1080
1081 ($self->{cat_blob_pid}, $self->{cat_blob_in},
1082 $self->{cat_blob_out}, $self->{cat_blob_ctx}) =
Masatake Osanai48d9e6a2011-02-14 22:13:04[diff] [blame]1083 $self->command_bidi_pipe(qw(cat-file --batch));
Adam Roben71825302008-05-23 14:19:40[diff] [blame]1084}
1085
1086sub _close_cat_blob {
1087 my ($self) = @_;
1088
1089 return unless defined($self->{cat_blob_pid});
1090
1091 my @vars = map { 'cat_blob_' . $_ } qw(pid in out ctx);
1092
Abhijit Menon-Sen452d36b2008-08-04 05:02:47[diff] [blame]1093 command_close_bidi_pipe(@$self{@vars});
1094 delete @$self{@vars};
Adam Roben71825302008-05-23 14:19:40[diff] [blame]1095}
Petr Baudis8b9150e2006-06-24 02:34:44[diff] [blame]1096
Marcus Griepe41352b2008-08-12 16:00:18[diff] [blame]1097
Michal Nazarewicz52dce6d2013-02-12 14:02:32[diff] [blame]1098=item credential_read( FILEHANDLE )
1099
1100Reads credential key-value pairs from C<FILEHANDLE>. Reading stops at EOF or
1101when an empty line is encountered. Each line must be of the form C<key=value>
1102with a non-empty key. Function returns hash with all read values. Any white
1103space (other than new-line character) is preserved.
1104
1105=cut
1106
1107sub credential_read {
1108 my ($self, $reader) = _maybe_self(@_);
1109 my %credential;
1110 while (<$reader>) {
1111 chomp;
1112 if ($_ eq '') {
1113 last;
1114 } elsif (!/^([^=]+)=(.*)$/) {
1115 throw Error::Simple("unable to parse git credential data:\n$_");
1116 }
1117 $credential{$1} = $2;
1118 }
1119 return %credential;
1120}
1121
1122=item credential_write( FILEHANDLE, CREDENTIAL_HASHREF )
1123
1124Writes credential key-value pairs from hash referenced by
1125C<CREDENTIAL_HASHREF> to C<FILEHANDLE>. Keys and values cannot contain
1126new-lines or NUL bytes characters, and key cannot contain equal signs nor be
1127empty (if they do Error::Simple is thrown). Any white space is preserved. If
1128value for a key is C<undef>, it will be skipped.
1129
1130If C<'url'> key exists it will be written first. (All the other key-value
1131pairs are written in sorted order but you should not depend on that). Once
1132all lines are written, an empty line is printed.
1133
1134=cut
1135
1136sub credential_write {
1137 my ($self, $writer, $credential) = _maybe_self(@_);
1138 my ($key, $value);
1139
1140 # Check if $credential is valid prior to writing anything
1141 while (($key, $value) = each %$credential) {
1142 if (!defined $key || !length $key) {
1143 throw Error::Simple("credential key empty or undefined");
1144 } elsif ($key =~ /[=\n\0]/) {
1145 throw Error::Simple("credential key contains invalid characters: $key");
1146 } elsif (defined $value && $value =~ /[\n\0]/) {
1147 throw Error::Simple("credential value for key=$key contains invalid characters: $value");
1148 }
1149 }
1150
1151 for $key (sort {
1152 # url overwrites other fields, so it must come first
1153 return -1 if $a eq 'url';
1154 return 1 if $b eq 'url';
1155 return $a cmp $b;
1156 } keys %$credential) {
1157 if (defined $credential->{$key}) {
1158 print $writer $key, '=', $credential->{$key}, "\n";
1159 }
1160 }
1161 print $writer "\n";
1162}
1163
1164sub _credential_run {
1165 my ($self, $credential, $op) = _maybe_self(@_);
1166 my ($pid, $reader, $writer, $ctx) = command_bidi_pipe('credential', $op);
1167
1168 credential_write $writer, $credential;
1169 close $writer;
1170
1171 if ($op eq "fill") {
1172 %$credential = credential_read $reader;
1173 }
1174 if (<$reader>) {
1175 throw Error::Simple("unexpected output from git credential $op response:\n$_\n");
1176 }
1177
1178 command_close_bidi_pipe($pid, $reader, undef, $ctx);
1179}
1180
1181=item credential( CREDENTIAL_HASHREF [, OPERATION ] )
1182
1183=item credential( CREDENTIAL_HASHREF, CODE )
1184
1185Executes C<git credential> for a given set of credentials and specified
1186operation. In both forms C<CREDENTIAL_HASHREF> needs to be a reference to
1187a hash which stores credentials. Under certain conditions the hash can
1188change.
1189
1190In the first form, C<OPERATION> can be C<'fill'>, C<'approve'> or C<'reject'>,
1191and function will execute corresponding C<git credential> sub-command. If
1192it's omitted C<'fill'> is assumed. In case of C<'fill'> the values stored in
1193C<CREDENTIAL_HASHREF> will be changed to the ones returned by the C<git
1194credential fill> command. The usual usage would look something like:
1195
1196 my %cred = (
1197 'protocol' => 'https',
1198 'host' => 'example.com',
1199 'username' => 'bob'
1200 );
1201 Git::credential \%cred;
1202 if (try_to_authenticate($cred{'username'}, $cred{'password'})) {
1203 Git::credential \%cred, 'approve';
1204 ... do more stuff ...
1205 } else {
1206 Git::credential \%cred, 'reject';
1207 }
1208
1209In the second form, C<CODE> needs to be a reference to a subroutine. The
1210function will execute C<git credential fill> to fill the provided credential
1211hash, then call C<CODE> with C<CREDENTIAL_HASHREF> as the sole argument. If
1212C<CODE>'s return value is defined, the function will execute C<git credential
1213approve> (if return value yields true) or C<git credential reject> (if return
1214value is false). If the return value is undef, nothing at all is executed;
1215this is useful, for example, if the credential could neither be verified nor
1216rejected due to an unrelated network error. The return value is the same as
1217what C<CODE> returns. With this form, the usage might look as follows:
1218
1219 if (Git::credential {
1220 'protocol' => 'https',
1221 'host' => 'example.com',
1222 'username' => 'bob'
1223 }, sub {
1224 my $cred = shift;
1225 return !!try_to_authenticate($cred->{'username'},
1226 $cred->{'password'});
1227 }) {
1228 ... do more stuff ...
1229 }
1230
1231=cut
1232
1233sub credential {
1234 my ($self, $credential, $op_or_code) = (_maybe_self(@_), 'fill');
1235
1236 if ('CODE' eq ref $op_or_code) {
1237 _credential_run $credential, 'fill';
1238 my $ret = $op_or_code->($credential);
1239 if (defined $ret) {
1240 _credential_run $credential, $ret ? 'approve' : 'reject';
1241 }
1242 return $ret;
1243 } else {
1244 _credential_run $credential, $op_or_code;
1245 }
1246}
1247
Marcus Griepe41352b2008-08-12 16:00:18[diff] [blame]1248{ # %TEMP_* Lexical Context
1249
Marcus Griep836ff952008-09-08 16:53:01[diff] [blame]1250my (%TEMP_FILEMAP, %TEMP_FILES);
Marcus Griepe41352b2008-08-12 16:00:18[diff] [blame]1251
1252=item temp_acquire ( NAME )
1253
Stefano Lattarini41ccfdd2013-04-11 22:36:10[diff] [blame]1254Attempts to retrieve the temporary file mapped to the string C<NAME>. If an
Marcus Griepe41352b2008-08-12 16:00:18[diff] [blame]1255associated temp file has not been created this session or was closed, it is
1256created, cached, and set for autoflush and binmode.
1257
1258Internally locks the file mapped to C<NAME>. This lock must be released with
1259C<temp_release()> when the temp file is no longer needed. Subsequent attempts
1260to retrieve temporary files mapped to the same C<NAME> while still locked will
1261cause an error. This locking mechanism provides a weak guarantee and is not
1262threadsafe. It does provide some error checking to help prevent temp file refs
1263writing over one another.
1264
1265In general, the L<File::Handle> returned should not be closed by consumers as
1266it defeats the purpose of this caching mechanism. If you need to close the temp
1267file handle, then you should use L<File::Temp> or another temp file faculty
1268directly. If a handle is closed and then requested again, then a warning will
1269issue.
1270
1271=cut
1272
1273sub temp_acquire {
Marten Svanfeldt (dev)bcdd1b42008-11-13 12:04:09[diff] [blame]1274 my $temp_fd = _temp_cache(@_);
Marcus Griepe41352b2008-08-12 16:00:18[diff] [blame]1275
Marcus Griep836ff952008-09-08 16:53:01[diff] [blame]1276 $TEMP_FILES{$temp_fd}{locked} = 1;
Marcus Griepe41352b2008-08-12 16:00:18[diff] [blame]1277 $temp_fd;
1278}
1279
Kyle J. McKay4e63dcc2013-07-07 04:20:48[diff] [blame]1280=item temp_is_locked ( NAME )
1281
1282Returns true if the internal lock created by a previous C<temp_acquire()>
1283call with C<NAME> is still in effect.
1284
1285When temp_acquire is called on a C<NAME>, it internally locks the temporary
1286file mapped to C<NAME>. That lock will not be released until C<temp_release()>
1287is called with either the original C<NAME> or the L<File::Handle> that was
1288returned from the original call to temp_acquire.
1289
1290Subsequent attempts to call C<temp_acquire()> with the same C<NAME> will fail
1291unless there has been an intervening C<temp_release()> call for that C<NAME>
1292(or its corresponding L<File::Handle> that was returned by the original
1293C<temp_acquire()> call).
1294
1295If true is returned by C<temp_is_locked()> for a C<NAME>, an attempt to
1296C<temp_acquire()> the same C<NAME> will cause an error unless
1297C<temp_release> is first called on that C<NAME> (or its corresponding
1298L<File::Handle> that was returned by the original C<temp_acquire()> call).
1299
1300=cut
1301
1302sub temp_is_locked {
1303 my ($self, $name) = _maybe_self(@_);
1304 my $temp_fd = \$TEMP_FILEMAP{$name};
1305
1306 defined $$temp_fd && $$temp_fd->opened && $TEMP_FILES{$$temp_fd}{locked};
1307}
1308
Marcus Griepe41352b2008-08-12 16:00:18[diff] [blame]1309=item temp_release ( NAME )
1310
1311=item temp_release ( FILEHANDLE )
1312
1313Releases a lock acquired through C<temp_acquire()>. Can be called either with
1314the C<NAME> mapping used when acquiring the temp file or with the C<FILEHANDLE>
1315referencing a locked temp file.
1316
1317Warns if an attempt is made to release a file that is not locked.
1318
1319The temp file will be truncated before being released. This can help to reduce
1320disk I/O where the system is smart enough to detect the truncation while data
1321is in the output buffers. Beware that after the temp file is released and
1322truncated, any operations on that file may fail miserably until it is
1323re-acquired. All contents are lost between each release and acquire mapped to
1324the same string.
1325
1326=cut
1327
1328sub temp_release {
1329 my ($self, $temp_fd, $trunc) = _maybe_self(@_);
1330
Marcus Griep836ff952008-09-08 16:53:01[diff] [blame]1331 if (exists $TEMP_FILEMAP{$temp_fd}) {
Marcus Griepe41352b2008-08-12 16:00:18[diff] [blame]1332 $temp_fd = $TEMP_FILES{$temp_fd};
1333 }
Marcus Griep836ff952008-09-08 16:53:01[diff] [blame]1334 unless ($TEMP_FILES{$temp_fd}{locked}) {
Marcus Griepe41352b2008-08-12 16:00:18[diff] [blame]1335 carp "Attempt to release temp file '",
1336 $temp_fd, "' that has not been locked";
1337 }
1338 temp_reset($temp_fd) if $trunc and $temp_fd->opened;
1339
Marcus Griep836ff952008-09-08 16:53:01[diff] [blame]1340 $TEMP_FILES{$temp_fd}{locked} = 0;
Marcus Griepe41352b2008-08-12 16:00:18[diff] [blame]1341 undef;
1342}
1343
1344sub _temp_cache {
Marten Svanfeldt (dev)bcdd1b42008-11-13 12:04:09[diff] [blame]1345 my ($self, $name) = _maybe_self(@_);
Marcus Griepe41352b2008-08-12 16:00:18[diff] [blame]1346
Marcus Griepc14c8ce2008-08-15 19:53:59[diff] [blame]1347 _verify_require();
1348
Marcus Griep836ff952008-09-08 16:53:01[diff] [blame]1349 my $temp_fd = \$TEMP_FILEMAP{$name};
Marcus Griepe41352b2008-08-12 16:00:18[diff] [blame]1350 if (defined $$temp_fd and $$temp_fd->opened) {
Kyle J. McKay9c081072013-07-19 00:16:16[diff] [blame]1351 if ($TEMP_FILES{$$temp_fd}{locked}) {
Jay Soffian8faea4f2009-01-13 22:41:35[diff] [blame]1352 throw Error::Simple("Temp file with moniker '" .
1353 $name . "' already in use");
Marcus Griepe41352b2008-08-12 16:00:18[diff] [blame]1354 }
1355 } else {
1356 if (defined $$temp_fd) {
1357 # then we're here because of a closed handle.
1358 carp "Temp file '", $name,
1359 "' was closed. Opening replacement.";
1360 }
Marcus Griep836ff952008-09-08 16:53:01[diff] [blame]1361 my $fname;
Marten Svanfeldt (dev)bcdd1b42008-11-13 12:04:09[diff] [blame]1362
1363 my $tmpdir;
1364 if (defined $self) {
1365 $tmpdir = $self->repo_path();
1366 }
1367
Eric Wong822aaf02014-10-29 19:31:55[diff] [blame]1368 my $n = $name;
1369 $n =~ s/\W/_/g; # no strange chars
1370
H. Merijn Brandeafc2dd2013-04-29 08:09:57[diff] [blame]1371 ($$temp_fd, $fname) = File::Temp::tempfile(
Eric Wong822aaf02014-10-29 19:31:55[diff] [blame]1372 "Git_${n}_XXXXXX", UNLINK => 1, DIR => $tmpdir,
Marcus Griepe41352b2008-08-12 16:00:18[diff] [blame]1373 ) or throw Error::Simple("couldn't open new temp file");
Marten Svanfeldt (dev)bcdd1b42008-11-13 12:04:09[diff] [blame]1374
Marcus Griepe41352b2008-08-12 16:00:18[diff] [blame]1375 $$temp_fd->autoflush;
1376 binmode $$temp_fd;
Marcus Griep836ff952008-09-08 16:53:01[diff] [blame]1377 $TEMP_FILES{$$temp_fd}{fname} = $fname;
Marcus Griepe41352b2008-08-12 16:00:18[diff] [blame]1378 }
1379 $$temp_fd;
1380}
1381
Marcus Griepc14c8ce2008-08-15 19:53:59[diff] [blame]1382sub _verify_require {
1383 eval { require File::Temp; require File::Spec; };
1384 $@ and throw Error::Simple($@);
1385}
1386
Marcus Griepe41352b2008-08-12 16:00:18[diff] [blame]1387=item temp_reset ( FILEHANDLE )
1388
1389Truncates and resets the position of the C<FILEHANDLE>.
1390
1391=cut
1392
1393sub temp_reset {
1394 my ($self, $temp_fd) = _maybe_self(@_);
1395
1396 truncate $temp_fd, 0
1397 or throw Error::Simple("couldn't truncate file");
1398 sysseek($temp_fd, 0, SEEK_SET) and seek($temp_fd, 0, SEEK_SET)
1399 or throw Error::Simple("couldn't seek to beginning of file");
1400 sysseek($temp_fd, 0, SEEK_CUR) == 0 and tell($temp_fd) == 0
1401 or throw Error::Simple("expected file position to be reset");
1402}
1403
Marcus Griep836ff952008-09-08 16:53:01[diff] [blame]1404=item temp_path ( NAME )
1405
1406=item temp_path ( FILEHANDLE )
1407
1408Returns the filename associated with the given tempfile.
1409
1410=cut
1411
1412sub temp_path {
1413 my ($self, $temp_fd) = _maybe_self(@_);
1414
1415 if (exists $TEMP_FILEMAP{$temp_fd}) {
1416 $temp_fd = $TEMP_FILEMAP{$temp_fd};
1417 }
1418 $TEMP_FILES{$temp_fd}{fname};
1419}
1420
Marcus Griepe41352b2008-08-12 16:00:18[diff] [blame]1421sub END {
Marcus Griep836ff952008-09-08 16:53:01[diff] [blame]1422 unlink values %TEMP_FILEMAP if %TEMP_FILEMAP;
Marcus Griepe41352b2008-08-12 16:00:18[diff] [blame]1423}
1424
1425} # %TEMP_* Lexical Context
1426
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]1427=back
1428
Petr Baudis97b16c02006-06-24 02:34:42[diff] [blame]1429=head1 ERROR HANDLING
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]1430
Petr Baudis97b16c02006-06-24 02:34:42[diff] [blame]1431All functions are supposed to throw Perl exceptions in case of errors.
Petr Baudis8b9150e2006-06-24 02:34:44[diff] [blame]1432See the L<Error> module on how to catch those. Most exceptions are mere
1433L<Error::Simple> instances.
1434
1435However, the C<command()>, C<command_oneline()> and C<command_noisy()>
1436functions suite can throw C<Git::Error::Command> exceptions as well: those are
1437thrown when the external command returns an error code and contain the error
1438code as well as access to the captured command's output. The exception class
1439provides the usual C<stringify> and C<value> (command's exit code) methods and
1440in addition also a C<cmd_output> method that returns either an array or a
1441string with the captured command output (depending on the original function
1442call context; C<command_noisy()> returns C<undef>) and $<cmdline> which
1443returns the command and its arguments (but without proper quoting).
1444
Petr Baudisd79850e2006-06-24 02:34:47[diff] [blame]1445Note that the C<command_*_pipe()> functions cannot throw this exception since
Petr Baudis8b9150e2006-06-24 02:34:44[diff] [blame]1446it has no idea whether the command failed or not. You will only find out
1447at the time you C<close> the pipe; if you want to have that automated,
1448use C<command_close_pipe()>, which can throw the exception.
1449
1450=cut
1451
1452{
1453 package Git::Error::Command;
1454
1455 @Git::Error::Command::ISA = qw(Error);
1456
1457 sub new {
1458 my $self = shift;
1459 my $cmdline = '' . shift;
1460 my $value = 0 + shift;
1461 my $outputref = shift;
1462 my(@args) = ();
1463
1464 local $Error::Depth = $Error::Depth + 1;
1465
1466 push(@args, '-cmdline', $cmdline);
1467 push(@args, '-value', $value);
1468 push(@args, '-outputref', $outputref);
1469
1470 $self->SUPER::new(-text => 'command returned error', @args);
1471 }
1472
1473 sub stringify {
1474 my $self = shift;
1475 my $text = $self->SUPER::stringify;
1476 $self->cmdline() . ': ' . $text . ': ' . $self->value() . "\n";
1477 }
1478
1479 sub cmdline {
1480 my $self = shift;
1481 $self->{'-cmdline'};
1482 }
1483
1484 sub cmd_output {
1485 my $self = shift;
1486 my $ref = $self->{'-outputref'};
1487 defined $ref or undef;
1488 if (ref $ref eq 'ARRAY') {
1489 return @$ref;
1490 } else { # SCALAR
1491 return $$ref;
1492 }
1493 }
1494}
1495
1496=over 4
1497
1498=item git_cmd_try { CODE } ERRMSG
1499
1500This magical statement will automatically catch any C<Git::Error::Command>
1501exceptions thrown by C<CODE> and make your program die with C<ERRMSG>
1502on its lips; the message will have %s substituted for the command line
1503and %d for the exit status. This statement is useful mostly for producing
1504more user-friendly error messages.
1505
1506In case of no exception caught the statement returns C<CODE>'s return value.
1507
1508Note that this is the only auto-exported function.
1509
1510=cut
1511
1512sub git_cmd_try(&$) {
1513 my ($code, $errmsg) = @_;
1514 my @result;
1515 my $err;
1516 my $array = wantarray;
1517 try {
1518 if ($array) {
1519 @result = &$code;
1520 } else {
1521 $result[0] = &$code;
1522 }
1523 } catch Git::Error::Command with {
1524 my $E = shift;
1525 $err = $errmsg;
1526 $err =~ s/\%s/$E->cmdline()/ge;
1527 $err =~ s/\%d/$E->value()/ge;
1528 # We can't croak here since Error.pm would mangle
1529 # that to Error::Simple.
1530 };
1531 $err and croak $err;
1532 return $array ? @result : $result[0];
1533}
1534
1535
1536=back
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]1537
1538=head1 COPYRIGHT
1539
1540Copyright 2006 by Petr Baudis E<lt>pasky@suse.czE<gt>.
1541
1542This module is free software; it may be used, copied, modified
1543and distributed under the terms of the GNU General Public Licence,
1544either version 2, or (at your option) any later version.
1545
1546=cut
1547
1548
1549# Take raw method argument list and return ($obj, @args) in case
1550# the method was called upon an instance and (undef, @args) if
1551# it was called directly.
1552sub _maybe_self {
Christian Jaegerd8b24b92008-10-18 18:25:12[diff] [blame]1553 UNIVERSAL::isa($_[0], 'Git') ? @_ : (undef, @_);
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]1554}
1555
Petr Baudisd79850e2006-06-24 02:34:47[diff] [blame]1556# Check if the command id is something reasonable.
1557sub _check_valid_cmd {
1558 my ($cmd) = @_;
1559 $cmd =~ /^[a-z0-9A-Z_-]+$/ or throw Error::Simple("bad command: $cmd");
1560}
1561
1562# Common backend for the pipe creators.
1563sub _command_common_pipe {
1564 my $direction = shift;
Petr Baudisd43ba462006-06-24 02:34:49[diff] [blame]1565 my ($self, @p) = _maybe_self(@_);
1566 my (%opts, $cmd, @args);
1567 if (ref $p[0]) {
1568 ($cmd, @args) = @{shift @p};
1569 %opts = ref $p[0] ? %{$p[0]} : @p;
1570 } else {
1571 ($cmd, @args) = @p;
1572 }
Petr Baudisd79850e2006-06-24 02:34:47[diff] [blame]1573 _check_valid_cmd($cmd);
1574
Petr Baudisa6065b52006-06-25 01:54:23[diff] [blame]1575 my $fh;
Alex Riesend3b17852007-01-22 16:14:56[diff] [blame]1576 if ($^O eq 'MSWin32') {
Petr Baudisa6065b52006-06-25 01:54:23[diff] [blame]1577 # ActiveState Perl
1578 #defined $opts{STDERR} and
1579 # warn 'ignoring STDERR option - running w/ ActiveState';
1580 $direction eq '-|' or
1581 die 'input pipe for ActiveState not implemented';
Alex Riesenbed118d2007-01-22 16:16:05[diff] [blame]1582 # the strange construction with *ACPIPE is just to
1583 # explain the tie below that we want to bind to
1584 # a handle class, not scalar. It is not known if
1585 # it is something specific to ActiveState Perl or
1586 # just a Perl quirk.
1587 tie (*ACPIPE, 'Git::activestate_pipe', $cmd, @args);
1588 $fh = *ACPIPE;
Petr Baudisa6065b52006-06-25 01:54:23[diff] [blame]1589
1590 } else {
1591 my $pid = open($fh, $direction);
1592 if (not defined $pid) {
1593 throw Error::Simple("open failed: $!");
1594 } elsif ($pid == 0) {
Petr Baudisa6065b52006-06-25 01:54:23[diff] [blame]1595 if ($opts{STDERR}) {
1596 open (STDERR, '>&', $opts{STDERR})
1597 or die "dup failed: $!";
Thomas Rastbd4ca092013-04-04 20:41:41[diff] [blame]1598 } elsif (defined $opts{STDERR}) {
1599 open (STDERR, '>', '/dev/null')
1600 or die "opening /dev/null failed: $!";
Petr Baudisa6065b52006-06-25 01:54:23[diff] [blame]1601 }
1602 _cmd_exec($self, $cmd, @args);
Petr Baudisd43ba462006-06-24 02:34:49[diff] [blame]1603 }
Petr Baudisd79850e2006-06-24 02:34:47[diff] [blame]1604 }
1605 return wantarray ? ($fh, join(' ', $cmd, @args)) : $fh;
1606}
1607
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]1608# When already in the subprocess, set up the appropriate state
1609# for the given repository and execute the git command.
1610sub _cmd_exec {
1611 my ($self, @args) = @_;
Masatake Osanai48d9e6a2011-02-14 22:13:04[diff] [blame]1612 _setup_git_cmd_env($self);
1613 _execv_git_cmd(@args);
1614 die qq[exec "@args" failed: $!];
1615}
1616
1617# set up the appropriate state for git command
1618sub _setup_git_cmd_env {
1619 my $self = shift;
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]1620 if ($self) {
Petr Baudisd5c77212006-06-24 02:34:51[diff] [blame]1621 $self->repo_path() and $ENV{'GIT_DIR'} = $self->repo_path();
Frank Lichtenheldda159c72009-05-07 13:41:27[diff] [blame]1622 $self->repo_path() and $self->wc_path()
1623 and $ENV{'GIT_WORK_TREE'} = $self->wc_path();
Petr Baudisd5c77212006-06-24 02:34:51[diff] [blame]1624 $self->wc_path() and chdir($self->wc_path());
1625 $self->wc_subdir() and chdir($self->wc_subdir());
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]1626 }
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]1627}
1628
Petr Baudis8062f812006-06-24 02:34:34[diff] [blame]1629# Execute the given Git command ($_[0]) with arguments ($_[1..])
1630# by searching for it at proper places.
Petr Baudis18b0fc12006-09-23 18:20:47[diff] [blame]1631sub _execv_git_cmd { exec('git', @_); }
Petr Baudis8062f812006-06-24 02:34:34[diff] [blame]1632
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]1633# Close pipe to a subprocess.
1634sub _cmd_close {
Michal Nazarewicz1323dba2013-02-12 14:02:30[diff] [blame]1635 my $ctx = shift @_;
1636 foreach my $fh (@_) {
1637 if (close $fh) {
1638 # nop
1639 } elsif ($!) {
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]1640 # It's just close, no point in fatalities
1641 carp "error closing pipe: $!";
1642 } elsif ($? >> 8) {
Petr Baudis8b9150e2006-06-24 02:34:44[diff] [blame]1643 # The caller should pepper this.
1644 throw Git::Error::Command($ctx, $? >> 8);
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]1645 }
1646 # else we might e.g. closed a live stream; the command
1647 # dying of SIGPIPE would drive us here.
1648 }
1649}
1650
1651
Adam Roben71825302008-05-23 14:19:40[diff] [blame]1652sub DESTROY {
1653 my ($self) = @_;
1654 $self->_close_hash_and_insert_object();
1655 $self->_close_cat_blob();
1656}
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]1657
1658
Petr Baudisa6065b52006-06-25 01:54:23[diff] [blame]1659# Pipe implementation for ActiveState Perl.
1660
1661package Git::activestate_pipe;
1662use strict;
1663
1664sub TIEHANDLE {
1665 my ($class, @params) = @_;
1666 # FIXME: This is probably horrible idea and the thing will explode
1667 # at the moment you give it arguments that require some quoting,
1668 # but I have no ActiveState clue... --pasky
Alex Riesend3b17852007-01-22 16:14:56[diff] [blame]1669 # Let's just hope ActiveState Perl does at least the quoting
1670 # correctly.
1671 my @data = qx{git @params};
Petr Baudisa6065b52006-06-25 01:54:23[diff] [blame]1672 bless { i => 0, data => \@data }, $class;
1673}
1674
1675sub READLINE {
1676 my $self = shift;
1677 if ($self->{i} >= scalar @{$self->{data}}) {
1678 return undef;
1679 }
Alex Riesen2f5b3982007-08-22 16:13:07[diff] [blame]1680 my $i = $self->{i};
1681 if (wantarray) {
1682 $self->{i} = $#{$self->{'data'}} + 1;
1683 return splice(@{$self->{'data'}}, $i);
1684 }
1685 $self->{i} = $i + 1;
1686 return $self->{'data'}->[ $i ];
Petr Baudisa6065b52006-06-25 01:54:23[diff] [blame]1687}
1688
1689sub CLOSE {
1690 my $self = shift;
1691 delete $self->{data};
1692 delete $self->{i};
1693}
1694
1695sub EOF {
1696 my $self = shift;
1697 return ($self->{i} >= scalar @{$self->{data}});
1698}
1699
1700
Petr Baudisb1edc532006-06-24 02:34:29[diff] [blame]17011; # Famous last words