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