X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fpart_export%2Fshellcommands.pm;h=ca4e52420b653110246f0340bf5c59450c42e5ba;hb=6868dfdef35b338f5f4f6c0bc9cae535dc344ab9;hp=7baf2dabe39f0a3a1f570c096d95ab32bfd28ae4;hpb=46c05dd754895d3d9511763998f9ef505c8d2bd7;p=freeside.git
diff --git a/FS/FS/part_export/shellcommands.pm b/FS/FS/part_export/shellcommands.pm
index 7baf2dabe..ca4e52420 100644
--- a/FS/FS/part_export/shellcommands.pm
+++ b/FS/FS/part_export/shellcommands.pm
@@ -78,24 +78,35 @@ 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' =>
- 'Real-time export via remote SSH (i.e. useradd, userdel, etc.)',
- 'options' => \%options,
- 'nodomain' => 'Y',
- 'notes' => <<'END'
+ 'svc' => 'svc_acct',
+ 'desc' => 'Real-time export via remote SSH (i.e. useradd, userdel, etc.)',
+ '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:
@@ -113,24 +124,7 @@ running will not accept a domain as a parameter. You will need to
this.form.unsuspend_stdin.value="";
'>
-
- Note: On FreeBSD versions before 5.3 and 4.10 (4.10 is after 4.9, not
- 4.1!), due to deficient locking in pw(1), you must disable the chpass(1),
- chsh(1), chfn(1), passwd(1), and vipw(1) commands, or replace them with
- wrappers that prepend "lockf /etc/passwd.lock". Alternatively, apply the
- patch in
- FreeBSD PR#23501
- and use the "FreeBSD 4.10 / 5.3 or later" button below.
-
- $reasontypetext (when suspending)
$pkgnum
$custnum
-
All other fields in svc_acct are also available.
+
All other fields in svc_acct are also available.
+
The following fields from cust_main are also available (except during replace): company, address1, address2, city, state, zip, county, daytime, night, fax, otaker, agent_custid, locale. When used on the command line (rather than STDIN), they will be quoted for the shell already (do not add additional quotes).
END
);
@@ -258,6 +253,16 @@ sub _export_command {
my $cust_pkg = $svc_acct->cust_svc->cust_pkg;
if ( $cust_pkg ) {
+ no strict 'vars';
+ {
+ no strict 'refs';
+ foreach my $custf (qw( company address1 address2 city state zip country
+ daytime night fax otaker agent_custid locale
+ ))
+ {
+ ${$custf} = $cust_pkg->cust_main->$custf();
+ }
+ }
$email = ( grep { $_ !~ /^(POST|FAX)$/ } $cust_pkg->cust_main->invoicing_list )[0];
} else {
$email = '';
@@ -309,6 +314,9 @@ sub _export_command {
$reasonnum = $reasontext = $reasontypenum = $reasontypetext = '';
}
+ $pkgnum = $cust_pkg ? $cust_pkg->pkgnum : '';
+ $custnum = $cust_pkg ? $cust_pkg->custnum : '';
+
my $stdin_string = eval(qq("$stdin"));
$first = shell_quote $first;
@@ -316,22 +324,39 @@ sub _export_command {
$finger = shell_quote $finger;
$crypt_password = shell_quote $crypt_password;
$ldap_password = shell_quote $ldap_password;
- $pkgnum = $cust_pkg ? $cust_pkg->pkgnum : '';
- $custnum = $cust_pkg ? $cust_pkg->custnum : '';
+
+ $company = shell_quote $company;
+ $address1 = shell_quote $address1;
+ $address2 = shell_quote $address2;
+ $city = shell_quote $city;
+ $state = shell_quote $state;
+ $zip = shell_quote $zip;
+ $country = shell_quote $country;
+ $daytime = shell_quote $daytime;
+ $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,
+ host => $self->svc_machine($svc_acct),
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 = $@;
- return $error. ' ('. $self->exporttype. ' to '. $self->machine. ')'
+ $error = $error->full_message if ref $error; # Exception::Class::Base
+ return $error. ' ('. $self->exporttype. ' to '. $self->svc_machine($svc_acct). ')'
if $error;
}
else {
@@ -342,6 +367,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';
{
@@ -351,6 +377,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?
@@ -388,9 +416,16 @@ sub _export_replace {
# $error ||= "can't change RADIUS groups";
#}
}
- return $error. ' ('. $self->exporttype. ' to '. $self->machine. ')'
+ return $error. ' ('. $self->exporttype. ' to '. $self->svc_machine($new). ')'
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;
@@ -398,25 +433,27 @@ 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"));
my @ssh_cmd_args = (
user => $self->option('user') || 'root',
- host => $self->machine,
+ host => $self->svc_machine($new),
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 = $@;
- return $error. ' ('. $self->exporttype. ' to '. $self->machine. ')'
+ $error = $error->full_message if ref $error; # Exception::Class::Base
+ return $error. ' ('. $self->exporttype. ' to '. $self->svc_machine($new). ')'
if $error;
}
else {
@@ -435,8 +472,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
@@ -446,5 +516,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;