export host selection per service, RT#17914
[freeside.git] / FS / FS / part_export / shellcommands.pm
index 418ff14..b9d6551 100644 (file)
@@ -78,10 +78,14 @@ tie my %options, 'Tie::IxHash',
              },
   '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',
@@ -93,12 +97,13 @@ tie my %options, 'Tie::IxHash',
 ;
 
 %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
@@ -120,24 +125,7 @@ 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";
@@ -353,19 +341,22 @@ sub _export_command {
   $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,
-    ignore_all_output => $self->option('ignore_all_output'),
     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;
   }
@@ -377,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';
   {
@@ -452,14 +444,16 @@ sub _export_replace {
     host          => $self->machine,
     command       => $command_string,
     stdin_string  => $stdin_string,
-    ignore_all_output => $self->option('ignore_all_output'),
-    ignored_errors => $self->option('ignored_errors') || '',
+    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;
   }
@@ -486,25 +480,33 @@ sub ssh_cmd { #subroutine, not method
     $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'};
+
+  return if $opt->{'ignore_all_errors'};
   die "Error running SSH command: ". $ssh->error if $ssh->error;
 
-  if ($errput && $opt->{'ignored_errors'} && length($opt->{'ignored_errors'})) {
+  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\n" if $errput;
+  die "$output\n" if $output and $opt->{'fail_on_output'};
   '';
 }
 
@@ -515,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;