]>
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 | ||
10 | use strict; | |
11 | ||
12 | ||
13 | BEGIN { | |
14 | ||
15 | our ($VERSION, @ISA, @EXPORT, @EXPORT_OK); | |
16 | ||
17 | # Totally unstable API. | |
18 | $VERSION = '0.01'; | |
19 | ||
20 | ||
21 | =head1 SYNOPSIS | |
22 | ||
23 | use Git; | |
24 | ||
25 | my $version = Git::command_oneline('version'); | |
26 | ||
8b9150e3 PB |
27 | git_cmd_try { Git::command_noisy('update-server-info') } |
28 | '%s failed w/ code %d'; | |
b1edc53d PB |
29 | |
30 | my $repo = Git->repository (Directory => '/srv/git/cogito.git'); | |
31 | ||
32 | ||
33 | my @revs = $repo->command('rev-list', '--since=last monday', '--all'); | |
34 | ||
d79850e1 | 35 | my ($fh, $c) = $repo->command_output_pipe('rev-list', '--since=last monday', '--all'); |
b1edc53d | 36 | my $lastrev = <$fh>; chomp $lastrev; |
8b9150e3 | 37 | $repo->command_close_pipe($fh, $c); |
b1edc53d | 38 | |
d43ba468 PB |
39 | my $lastrev = $repo->command_oneline( [ 'rev-list', '--all' ], |
40 | STDERR => 0 ); | |
b1edc53d PB |
41 | |
42 | =cut | |
43 | ||
44 | ||
45 | require Exporter; | |
46 | ||
47 | @ISA = qw(Exporter); | |
48 | ||
8b9150e3 | 49 | @EXPORT = qw(git_cmd_try); |
b1edc53d PB |
50 | |
51 | # Methods which can be called as standalone functions as well: | |
d79850e1 PB |
52 | @EXPORT_OK = qw(command command_oneline command_noisy |
53 | command_output_pipe command_input_pipe command_close_pipe | |
8b9150e3 | 54 | version exec_path hash_object git_cmd_try); |
b1edc53d PB |
55 | |
56 | ||
57 | =head1 DESCRIPTION | |
58 | ||
59 | This module provides Perl scripts easy way to interface the Git version control | |
60 | system. The modules have an easy and well-tested way to call arbitrary Git | |
61 | commands; in the future, the interface will also provide specialized methods | |
62 | for doing easily operations which are not totally trivial to do over | |
63 | the generic command interface. | |
64 | ||
65 | While some commands can be executed outside of any context (e.g. 'version' | |
5c94f87e | 66 | or 'init'), most operations require a repository context, which in practice |
b1edc53d PB |
67 | means getting an instance of the Git object using the repository() constructor. |
68 | (In the future, we will also get a new_repository() constructor.) All commands | |
69 | called as methods of the object are then executed in the context of the | |
70 | repository. | |
71 | ||
d5c7721d PB |
72 | Part of the "repository state" is also information about path to the attached |
73 | working copy (unless you work with a bare repository). You can also navigate | |
74 | inside of the working copy using the C<wc_chdir()> method. (Note that | |
75 | the repository object is self-contained and will not change working directory | |
76 | of your process.) | |
b1edc53d | 77 | |
d5c7721d | 78 | TODO: In the future, we might also do |
b1edc53d PB |
79 | |
80 | my $remoterepo = $repo->remote_repository (Name => 'cogito', Branch => 'master'); | |
81 | $remoterepo ||= Git->remote_repository ('http://git.or.cz/cogito.git/'); | |
82 | my @refs = $remoterepo->refs(); | |
83 | ||
b1edc53d PB |
84 | Currently, the module merely wraps calls to external Git tools. In the future, |
85 | it will provide a much faster way to interact with Git by linking directly | |
86 | to libgit. This should be completely opaque to the user, though (performance | |
87 | increate nonwithstanding). | |
88 | ||
89 | =cut | |
90 | ||
91 | ||
8b9150e3 | 92 | use Carp qw(carp croak); # but croak is bad - throw instead |
97b16c06 | 93 | use Error qw(:try); |
d5c7721d | 94 | use Cwd qw(abs_path); |
b1edc53d | 95 | |
b1edc53d PB |
96 | } |
97 | ||
98 | ||
99 | =head1 CONSTRUCTORS | |
100 | ||
101 | =over 4 | |
102 | ||
103 | =item repository ( OPTIONS ) | |
104 | ||
105 | =item repository ( DIRECTORY ) | |
106 | ||
107 | =item repository () | |
108 | ||
109 | Construct a new repository object. | |
110 | C<OPTIONS> are passed in a hash like fashion, using key and value pairs. | |
111 | Possible options are: | |
112 | ||
113 | B<Repository> - Path to the Git repository. | |
114 | ||
115 | B<WorkingCopy> - Path to the associated working copy; not strictly required | |
116 | as many commands will happily crunch on a bare repository. | |
117 | ||
d5c7721d PB |
118 | B<WorkingSubdir> - Subdirectory in the working copy to work inside. |
119 | Just left undefined if you do not want to limit the scope of operations. | |
120 | ||
121 | B<Directory> - Path to the Git working directory in its usual setup. | |
122 | The C<.git> directory is searched in the directory and all the parent | |
123 | directories; if found, C<WorkingCopy> is set to the directory containing | |
124 | it and C<Repository> to the C<.git> directory itself. If no C<.git> | |
125 | directory was found, the C<Directory> is assumed to be a bare repository, | |
126 | C<Repository> is set to point at it and C<WorkingCopy> is left undefined. | |
127 | If the C<$GIT_DIR> environment variable is set, things behave as expected | |
128 | as well. | |
b1edc53d | 129 | |
b1edc53d PB |
130 | You should not use both C<Directory> and either of C<Repository> and |
131 | C<WorkingCopy> - the results of that are undefined. | |
132 | ||
133 | Alternatively, a directory path may be passed as a single scalar argument | |
134 | to the constructor; it is equivalent to setting only the C<Directory> option | |
135 | field. | |
136 | ||
137 | Calling the constructor with no options whatsoever is equivalent to | |
d5c7721d PB |
138 | calling it with C<< Directory => '.' >>. In general, if you are building |
139 | a standard porcelain command, simply doing C<< Git->repository() >> should | |
140 | do the right thing and setup the object to reflect exactly where the user | |
141 | is right now. | |
b1edc53d PB |
142 | |
143 | =cut | |
144 | ||
145 | sub repository { | |
146 | my $class = shift; | |
147 | my @args = @_; | |
148 | my %opts = (); | |
149 | my $self; | |
150 | ||
151 | if (defined $args[0]) { | |
152 | if ($#args % 2 != 1) { | |
153 | # Not a hash. | |
97b16c06 PB |
154 | $#args == 0 or throw Error::Simple("bad usage"); |
155 | %opts = ( Directory => $args[0] ); | |
b1edc53d PB |
156 | } else { |
157 | %opts = @args; | |
158 | } | |
d5c7721d PB |
159 | } |
160 | ||
161 | if (not defined $opts{Repository} and not defined $opts{WorkingCopy}) { | |
162 | $opts{Directory} ||= '.'; | |
163 | } | |
164 | ||
165 | if ($opts{Directory}) { | |
166 | -d $opts{Directory} or throw Error::Simple("Directory not found: $!"); | |
167 | ||
168 | my $search = Git->repository(WorkingCopy => $opts{Directory}); | |
169 | my $dir; | |
170 | try { | |
171 | $dir = $search->command_oneline(['rev-parse', '--git-dir'], | |
172 | STDERR => 0); | |
173 | } catch Git::Error::Command with { | |
174 | $dir = undef; | |
175 | }; | |
b1edc53d | 176 | |
d5c7721d | 177 | if ($dir) { |
71efe0ca PB |
178 | $dir =~ m#^/# or $dir = $opts{Directory} . '/' . $dir; |
179 | $opts{Repository} = $dir; | |
d5c7721d PB |
180 | |
181 | # If --git-dir went ok, this shouldn't die either. | |
182 | my $prefix = $search->command_oneline('rev-parse', '--show-prefix'); | |
183 | $dir = abs_path($opts{Directory}) . '/'; | |
184 | if ($prefix) { | |
185 | if (substr($dir, -length($prefix)) ne $prefix) { | |
186 | throw Error::Simple("rev-parse confused me - $dir does not have trailing $prefix"); | |
187 | } | |
188 | substr($dir, -length($prefix)) = ''; | |
b1edc53d | 189 | } |
d5c7721d PB |
190 | $opts{WorkingCopy} = $dir; |
191 | $opts{WorkingSubdir} = $prefix; | |
192 | ||
193 | } else { | |
194 | # A bare repository? Let's see... | |
195 | $dir = $opts{Directory}; | |
196 | ||
197 | unless (-d "$dir/refs" and -d "$dir/objects" and -e "$dir/HEAD") { | |
198 | # Mimick git-rev-parse --git-dir error message: | |
199 | throw Error::Simple('fatal: Not a git repository'); | |
200 | } | |
201 | my $search = Git->repository(Repository => $dir); | |
202 | try { | |
203 | $search->command('symbolic-ref', 'HEAD'); | |
204 | } catch Git::Error::Command with { | |
205 | # Mimick git-rev-parse --git-dir error message: | |
206 | throw Error::Simple('fatal: Not a git repository'); | |
207 | } | |
208 | ||
209 | $opts{Repository} = abs_path($dir); | |
b1edc53d | 210 | } |
d5c7721d PB |
211 | |
212 | delete $opts{Directory}; | |
b1edc53d PB |
213 | } |
214 | ||
81a71734 | 215 | $self = { opts => \%opts }; |
b1edc53d PB |
216 | bless $self, $class; |
217 | } | |
218 | ||
219 | ||
220 | =back | |
221 | ||
222 | =head1 METHODS | |
223 | ||
224 | =over 4 | |
225 | ||
226 | =item command ( COMMAND [, ARGUMENTS... ] ) | |
227 | ||
d43ba468 PB |
228 | =item command ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } ) |
229 | ||
b1edc53d PB |
230 | Execute the given Git C<COMMAND> (specify it without the 'git-' |
231 | prefix), optionally with the specified extra C<ARGUMENTS>. | |
232 | ||
d43ba468 PB |
233 | The second more elaborate form can be used if you want to further adjust |
234 | the command execution. Currently, only one option is supported: | |
235 | ||
236 | B<STDERR> - How to deal with the command's error output. By default (C<undef>) | |
237 | it is delivered to the caller's C<STDERR>. A false value (0 or '') will cause | |
238 | it to be thrown away. If you want to process it, you can get it in a filehandle | |
239 | you specify, but you must be extremely careful; if the error output is not | |
240 | very short and you want to read it in the same process as where you called | |
241 | C<command()>, you are set up for a nice deadlock! | |
242 | ||
b1edc53d PB |
243 | The method can be called without any instance or on a specified Git repository |
244 | (in that case the command will be run in the repository context). | |
245 | ||
246 | In scalar context, it returns all the command output in a single string | |
247 | (verbatim). | |
248 | ||
249 | In array context, it returns an array containing lines printed to the | |
250 | command's stdout (without trailing newlines). | |
251 | ||
252 | In both cases, the command's stdin and stderr are the same as the caller's. | |
253 | ||
254 | =cut | |
255 | ||
256 | sub command { | |
d79850e1 | 257 | my ($fh, $ctx) = command_output_pipe(@_); |
b1edc53d PB |
258 | |
259 | if (not defined wantarray) { | |
8b9150e3 PB |
260 | # Nothing to pepper the possible exception with. |
261 | _cmd_close($fh, $ctx); | |
b1edc53d PB |
262 | |
263 | } elsif (not wantarray) { | |
264 | local $/; | |
265 | my $text = <$fh>; | |
8b9150e3 PB |
266 | try { |
267 | _cmd_close($fh, $ctx); | |
268 | } catch Git::Error::Command with { | |
269 | # Pepper with the output: | |
270 | my $E = shift; | |
271 | $E->{'-outputref'} = \$text; | |
272 | throw $E; | |
273 | }; | |
b1edc53d PB |
274 | return $text; |
275 | ||
276 | } else { | |
277 | my @lines = <$fh>; | |
67e4baf8 | 278 | defined and chomp for @lines; |
8b9150e3 PB |
279 | try { |
280 | _cmd_close($fh, $ctx); | |
281 | } catch Git::Error::Command with { | |
282 | my $E = shift; | |
283 | $E->{'-outputref'} = \@lines; | |
284 | throw $E; | |
285 | }; | |
b1edc53d PB |
286 | return @lines; |
287 | } | |
288 | } | |
289 | ||
290 | ||
291 | =item command_oneline ( COMMAND [, ARGUMENTS... ] ) | |
292 | ||
d43ba468 PB |
293 | =item command_oneline ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } ) |
294 | ||
b1edc53d PB |
295 | Execute the given C<COMMAND> in the same way as command() |
296 | does but always return a scalar string containing the first line | |
297 | of the command's standard output. | |
298 | ||
299 | =cut | |
300 | ||
301 | sub command_oneline { | |
d79850e1 | 302 | my ($fh, $ctx) = command_output_pipe(@_); |
b1edc53d PB |
303 | |
304 | my $line = <$fh>; | |
d5c7721d | 305 | defined $line and chomp $line; |
8b9150e3 PB |
306 | try { |
307 | _cmd_close($fh, $ctx); | |
308 | } catch Git::Error::Command with { | |
309 | # Pepper with the output: | |
310 | my $E = shift; | |
311 | $E->{'-outputref'} = \$line; | |
312 | throw $E; | |
313 | }; | |
b1edc53d PB |
314 | return $line; |
315 | } | |
316 | ||
317 | ||
d79850e1 | 318 | =item command_output_pipe ( COMMAND [, ARGUMENTS... ] ) |
b1edc53d | 319 | |
d43ba468 PB |
320 | =item command_output_pipe ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } ) |
321 | ||
b1edc53d PB |
322 | Execute the given C<COMMAND> in the same way as command() |
323 | does but return a pipe filehandle from which the command output can be | |
324 | read. | |
325 | ||
d79850e1 PB |
326 | The function can return C<($pipe, $ctx)> in array context. |
327 | See C<command_close_pipe()> for details. | |
328 | ||
b1edc53d PB |
329 | =cut |
330 | ||
d79850e1 PB |
331 | sub command_output_pipe { |
332 | _command_common_pipe('-|', @_); | |
333 | } | |
b1edc53d | 334 | |
b1edc53d | 335 | |
d79850e1 PB |
336 | =item command_input_pipe ( COMMAND [, ARGUMENTS... ] ) |
337 | ||
d43ba468 PB |
338 | =item command_input_pipe ( [ COMMAND, ARGUMENTS... ], { Opt => Val ... } ) |
339 | ||
d79850e1 PB |
340 | Execute the given C<COMMAND> in the same way as command_output_pipe() |
341 | does but return an input pipe filehandle instead; the command output | |
342 | is not captured. | |
343 | ||
344 | The function can return C<($pipe, $ctx)> in array context. | |
345 | See C<command_close_pipe()> for details. | |
346 | ||
347 | =cut | |
348 | ||
349 | sub command_input_pipe { | |
350 | _command_common_pipe('|-', @_); | |
8b9150e3 PB |
351 | } |
352 | ||
353 | ||
354 | =item command_close_pipe ( PIPE [, CTX ] ) | |
355 | ||
d79850e1 | 356 | Close the C<PIPE> as returned from C<command_*_pipe()>, checking |
3dff5379 | 357 | whether the command finished successfully. The optional C<CTX> argument |
8b9150e3 | 358 | is required if you want to see the command name in the error message, |
d79850e1 | 359 | and it is the second value returned by C<command_*_pipe()> when |
8b9150e3 PB |
360 | called in array context. The call idiom is: |
361 | ||
d79850e1 PB |
362 | my ($fh, $ctx) = $r->command_output_pipe('status'); |
363 | while (<$fh>) { ... } | |
364 | $r->command_close_pipe($fh, $ctx); | |
8b9150e3 PB |
365 | |
366 | Note that you should not rely on whatever actually is in C<CTX>; | |
367 | currently it is simply the command name but in future the context might | |
368 | have more complicated structure. | |
369 | ||
370 | =cut | |
371 | ||
372 | sub command_close_pipe { | |
373 | my ($self, $fh, $ctx) = _maybe_self(@_); | |
374 | $ctx ||= '<unknown>'; | |
375 | _cmd_close($fh, $ctx); | |
b1edc53d PB |
376 | } |
377 | ||
378 | ||
379 | =item command_noisy ( COMMAND [, ARGUMENTS... ] ) | |
380 | ||
381 | Execute the given C<COMMAND> in the same way as command() does but do not | |
382 | capture the command output - the standard output is not redirected and goes | |
383 | to the standard output of the caller application. | |
384 | ||
385 | While the method is called command_noisy(), you might want to as well use | |
386 | it for the most silent Git commands which you know will never pollute your | |
387 | stdout but you want to avoid the overhead of the pipe setup when calling them. | |
388 | ||
389 | The function returns only after the command has finished running. | |
390 | ||
391 | =cut | |
392 | ||
393 | sub command_noisy { | |
394 | my ($self, $cmd, @args) = _maybe_self(@_); | |
d79850e1 | 395 | _check_valid_cmd($cmd); |
b1edc53d PB |
396 | |
397 | my $pid = fork; | |
398 | if (not defined $pid) { | |
97b16c06 | 399 | throw Error::Simple("fork failed: $!"); |
b1edc53d PB |
400 | } elsif ($pid == 0) { |
401 | _cmd_exec($self, $cmd, @args); | |
402 | } | |
8b9150e3 PB |
403 | if (waitpid($pid, 0) > 0 and $?>>8 != 0) { |
404 | throw Git::Error::Command(join(' ', $cmd, @args), $? >> 8); | |
b1edc53d PB |
405 | } |
406 | } | |
407 | ||
408 | ||
63df97ae PB |
409 | =item version () |
410 | ||
411 | Return the Git version in use. | |
412 | ||
63df97ae PB |
413 | =cut |
414 | ||
18b0fc1c PB |
415 | sub version { |
416 | my $verstr = command_oneline('--version'); | |
417 | $verstr =~ s/^git version //; | |
418 | $verstr; | |
419 | } | |
63df97ae PB |
420 | |
421 | ||
eca1f6fd PB |
422 | =item exec_path () |
423 | ||
d5c7721d | 424 | Return path to the Git sub-command executables (the same as |
eca1f6fd PB |
425 | C<git --exec-path>). Useful mostly only internally. |
426 | ||
eca1f6fd PB |
427 | =cut |
428 | ||
18b0fc1c | 429 | sub exec_path { command_oneline('--exec-path') } |
eca1f6fd PB |
430 | |
431 | ||
d5c7721d PB |
432 | =item repo_path () |
433 | ||
434 | Return path to the git repository. Must be called on a repository instance. | |
435 | ||
436 | =cut | |
437 | ||
438 | sub repo_path { $_[0]->{opts}->{Repository} } | |
439 | ||
440 | ||
441 | =item wc_path () | |
442 | ||
443 | Return path to the working copy. Must be called on a repository instance. | |
444 | ||
445 | =cut | |
446 | ||
447 | sub wc_path { $_[0]->{opts}->{WorkingCopy} } | |
448 | ||
449 | ||
450 | =item wc_subdir () | |
451 | ||
452 | Return path to the subdirectory inside of a working copy. Must be called | |
453 | on a repository instance. | |
454 | ||
455 | =cut | |
456 | ||
457 | sub wc_subdir { $_[0]->{opts}->{WorkingSubdir} ||= '' } | |
458 | ||
459 | ||
460 | =item wc_chdir ( SUBDIR ) | |
461 | ||
462 | Change the working copy subdirectory to work within. The C<SUBDIR> is | |
463 | relative to the working copy root directory (not the current subdirectory). | |
464 | Must be called on a repository instance attached to a working copy | |
465 | and the directory must exist. | |
466 | ||
467 | =cut | |
468 | ||
469 | sub wc_chdir { | |
470 | my ($self, $subdir) = @_; | |
d5c7721d PB |
471 | $self->wc_path() |
472 | or throw Error::Simple("bare repository"); | |
473 | ||
474 | -d $self->wc_path().'/'.$subdir | |
475 | or throw Error::Simple("subdir not found: $!"); | |
476 | # Of course we will not "hold" the subdirectory so anyone | |
477 | # can delete it now and we will never know. But at least we tried. | |
478 | ||
479 | $self->{opts}->{WorkingSubdir} = $subdir; | |
480 | } | |
481 | ||
482 | ||
dc2613de PB |
483 | =item config ( VARIABLE ) |
484 | ||
e0d10e1c | 485 | Retrieve the configuration C<VARIABLE> in the same manner as C<config> |
dc2613de PB |
486 | does. In scalar context requires the variable to be set only one time |
487 | (exception is thrown otherwise), in array context returns allows the | |
488 | variable to be set multiple times and returns all the values. | |
489 | ||
490 | Must be called on a repository instance. | |
491 | ||
e0d10e1c | 492 | This currently wraps command('config') so it is not so fast. |
dc2613de PB |
493 | |
494 | =cut | |
495 | ||
496 | sub config { | |
497 | my ($self, $var) = @_; | |
498 | $self->repo_path() | |
499 | or throw Error::Simple("not a repository"); | |
500 | ||
501 | try { | |
502 | if (wantarray) { | |
e0d10e1c | 503 | return $self->command('config', '--get-all', $var); |
dc2613de | 504 | } else { |
e0d10e1c | 505 | return $self->command_oneline('config', '--get', $var); |
dc2613de PB |
506 | } |
507 | } catch Git::Error::Command with { | |
508 | my $E = shift; | |
509 | if ($E->value() == 1) { | |
510 | # Key not found. | |
511 | return undef; | |
512 | } else { | |
513 | throw $E; | |
514 | } | |
515 | }; | |
516 | } | |
517 | ||
518 | ||
35c49eea | 519 | =item config_bool ( VARIABLE ) |
7b9a13ec | 520 | |
35c49eea PB |
521 | Retrieve the bool configuration C<VARIABLE>. The return value |
522 | is usable as a boolean in perl (and C<undef> if it's not defined, | |
523 | of course). | |
7b9a13ec TT |
524 | |
525 | Must be called on a repository instance. | |
526 | ||
527 | This currently wraps command('config') so it is not so fast. | |
528 | ||
529 | =cut | |
530 | ||
35c49eea | 531 | sub config_bool { |
7b9a13ec TT |
532 | my ($self, $var) = @_; |
533 | $self->repo_path() | |
534 | or throw Error::Simple("not a repository"); | |
535 | ||
536 | try { | |
35c49eea | 537 | my $val = $self->command_oneline('config', '--bool', '--get', |
7b9a13ec | 538 | $var); |
35c49eea PB |
539 | return undef unless defined $val; |
540 | return $val eq 'true'; | |
7b9a13ec TT |
541 | } catch Git::Error::Command with { |
542 | my $E = shift; | |
543 | if ($E->value() == 1) { | |
544 | # Key not found. | |
545 | return undef; | |
546 | } else { | |
547 | throw $E; | |
548 | } | |
549 | }; | |
550 | } | |
551 | ||
346d203b JN |
552 | =item config_int ( VARIABLE ) |
553 | ||
554 | Retrieve the integer configuration C<VARIABLE>. The return value | |
555 | is simple decimal number. An optional value suffix of 'k', 'm', | |
556 | or 'g' in the config file will cause the value to be multiplied | |
557 | by 1024, 1048576 (1024^2), or 1073741824 (1024^3) prior to output. | |
558 | It would return C<undef> if configuration variable is not defined, | |
559 | ||
560 | Must be called on a repository instance. | |
561 | ||
562 | This currently wraps command('config') so it is not so fast. | |
563 | ||
564 | =cut | |
565 | ||
566 | sub config_int { | |
567 | my ($self, $var) = @_; | |
568 | $self->repo_path() | |
569 | or throw Error::Simple("not a repository"); | |
570 | ||
571 | try { | |
572 | return $self->command_oneline('config', '--int', '--get', $var); | |
573 | } catch Git::Error::Command with { | |
574 | my $E = shift; | |
575 | if ($E->value() == 1) { | |
576 | # Key not found. | |
577 | return undef; | |
578 | } else { | |
579 | throw $E; | |
580 | } | |
581 | }; | |
582 | } | |
7b9a13ec | 583 | |
b4c61ed6 JH |
584 | =item get_colorbool ( NAME ) |
585 | ||
586 | Finds if color should be used for NAMEd operation from the configuration, | |
587 | and returns boolean (true for "use color", false for "do not use color"). | |
588 | ||
589 | =cut | |
590 | ||
591 | sub get_colorbool { | |
592 | my ($self, $var) = @_; | |
593 | my $stdout_to_tty = (-t STDOUT) ? "true" : "false"; | |
594 | my $use_color = $self->command_oneline('config', '--get-colorbool', | |
595 | $var, $stdout_to_tty); | |
596 | return ($use_color eq 'true'); | |
597 | } | |
598 | ||
599 | =item get_color ( SLOT, COLOR ) | |
600 | ||
601 | Finds color for SLOT from the configuration, while defaulting to COLOR, | |
602 | and returns the ANSI color escape sequence: | |
603 | ||
604 | print $repo->get_color("color.interactive.prompt", "underline blue white"); | |
605 | print "some text"; | |
606 | print $repo->get_color("", "normal"); | |
607 | ||
608 | =cut | |
609 | ||
610 | sub get_color { | |
611 | my ($self, $slot, $default) = @_; | |
612 | my $color = $self->command_oneline('config', '--get-color', $slot, $default); | |
613 | if (!defined $color) { | |
614 | $color = ""; | |
615 | } | |
616 | return $color; | |
617 | } | |
618 | ||
c7a30e56 PB |
619 | =item ident ( TYPE | IDENTSTR ) |
620 | ||
621 | =item ident_person ( TYPE | IDENTSTR | IDENTARRAY ) | |
622 | ||
623 | This suite of functions retrieves and parses ident information, as stored | |
624 | in the commit and tag objects or produced by C<var GIT_type_IDENT> (thus | |
625 | C<TYPE> can be either I<author> or I<committer>; case is insignificant). | |
626 | ||
627 | The C<ident> method retrieves the ident information from C<git-var> | |
628 | and either returns it as a scalar string or as an array with the fields parsed. | |
629 | Alternatively, it can take a prepared ident string (e.g. from the commit | |
630 | object) and just parse it. | |
631 | ||
632 | C<ident_person> returns the person part of the ident - name and email; | |
633 | it can take the same arguments as C<ident> or the array returned by C<ident>. | |
634 | ||
635 | The synopsis is like: | |
636 | ||
637 | my ($name, $email, $time_tz) = ident('author'); | |
638 | "$name <$email>" eq ident_person('author'); | |
639 | "$name <$email>" eq ident_person($name); | |
640 | $time_tz =~ /^\d+ [+-]\d{4}$/; | |
641 | ||
642 | Both methods must be called on a repository instance. | |
643 | ||
644 | =cut | |
645 | ||
646 | sub ident { | |
647 | my ($self, $type) = @_; | |
648 | my $identstr; | |
649 | if (lc $type eq lc 'committer' or lc $type eq lc 'author') { | |
650 | $identstr = $self->command_oneline('var', 'GIT_'.uc($type).'_IDENT'); | |
651 | } else { | |
652 | $identstr = $type; | |
653 | } | |
654 | if (wantarray) { | |
655 | return $identstr =~ /^(.*) <(.*)> (\d+ [+-]\d{4})$/; | |
656 | } else { | |
657 | return $identstr; | |
658 | } | |
659 | } | |
660 | ||
661 | sub ident_person { | |
662 | my ($self, @ident) = @_; | |
663 | $#ident == 0 and @ident = $self->ident($ident[0]); | |
664 | return "$ident[0] <$ident[1]>"; | |
665 | } | |
666 | ||
667 | ||
24c4b714 | 668 | =item hash_object ( TYPE, FILENAME ) |
b1edc53d | 669 | |
b1edc53d | 670 | Compute the SHA1 object id of the given C<FILENAME> (or data waiting in |
24c4b714 PB |
671 | C<FILEHANDLE>) considering it is of the C<TYPE> object type (C<blob>, |
672 | C<commit>, C<tree>). | |
b1edc53d | 673 | |
b1edc53d PB |
674 | The method can be called without any instance or on a specified Git repository, |
675 | it makes zero difference. | |
676 | ||
677 | The function returns the SHA1 hash. | |
678 | ||
b1edc53d PB |
679 | =cut |
680 | ||
18b0fc1c | 681 | # TODO: Support for passing FILEHANDLE instead of FILENAME |
e6634ac9 PB |
682 | sub hash_object { |
683 | my ($self, $type, $file) = _maybe_self(@_); | |
18b0fc1c | 684 | command_oneline('hash-object', '-t', $type, $file); |
e6634ac9 | 685 | } |
b1edc53d PB |
686 | |
687 | ||
8b9150e3 | 688 | |
b1edc53d PB |
689 | =back |
690 | ||
97b16c06 | 691 | =head1 ERROR HANDLING |
b1edc53d | 692 | |
97b16c06 | 693 | All functions are supposed to throw Perl exceptions in case of errors. |
8b9150e3 PB |
694 | See the L<Error> module on how to catch those. Most exceptions are mere |
695 | L<Error::Simple> instances. | |
696 | ||
697 | However, the C<command()>, C<command_oneline()> and C<command_noisy()> | |
698 | functions suite can throw C<Git::Error::Command> exceptions as well: those are | |
699 | thrown when the external command returns an error code and contain the error | |
700 | code as well as access to the captured command's output. The exception class | |
701 | provides the usual C<stringify> and C<value> (command's exit code) methods and | |
702 | in addition also a C<cmd_output> method that returns either an array or a | |
703 | string with the captured command output (depending on the original function | |
704 | call context; C<command_noisy()> returns C<undef>) and $<cmdline> which | |
705 | returns the command and its arguments (but without proper quoting). | |
706 | ||
d79850e1 | 707 | Note that the C<command_*_pipe()> functions cannot throw this exception since |
8b9150e3 PB |
708 | it has no idea whether the command failed or not. You will only find out |
709 | at the time you C<close> the pipe; if you want to have that automated, | |
710 | use C<command_close_pipe()>, which can throw the exception. | |
711 | ||
712 | =cut | |
713 | ||
714 | { | |
715 | package Git::Error::Command; | |
716 | ||
717 | @Git::Error::Command::ISA = qw(Error); | |
718 | ||
719 | sub new { | |
720 | my $self = shift; | |
721 | my $cmdline = '' . shift; | |
722 | my $value = 0 + shift; | |
723 | my $outputref = shift; | |
724 | my(@args) = (); | |
725 | ||
726 | local $Error::Depth = $Error::Depth + 1; | |
727 | ||
728 | push(@args, '-cmdline', $cmdline); | |
729 | push(@args, '-value', $value); | |
730 | push(@args, '-outputref', $outputref); | |
731 | ||
732 | $self->SUPER::new(-text => 'command returned error', @args); | |
733 | } | |
734 | ||
735 | sub stringify { | |
736 | my $self = shift; | |
737 | my $text = $self->SUPER::stringify; | |
738 | $self->cmdline() . ': ' . $text . ': ' . $self->value() . "\n"; | |
739 | } | |
740 | ||
741 | sub cmdline { | |
742 | my $self = shift; | |
743 | $self->{'-cmdline'}; | |
744 | } | |
745 | ||
746 | sub cmd_output { | |
747 | my $self = shift; | |
748 | my $ref = $self->{'-outputref'}; | |
749 | defined $ref or undef; | |
750 | if (ref $ref eq 'ARRAY') { | |
751 | return @$ref; | |
752 | } else { # SCALAR | |
753 | return $$ref; | |
754 | } | |
755 | } | |
756 | } | |
757 | ||
758 | =over 4 | |
759 | ||
760 | =item git_cmd_try { CODE } ERRMSG | |
761 | ||
762 | This magical statement will automatically catch any C<Git::Error::Command> | |
763 | exceptions thrown by C<CODE> and make your program die with C<ERRMSG> | |
764 | on its lips; the message will have %s substituted for the command line | |
765 | and %d for the exit status. This statement is useful mostly for producing | |
766 | more user-friendly error messages. | |
767 | ||
768 | In case of no exception caught the statement returns C<CODE>'s return value. | |
769 | ||
770 | Note that this is the only auto-exported function. | |
771 | ||
772 | =cut | |
773 | ||
774 | sub git_cmd_try(&$) { | |
775 | my ($code, $errmsg) = @_; | |
776 | my @result; | |
777 | my $err; | |
778 | my $array = wantarray; | |
779 | try { | |
780 | if ($array) { | |
781 | @result = &$code; | |
782 | } else { | |
783 | $result[0] = &$code; | |
784 | } | |
785 | } catch Git::Error::Command with { | |
786 | my $E = shift; | |
787 | $err = $errmsg; | |
788 | $err =~ s/\%s/$E->cmdline()/ge; | |
789 | $err =~ s/\%d/$E->value()/ge; | |
790 | # We can't croak here since Error.pm would mangle | |
791 | # that to Error::Simple. | |
792 | }; | |
793 | $err and croak $err; | |
794 | return $array ? @result : $result[0]; | |
795 | } | |
796 | ||
797 | ||
798 | =back | |
b1edc53d PB |
799 | |
800 | =head1 COPYRIGHT | |
801 | ||
802 | Copyright 2006 by Petr Baudis E<lt>pasky@suse.czE<gt>. | |
803 | ||
804 | This module is free software; it may be used, copied, modified | |
805 | and distributed under the terms of the GNU General Public Licence, | |
806 | either version 2, or (at your option) any later version. | |
807 | ||
808 | =cut | |
809 | ||
810 | ||
811 | # Take raw method argument list and return ($obj, @args) in case | |
812 | # the method was called upon an instance and (undef, @args) if | |
813 | # it was called directly. | |
814 | sub _maybe_self { | |
815 | # This breaks inheritance. Oh well. | |
816 | ref $_[0] eq 'Git' ? @_ : (undef, @_); | |
817 | } | |
818 | ||
d79850e1 PB |
819 | # Check if the command id is something reasonable. |
820 | sub _check_valid_cmd { | |
821 | my ($cmd) = @_; | |
822 | $cmd =~ /^[a-z0-9A-Z_-]+$/ or throw Error::Simple("bad command: $cmd"); | |
823 | } | |
824 | ||
825 | # Common backend for the pipe creators. | |
826 | sub _command_common_pipe { | |
827 | my $direction = shift; | |
d43ba468 PB |
828 | my ($self, @p) = _maybe_self(@_); |
829 | my (%opts, $cmd, @args); | |
830 | if (ref $p[0]) { | |
831 | ($cmd, @args) = @{shift @p}; | |
832 | %opts = ref $p[0] ? %{$p[0]} : @p; | |
833 | } else { | |
834 | ($cmd, @args) = @p; | |
835 | } | |
d79850e1 PB |
836 | _check_valid_cmd($cmd); |
837 | ||
a6065b54 | 838 | my $fh; |
d3b1785f | 839 | if ($^O eq 'MSWin32') { |
a6065b54 PB |
840 | # ActiveState Perl |
841 | #defined $opts{STDERR} and | |
842 | # warn 'ignoring STDERR option - running w/ ActiveState'; | |
843 | $direction eq '-|' or | |
844 | die 'input pipe for ActiveState not implemented'; | |
bed118d6 AR |
845 | # the strange construction with *ACPIPE is just to |
846 | # explain the tie below that we want to bind to | |
847 | # a handle class, not scalar. It is not known if | |
848 | # it is something specific to ActiveState Perl or | |
849 | # just a Perl quirk. | |
850 | tie (*ACPIPE, 'Git::activestate_pipe', $cmd, @args); | |
851 | $fh = *ACPIPE; | |
a6065b54 PB |
852 | |
853 | } else { | |
854 | my $pid = open($fh, $direction); | |
855 | if (not defined $pid) { | |
856 | throw Error::Simple("open failed: $!"); | |
857 | } elsif ($pid == 0) { | |
858 | if (defined $opts{STDERR}) { | |
859 | close STDERR; | |
860 | } | |
861 | if ($opts{STDERR}) { | |
862 | open (STDERR, '>&', $opts{STDERR}) | |
863 | or die "dup failed: $!"; | |
864 | } | |
865 | _cmd_exec($self, $cmd, @args); | |
d43ba468 | 866 | } |
d79850e1 PB |
867 | } |
868 | return wantarray ? ($fh, join(' ', $cmd, @args)) : $fh; | |
869 | } | |
870 | ||
b1edc53d PB |
871 | # When already in the subprocess, set up the appropriate state |
872 | # for the given repository and execute the git command. | |
873 | sub _cmd_exec { | |
874 | my ($self, @args) = @_; | |
875 | if ($self) { | |
d5c7721d PB |
876 | $self->repo_path() and $ENV{'GIT_DIR'} = $self->repo_path(); |
877 | $self->wc_path() and chdir($self->wc_path()); | |
878 | $self->wc_subdir() and chdir($self->wc_subdir()); | |
b1edc53d | 879 | } |
97b16c06 | 880 | _execv_git_cmd(@args); |
6aaa65da | 881 | die qq[exec "@args" failed: $!]; |
b1edc53d PB |
882 | } |
883 | ||
8062f81c PB |
884 | # Execute the given Git command ($_[0]) with arguments ($_[1..]) |
885 | # by searching for it at proper places. | |
18b0fc1c | 886 | sub _execv_git_cmd { exec('git', @_); } |
8062f81c | 887 | |
b1edc53d PB |
888 | # Close pipe to a subprocess. |
889 | sub _cmd_close { | |
8b9150e3 | 890 | my ($fh, $ctx) = @_; |
b1edc53d PB |
891 | if (not close $fh) { |
892 | if ($!) { | |
893 | # It's just close, no point in fatalities | |
894 | carp "error closing pipe: $!"; | |
895 | } elsif ($? >> 8) { | |
8b9150e3 PB |
896 | # The caller should pepper this. |
897 | throw Git::Error::Command($ctx, $? >> 8); | |
b1edc53d PB |
898 | } |
899 | # else we might e.g. closed a live stream; the command | |
900 | # dying of SIGPIPE would drive us here. | |
901 | } | |
902 | } | |
903 | ||
904 | ||
b1edc53d PB |
905 | sub DESTROY { } |
906 | ||
907 | ||
a6065b54 PB |
908 | # Pipe implementation for ActiveState Perl. |
909 | ||
910 | package Git::activestate_pipe; | |
911 | use strict; | |
912 | ||
913 | sub TIEHANDLE { | |
914 | my ($class, @params) = @_; | |
915 | # FIXME: This is probably horrible idea and the thing will explode | |
916 | # at the moment you give it arguments that require some quoting, | |
917 | # but I have no ActiveState clue... --pasky | |
d3b1785f AR |
918 | # Let's just hope ActiveState Perl does at least the quoting |
919 | # correctly. | |
920 | my @data = qx{git @params}; | |
a6065b54 PB |
921 | bless { i => 0, data => \@data }, $class; |
922 | } | |
923 | ||
924 | sub READLINE { | |
925 | my $self = shift; | |
926 | if ($self->{i} >= scalar @{$self->{data}}) { | |
927 | return undef; | |
928 | } | |
2f5b3980 AR |
929 | my $i = $self->{i}; |
930 | if (wantarray) { | |
931 | $self->{i} = $#{$self->{'data'}} + 1; | |
932 | return splice(@{$self->{'data'}}, $i); | |
933 | } | |
934 | $self->{i} = $i + 1; | |
935 | return $self->{'data'}->[ $i ]; | |
a6065b54 PB |
936 | } |
937 | ||
938 | sub CLOSE { | |
939 | my $self = shift; | |
940 | delete $self->{data}; | |
941 | delete $self->{i}; | |
942 | } | |
943 | ||
944 | sub EOF { | |
945 | my $self = shift; | |
946 | return ($self->{i} >= scalar @{$self->{data}}); | |
947 | } | |
948 | ||
949 | ||
b1edc53d | 950 | 1; # Famous last words |