undef/git-commit-vandalism
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Git.pm: Enhance the command_pipe() mechanism

Browse Source 
Rename command_pipe() to command_output_pipe(), outsource
the functionality to _command_common_pipe().

Add command_input_pipe().

Signed-off-by: Petr Baudis <pasky@suse.cz>
Signed-off-by: Junio C Hamano <junkio@cox.net>
This commit is contained in:
Petr Baudis 2006-06-24 04:34:47 +02:00 committed by Junio C Hamano
parent 8b9150e3e3
commit d79850e1fd
1 changed files with 53 additions and 23 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

74
perl/Git.pm
View File

@ -32,7 +32,7 @@ $VERSION = '0.01';
my @revs = $repo->command('rev-list', '--since=last monday', '--all');
my ($fh, $c) = $repo->command_pipe('rev-list', '--since=last monday', '--all');
my ($fh, $c) = $repo->command_output_pipe('rev-list', '--since=last monday', '--all');
my $lastrev = <$fh>; chomp $lastrev;
$repo->command_close_pipe($fh, $c);
@ -48,7 +48,8 @@ require Exporter;
@EXPORT = qw(git_cmd_try);
# Methods which can be called as standalone functions as well:
@EXPORT_OK = qw(command command_oneline command_pipe command_noisy
@EXPORT_OK = qw(command command_oneline command_noisy
command_output_pipe command_input_pipe command_close_pipe
version exec_path hash_object git_cmd_try);
@ -194,7 +195,7 @@ In both cases, the command's stdin and stderr are the same as the caller's.
=cut
sub command {
my ($fh, $ctx) = command_pipe(@_);
my ($fh, $ctx) = command_output_pipe(@_);
if (not defined wantarray) {
# Nothing to pepper the possible exception with.
@ -237,7 +238,7 @@ of the command's standard output.
=cut
sub command_oneline {
my ($fh, $ctx) = command_pipe(@_);
my ($fh, $ctx) = command_output_pipe(@_);
my $line = <$fh>;
chomp $line;
@ -253,38 +254,47 @@ sub command_oneline {
}
=item command_pipe ( COMMAND [, ARGUMENTS... ] )
=item command_output_pipe ( COMMAND [, ARGUMENTS... ] )
Execute the given C<COMMAND> in the same way as command()
does but return a pipe filehandle from which the command output can be
read.
The function can return C<($pipe, $ctx)> in array context.
See C<command_close_pipe()> for details.
=cut
sub command_pipe {
my ($self, $cmd, @args) = _maybe_self(@_);
$cmd =~ /^[a-z0-9A-Z_-]+$/ or throw Error::Simple("bad command: $cmd");
my $pid = open(my $fh, "-|");
if (not defined $pid) {
throw Error::Simple("open failed: $!");
} elsif ($pid == 0) {
_cmd_exec($self, $cmd, @args);
sub command_output_pipe {
_command_common_pipe('-|', @_);
}
return wantarray ? ($fh, join(' ', $cmd, @args)) : $fh;
=item command_input_pipe ( COMMAND [, ARGUMENTS... ] )
Execute the given C<COMMAND> in the same way as command_output_pipe()
does but return an input pipe filehandle instead; the command output
is not captured.
The function can return C<($pipe, $ctx)> in array context.
See C<command_close_pipe()> for details.
=cut
sub command_input_pipe {
_command_common_pipe('|-', @_);
}
=item command_close_pipe ( PIPE [, CTX ] )
Close the C<PIPE> as returned from C<command_pipe()>, checking
Close the C<PIPE> as returned from C<command_*_pipe()>, checking
whether the command finished successfuly. The optional C<CTX> argument
is required if you want to see the command name in the error message,
and it is the second value returned by C<command_pipe()> when
and it is the second value returned by C<command_*_pipe()> when
called in array context. The call idiom is:
my ($fh, $ctx) = $r->command_pipe('status');
my ($fh, $ctx) = $r->command_output_pipe('status');
while (<$fh>) { ... }
$r->command_close_pipe($fh, $ctx);
@ -317,8 +327,7 @@ The function returns only after the command has finished running.
sub command_noisy {
my ($self, $cmd, @args) = _maybe_self(@_);
$cmd =~ /^[a-z0-9A-Z_-]+$/ or throw Error::Simple("bad command: $cmd");
_check_valid_cmd($cmd);
my $pid = fork;
if (not defined $pid) {
@ -404,7 +413,7 @@ string with the captured command output (depending on the original function
call context; C<command_noisy()> returns C<undef>) and $<cmdline> which
returns the command and its arguments (but without proper quoting).
Note that the C<command_pipe()> function cannot throw this exception since
Note that the C<command_*_pipe()> functions cannot throw this exception since
it has no idea whether the command failed or not. You will only find out
at the time you C<close> the pipe; if you want to have that automated,
use C<command_close_pipe()>, which can throw the exception.
@ -516,6 +525,27 @@ sub _maybe_self {
ref $_[0] eq 'Git' ? @_ : (undef, @_);
}
# Check if the command id is something reasonable.
sub _check_valid_cmd {
my ($cmd) = @_;
$cmd =~ /^[a-z0-9A-Z_-]+$/ or throw Error::Simple("bad command: $cmd");
}
# Common backend for the pipe creators.
sub _command_common_pipe {
my $direction = shift;
my ($self, $cmd, @args) = _maybe_self(@_);
_check_valid_cmd($cmd);
my $pid = open(my $fh, $direction);
if (not defined $pid) {
throw Error::Simple("open failed: $!");
} elsif ($pid == 0) {
_cmd_exec($self, $cmd, @args);
}
return wantarray ? ($fh, join(' ', $cmd, @args)) : $fh;
}
# When already in the subprocess, set up the appropriate state
# for the given repository and execute the git command.
sub _cmd_exec {