X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fpart_export%2Fshellcommands.pm;h=7c280e5f8c2da55e1d08eacbb6a7c770e8a72bbc;hp=0b9e475dbd8a2a961ee65622ae72e36814ab9614;hb=197f613bac6c3f9a4bd7d1ea5fbf4769aea4ce1a;hpb=87b5a2f15b23247a68fd29f8c0fb5cd81ab406ba diff --git a/FS/FS/part_export/shellcommands.pm b/FS/FS/part_export/shellcommands.pm index 0b9e475db..7c280e5f8 100644 --- a/FS/FS/part_export/shellcommands.pm +++ b/FS/FS/part_export/shellcommands.pm @@ -2,14 +2,18 @@ package FS::part_export::shellcommands; use vars qw(@ISA %info); use Tie::IxHash; +use Date::Format; use String::ShellQuote; +use Net::OpenSSH; use FS::part_export; use FS::Record qw( qsearch qsearchs ); @ISA = qw(FS::part_export); tie my %options, 'Tie::IxHash', + 'user' => { label=>'Remote username', default=>'root' }, + 'useradd' => { label=>'Insert command', default=>'useradd -c $finger -d $dir -m -s $shell -u $uid -p $crypt_password $username' #default=>'cp -pr /etc/skel $dir; chown -R $uid.$gid $dir' @@ -21,6 +25,7 @@ tie my %options, 'Tie::IxHash', type =>'textarea', default=>'', }, + 'userdel' => { label=>'Delete command', default=>'userdel -r $username', #default=>'rm -rf $dir', @@ -32,6 +37,7 @@ tie my %options, 'Tie::IxHash', type =>'textarea', default=>'', }, + 'usermod' => { label=>'Modify command', default=>'usermod -c $new_finger -d $new_dir -m -l $new_username -s $new_shell -u $new_uid -g $new_gid -p $new_crypt_password $old_username', #default=>'[ -d $old_dir ] && mv $old_dir $new_dir || ( '. @@ -54,6 +60,7 @@ tie my %options, 'Tie::IxHash', 'usermod_nousername' => { label=>'Disallow just username changes', type =>'checkbox', }, + 'suspend' => { label=>'Suspension command', default=>'usermod -L $username', }, @@ -63,6 +70,7 @@ tie my %options, 'Tie::IxHash', 'suspend_stdin' => { label=>'Suspension command STDIN', default=>'', }, + 'unsuspend' => { label=>'Unsuspension command', default=>'usermod -U $username', }, @@ -72,30 +80,57 @@ tie my %options, 'Tie::IxHash', 'unsuspend_stdin' => { label=>'Unsuspension command STDIN', default=>'', }, + + 'pkg_change' => { label=>'Package changed command', + default=>'', + }, + + # run commands on package change for multiple services and roll back the + # package change transaciton if one fails? yuck. no. + # if this was really needed, would need to restrict to a single service with + # this kind of export configured. + #'pkg_change_no_queue' => { label=>'Run immediately', + # type =>'checkbox', + # }, + 'pkg_change_stdin' => { label=>'Package changed command STDIN', + default=>'', + }, + 'crypt' => { label => 'Default password encryption', - type=>'select', options=>[qw(crypt md5)], - default => 'crypt', + type=>'select', options=>[qw(crypt md5 sha512)], + default => 'md5', }, '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: +For the package changed command only, the following fields are also available: + END ); @@ -208,25 +245,50 @@ sub _map { sub rebless { shift; } sub _export_insert { - my($self) = shift; + my $self = shift; $self->_export_command('useradd', @_); } sub _export_delete { - my($self) = shift; + my $self = shift; $self->_export_command('userdel', @_); } sub _export_suspend { - my($self) = shift; + my $self = shift; $self->_export_command_or_super('suspend', @_); } sub _export_unsuspend { - my($self) = shift; + my $self = shift; $self->_export_command_or_super('unsuspend', @_); } +sub export_pkg_change { + my( $self, $svc_acct, $new_cust_pkg, $old_cust_pkg ) = @_; + + my @fields = qw( pkgnum pkgpart agent_pkgid ); #others? + my @date_fields = qw( order_date start_date setup bill last_bill susp adjourn + resume cancel uncancel expire contract_end ); + + no strict 'vars'; + { + no strict 'refs'; + foreach (@fields) { + ${"old_$_"} = $old_cust_pkg ? $old_cust_pkg->getfield($_) : ''; + ${"new_$_"} = $new_cust_pkg->getfield($_); + } + foreach (@date_fields) { + ${"old_$_"} = $old_cust_pkg + ? time2str('%Y-%m-%d', $old_cust_pkg->getfield($_)) + : ''; + ${"new_$_"} = time2str('%Y-%m-%d', $new_cust_pkg->getfield($_)); + } + } + + $self->_export_command('pkg_change', $svc_acct); +} + sub _export_command_or_super { my($self, $action) = (shift, shift); if ( $self->option($action) =~ /^\s*$/ ) { @@ -235,26 +297,62 @@ sub _export_command_or_super { } else { $self->_export_command($action, @_); } -}; +} sub _export_command { my ( $self, $action, $svc_acct) = (shift, shift, shift); my $command = $self->option($action); + return '' if $command =~ /^\s*$/; my $stdin = $self->option($action."_stdin"); + my( $command_string, $stdin_string ) = + $self->_export_subvars( $svc_acct, $command, $stdin ); + + $self->ssh_or_queue( $svc_acct, $command_string, $stdin_string ); +} + +sub ssh_or_queue { + my( $self, $svc_acct, $command_string, $stdin_string ) = @_; + + my @ssh_cmd_args = ( + user => $self->option('user') || 'root', + 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 = $@; + $error = $error->full_message if ref $error; # Exception::Class::Base + return $error. + ' ('. $self->exporttype. ' to '. $self->svc_machine($svc_acct). ')' + if $error; + } else { + $self->shellcommands_queue( $svc_acct->svcnum, @ssh_cmd_args ); + } +} + +sub _export_subvars { + my( $self, $svc_acct, $command, $stdin ) = @_; + no strict 'vars'; { no strict 'refs'; ${$_} = $svc_acct->getfield($_) foreach $svc_acct->fields; # snarfs are unused at this point? - my $count = 1; - foreach my $acct_snarf ( $svc_acct->acct_snarf ) { - ${"snarf_$_$count"} = shell_quote( $acct_snarf->get($_) ) - foreach qw( machine username _password ); - $count++; - } + # my $count = 1; + # foreach my $acct_snarf ( $svc_acct->acct_snarf ) { + # ${"snarf_$_$count"} = shell_quote( $acct_snarf->get($_) ) + # foreach qw( machine username _password ); + # $count++; + # } } my $cust_pkg = $svc_acct->cust_svc->cust_pkg; @@ -263,7 +361,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(); @@ -321,9 +419,11 @@ sub _export_command { } $pkgnum = $cust_pkg ? $cust_pkg->pkgnum : ''; + $locationnum = $cust_pkg ? $cust_pkg->locationnum : ''; $custnum = $cust_pkg ? $cust_pkg->custnum : ''; my $stdin_string = eval(qq("$stdin")); + return "error filling in STDIN: $@" if $@; $first = shell_quote $first; $last = shell_quote $last; @@ -342,31 +442,30 @@ 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, - ); + return "error filling in command: $@" if $@; - 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. ')' - if $error; - } - else { - $self->shellcommands_queue( $svc_acct->svcnum, @ssh_cmd_args ); - } + ( $command_string, $stdin_string ); } 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'); + + my( $command_string, $stdin_string ) = + $self->_export_subvars_replace( $new, $old, $command, $stdin ); + + $self->ssh_or_queue( $new, $command_string, $stdin_string ); +} + +sub _export_subvars_replace { + my( $self, $new, $old, $command, $stdin ) = @_; + no strict 'vars'; { no strict 'refs'; @@ -375,6 +474,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? @@ -412,9 +513,18 @@ 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_locationnum = $old_cust_pkg ? $old_cust_pkg->locationnum : ''; + $old_custnum = $old_cust_pkg ? $old_cust_pkg->custnum : ''; + $new_pkgnum = $new_cust_pkg ? $new_cust_pkg->pkgnum : ''; + $new_locationnum = $new_cust_pkg ? $new_cust_pkg->locationnum : ''; + $new_custnum = $new_cust_pkg ? $new_cust_pkg->custnum : ''; + my $stdin_string = eval(qq("$stdin")); $new_first = shell_quote $new_first; @@ -422,30 +532,12 @@ 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, - command => $command_string, - stdin_string => $stdin_string, - ); - - 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. ')' - if $error; - } - else { - $self->shellcommands_queue( $new->svcnum, @ssh_cmd_args ); - } + ( $command_string, $stdin_string ); } #a good idea to queue anything that could fail or take any time @@ -459,8 +551,42 @@ sub shellcommands_queue { } sub ssh_cmd { #subroutine, not method - use Net::SSH '0.08'; - &Net::SSH::ssh_cmd( { @_ } ); + 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 || $ssh->error). "\n") if $errput || $ssh->error; + #die "$errput\n" if $errput; + + die "$output\n" if $output and $opt->{'fail_on_output'}; + ''; } #sub shellcommands_insert { #subroutine, not method @@ -470,5 +596,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;