]>
Commit | Line | Data |
---|---|---|
b1edc53d PB |
1 | =head1 NAME |
2 | ||
3 | Git - Perl interface to the Git version control system | |
4 | ||
5 | =cut | |
6 | ||
7 | ||
8 | package Git; | |
9 | ||
d48b2841 | 10 | use 5.008; |
b1edc53d PB |
11 | use strict; |
12 | ||
13 | ||
14 | BEGIN { | |
15 | ||
16 | our ($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 | ||
8b9150e3 PB |
28 | git_cmd_try { Git::command_noisy('update-server-info') } |
29 | '%s failed w/ code %d'; | |
b1edc53d PB |
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 | ||
d79850e1 | 36 | my ($fh, $c) = $repo->command_output_pipe('rev-list', '--since=last monday', '--all'); |
b1edc53d | 37 | my $lastrev = <$fh>; chomp $lastrev; |
8b9150e3 | 38 | $repo->command_close_pipe($fh, $c); |
b1edc53d | 39 | |
d43ba468 PB |
40 | my $lastrev = $repo->command_oneline( [ 'rev-list', '--all' ], |
41 | STDERR => 0 ); | |
b1edc53d | 42 | |
7182530d AR |
43 | my $sha1 = $repo->hash_and_insert_object('file.txt'); |
44 | my $tempfile = tempfile(); | |
45 | my $size = $repo->cat_blob($sha1, $tempfile); | |
46 | ||
b1edc53d PB |
47 | =cut |
48 | ||
49 | ||
50 | require Exporter; | |
51 | ||
52 | @ISA = qw(Exporter); | |
53 | ||
8b9150e3 | 54 | @EXPORT = qw(git_cmd_try); |
b1edc53d PB |
55 | |
56 | # Methods which can be called as standalone functions as well: | |
d79850e1 PB |
57 | @EXPORT_OK = qw(command command_oneline command_noisy |
58 | command_output_pipe command_input_pipe command_close_pipe | |
d1a29af9 | 59 | command_bidi_pipe command_close_bidi_pipe |
89a56bfb | 60 | version exec_path html_path hash_object git_cmd_try |
38ecf3a3 | 61 | remote_refs prompt |
68868ff5 | 62 | get_tz_offset |
52dce6d0 | 63 | credential credential_read credential_write |
4e63dcc8 | 64 | temp_acquire temp_is_locked temp_release temp_reset temp_path); |
b1edc53d PB |
65 | |
66 | ||
67 | =head1 DESCRIPTION | |
68 | ||
69 | This module provides Perl scripts easy way to interface the Git version control | |
70 | system. The modules have an easy and well-tested way to call arbitrary Git | |
71 | commands; in the future, the interface will also provide specialized methods | |
72 | for doing easily operations which are not totally trivial to do over | |
73 | the generic command interface. | |
74 | ||
75 | While some commands can be executed outside of any context (e.g. 'version' | |
5c94f87e | 76 | or 'init'), most operations require a repository context, which in practice |
b1edc53d PB |
77 | means 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 | |
79 | called as methods of the object are then executed in the context of the | |
80 | repository. | |
81 | ||
d5c7721d PB |
82 | Part of the "repository state" is also information about path to the attached |
83 | working copy (unless you work with a bare repository). You can also navigate | |
84 | inside of the working copy using the C<wc_chdir()> method. (Note that | |
85 | the repository object is self-contained and will not change working directory | |
86 | of your process.) | |
b1edc53d | 87 | |
d5c7721d | 88 | TODO: In the future, we might also do |
b1edc53d PB |
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 | ||
b1edc53d PB |
94 | Currently, the module merely wraps calls to external Git tools. In the future, |
95 | it will provide a much faster way to interact with Git by linking directly | |
96 | to libgit. This should be completely opaque to the user, though (performance | |
9751a32a | 97 | increase notwithstanding). |
b1edc53d PB |
98 | |
99 | =cut | |
100 | ||
101 | ||
8b9150e3 | 102 | use Carp qw(carp croak); # but croak is bad - throw instead |
97b16c06 | 103 | use Error qw(:try); |
48d9e6ae | 104 | use Cwd qw(abs_path cwd); |
d1a29af9 | 105 | use IPC::Open2 qw(open2); |
e41352b2 | 106 | use Fcntl qw(SEEK_SET SEEK_CUR); |
75f7b5df | 107 | use Time::Local qw(timegm); |
b1edc53d PB |
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 | ||
121 | Construct a new repository object. | |
122 | C<OPTIONS> are passed in a hash like fashion, using key and value pairs. | |
123 | Possible options are: | |
124 | ||
125 | B<Repository> - Path to the Git repository. | |
126 | ||
127 | B<WorkingCopy> - Path to the associated working copy; not strictly required | |
128 | as many commands will happily crunch on a bare repository. | |
129 | ||
d5c7721d PB |
130 | B<WorkingSubdir> - Subdirectory in the working copy to work inside. |
131 | Just left undefined if you do not want to limit the scope of operations. | |
132 | ||
133 | B<Directory> - Path to the Git working directory in its usual setup. | |
134 | The C<.git> directory is searched in the directory and all the parent | |
135 | directories; if found, C<WorkingCopy> is set to the directory containing | |
136 | it and C<Repository> to the C<.git> directory itself. If no C<.git> | |
137 | directory was found, the C<Directory> is assumed to be a bare repository, | |
138 | C<Repository> is set to point at it and C<WorkingCopy> is left undefined. | |
139 | If the C<$GIT_DIR> environment variable is set, things behave as expected | |
140 | as well. | |
b1edc53d | 141 | |
b1edc53d PB |
142 | You should not use both C<Directory> and either of C<Repository> and |
143 | C<WorkingCopy> - the results of that are undefined. | |
144 | ||
145 | Alternatively, a directory path may be passed as a single scalar argument | |
146 | to the constructor; it is equivalent to setting only the C<Directory> option | |
147 | field. | |
148 | ||
149 | Calling the constructor with no options whatsoever is equivalent to | |
d5c7721d PB |
150 | calling it with C<< Directory => '.' >>. In general, if you are building |
151 | a standard porcelain command, simply doing C<< Git->repository() >> should | |
152 | do the right thing and setup the object to reflect exactly where the user | |
153 | is right now. | |
b1edc53d PB |
154 | |
155 | =cut | |
156 | ||
157 | sub 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. | |
97b16c06 PB |
166 | $#args == 0 or throw Error::Simple("bad usage"); |
167 | %opts = ( Directory => $args[0] ); | |
b1edc53d PB |
168 | } else { |
169 | %opts = @args; | |
170 | } | |
d5c7721d PB |
171 | } |
172 | ||
11b8a41c PB |
173 | if (not defined $opts{Repository} and not defined $opts{WorkingCopy} |
174 | and not defined $opts{Directory}) { | |
175 | $opts{Directory} = '.'; | |
d5c7721d PB |
176 | } |
177 | ||
11b8a41c | 178 | if (defined $opts{Directory}) { |
64abcc48 | 179 | -d $opts{Directory} or throw Error::Simple("Directory not found: $opts{Directory} $!"); |
d5c7721d PB |
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 | }; | |
b1edc53d | 189 | |
d5c7721d | 190 | if ($dir) { |
888ab716 JS |
191 | _verify_require(); |
192 | File::Spec->file_name_is_absolute($dir) or $dir = $opts{Directory} . '/' . $dir; | |
fe53bbc9 | 193 | $opts{Repository} = abs_path($dir); |
d5c7721d PB |
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)) = ''; | |
b1edc53d | 203 | } |
d5c7721d PB |
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") { | |
9517e6b8 | 212 | # Mimic git-rev-parse --git-dir error message: |
f66bc5f9 | 213 | throw Error::Simple("fatal: Not a git repository: $dir"); |
d5c7721d PB |
214 | } |
215 | my $search = Git->repository(Repository => $dir); | |
216 | try { | |
217 | $search->command('symbolic-ref', 'HEAD'); | |
218 | } catch Git::Error::Command with { | |
9517e6b8 | 219 | # Mimic git-rev-parse --git-dir error message: |
f66bc5f9 | 220 | throw Error::Simple("fatal: Not a git repository: $dir"); |
d5c7721d PB |
221 | } |
222 | ||
223 | $opts{Repository} = abs_path($dir); | |
b1edc53d | 224 | } |
d5c7721d PB |
225 | |
226 | delete $opts{Directory}; | |
b1edc53d PB |
227 | } |
228 | ||
81a71734 | 229 | $self = { opts => \%opts }; |
b1edc53d PB |
230 | bless $self, $class; |
231 | } | |
232 | ||
b1edc53d PB |
233 | =back |
234 | ||
235 | =head1 METHODS | |
236 | ||
237 | =over 4 | |
238 | ||
239 | =item command ( COMMAND [, ARGUMENTS... ] ) | |
240 | ||
d43ba468 PB |
241 | =item command ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } ) |
242 | ||
b1edc53d PB |
243 | Execute the given Git C<COMMAND> (specify it without the 'git-' |
244 | prefix), optionally with the specified extra C<ARGUMENTS>. | |
245 | ||
d43ba468 PB |
246 | The second more elaborate form can be used if you want to further adjust |
247 | the command execution. Currently, only one option is supported: | |
248 | ||
249 | B<STDERR> - How to deal with the command's error output. By default (C<undef>) | |
250 | it is delivered to the caller's C<STDERR>. A false value (0 or '') will cause | |
251 | it to be thrown away. If you want to process it, you can get it in a filehandle | |
252 | you specify, but you must be extremely careful; if the error output is not | |
253 | very short and you want to read it in the same process as where you called | |
254 | C<command()>, you are set up for a nice deadlock! | |
255 | ||
b1edc53d PB |
256 | The 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 | ||
259 | In scalar context, it returns all the command output in a single string | |
260 | (verbatim). | |
261 | ||
262 | In array context, it returns an array containing lines printed to the | |
263 | command's stdout (without trailing newlines). | |
264 | ||
265 | In both cases, the command's stdin and stderr are the same as the caller's. | |
266 | ||
267 | =cut | |
268 | ||
269 | sub command { | |
d79850e1 | 270 | my ($fh, $ctx) = command_output_pipe(@_); |
b1edc53d PB |
271 | |
272 | if (not defined wantarray) { | |
8b9150e3 | 273 | # Nothing to pepper the possible exception with. |
1323dba6 | 274 | _cmd_close($ctx, $fh); |
b1edc53d PB |
275 | |
276 | } elsif (not wantarray) { | |
277 | local $/; | |
278 | my $text = <$fh>; | |
8b9150e3 | 279 | try { |
1323dba6 | 280 | _cmd_close($ctx, $fh); |
8b9150e3 PB |
281 | } catch Git::Error::Command with { |
282 | # Pepper with the output: | |
283 | my $E = shift; | |
284 | $E->{'-outputref'} = \$text; | |
285 | throw $E; | |
286 | }; | |
b1edc53d PB |
287 | return $text; |
288 | ||
289 | } else { | |
290 | my @lines = <$fh>; | |
67e4baf8 | 291 | defined and chomp for @lines; |
8b9150e3 | 292 | try { |
1323dba6 | 293 | _cmd_close($ctx, $fh); |
8b9150e3 PB |
294 | } catch Git::Error::Command with { |
295 | my $E = shift; | |
296 | $E->{'-outputref'} = \@lines; | |
297 | throw $E; | |
298 | }; | |
b1edc53d PB |
299 | return @lines; |
300 | } | |
301 | } | |
302 | ||
303 | ||
304 | =item command_oneline ( COMMAND [, ARGUMENTS... ] ) | |
305 | ||
d43ba468 PB |
306 | =item command_oneline ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } ) |
307 | ||
b1edc53d PB |
308 | Execute the given C<COMMAND> in the same way as command() |
309 | does but always return a scalar string containing the first line | |
310 | of the command's standard output. | |
311 | ||
312 | =cut | |
313 | ||
314 | sub command_oneline { | |
d79850e1 | 315 | my ($fh, $ctx) = command_output_pipe(@_); |
b1edc53d PB |
316 | |
317 | my $line = <$fh>; | |
d5c7721d | 318 | defined $line and chomp $line; |
8b9150e3 | 319 | try { |
1323dba6 | 320 | _cmd_close($ctx, $fh); |
8b9150e3 PB |
321 | } catch Git::Error::Command with { |
322 | # Pepper with the output: | |
323 | my $E = shift; | |
324 | $E->{'-outputref'} = \$line; | |
325 | throw $E; | |
326 | }; | |
b1edc53d PB |
327 | return $line; |
328 | } | |
329 | ||
330 | ||
d79850e1 | 331 | =item command_output_pipe ( COMMAND [, ARGUMENTS... ] ) |
b1edc53d | 332 | |
d43ba468 PB |
333 | =item command_output_pipe ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } ) |
334 | ||
b1edc53d PB |
335 | Execute the given C<COMMAND> in the same way as command() |
336 | does but return a pipe filehandle from which the command output can be | |
337 | read. | |
338 | ||
d79850e1 PB |
339 | The function can return C<($pipe, $ctx)> in array context. |
340 | See C<command_close_pipe()> for details. | |
341 | ||
b1edc53d PB |
342 | =cut |
343 | ||
d79850e1 PB |
344 | sub command_output_pipe { |
345 | _command_common_pipe('-|', @_); | |
346 | } | |
b1edc53d | 347 | |
b1edc53d | 348 | |
d79850e1 PB |
349 | =item command_input_pipe ( COMMAND [, ARGUMENTS... ] ) |
350 | ||
d43ba468 PB |
351 | =item command_input_pipe ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } ) |
352 | ||
d79850e1 PB |
353 | Execute the given C<COMMAND> in the same way as command_output_pipe() |
354 | does but return an input pipe filehandle instead; the command output | |
355 | is not captured. | |
356 | ||
357 | The function can return C<($pipe, $ctx)> in array context. | |
358 | See C<command_close_pipe()> for details. | |
359 | ||
360 | =cut | |
361 | ||
362 | sub command_input_pipe { | |
363 | _command_common_pipe('|-', @_); | |
8b9150e3 PB |
364 | } |
365 | ||
366 | ||
367 | =item command_close_pipe ( PIPE [, CTX ] ) | |
368 | ||
d79850e1 | 369 | Close the C<PIPE> as returned from C<command_*_pipe()>, checking |
3dff5379 | 370 | whether the command finished successfully. The optional C<CTX> argument |
8b9150e3 | 371 | is required if you want to see the command name in the error message, |
d79850e1 | 372 | and it is the second value returned by C<command_*_pipe()> when |
8b9150e3 PB |
373 | called in array context. The call idiom is: |
374 | ||
d79850e1 PB |
375 | my ($fh, $ctx) = $r->command_output_pipe('status'); |
376 | while (<$fh>) { ... } | |
377 | $r->command_close_pipe($fh, $ctx); | |
8b9150e3 PB |
378 | |
379 | Note that you should not rely on whatever actually is in C<CTX>; | |
380 | currently it is simply the command name but in future the context might | |
381 | have more complicated structure. | |
382 | ||
383 | =cut | |
384 | ||
385 | sub command_close_pipe { | |
386 | my ($self, $fh, $ctx) = _maybe_self(@_); | |
387 | $ctx ||= '<unknown>'; | |
1323dba6 | 388 | _cmd_close($ctx, $fh); |
b1edc53d PB |
389 | } |
390 | ||
d1a29af9 AR |
391 | =item command_bidi_pipe ( COMMAND [, ARGUMENTS... ] ) |
392 | ||
393 | Execute the given C<COMMAND> in the same way as command_output_pipe() | |
394 | does but return both an input pipe filehandle and an output pipe filehandle. | |
395 | ||
832c0e5e | 396 | The function will return C<($pid, $pipe_in, $pipe_out, $ctx)>. |
d1a29af9 AR |
397 | See C<command_close_bidi_pipe()> for details. |
398 | ||
399 | =cut | |
400 | ||
401 | sub command_bidi_pipe { | |
402 | my ($pid, $in, $out); | |
48d9e6ae MO |
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 | } | |
d1a29af9 | 411 | $pid = open2($in, $out, 'git', @_); |
48d9e6ae | 412 | chdir($cwd_save) if $cwd_save; |
d1a29af9 AR |
413 | return ($pid, $in, $out, join(' ', @_)); |
414 | } | |
415 | ||
416 | =item command_close_bidi_pipe ( PID, PIPE_IN, PIPE_OUT [, CTX] ) | |
417 | ||
418 | Close the C<PIPE_IN> and C<PIPE_OUT> as returned from C<command_bidi_pipe()>, | |
419 | checking whether the command finished successfully. The optional C<CTX> | |
420 | argument is required if you want to see the command name in the error message, | |
421 | and it is the fourth value returned by C<command_bidi_pipe()>. The call idiom | |
422 | is: | |
423 | ||
424 | my ($pid, $in, $out, $ctx) = $r->command_bidi_pipe('cat-file --batch-check'); | |
8a2cc51b | 425 | print $out "000000000\n"; |
d1a29af9 AR |
426 | while (<$in>) { ... } |
427 | $r->command_close_bidi_pipe($pid, $in, $out, $ctx); | |
428 | ||
429 | Note that you should not rely on whatever actually is in C<CTX>; | |
430 | currently it is simply the command name but in future the context might | |
431 | have more complicated structure. | |
432 | ||
f4c0035d MN |
433 | C<PIPE_IN> and C<PIPE_OUT> may be C<undef> if they have been closed prior to |
434 | calling this function. This may be useful in a query-response type of | |
435 | commands 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 | ||
443 | This idiom may prevent potential dead locks caused by data sent to the output | |
444 | pipe not being flushed and thus not reaching the executed command. | |
445 | ||
d1a29af9 AR |
446 | =cut |
447 | ||
448 | sub command_close_bidi_pipe { | |
108c2aaf | 449 | local $?; |
1bc760ae | 450 | my ($self, $pid, $in, $out, $ctx) = _maybe_self(@_); |
f4c0035d | 451 | _cmd_close($ctx, (grep { defined } ($in, $out))); |
d1a29af9 | 452 | waitpid $pid, 0; |
d1a29af9 AR |
453 | if ($? >> 8) { |
454 | throw Git::Error::Command($ctx, $? >>8); | |
455 | } | |
456 | } | |
457 | ||
b1edc53d PB |
458 | |
459 | =item command_noisy ( COMMAND [, ARGUMENTS... ] ) | |
460 | ||
461 | Execute the given C<COMMAND> in the same way as command() does but do not | |
462 | capture the command output - the standard output is not redirected and goes | |
463 | to the standard output of the caller application. | |
464 | ||
465 | While the method is called command_noisy(), you might want to as well use | |
466 | it for the most silent Git commands which you know will never pollute your | |
467 | stdout but you want to avoid the overhead of the pipe setup when calling them. | |
468 | ||
469 | The function returns only after the command has finished running. | |
470 | ||
471 | =cut | |
472 | ||
473 | sub command_noisy { | |
474 | my ($self, $cmd, @args) = _maybe_self(@_); | |
d79850e1 | 475 | _check_valid_cmd($cmd); |
b1edc53d PB |
476 | |
477 | my $pid = fork; | |
478 | if (not defined $pid) { | |
97b16c06 | 479 | throw Error::Simple("fork failed: $!"); |
b1edc53d PB |
480 | } elsif ($pid == 0) { |
481 | _cmd_exec($self, $cmd, @args); | |
482 | } | |
8b9150e3 PB |
483 | if (waitpid($pid, 0) > 0 and $?>>8 != 0) { |
484 | throw Git::Error::Command(join(' ', $cmd, @args), $? >> 8); | |
b1edc53d PB |
485 | } |
486 | } | |
487 | ||
488 | ||
63df97ae PB |
489 | =item version () |
490 | ||
491 | Return the Git version in use. | |
492 | ||
63df97ae PB |
493 | =cut |
494 | ||
18b0fc1c PB |
495 | sub version { |
496 | my $verstr = command_oneline('--version'); | |
497 | $verstr =~ s/^git version //; | |
498 | $verstr; | |
499 | } | |
63df97ae PB |
500 | |
501 | ||
eca1f6fd PB |
502 | =item exec_path () |
503 | ||
d5c7721d | 504 | Return path to the Git sub-command executables (the same as |
eca1f6fd PB |
505 | C<git --exec-path>). Useful mostly only internally. |
506 | ||
eca1f6fd PB |
507 | =cut |
508 | ||
18b0fc1c | 509 | sub exec_path { command_oneline('--exec-path') } |
eca1f6fd PB |
510 | |
511 | ||
89a56bfb MH |
512 | =item html_path () |
513 | ||
514 | Return path to the Git html documentation (the same as | |
515 | C<git --html-path>). Useful mostly only internally. | |
516 | ||
517 | =cut | |
518 | ||
519 | sub html_path { command_oneline('--html-path') } | |
520 | ||
68868ff5 BW |
521 | |
522 | =item get_tz_offset ( TIME ) | |
523 | ||
524 | Return the time zone offset from GMT in the form +/-HHMM where HH is | |
525 | the number of hours from GMT and MM is the number of minutes. This is | |
526 | the equivalent of what strftime("%z", ...) would provide on a GNU | |
527 | platform. | |
528 | ||
529 | If TIME is not supplied, the current local time is used. | |
530 | ||
531 | =cut | |
532 | ||
533 | sub get_tz_offset { | |
534 | # some systmes don't handle or mishandle %z, so be creative. | |
535 | my $t = shift || time; | |
75f7b5df BW |
536 | my $gm = timegm(localtime($t)); |
537 | my $sign = qw( + + - )[ $gm <=> $t ]; | |
68868ff5 BW |
538 | return sprintf("%s%02d%02d", $sign, (gmtime(abs($t - $gm)))[2,1]); |
539 | } | |
540 | ||
541 | ||
e9263e45 | 542 | =item prompt ( PROMPT , ISPASSWORD ) |
38ecf3a3 SS |
543 | |
544 | Query user C<PROMPT> and return answer from user. | |
545 | ||
8f3cab2b SS |
546 | Honours GIT_ASKPASS and SSH_ASKPASS environment variables for querying |
547 | the user. If no *_ASKPASS variable is set or an error occoured, | |
38ecf3a3 | 548 | the terminal is tried as a fallback. |
e9263e45 | 549 | If C<ISPASSWORD> is set and true, the terminal disables echo. |
38ecf3a3 SS |
550 | |
551 | =cut | |
552 | ||
553 | sub prompt { | |
e9263e45 | 554 | my ($prompt, $isPassword) = @_; |
38ecf3a3 SS |
555 | my $ret; |
556 | if (exists $ENV{'GIT_ASKPASS'}) { | |
557 | $ret = _prompt($ENV{'GIT_ASKPASS'}, $prompt); | |
558 | } | |
8f3cab2b SS |
559 | if (!defined $ret && exists $ENV{'SSH_ASKPASS'}) { |
560 | $ret = _prompt($ENV{'SSH_ASKPASS'}, $prompt); | |
561 | } | |
38ecf3a3 SS |
562 | if (!defined $ret) { |
563 | print STDERR $prompt; | |
564 | STDERR->flush; | |
e9263e45 SS |
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>); | |
38ecf3a3 | 578 | } |
38ecf3a3 SS |
579 | } |
580 | return $ret; | |
581 | } | |
582 | ||
583 | sub _prompt { | |
584 | my ($askpass, $prompt) = @_; | |
585 | return unless length $askpass; | |
e9263e45 | 586 | $prompt =~ s/\n/ /g; |
38ecf3a3 SS |
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 | } | |
89a56bfb | 594 | |
d5c7721d PB |
595 | =item repo_path () |
596 | ||
597 | Return path to the git repository. Must be called on a repository instance. | |
598 | ||
599 | =cut | |
600 | ||
601 | sub repo_path { $_[0]->{opts}->{Repository} } | |
602 | ||
603 | ||
604 | =item wc_path () | |
605 | ||
606 | Return path to the working copy. Must be called on a repository instance. | |
607 | ||
608 | =cut | |
609 | ||
610 | sub wc_path { $_[0]->{opts}->{WorkingCopy} } | |
611 | ||
612 | ||
613 | =item wc_subdir () | |
614 | ||
615 | Return path to the subdirectory inside of a working copy. Must be called | |
616 | on a repository instance. | |
617 | ||
618 | =cut | |
619 | ||
620 | sub wc_subdir { $_[0]->{opts}->{WorkingSubdir} ||= '' } | |
621 | ||
622 | ||
623 | =item wc_chdir ( SUBDIR ) | |
624 | ||
625 | Change the working copy subdirectory to work within. The C<SUBDIR> is | |
626 | relative to the working copy root directory (not the current subdirectory). | |
627 | Must be called on a repository instance attached to a working copy | |
628 | and the directory must exist. | |
629 | ||
630 | =cut | |
631 | ||
632 | sub wc_chdir { | |
633 | my ($self, $subdir) = @_; | |
d5c7721d PB |
634 | $self->wc_path() |
635 | or throw Error::Simple("bare repository"); | |
636 | ||
637 | -d $self->wc_path().'/'.$subdir | |
64abcc48 | 638 | or throw Error::Simple("subdir not found: $subdir $!"); |
d5c7721d PB |
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 | ||
dc2613de PB |
646 | =item config ( VARIABLE ) |
647 | ||
e0d10e1c | 648 | Retrieve the configuration C<VARIABLE> in the same manner as C<config> |
dc2613de PB |
649 | does. In scalar context requires the variable to be set only one time |
650 | (exception is thrown otherwise), in array context returns allows the | |
651 | variable to be set multiple times and returns all the values. | |
652 | ||
dc2613de PB |
653 | =cut |
654 | ||
655 | sub config { | |
6942a3d7 | 656 | return _config_common({}, @_); |
dc2613de PB |
657 | } |
658 | ||
659 | ||
35c49eea | 660 | =item config_bool ( VARIABLE ) |
7b9a13ec | 661 | |
35c49eea PB |
662 | Retrieve the bool configuration C<VARIABLE>. The return value |
663 | is usable as a boolean in perl (and C<undef> if it's not defined, | |
664 | of course). | |
7b9a13ec | 665 | |
7b9a13ec TT |
666 | =cut |
667 | ||
35c49eea | 668 | sub config_bool { |
6942a3d7 | 669 | my $val = scalar _config_common({'kind' => '--bool'}, @_); |
7b9a13ec | 670 | |
6942a3d7 JH |
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 { | |
35c49eea | 676 | return $val eq 'true'; |
6942a3d7 | 677 | } |
7b9a13ec TT |
678 | } |
679 | ||
9fef9e27 CS |
680 | |
681 | =item config_path ( VARIABLE ) | |
682 | ||
683 | Retrieve the path configuration C<VARIABLE>. The return value | |
684 | is an expanded path or C<undef> if it's not defined. | |
685 | ||
9fef9e27 CS |
686 | =cut |
687 | ||
688 | sub config_path { | |
6942a3d7 | 689 | return _config_common({'kind' => '--path'}, @_); |
9fef9e27 CS |
690 | } |
691 | ||
6942a3d7 | 692 | |
346d203b JN |
693 | =item config_int ( VARIABLE ) |
694 | ||
695 | Retrieve the integer configuration C<VARIABLE>. The return value | |
696 | is simple decimal number. An optional value suffix of 'k', 'm', | |
697 | or 'g' in the config file will cause the value to be multiplied | |
698 | by 1024, 1048576 (1024^2), or 1073741824 (1024^3) prior to output. | |
ef2956a5 | 699 | It would return C<undef> if configuration variable is not defined. |
346d203b | 700 | |
346d203b JN |
701 | =cut |
702 | ||
703 | sub config_int { | |
6942a3d7 JH |
704 | return scalar _config_common({'kind' => '--int'}, @_); |
705 | } | |
706 | ||
707 | # Common subroutine to implement bulk of what the config* family of methods | |
ef2956a5 | 708 | # do. This currently wraps command('config') so it is not so fast. |
6942a3d7 JH |
709 | sub _config_common { |
710 | my ($opts) = shift @_; | |
c2e357c2 | 711 | my ($self, $var) = _maybe_self(@_); |
346d203b JN |
712 | |
713 | try { | |
6942a3d7 | 714 | my @cmd = ('config', $opts->{'kind'} ? $opts->{'kind'} : ()); |
c2e357c2 | 715 | unshift @cmd, $self if $self; |
6942a3d7 JH |
716 | if (wantarray) { |
717 | return command(@cmd, '--get-all', $var); | |
718 | } else { | |
719 | return command_oneline(@cmd, '--get', $var); | |
720 | } | |
346d203b JN |
721 | } catch Git::Error::Command with { |
722 | my $E = shift; | |
723 | if ($E->value() == 1) { | |
724 | # Key not found. | |
6942a3d7 | 725 | return; |
346d203b JN |
726 | } else { |
727 | throw $E; | |
728 | } | |
729 | }; | |
730 | } | |
7b9a13ec | 731 | |
b4c61ed6 JH |
732 | =item get_colorbool ( NAME ) |
733 | ||
734 | Finds if color should be used for NAMEd operation from the configuration, | |
735 | and returns boolean (true for "use color", false for "do not use color"). | |
736 | ||
737 | =cut | |
738 | ||
739 | sub 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 | ||
749 | Finds color for SLOT from the configuration, while defaulting to COLOR, | |
750 | and 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 | ||
758 | sub 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 | ||
31a92f6a PB |
767 | =item remote_refs ( REPOSITORY [, GROUPS [, REFGLOBS ] ] ) |
768 | ||
769 | This function returns a hashref of refs stored in a given remote repository. | |
770 | The hash is in the format C<refname =\> hash>. For tags, the C<refname> entry | |
771 | contains the tag object while a C<refname^{}> entry gives the tagged objects. | |
772 | ||
773 | C<REPOSITORY> has the same meaning as the appropriate C<git-ls-remote> | |
a7793a74 | 774 | argument; either a URL or a remote name (if called on a repository instance). |
31a92f6a PB |
775 | C<GROUPS> is an optional arrayref that can contain 'tags' to return all the |
776 | tags and/or 'heads' to return all the heads. C<REFGLOB> is an optional array | |
777 | of strings containing a shell-like glob to further limit the refs returned in | |
778 | the hash; the meaning is again the same as the appropriate C<git-ls-remote> | |
779 | argument. | |
780 | ||
781 | This function may or may not be called on a repository instance. In the former | |
782 | case, remote names as defined in the repository are recognized as repository | |
783 | specifiers. | |
784 | ||
785 | =cut | |
786 | ||
787 | sub 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 | ||
c7a30e56 PB |
820 | =item ident ( TYPE | IDENTSTR ) |
821 | ||
822 | =item ident_person ( TYPE | IDENTSTR | IDENTARRAY ) | |
823 | ||
824 | This suite of functions retrieves and parses ident information, as stored | |
825 | in the commit and tag objects or produced by C<var GIT_type_IDENT> (thus | |
826 | C<TYPE> can be either I<author> or I<committer>; case is insignificant). | |
827 | ||
5354a56f | 828 | The C<ident> method retrieves the ident information from C<git var> |
c7a30e56 PB |
829 | and either returns it as a scalar string or as an array with the fields parsed. |
830 | Alternatively, it can take a prepared ident string (e.g. from the commit | |
831 | object) and just parse it. | |
832 | ||
833 | C<ident_person> returns the person part of the ident - name and email; | |
834 | it can take the same arguments as C<ident> or the array returned by C<ident>. | |
835 | ||
836 | The 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 | ||
c7a30e56 PB |
843 | =cut |
844 | ||
845 | sub ident { | |
44617928 | 846 | my ($self, $type) = _maybe_self(@_); |
c7a30e56 PB |
847 | my $identstr; |
848 | if (lc $type eq lc 'committer' or lc $type eq lc 'author') { | |
44617928 FL |
849 | my @cmd = ('var', 'GIT_'.uc($type).'_IDENT'); |
850 | unshift @cmd, $self if $self; | |
851 | $identstr = command_oneline(@cmd); | |
c7a30e56 PB |
852 | } else { |
853 | $identstr = $type; | |
854 | } | |
855 | if (wantarray) { | |
856 | return $identstr =~ /^(.*) <(.*)> (\d+ [+-]\d{4})$/; | |
857 | } else { | |
858 | return $identstr; | |
859 | } | |
860 | } | |
861 | ||
862 | sub ident_person { | |
44617928 FL |
863 | my ($self, @ident) = _maybe_self(@_); |
864 | $#ident == 0 and @ident = $self ? $self->ident($ident[0]) : ident($ident[0]); | |
c7a30e56 PB |
865 | return "$ident[0] <$ident[1]>"; |
866 | } | |
867 | ||
8d314d7a RL |
868 | =item parse_mailboxes |
869 | ||
870 | Return an array of mailboxes extracted from a string. | |
871 | ||
872 | =cut | |
873 | ||
dcfafc52 MM |
874 | # Very close to Mail::Address's parser, but we still have minor |
875 | # differences in some cases (see t9000 for examples). | |
8d314d7a RL |
876 | sub 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 } @_; | |
e3fdbcc8 | 884 | my $end_of_addr_seen = 0; |
8d314d7a RL |
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 | |
e3fdbcc8 | 894 | if ($end_of_addr_seen) { |
8d314d7a | 895 | push @phrase, @buffer; |
e3fdbcc8 MM |
896 | } else { |
897 | push @address, @buffer; | |
8d314d7a RL |
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 = (); | |
e3fdbcc8 | 921 | $end_of_addr_seen = 0; |
8d314d7a RL |
922 | } elsif ($token =~ /^\(/) { |
923 | push @comment, $token; | |
924 | } elsif ($token eq "<") { | |
925 | push @phrase, (splice @address), (splice @buffer); | |
926 | } elsif ($token eq ">") { | |
e3fdbcc8 | 927 | $end_of_addr_seen = 1; |
8d314d7a | 928 | push @address, (splice @buffer); |
e3fdbcc8 | 929 | } elsif ($token eq "@" && !$end_of_addr_seen) { |
8d314d7a | 930 | push @address, (splice @buffer), "@"; |
8d314d7a RL |
931 | } else { |
932 | push @buffer, $token; | |
933 | } | |
934 | } | |
935 | ||
936 | return @addr_list; | |
937 | } | |
c7a30e56 | 938 | |
24c4b714 | 939 | =item hash_object ( TYPE, FILENAME ) |
b1edc53d | 940 | |
58c8dd21 LW |
941 | Compute the SHA1 object id of the given C<FILENAME> considering it is |
942 | of the C<TYPE> object type (C<blob>, C<commit>, C<tree>). | |
b1edc53d | 943 | |
b1edc53d PB |
944 | The method can be called without any instance or on a specified Git repository, |
945 | it makes zero difference. | |
946 | ||
947 | The function returns the SHA1 hash. | |
948 | ||
b1edc53d PB |
949 | =cut |
950 | ||
18b0fc1c | 951 | # TODO: Support for passing FILEHANDLE instead of FILENAME |
e6634ac9 PB |
952 | sub hash_object { |
953 | my ($self, $type, $file) = _maybe_self(@_); | |
18b0fc1c | 954 | command_oneline('hash-object', '-t', $type, $file); |
e6634ac9 | 955 | } |
b1edc53d PB |
956 | |
957 | ||
7182530d AR |
958 | =item hash_and_insert_object ( FILENAME ) |
959 | ||
960 | Compute the SHA1 object id of the given C<FILENAME> and add the object to the | |
961 | object database. | |
962 | ||
963 | The function returns the SHA1 hash. | |
964 | ||
965 | =cut | |
966 | ||
967 | # TODO: Support for passing FILEHANDLE instead of FILENAME | |
968 | sub 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 | ||
990 | sub _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}) = | |
48d9e6ae | 997 | $self->command_bidi_pipe(qw(hash-object -w --stdin-paths --no-filters)); |
7182530d AR |
998 | } |
999 | ||
1000 | sub _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 | ||
452d36b1 AMS |
1007 | command_close_bidi_pipe(@$self{@vars}); |
1008 | delete @$self{@vars}; | |
7182530d AR |
1009 | } |
1010 | ||
1011 | =item cat_blob ( SHA1, FILEHANDLE ) | |
1012 | ||
1013 | Prints the contents of the blob identified by C<SHA1> to C<FILEHANDLE> and | |
1014 | returns the number of bytes printed. | |
1015 | ||
1016 | =cut | |
1017 | ||
1018 | sub 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"; | |
d683a0e0 | 1032 | return -1; |
7182530d AR |
1033 | } |
1034 | ||
1035 | if ($description !~ /^[0-9a-fA-F]{40} \S+ (\d+)$/) { | |
1036 | carp "Unexpected result returned from git cat-file"; | |
d683a0e0 | 1037 | return -1; |
7182530d AR |
1038 | } |
1039 | ||
1040 | my $size = $1; | |
1041 | ||
1042 | my $blob; | |
712c6ada | 1043 | my $bytesLeft = $size; |
7182530d AR |
1044 | |
1045 | while (1) { | |
7182530d AR |
1046 | last unless $bytesLeft; |
1047 | ||
1048 | my $bytesToRead = $bytesLeft < 1024 ? $bytesLeft : 1024; | |
712c6ada | 1049 | my $read = read($in, $blob, $bytesToRead); |
7182530d AR |
1050 | unless (defined($read)) { |
1051 | $self->_close_cat_blob(); | |
1052 | throw Error::Simple("in pipe went bad"); | |
1053 | } | |
712c6ada JC |
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; | |
7182530d AR |
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 | ||
7182530d AR |
1073 | return $size; |
1074 | } | |
1075 | ||
1076 | sub _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}) = | |
48d9e6ae | 1083 | $self->command_bidi_pipe(qw(cat-file --batch)); |
7182530d AR |
1084 | } |
1085 | ||
1086 | sub _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 | ||
452d36b1 AMS |
1093 | command_close_bidi_pipe(@$self{@vars}); |
1094 | delete @$self{@vars}; | |
7182530d | 1095 | } |
8b9150e3 | 1096 | |
e41352b2 | 1097 | |
52dce6d0 MN |
1098 | =item credential_read( FILEHANDLE ) |
1099 | ||
1100 | Reads credential key-value pairs from C<FILEHANDLE>. Reading stops at EOF or | |
1101 | when an empty line is encountered. Each line must be of the form C<key=value> | |
1102 | with a non-empty key. Function returns hash with all read values. Any white | |
1103 | space (other than new-line character) is preserved. | |
1104 | ||
1105 | =cut | |
1106 | ||
1107 | sub 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 | ||
1124 | Writes credential key-value pairs from hash referenced by | |
1125 | C<CREDENTIAL_HASHREF> to C<FILEHANDLE>. Keys and values cannot contain | |
1126 | new-lines or NUL bytes characters, and key cannot contain equal signs nor be | |
1127 | empty (if they do Error::Simple is thrown). Any white space is preserved. If | |
1128 | value for a key is C<undef>, it will be skipped. | |
1129 | ||
1130 | If C<'url'> key exists it will be written first. (All the other key-value | |
1131 | pairs are written in sorted order but you should not depend on that). Once | |
1132 | all lines are written, an empty line is printed. | |
1133 | ||
1134 | =cut | |
1135 | ||
1136 | sub 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 | ||
1164 | sub _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 | ||
1185 | Executes C<git credential> for a given set of credentials and specified | |
1186 | operation. In both forms C<CREDENTIAL_HASHREF> needs to be a reference to | |
1187 | a hash which stores credentials. Under certain conditions the hash can | |
1188 | change. | |
1189 | ||
1190 | In the first form, C<OPERATION> can be C<'fill'>, C<'approve'> or C<'reject'>, | |
1191 | and function will execute corresponding C<git credential> sub-command. If | |
1192 | it's omitted C<'fill'> is assumed. In case of C<'fill'> the values stored in | |
1193 | C<CREDENTIAL_HASHREF> will be changed to the ones returned by the C<git | |
1194 | credential 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 | ||
1209 | In the second form, C<CODE> needs to be a reference to a subroutine. The | |
1210 | function will execute C<git credential fill> to fill the provided credential | |
1211 | hash, then call C<CODE> with C<CREDENTIAL_HASHREF> as the sole argument. If | |
1212 | C<CODE>'s return value is defined, the function will execute C<git credential | |
1213 | approve> (if return value yields true) or C<git credential reject> (if return | |
1214 | value is false). If the return value is undef, nothing at all is executed; | |
1215 | this is useful, for example, if the credential could neither be verified nor | |
1216 | rejected due to an unrelated network error. The return value is the same as | |
1217 | what 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 | ||
1233 | sub 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 | ||
e41352b2 MG |
1248 | { # %TEMP_* Lexical Context |
1249 | ||
836ff95d | 1250 | my (%TEMP_FILEMAP, %TEMP_FILES); |
e41352b2 MG |
1251 | |
1252 | =item temp_acquire ( NAME ) | |
1253 | ||
41ccfdd9 | 1254 | Attempts to retrieve the temporary file mapped to the string C<NAME>. If an |
e41352b2 MG |
1255 | associated temp file has not been created this session or was closed, it is |
1256 | created, cached, and set for autoflush and binmode. | |
1257 | ||
1258 | Internally locks the file mapped to C<NAME>. This lock must be released with | |
1259 | C<temp_release()> when the temp file is no longer needed. Subsequent attempts | |
1260 | to retrieve temporary files mapped to the same C<NAME> while still locked will | |
1261 | cause an error. This locking mechanism provides a weak guarantee and is not | |
1262 | threadsafe. It does provide some error checking to help prevent temp file refs | |
1263 | writing over one another. | |
1264 | ||
1265 | In general, the L<File::Handle> returned should not be closed by consumers as | |
1266 | it defeats the purpose of this caching mechanism. If you need to close the temp | |
1267 | file handle, then you should use L<File::Temp> or another temp file faculty | |
1268 | directly. If a handle is closed and then requested again, then a warning will | |
1269 | issue. | |
1270 | ||
1271 | =cut | |
1272 | ||
1273 | sub temp_acquire { | |
bcdd1b44 | 1274 | my $temp_fd = _temp_cache(@_); |
e41352b2 | 1275 | |
836ff95d | 1276 | $TEMP_FILES{$temp_fd}{locked} = 1; |
e41352b2 MG |
1277 | $temp_fd; |
1278 | } | |
1279 | ||
4e63dcc8 KM |
1280 | =item temp_is_locked ( NAME ) |
1281 | ||
1282 | Returns true if the internal lock created by a previous C<temp_acquire()> | |
1283 | call with C<NAME> is still in effect. | |
1284 | ||
1285 | When temp_acquire is called on a C<NAME>, it internally locks the temporary | |
1286 | file mapped to C<NAME>. That lock will not be released until C<temp_release()> | |
1287 | is called with either the original C<NAME> or the L<File::Handle> that was | |
1288 | returned from the original call to temp_acquire. | |
1289 | ||
1290 | Subsequent attempts to call C<temp_acquire()> with the same C<NAME> will fail | |
1291 | unless 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 | |
1293 | C<temp_acquire()> call). | |
1294 | ||
1295 | If true is returned by C<temp_is_locked()> for a C<NAME>, an attempt to | |
1296 | C<temp_acquire()> the same C<NAME> will cause an error unless | |
1297 | C<temp_release> is first called on that C<NAME> (or its corresponding | |
1298 | L<File::Handle> that was returned by the original C<temp_acquire()> call). | |
1299 | ||
1300 | =cut | |
1301 | ||
1302 | sub 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 | ||
e41352b2 MG |
1309 | =item temp_release ( NAME ) |
1310 | ||
1311 | =item temp_release ( FILEHANDLE ) | |
1312 | ||
1313 | Releases a lock acquired through C<temp_acquire()>. Can be called either with | |
1314 | the C<NAME> mapping used when acquiring the temp file or with the C<FILEHANDLE> | |
1315 | referencing a locked temp file. | |
1316 | ||
1317 | Warns if an attempt is made to release a file that is not locked. | |
1318 | ||
1319 | The temp file will be truncated before being released. This can help to reduce | |
1320 | disk I/O where the system is smart enough to detect the truncation while data | |
1321 | is in the output buffers. Beware that after the temp file is released and | |
1322 | truncated, any operations on that file may fail miserably until it is | |
1323 | re-acquired. All contents are lost between each release and acquire mapped to | |
1324 | the same string. | |
1325 | ||
1326 | =cut | |
1327 | ||
1328 | sub temp_release { | |
1329 | my ($self, $temp_fd, $trunc) = _maybe_self(@_); | |
1330 | ||
836ff95d | 1331 | if (exists $TEMP_FILEMAP{$temp_fd}) { |
e41352b2 MG |
1332 | $temp_fd = $TEMP_FILES{$temp_fd}; |
1333 | } | |
836ff95d | 1334 | unless ($TEMP_FILES{$temp_fd}{locked}) { |
e41352b2 MG |
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 | ||
836ff95d | 1340 | $TEMP_FILES{$temp_fd}{locked} = 0; |
e41352b2 MG |
1341 | undef; |
1342 | } | |
1343 | ||
1344 | sub _temp_cache { | |
bcdd1b44 | 1345 | my ($self, $name) = _maybe_self(@_); |
e41352b2 | 1346 | |
c14c8ceb MG |
1347 | _verify_require(); |
1348 | ||
836ff95d | 1349 | my $temp_fd = \$TEMP_FILEMAP{$name}; |
e41352b2 | 1350 | if (defined $$temp_fd and $$temp_fd->opened) { |
9c081073 | 1351 | if ($TEMP_FILES{$$temp_fd}{locked}) { |
8faea4f3 JS |
1352 | throw Error::Simple("Temp file with moniker '" . |
1353 | $name . "' already in use"); | |
e41352b2 MG |
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 | } | |
836ff95d | 1361 | my $fname; |
bcdd1b44 MS |
1362 | |
1363 | my $tmpdir; | |
1364 | if (defined $self) { | |
1365 | $tmpdir = $self->repo_path(); | |
1366 | } | |
1367 | ||
822aaf0f EW |
1368 | my $n = $name; |
1369 | $n =~ s/\W/_/g; # no strange chars | |
1370 | ||
eafc2dd5 | 1371 | ($$temp_fd, $fname) = File::Temp::tempfile( |
822aaf0f | 1372 | "Git_${n}_XXXXXX", UNLINK => 1, DIR => $tmpdir, |
e41352b2 | 1373 | ) or throw Error::Simple("couldn't open new temp file"); |
bcdd1b44 | 1374 | |
e41352b2 MG |
1375 | $$temp_fd->autoflush; |
1376 | binmode $$temp_fd; | |
836ff95d | 1377 | $TEMP_FILES{$$temp_fd}{fname} = $fname; |
e41352b2 MG |
1378 | } |
1379 | $$temp_fd; | |
1380 | } | |
1381 | ||
c14c8ceb MG |
1382 | sub _verify_require { |
1383 | eval { require File::Temp; require File::Spec; }; | |
1384 | $@ and throw Error::Simple($@); | |
1385 | } | |
1386 | ||
e41352b2 MG |
1387 | =item temp_reset ( FILEHANDLE ) |
1388 | ||
1389 | Truncates and resets the position of the C<FILEHANDLE>. | |
1390 | ||
1391 | =cut | |
1392 | ||
1393 | sub 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 | ||
836ff95d MG |
1404 | =item temp_path ( NAME ) |
1405 | ||
1406 | =item temp_path ( FILEHANDLE ) | |
1407 | ||
1408 | Returns the filename associated with the given tempfile. | |
1409 | ||
1410 | =cut | |
1411 | ||
1412 | sub 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 | ||
e41352b2 | 1421 | sub END { |
836ff95d | 1422 | unlink values %TEMP_FILEMAP if %TEMP_FILEMAP; |
e41352b2 MG |
1423 | } |
1424 | ||
1425 | } # %TEMP_* Lexical Context | |
1426 | ||
b1edc53d PB |
1427 | =back |
1428 | ||
97b16c06 | 1429 | =head1 ERROR HANDLING |
b1edc53d | 1430 | |
97b16c06 | 1431 | All functions are supposed to throw Perl exceptions in case of errors. |
8b9150e3 PB |
1432 | See the L<Error> module on how to catch those. Most exceptions are mere |
1433 | L<Error::Simple> instances. | |
1434 | ||
1435 | However, the C<command()>, C<command_oneline()> and C<command_noisy()> | |
1436 | functions suite can throw C<Git::Error::Command> exceptions as well: those are | |
1437 | thrown when the external command returns an error code and contain the error | |
1438 | code as well as access to the captured command's output. The exception class | |
1439 | provides the usual C<stringify> and C<value> (command's exit code) methods and | |
1440 | in addition also a C<cmd_output> method that returns either an array or a | |
1441 | string with the captured command output (depending on the original function | |
1442 | call context; C<command_noisy()> returns C<undef>) and $<cmdline> which | |
1443 | returns the command and its arguments (but without proper quoting). | |
1444 | ||
d79850e1 | 1445 | Note that the C<command_*_pipe()> functions cannot throw this exception since |
8b9150e3 PB |
1446 | it has no idea whether the command failed or not. You will only find out |
1447 | at the time you C<close> the pipe; if you want to have that automated, | |
1448 | use 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 | ||
1500 | This magical statement will automatically catch any C<Git::Error::Command> | |
1501 | exceptions thrown by C<CODE> and make your program die with C<ERRMSG> | |
1502 | on its lips; the message will have %s substituted for the command line | |
1503 | and %d for the exit status. This statement is useful mostly for producing | |
1504 | more user-friendly error messages. | |
1505 | ||
1506 | In case of no exception caught the statement returns C<CODE>'s return value. | |
1507 | ||
1508 | Note that this is the only auto-exported function. | |
1509 | ||
1510 | =cut | |
1511 | ||
1512 | sub 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 | |
b1edc53d PB |
1537 | |
1538 | =head1 COPYRIGHT | |
1539 | ||
1540 | Copyright 2006 by Petr Baudis E<lt>pasky@suse.czE<gt>. | |
1541 | ||
1542 | This module is free software; it may be used, copied, modified | |
1543 | and distributed under the terms of the GNU General Public Licence, | |
1544 | either 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. | |
1552 | sub _maybe_self { | |
d8b24b93 | 1553 | UNIVERSAL::isa($_[0], 'Git') ? @_ : (undef, @_); |
b1edc53d PB |
1554 | } |
1555 | ||
d79850e1 PB |
1556 | # Check if the command id is something reasonable. |
1557 | sub _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. | |
1563 | sub _command_common_pipe { | |
1564 | my $direction = shift; | |
d43ba468 PB |
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 | } | |
d79850e1 PB |
1573 | _check_valid_cmd($cmd); |
1574 | ||
a6065b54 | 1575 | my $fh; |
d3b1785f | 1576 | if ($^O eq 'MSWin32') { |
a6065b54 PB |
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'; | |
bed118d6 AR |
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; | |
a6065b54 PB |
1589 | |
1590 | } else { | |
1591 | my $pid = open($fh, $direction); | |
1592 | if (not defined $pid) { | |
1593 | throw Error::Simple("open failed: $!"); | |
1594 | } elsif ($pid == 0) { | |
a6065b54 PB |
1595 | if ($opts{STDERR}) { |
1596 | open (STDERR, '>&', $opts{STDERR}) | |
1597 | or die "dup failed: $!"; | |
bd4ca09d TR |
1598 | } elsif (defined $opts{STDERR}) { |
1599 | open (STDERR, '>', '/dev/null') | |
1600 | or die "opening /dev/null failed: $!"; | |
a6065b54 PB |
1601 | } |
1602 | _cmd_exec($self, $cmd, @args); | |
d43ba468 | 1603 | } |
d79850e1 PB |
1604 | } |
1605 | return wantarray ? ($fh, join(' ', $cmd, @args)) : $fh; | |
1606 | } | |
1607 | ||
b1edc53d PB |
1608 | # When already in the subprocess, set up the appropriate state |
1609 | # for the given repository and execute the git command. | |
1610 | sub _cmd_exec { | |
1611 | my ($self, @args) = @_; | |
48d9e6ae MO |
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 | |
1618 | sub _setup_git_cmd_env { | |
1619 | my $self = shift; | |
b1edc53d | 1620 | if ($self) { |
d5c7721d | 1621 | $self->repo_path() and $ENV{'GIT_DIR'} = $self->repo_path(); |
da159c77 FL |
1622 | $self->repo_path() and $self->wc_path() |
1623 | and $ENV{'GIT_WORK_TREE'} = $self->wc_path(); | |
d5c7721d PB |
1624 | $self->wc_path() and chdir($self->wc_path()); |
1625 | $self->wc_subdir() and chdir($self->wc_subdir()); | |
b1edc53d | 1626 | } |
b1edc53d PB |
1627 | } |
1628 | ||
8062f81c PB |
1629 | # Execute the given Git command ($_[0]) with arguments ($_[1..]) |
1630 | # by searching for it at proper places. | |
18b0fc1c | 1631 | sub _execv_git_cmd { exec('git', @_); } |
8062f81c | 1632 | |
b1edc53d PB |
1633 | # Close pipe to a subprocess. |
1634 | sub _cmd_close { | |
1323dba6 MN |
1635 | my $ctx = shift @_; |
1636 | foreach my $fh (@_) { | |
1637 | if (close $fh) { | |
1638 | # nop | |
1639 | } elsif ($!) { | |
b1edc53d PB |
1640 | # It's just close, no point in fatalities |
1641 | carp "error closing pipe: $!"; | |
1642 | } elsif ($? >> 8) { | |
8b9150e3 PB |
1643 | # The caller should pepper this. |
1644 | throw Git::Error::Command($ctx, $? >> 8); | |
b1edc53d PB |
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 | ||
7182530d AR |
1652 | sub DESTROY { |
1653 | my ($self) = @_; | |
1654 | $self->_close_hash_and_insert_object(); | |
1655 | $self->_close_cat_blob(); | |
1656 | } | |
b1edc53d PB |
1657 | |
1658 | ||
a6065b54 PB |
1659 | # Pipe implementation for ActiveState Perl. |
1660 | ||
1661 | package Git::activestate_pipe; | |
1662 | use strict; | |
1663 | ||
1664 | sub 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 | |
d3b1785f AR |
1669 | # Let's just hope ActiveState Perl does at least the quoting |
1670 | # correctly. | |
1671 | my @data = qx{git @params}; | |
a6065b54 PB |
1672 | bless { i => 0, data => \@data }, $class; |
1673 | } | |
1674 | ||
1675 | sub READLINE { | |
1676 | my $self = shift; | |
1677 | if ($self->{i} >= scalar @{$self->{data}}) { | |
1678 | return undef; | |
1679 | } | |
2f5b3980 AR |
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 ]; | |
a6065b54 PB |
1687 | } |
1688 | ||
1689 | sub CLOSE { | |
1690 | my $self = shift; | |
1691 | delete $self->{data}; | |
1692 | delete $self->{i}; | |
1693 | } | |
1694 | ||
1695 | sub EOF { | |
1696 | my $self = shift; | |
1697 | return ($self->{i} >= scalar @{$self->{data}}); | |
1698 | } | |
1699 | ||
1700 | ||
b1edc53d | 1701 | 1; # Famous last words |