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