Add more fine-grained queue options
[freeside.git] / FS / FS / part_export / shellcommands.pm
index 0545b5c..7baf2da 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,9 @@ tie my %options, 'Tie::IxHash',
                              'Radius group mapping to reason (via template user)',
                            type  => 'textarea',
                          },
+#  'no_queue' => { label => 'Run command immediately',
+#                   type  => 'checkbox',
+#                },
 ;
 
 %info = (
@@ -157,12 +175,13 @@ old_ for replace operations):
   <LI><code>$username</code>
   <LI><code>$_password</code>
   <LI><code>$quoted_password</code> - unencrypted password, already quoted for the shell (do not add additional quotes).
-  <LI><code>$crypt_password</code> - encrypted password.  When used on the command line (rather than STDIN), it will be already quoted for the shell (do not add additional quotes).
+  <LI><code>$crypt_password</code> - encrypted password.  When used on the command line (rather than STDIN), it will be quoted for the shell already (do not add additional quotes).
+  <LI><code>$ldap_password</code> - Password in LDAP/RFC2307 format (for example, "{PLAIN}himom", "{CRYPT}94pAVyK/4oIBk" or "{MD5}5426824942db4253f87a1009fd5d2d4").  When used on the command line (rather than STDIN), it will be quoted for the shell already (do not add additional quotes).
   <LI><code>$uid</code>
   <LI><code>$gid</code>
-  <LI><code>$finger</code> - GECOS.  When used on the command line (rather than STDIN), it will be already quoted for the shell (do not add additional quotes).
-  <LI><code>$first</code> - First name of GECOS.  When used on the command line (rather than STDIN), it will be already quoted for the shell (do not add additional quotes).
-  <LI><code>$last</code> - Last name of GECOS.  When used on the command line (rather than STDIN), it will be already quoted for the shell (do not add additional quotes).
+  <LI><code>$finger</code> - GECOS.  When used on the command line (rather than STDIN), it will be quoted for the shell already (do not add additional quotes).
+  <LI><code>$first</code> - First name of GECOS.  When used on the command line (rather than STDIN), it will be quoted for the shell already (do not add additional quotes).
+  <LI><code>$last</code> - Last name of GECOS.  When used on the command line (rather than STDIN), it will be quoted for the shell already (do not add additional quotes).
   <LI><code>$dir</code> - home directory
   <LI><code>$shell</code>
   <LI><code>$quota</code>
@@ -171,6 +190,8 @@ old_ for replace operations):
   <LI><code>$reasontext (when suspending)</code>
   <LI><code>$reasontypenum (when suspending)</code>
   <LI><code>$reasontypetext (when suspending)</code>
+  <LI><code>$pkgnum</code>
+  <LI><code>$custnum</code>
   <LI>All other fields in <a href="../docs/schema.html#svc_acct">svc_acct</a> are also available.
 </UL>
 END
@@ -249,11 +270,14 @@ sub _export_command {
   $quoted_password = shell_quote $_password;
 
   $crypt_password = $svc_acct->crypt_password( $self->option('crypt') );
+  $ldap_password  = $svc_acct->ldap_password(  $self->option('crypt') );
 
   @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;
@@ -291,15 +315,28 @@ sub _export_command {
   $last = shell_quote $last;
   $finger = shell_quote $finger;
   $crypt_password = shell_quote $crypt_password;
+  $ldap_password  = shell_quote $ldap_password;
+  $pkgnum = $cust_pkg ? $cust_pkg->pkgnum : '';
+  $custnum = $cust_pkg ? $cust_pkg->custnum : '';
 
   my $command_string = eval(qq("$command"));
-
-  $self->shellcommands_queue( $svc_acct->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,
   );
+
+  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 {
@@ -312,6 +349,8 @@ 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;
   $new_finger =~ /^(.*)\s+(\S+)$/ or $new_finger =~ /^((.*))$/;
   ($new_first, $new_last ) = ( $1, $2 );
   $quoted_new__password = shell_quote $new__password; #old, wrong?
@@ -320,6 +359,7 @@ sub _export_replace {
   $new_domain = $new->domain;
 
   $new_crypt_password = $new->crypt_password( $self->option('crypt') );
+  $new_ldap_password  = $new->ldap_password(  $self->option('crypt') );
 
   @old_radius_groups = $old->radius_groups;
   @new_radius_groups = $new->radius_groups;
@@ -356,16 +396,32 @@ sub _export_replace {
   $new_first = shell_quote $new_first;
   $new_last = shell_quote $new_last;
   $new_finger = shell_quote $new_finger;
-  $new_crypt_password = shell_quote $crypt_password;
+  $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 : '';
 
   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,
   );
+
+  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