option for shellcommands to ignore errors, #15357
[freeside.git] / FS / FS / part_export / shellcommands.pm
index 29e0a57..418ff14 100644 (file)
@@ -14,6 +14,9 @@ tie my %options, 'Tie::IxHash',
                  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'
                },
+  'useradd_no_queue' => { label=>'Run immediately',
+                          type => 'checkbox',
+                        },
   'useradd_stdin' => { label=>'Insert command STDIN',
                        type =>'textarea',
                        default=>'',
@@ -22,6 +25,9 @@ tie my %options, 'Tie::IxHash',
                  default=>'userdel -r $username',
                  #default=>'rm -rf $dir',
                },
+  'userdel_no_queue' => { label=>'Run immediately',
+                          type =>'checkbox',
+                        },
   'userdel_stdin' => { label=>'Delete command STDIN',
                        type =>'textarea',
                        default=>'',
@@ -35,6 +41,9 @@ tie my %options, 'Tie::IxHash',
                  #  'rm -rf $old_dir'.
                  #')'
                },
+  'usermod_no_queue' => { label=>'Run immediately',
+                          type =>'checkbox',
+                        },
   'usermod_stdin' => { label=>'Modify command STDIN',
                        type =>'textarea',
                        default=>'',
@@ -48,12 +57,18 @@ tie my %options, 'Tie::IxHash',
   'suspend' => { label=>'Suspension command',
                  default=>'usermod -L $username',
                },
+  'suspend_no_queue' => { label=>'Run immediately',
+                          type =>'checkbox',
+                        },
   'suspend_stdin' => { label=>'Suspension command STDIN',
                        default=>'',
                      },
   'unsuspend' => { label=>'Unsuspension command',
                    default=>'usermod -U $username',
                  },
+  'unsuspend_no_queue' => { label=>'Run immediately',
+                            type =>'checkbox',
+                          },
   'unsuspend_stdin' => { label=>'Unsuspension command STDIN',
                          default=>'',
                        },
@@ -65,6 +80,16 @@ tie my %options, 'Tie::IxHash',
                              'Radius group mapping to reason (via template user)',
                            type  => 'textarea',
                          },
+  'ignore_all_output' => { 
+      label => 'Ignore all output and 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 = (
@@ -77,7 +102,7 @@ tie my %options, 'Tie::IxHash',
 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
-<a href="../docs/ssh.html">setup SSH for unattended operation</a>.
+<a href="http://www.freeside.biz/mediawiki/index.php/Freeside:1.9:Documentation:Administration:SSH_Keys">setup SSH for unattended operation</a>.
 
 <BR><BR>Use these buttons for some useful presets:
 <UL>
@@ -172,7 +197,10 @@ old_ for replace operations):
   <LI><code>$reasontext (when suspending)</code>
   <LI><code>$reasontypenum (when suspending)</code>
   <LI><code>$reasontypetext (when suspending)</code>
-  <LI>All other fields in <a href="../docs/schema.html#svc_acct">svc_acct</a> are also available.
+  <LI><code>$pkgnum</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>
 END
 );
@@ -238,6 +266,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 = '';
@@ -255,7 +293,9 @@ sub _export_command {
   @radius_groups = $svc_acct->radius_groups;
 
   my ($reasonnum, $reasontext, $reasontypenum, $reasontypetext);
-  if ( $cust_pkg && $action eq 'suspend' && (my $r = $cust_pkg->last_reason) ) {
+  if ( $cust_pkg && $action eq 'suspend' &&
+       (my $r = $cust_pkg->last_reason('susp')) )
+  {
     $reasonnum = $r->reasonnum;
     $reasontext = $r->reason;
     $reasontypenum = $r->reason_type;
@@ -287,6 +327,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;
@@ -295,14 +338,40 @@ sub _export_command {
   $crypt_password = shell_quote $crypt_password;
   $ldap_password  = shell_quote $ldap_password;
 
-  my $command_string = eval(qq("$command"));
+  $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;
 
-  $self->shellcommands_queue( $svc_acct->svcnum,
-    user         => $self->option('user')||'root',
-    host         => $self->machine,
-    command      => $command_string,
-    stdin_string => $stdin_string,
+  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($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 );
+  }
 }
 
 sub _export_replace {
@@ -315,6 +384,10 @@ sub _export_replace {
     ${"old_$_"} = $old->getfield($_) foreach $old->fields;
     ${"new_$_"} = $new->getfield($_) foreach $new->fields;
   }
+  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?
@@ -355,6 +428,13 @@ sub _export_replace {
   return $error. ' ('. $self->exporttype. ' to '. $self->machine. ')'
     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;
@@ -362,15 +442,30 @@ 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;
+  $new_agent_custid = shell_quote $new_agent_custid;
+  $new_locale = shell_quote $new_locale;
 
   my $command_string = eval(qq("$command"));
 
-  $self->shellcommands_queue( $new->svcnum,
-    user         => $self->option('user')||'root',
-    host         => $self->machine,
-    command      => $command_string,
-    stdin_string => $stdin_string,
+  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 );
+  }
 }
 
 #a good idea to queue anything that could fail or take any time
@@ -384,8 +479,33 @@ 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_output doesn't override this
+  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'})) {
+    my @ignored_errors = split('\n',$opt->{'ignored_errors'});
+    foreach my $ignored_error ( @ignored_errors ) {
+        $errput =~ s/$ignored_error//g;
+    }
+    chomp($errput);
+  }
+  die $errput if $errput;
+  die $output if $output;
+  '';
 }
 
 #sub shellcommands_insert { #subroutine, not method