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'
type =>'textarea',
default=>'',
},
+
'userdel' => { label=>'Delete command',
default=>'userdel -r $username',
#default=>'rm -rf $dir',
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 || ( '.
'usermod_nousername' => { label=>'Disallow just username changes',
type =>'checkbox',
},
+
'suspend' => { label=>'Suspension command',
default=>'usermod -L $username',
},
'suspend_stdin' => { label=>'Suspension command STDIN',
default=>'',
},
+
'unsuspend' => { label=>'Unsuspension command',
default=>'usermod -U $username',
},
'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',
- },
- 'ignore_all_output' => {
- label => 'Ignore all output and errors from the command',
+ 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',
;
%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
this.form.unsuspend_stdin.value="";
'>
<LI>
- <INPUT TYPE="button" VALUE="FreeBSD before 4.10 / 5.3" onClick='
- this.form.useradd.value = "lockf /etc/passwd.lock pw useradd $username -d $dir -m -s $shell -u $uid -c $finger -h 0";
- this.form.useradd_stdin.value = "$_password\n";
- this.form.userdel.value = "lockf /etc/passwd.lock pw userdel $username -r"; this.form.userdel_stdin.value="";
- this.form.usermod.value = "lockf /etc/passwd.lock pw usermod $old_username -d $new_dir -m -l $new_username -s $new_shell -u $new_uid -g $new_gid -c $new_finger -h 0";
- this.form.usermod_stdin.value = "$new__password\n"; this.form.suspend.value = "lockf /etc/passwd.lock pw lock $username";
- this.form.suspend_stdin.value="";
- this.form.unsuspend.value = "lockf /etc/passwd.lock pw unlock $username"; 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
- <A HREF="http://www.freebsd.org/cgi/query-pr.cgi?pr=23501">FreeBSD PR#23501</A>
- and use the "FreeBSD 4.10 / 5.3 or later" button below.
- <LI>
- <INPUT TYPE="button" VALUE="FreeBSD 4.10 / 5.3 or later" onClick='
+ <INPUT TYPE="button" VALUE="FreeBSD" onClick='
this.form.useradd.value = "pw useradd $username -d $dir -m -s $shell -u $uid -g $gid -c $finger -h 0";
this.form.useradd_stdin.value = "$_password\n";
this.form.userdel.value = "pw userdel $username -r";
<LI><code>$reasontypenum (when suspending)</code>
<LI><code>$reasontypetext (when suspending)</code>
<LI><code>$pkgnum</code>
+ <LI><code>$locationnum</code>
<LI><code>$custnum</code>
<LI>All other fields in <b>svc_acct</b> are also available.
<LI>The following fields from <b>cust_main</b> 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).
</UL>
+For the package changed command only, the following fields are also available:
+<UL>
+ <LI>$old_pkgnum and $new_pkgnum
+ <LI>$old_pkgpart and $new_pkgpart
+ <LI>$old_agent_pkgid and $new_agent_pkgid
+ <LI>$old_order_date and $new_order_date
+ <LI>$old_start_date and $new_start_date
+ <LI>$old_setup and $new_setup
+ <LI>$old_bill and $new_bill
+ <LI>$old_last_bill and $new_last_bill
+ <LI>$old_susp and $new_susp
+ <LI>$old_adjourn and $new_adjourn
+ <LI>$old_resume and $new_resume
+ <LI>$old_cancel and $new_cancel
+ <LI>$old_unancel and $new_unancel
+ <LI>$old_expire and $new_expire
+ <LI>$old_contract_end and $new_contract_end
+</UL>
END
);
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*$/ ) {
} 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;
}
$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;
$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->machine,
- command => $command_string,
- stdin_string => $stdin_string,
- ignore_all_output => $self->option('ignore_all_output'),
- ignored_errors => $self->option('ignored_errors') || '',
- );
-
- 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 $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';
# $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"));
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,
- ignore_all_output => $self->option('ignore_all_output'),
- ignored_errors => $self->option('ignored_errors') || '',
- );
-
- 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
}
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(
$opt->{'user'}.'@'.$opt->{'host'},
'default_stdin_fh' => $def_in
);
- # ignore_all_output doesn't override this
+ # 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_output'};
- die "Error running SSH command: ". $ssh->error if $ssh->error;
- if ($errput && $opt->{'ignored_errors'} && length($opt->{'ignored_errors'})) {
+ 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;
}
- chomp($errput);
+ $output =~ s/[\s\n]//g;
+ $errput =~ s/[\s\n]//g;
}
- die $errput if $errput;
- die $output if $output;
+
+ 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_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;
projects / freeside.git / blobdiff