X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fpart_export%2Fshellcommands.pm;h=7c280e5f8c2da55e1d08eacbb6a7c770e8a72bbc;hp=9408d1454fc2f0c709ea88f38afa857d36e2aa2e;hb=197f613bac6c3f9a4bd7d1ea5fbf4769aea4ce1a;hpb=ded0ab5cac02f099b387de360fb6dd6bd8cbb6b4 diff --git a/FS/FS/part_export/shellcommands.pm b/FS/FS/part_export/shellcommands.pm index 9408d1454..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,9 +80,25 @@ 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)', @@ -185,10 +209,29 @@ old_ for replace operations):
  • $reasontypenum (when suspending)
  • $reasontypetext (when suspending)
  • $pkgnum +
  • $locationnum
  • $custnum
  • 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). +For the package changed command only, the following fields are also available: + END ); @@ -202,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*$/ ) { @@ -229,14 +297,50 @@ 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'; @@ -315,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; @@ -340,28 +446,9 @@ sub _export_command { $locale = shell_quote $locale; my $command_string = eval(qq("$command")); + return "error filling in command: $@" if $@; - 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 ); - } + ( $command_string, $stdin_string ); } sub _export_replace { @@ -369,6 +456,16 @@ sub _export_replace { 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'; @@ -422,8 +519,10 @@ sub _export_replace { $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")); @@ -438,27 +537,7 @@ sub _export_replace { my $command_string = eval(qq("$command")); - my @ssh_cmd_args = ( - user => $self->option('user') || 'root', - 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 = $@; - $error = $error->full_message if ref $error; # Exception::Class::Base - return $error. ' ('. $self->exporttype. ' to '. $self->svc_machine($new). ')' - 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 @@ -472,7 +551,6 @@ sub shellcommands_queue { } sub ssh_cmd { #subroutine, not method - use Net::OpenSSH; my $opt = { @_ }; open my $def_in, '<', '/dev/null' or die "unable to open /dev/null\n"; my $ssh = Net::OpenSSH->new(