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