X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;ds=sidebyside;f=FS%2FFS%2Fpart_export%2Fshellcommands.pm;h=b9d6551db96e29fd2477a04d770a48a8c5408ecd;hb=1ad547a47f16b4230762e752fbe48d460ed997e1;hp=0b9e475dbd8a2a961ee65622ae72e36814ab9614;hpb=40a7b3dc653e099f7bd0bd762b649b04c4432db2;p=freeside.git diff --git a/FS/FS/part_export/shellcommands.pm b/FS/FS/part_export/shellcommands.pm index 0b9e475db..b9d6551db 100644 --- a/FS/FS/part_export/shellcommands.pm +++ b/FS/FS/part_export/shellcommands.pm @@ -78,24 +78,36 @@ tie my %options, 'Tie::IxHash', }, 'groups_susp_reason' => { label => 'Radius group mapping to reason (via template user)', - type => 'textarea', - }, + type => 'textarea', + }, + 'fail_on_output' => { + label => 'Treat any output from the command as an error', + type => 'checkbox', + }, + 'ignore_all_errors' => { + label => 'Ignore all errors from the command', + type => 'checkbox', + }, + 'ignored_errors' => { label => 'Regexes of specific errors to ignore, separated by newlines', + type => 'textarea' + }, # 'no_queue' => { label => 'Run command immediately', # type => 'checkbox', # }, ; %info = ( - 'svc' => 'svc_acct', - 'desc' => + 'svc' => 'svc_acct', + 'desc' => 'Real-time export via remote SSH (i.e. useradd, userdel, etc.)', - 'options' => \%options, - 'nodomain' => 'Y', - 'notes' => <<'END' + 'options' => \%options, + 'nodomain' => 'Y', + 'svc_machine' => 1, + 'notes' => <<'END' Run remote commands via SSH. Usernames are considered unique (also see shellcommands_withdomain). You probably want this if the commands you are running will not accept a domain as a parameter. You will need to -setup SSH for unattended operation. +setup SSH for unattended operation.

Use these buttons for some useful presets: END ); @@ -263,7 +258,7 @@ sub _export_command { { no strict 'refs'; foreach my $custf (qw( company address1 address2 city state zip country - daytime night fax otaker + daytime night fax otaker agent_custid locale )) { ${$custf} = $cust_pkg->cust_main->$custf(); @@ -342,19 +337,26 @@ sub _export_command { $night = shell_quote $night; $fax = shell_quote $fax; $otaker = shell_quote $otaker; + $agent_custid = shell_quote $agent_custid; + $locale = shell_quote $locale; my $command_string = eval(qq("$command")); + my @ssh_cmd_args = ( user => $self->option('user') || 'root', host => $self->machine, command => $command_string, stdin_string => $stdin_string, - ); + ignored_errors => $self->option('ignored_errors') || '', + ignore_all_errors => $self->option('ignore_all_errors'), + fail_on_output => $self->option('fail_on_output'), + ); if($self->option($action . '_no_queue')) { # discard return value just like freeside-queued. eval { ssh_cmd(@ssh_cmd_args) }; $error = $@; + $error = $error->full_message if ref $error; # Exception::Class::Base return $error. ' ('. $self->exporttype. ' to '. $self->machine. ')' if $error; } @@ -366,6 +368,7 @@ sub _export_command { sub _export_replace { my($self, $new, $old ) = (shift, shift, shift); my $command = $self->option('usermod'); + return '' if $command =~ /^\s*$/; my $stdin = $self->option('usermod_stdin'); no strict 'vars'; { @@ -375,6 +378,8 @@ sub _export_replace { } my $old_cust_pkg = $old->cust_svc->cust_pkg; my $new_cust_pkg = $new->cust_svc->cust_pkg; + my $new_cust_main = $new_cust_pkg ? $new_cust_pkg->cust_main : ''; + $new_finger =~ /^(.*)\s+(\S+)$/ or $new_finger =~ /^((.*))$/; ($new_first, $new_last ) = ( $1, $2 ); $quoted_new__password = shell_quote $new__password; #old, wrong? @@ -415,6 +420,13 @@ sub _export_replace { return $error. ' ('. $self->exporttype. ' to '. $self->machine. ')' if $error; + $new_agent_custid = $new_cust_main ? $new_cust_main->agent_custid : ''; + $new_locale = $new_cust_main ? $new_cust_main->locale : ''; + $old_pkgnum = $old_cust_pkg ? $old_cust_pkg->pkgnum : ''; + $old_custnum = $old_cust_pkg ? $old_cust_pkg->custnum : ''; + $new_pkgnum = $new_cust_pkg ? $new_cust_pkg->pkgnum : ''; + $new_custnum = $new_cust_pkg ? $new_cust_pkg->custnum : ''; + my $stdin_string = eval(qq("$stdin")); $new_first = shell_quote $new_first; @@ -422,10 +434,8 @@ sub _export_replace { $new_finger = shell_quote $new_finger; $new_crypt_password = shell_quote $new_crypt_password; $new_ldap_password = shell_quote $new_ldap_password; - $old_pkgnum = $old_cust_pkg ? $old_cust_pkg->pkgnum : ''; - $old_custnum = $old_cust_pkg ? $old_cust_pkg->custnum : ''; - $new_pkgnum = $new_cust_pkg ? $new_cust_pkg->pkgnum : ''; - $new_custnum = $new_cust_pkg ? $new_cust_pkg->custnum : ''; + $new_agent_custid = shell_quote $new_agent_custid; + $new_locale = shell_quote $new_locale; my $command_string = eval(qq("$command")); @@ -434,12 +444,16 @@ sub _export_replace { host => $self->machine, command => $command_string, stdin_string => $stdin_string, + ignored_errors => $self->option('ignored_errors') || '', + ignore_all_errors => $self->option('ignore_all_errors'), + fail_on_output => $self->option('fail_on_output'), ); if($self->option('usermod_no_queue')) { # discard return value just like freeside-queued. eval { ssh_cmd(@ssh_cmd_args) }; $error = $@; + $error = $error->full_message if ref $error; # Exception::Class::Base return $error. ' ('. $self->exporttype. ' to '. $self->machine. ')' if $error; } @@ -459,8 +473,41 @@ sub shellcommands_queue { } sub ssh_cmd { #subroutine, not method - use Net::SSH '0.08'; - &Net::SSH::ssh_cmd( { @_ } ); + use Net::OpenSSH; + my $opt = { @_ }; + open my $def_in, '<', '/dev/null' or die "unable to open /dev/null\n"; + my $ssh = Net::OpenSSH->new( + $opt->{'user'}.'@'.$opt->{'host'}, + 'default_stdin_fh' => $def_in + ); + # ignore_all_errors doesn't override SSH connection/auth errors-- + # probably correct + die "Couldn't establish SSH connection: ". $ssh->error if $ssh->error; + + my $ssh_opt = {}; + $ssh_opt->{'stdin_data'} = $opt->{'stdin_string'} + if exists($opt->{'stdin_string'}) and length($opt->{'stdin_string'}); + + my ($output, $errput) = $ssh->capture2($ssh_opt, $opt->{'command'}); + + return if $opt->{'ignore_all_errors'}; + die "Error running SSH command: ". $ssh->error if $ssh->error; + + if ( ($output || $errput) + && $opt->{'ignored_errors'} && length($opt->{'ignored_errors'}) + ) { + my @ignored_errors = split('\n',$opt->{'ignored_errors'}); + foreach my $ignored_error ( @ignored_errors ) { + $output =~ s/$ignored_error//g; + $errput =~ s/$ignored_error//g; + } + $output =~ s/[\s\n]//g; + $errput =~ s/[\s\n]//g; + } + + die "$errput\n" if $errput; + die "$output\n" if $output and $opt->{'fail_on_output'}; + ''; } #sub shellcommands_insert { #subroutine, not method @@ -470,5 +517,23 @@ sub ssh_cmd { #subroutine, not method #sub shellcommands_delete { #subroutine, not method #} +sub _upgrade_exporttype { + my $class = shift; + $class =~ /^FS::part_export::(\w+)$/; + foreach my $self ( qsearch('part_export', { 'exporttype' => $1 }) ) { + my %options = $self->options; + my $changed = 0; + # 2011-12-13 - 2012-02-16: ignore_all_output option + if ( $options{'ignore_all_output'} ) { + # ignoring STDOUT is now the default + $options{'ignore_all_errors'} = 1; + delete $options{'ignore_all_output'}; + $changed++; + } + my $error = $self->replace(%options) if $changed; + die $error if $error; + } +} + 1;