use Net::SSH::ssh_cmd for all job queueing rather than local duplicated ssh subs

queue daemon updates: retry & remove links work, bubble up error message
to webinterface, link to svcnum & have job listings on view/svc_* pages,
closes: Bug#280

s/option/optionname/ schema change, dumb mysql, closes: Bug#334

6 files changed, 183 insertions, 82 deletions

diff --git a/FS/FS/CGI.pm b/FS/FS/CGI.pm
index 35d2e28..ee59b25 100644
--- a/FS/FS/CGI.pm
+++ b/FS/FS/CGI.pm
@@ -5,7 +5,7 @@ use vars qw(@EXPORT_OK @ISA @header);
 use Exporter;
 use CGI;
 use URI::URL;
-use CGI::Carp qw(fatalsToBrowser);
+#use CGI::Carp qw(fatalsToBrowser);
 use FS::UID;
 
 @ISA = qw(Exporter);
@@ -45,7 +45,7 @@ Returns an HTML header.
 
 sub header {
   my($title,$menubar,$etc)=@_; #$etc is for things like onLoad= etc.
-  use Carp;
+  #use Carp;
   $etc = '' unless defined $etc;
 
   my $x =  <<END;
diff --git a/FS/FS/Record.pm b/FS/FS/Record.pm
index 755cef8..020d14d 100644
--- a/FS/FS/Record.pm
+++ b/FS/FS/Record.pm
@@ -59,13 +59,13 @@ FS::Record - Database record objects
     $hashref = $record->hashref;
 
     $error = $record->insert;
-    #$error = $record->add; #depriciated
+    #$error = $record->add; #deprecated
 
     $error = $record->delete;
-    #$error = $record->del; #depriciated
+    #$error = $record->del; #deprecated
 
     $error = $new_record->replace($old_record);
-    #$error = $new_record->rep($old_record); #depriciated
+    #$error = $new_record->rep($old_record); #deprecated
 
     $value = $record->unique('column');
 
@@ -974,6 +974,34 @@ sub ut_enum {
   return "Illegal (enum) field $field: ". $self->getfield($field);
 }
 
+=item ut_foreign_key COLUMN FOREIGN_TABLE FOREIGN_COLUMN
+
+Check/untaint a foreign column key.  Call a regular ut_ method (like ut_number)
+on the column first.
+
+=cut
+
+sub ut_foreign_key {
+  my( $self, $field, $table, $foreign ) = @_;
+  qsearchs($table, { $foreign => $self->getfield($field) })
+    or return "Can't find $field ". $self->getfield($field).
+              " in $table.$foreign";
+  '';
+}
+
+=item ut_foreign_keyn COLUMN FOREIGN_TABLE FOREIGN_COLUMN
+
+Like ut_foreign_key, except the null value is also allowed.
+
+=cut
+
+sub ut_foreign_keyn {
+  my( $self, $field, $table, $foreign ) = @_;
+  $self->getfield($field)
+    ? $self->ut_foreign_key($field, $table, $foreign)
+    : '';
+}
+
 =item fields [ TABLE ]
 
 This can be used as both a subroutine and a method call.  It returns a list
diff --git a/FS/FS/queue.pm b/FS/FS/queue.pm
index 0967248..83ae171 100644
--- a/FS/FS/queue.pm
+++ b/FS/FS/queue.pm
@@ -1,11 +1,15 @@
 package FS::queue;
 
 use strict;
-use vars qw( @ISA );
+use vars qw( @ISA @EXPORT_OK );
+use Exporter;
 use FS::Record qw( qsearch qsearchs dbh );
+#use FS::queue;
 use FS::queue_arg;
+use FS::cust_svc;
 
 @ISA = qw(FS::Record);
+@EXPORT_OK = qw( joblisting );
 
 =head1 NAME
 
@@ -39,6 +43,12 @@ FS::Record.  The following fields are currently supported:
 
 =item status - job status
 
+=item statustext - freeform text status message
+
+=item _date - UNIX timestamp
+
+=item svcnum - optional link to service (see L<FS::cust_svc>)
+
 =back
 
 =head1 METHODS
@@ -173,6 +183,9 @@ sub check {
     || $self->ut_anything('job')
     || $self->ut_numbern('_date')
     || $self->ut_enum('status',['', qw( new locked failed )])
+    || $self->ut_textn('statustext')
+    || $self->ut_numbern('svcnum')
+    || $self->ut_foreign_keyn('svcnum', 'cust_svc', 'svcnum')
   ;
   return $error if $error;
 
@@ -195,11 +208,86 @@ sub args {
                       );
 }
 
+=item cust_svc
+
+Returns the FS::cust_svc object associated with this job, if any.
+
+=cut
+
+sub cust_svc {
+  my $self = shift;
+  qsearchs('cust_svc', { 'svcnum' => $self->svcnum } );
+}
+
+=item joblisting HASHREF
+
+=cut
+
+sub joblisting {
+  my($hashref, $noactions) = @_;
+
+  use Date::Format;
+  use FS::CGI;
+
+  my $html = FS::CGI::table(). <<END;
+      <TR>
+        <TH COLSPAN=2>Job</TH>
+        <TH>Args</TH>
+        <TH>Date</TH>
+        <TH>Status</TH>
+        <TH>Account</TH>
+      </TR>
+END
+
+  my $p = FS::CGI::popurl(2);
+  foreach my $queue ( sort { 
+    $a->getfield('jobnum') <=> $b->getfield('jobnum')
+  } qsearch( 'queue', $hashref ) ) {
+    my $hashref = $queue->hashref;
+    my $jobnum = $queue->jobnum;
+    my $args = join(' ', $queue->args);
+    my $date = time2str( "%a %b %e %T %Y", $queue->_date );
+    my $status = $queue->status;
+    $status .= ': '. $queue->statustext if $queue->statustext;
+    if ( ! $noactions && $status =~ /^failed/ || $status =~ /^locked/ ) {
+      $status .=
+        qq! ( <A HREF="$p/misc/queue.cgi?jobnum=$jobnum&action=new">retry</A> |!.
+        qq! <A HREF="$p/misc/queue.cgi?jobnum=$jobnum&action=del">remove </A> )!;
+    }
+    my $cust_svc = $queue->cust_svc;
+    my $account;
+    if ( $cust_svc ) {
+      my $table = $cust_svc->part_svc->svcdb;
+      my $label = ( $cust_svc->label )[1];
+      $account = qq!<A HREF="../view/$table.cgi?!. $queue->svcnum.
+                 qq!">$label</A>!;
+    } else {
+      $account = '';
+    }
+    $html .= <<END;
+      <TR>
+        <TD>$jobnum</TD>
+        <TD>$hashref->{job}</TD>
+        <TD>$args</TD>
+        <TD>$date</TD>
+        <TD>$status</TD>
+        <TD>$account</TD>
+      </TR>
+END
+
+}
+
+  $html .= '</TABLE>';
+
+  $html;
+
+}
+
 =back
 
 =head1 VERSION
 
-$Id: queue.pm,v 1.3 2001-09-11 12:25:55 ivan Exp $
+$Id: queue.pm,v 1.4 2002-02-20 01:03:09 ivan Exp $
 
 =head1 BUGS
 
diff --git a/FS/FS/svc_acct.pm b/FS/FS/svc_acct.pm
index 65a58fc..2f327a3 100644
--- a/FS/FS/svc_acct.pm
+++ b/FS/FS/svc_acct.pm
@@ -281,7 +281,10 @@ sub insert {
     $self->shell,
   );
   if ( $username && $uid && $dir && $shellmachine && ! $nossh_hack ) {
-    my $queue = new FS::queue { 'job' => 'FS::svc_acct::ssh' };
+    my $queue = new FS::queue {
+      'svcnum' => $self->svcnum,
+      'job' => 'Net::SSH::ssh_cmd',
+    };
     $error = $queue->insert("root\@$shellmachine", eval qq("$useradd") );
     if ( $error ) {
       $dbh->rollback if $oldAutoCommit;
@@ -290,7 +293,10 @@ sub insert {
   }
 
   if ( $cyrus_server ) {
-    my $queue = new FS::queue { 'job' => 'FS::svc_acct::cyrus_insert' };
+    my $queue = new FS::queue {
+      'svcnum' => $self->svcnum,
+      'job'    => 'FS::svc_acct::cyrus_insert',
+    };
     $error = $queue->insert($self->username, $self->quota);
     if ( $error ) {
       $dbh->rollback if $oldAutoCommit;
@@ -299,7 +305,10 @@ sub insert {
   }
 
   if ( $cp_server ) {
-    my $queue = new FS::queue { 'job' => 'FS::svc_acct::cp_insert' };
+    my $queue = new FS::queue {
+      'svcnum' => $self->svcnum,
+      'job'    => 'FS::svc_acct::cp_insert'
+    };
     $error = $queue->insert($self->username, $self->_password);
     if ( $error ) {
       $dbh->rollback if $oldAutoCommit;
@@ -310,7 +319,10 @@ sub insert {
   if ( $icradius_dbh ) {
 
     my $radcheck_queue =
-      new FS::queue { 'job' => 'FS::svc_acct::icradius_rc_insert' };
+      new FS::queue {
+      'svcnum' => $self->svcnum,
+      'job' => 'FS::svc_acct::icradius_rc_insert'
+    };
     $error = $radcheck_queue->insert( $self->username,
                                       $self->_password,
                                       $self->radius_check
@@ -321,7 +333,10 @@ sub insert {
     }
 
     my $radreply_queue =
-      new FS::queue { 'job' => 'FS::svc_acct::icradius_rr_insert' };
+      new FS::queue { 
+      'svcnum' => $self->svcnum,
+      'job' => 'FS::svc_acct::icradius_rr_insert'
+    };
     $error = $radreply_queue->insert( $self->username,
                                       $self->_password,
                                       $self->radius_reply
@@ -542,7 +557,7 @@ sub delete {
     $self->dir,
   );
   if ( $username && $shellmachine && ! $nossh_hack ) {
-    my $queue = new FS::queue { 'job' => 'FS::svc_acct::ssh' };
+    my $queue = new FS::queue { 'job' => 'Net::SSH::ssh_cmd' };
     $error = $queue->insert("root\@$shellmachine", eval qq("$userdel") );
     if ( $error ) {
       $dbh->rollback if $oldAutoCommit;
@@ -728,7 +743,10 @@ sub replace {
     $new->getfield('gid'),
   );
   if ( $old_dir && $new_dir && $old_dir ne $new_dir && ! $nossh_hack ) {
-    my $queue = new FS::queue { 'job' => 'FS::svc_acct::ssh' };
+    my $queue = new FS::queue { 
+      'svcnum' => $new->svcnum,
+      'job' => 'Net::SSH::ssh_cmd'
+    };
     $error = $queue->insert("root\@$shellmachine", eval qq("$usermod") );
     if ( $error ) {
       $dbh->rollback if $oldAutoCommit;
@@ -737,7 +755,10 @@ sub replace {
   }
 
   if ( $cp_server && $old->username ne $new->username ) {
-    my $queue = new FS::queue { 'job' => 'FS::svc_acct::cp_rename' };
+    my $queue = new FS::queue { 
+      'svcnum' => $new->svcnum,
+      'job' => 'FS::svc_acct::cp_rename'
+    };
     $error = $queue->insert( $old->username, $new->username );
     if ( $error ) {
       $dbh->rollback if $oldAutoCommit;
@@ -746,7 +767,10 @@ sub replace {
   }
 
   if ( $cp_server && $old->_password ne $new->_password ) {
-    my $queue = new FS::queue { 'job' => 'FS::svc_acct::cp_change' };
+    my $queue = new FS::queue {  
+      'svcnum' => $new->svcnum,
+      'job' => 'FS::svc_acct::cp_change'
+    };
     $error = $queue->insert( $new->username, $new->_password );
     if ( $error ) {
       $dbh->rollback if $oldAutoCommit;
@@ -755,7 +779,10 @@ sub replace {
   }
 
   if ( $icradius_dbh ) {
-    my $queue = new FS::queue { 'job' => 'FS::svc_acct::icradius_rc_replace' };
+    my $queue = new FS::queue {  
+      'svcnum' => $new->svcnum,
+      'job' => 'FS::svc_acct::icradius_rc_replace'
+    };
     $error = $queue->insert( $new->username,
                              $new->_password,
                            );
@@ -1164,34 +1191,6 @@ sub seconds_since {
   $self->cust_svc->seconds_since(@_);
 }
 
-=item ssh
-
-=cut
-
-sub ssh {
-  my ( $host, @cmd_and_args ) = @_;
-
-  use IO::File;
-  my $reader = IO::File->new();
-  my $writer = IO::File->new();
-  my $error = IO::File->new();
-
-  &Net::SSH::sshopen3( $host, $reader, $writer, $error, @cmd_and_args) or die $!;
-
-  local $/ = undef;
-  my $output_stream = <$writer>;
-  my $error_stream = <$error>;
-  if ( length $error_stream ) {
-    #warn "[FS::svc_acct::ssh] STDERR $error_stream";
-    die "[FS::svc_acct::ssh] STDERR $error_stream";
-  }
-  if ( length $output_stream ) {
-    warn "[FS::svc_acct::ssh] STDOUT $output_stream";
-  }
-
-#  &Net::SSH::ssh(@args,">>/usr/local/etc/freeside/sshoutput 2>&1");
-}
-
 =back
 
 =head1 BUGS
diff --git a/FS/FS/svc_domain.pm b/FS/FS/svc_domain.pm
index d0f0e11..84a1029 100644
--- a/FS/FS/svc_domain.pm
+++ b/FS/FS/svc_domain.pm
@@ -241,7 +241,10 @@ sub insert {
         $svc_acct->dir,
       );
   
-    my $queue = new FS::queue { 'job' => 'FS::svc_domain::ssh' };
+    my $queue = new FS::queue {
+      'svcnum' => $self->svcnum,
+      'job'    => 'Net::SSH::ssh_cmd',
+    };
     $error = $queue->insert("root\@$qshellmachine", "[ -e $dir/.qmail-$qdomain-default ] || { touch $dir/.qmail-$qdomain-default; chown $uid:$gid $dir/.qmail-$qdomain-default; }" );
 
     }
@@ -250,36 +253,6 @@ sub insert {
   ''; #no error
 }
 
-=item ssh
-
-=cut
-
-#false laziness with FS::svc_acct::ssh
-sub ssh {
-  my ( $host, @cmd_and_args ) = @_;
-
-  use IO::File;
-  my $reader = IO::File->new();
-  my $writer = IO::File->new();
-  my $error = IO::File->new();
-
-  &Net::SSH::sshopen3( $host, $reader, $writer, $error, @cmd_and_args) or die $!;
-
-  local $/ = undef;
-  my $output_stream = <$writer>;
-  my $error_stream = <$error>;
-  if ( length $error_stream ) {
-    #warn "[FS::svc_acct::ssh] STDERR $error_stream";
-    die "[FS::svc_domain::ssh] STDERR $error_stream";
-  }
-  if ( length $output_stream ) {
-    warn "[FS::svc_domain::ssh] STDOUT $output_stream";
-  }
-
-#  &Net::SSH::ssh(@args,">>/usr/local/etc/freeside/sshoutput 2>&1");
-}
-
-
 =item delete
 
 Deletes this domain from the database.  If there is an error, returns the
@@ -451,7 +424,7 @@ sub submit_internic {
 
 =head1 VERSION
 
-$Id: svc_domain.pm,v 1.23 2002-02-09 18:09:30 ivan Exp $
+$Id: svc_domain.pm,v 1.24 2002-02-20 01:03:09 ivan Exp $
 
 =head1 BUGS
 
diff --git a/FS/FS/svc_forward.pm b/FS/FS/svc_forward.pm
index 7e0a4fd..12f8b92 100644
--- a/FS/FS/svc_forward.pm
+++ b/FS/FS/svc_forward.pm
@@ -140,7 +140,11 @@ sub insert {
     
   foreach my $vpopmailmachine ( @vpopmailmachines ) {
     my($machine, $vpopdir, $vpopuid, $vpopgid) = split(/\s+/, $vpopmailmachine);
-    my $queue = new FS::queue { 'job' => 'Net::SSH::ssh_cmd' };  # should be neater
+    my $queue = new FS::queue {
+      'svcnum' => $self->svcnum,
+      'job'    => 'Net::SSH::ssh_cmd',
+    };
+    # should be neater
     my $error = $queue->insert("root\@$machine","[ -d $vpopdir/domains/$domain/$username ] && { echo \"$destination\" >> $vpopdir/domains/$domain/$username/.qmail; chown $vpopuid:$vpopgid $vpopdir/domains/$domain/$username/.qmail; }") 
       unless $nossh_hack;
     if ( $error ) {
@@ -209,7 +213,8 @@ sub delete {
   foreach my $vpopmailmachine ( @vpopmailmachines ) {
     my($machine, $vpopdir, $vpopuid, $vpopgid) =
       split(/\s+/, $vpopmailmachine);
-    my $queue = new FS::queue { 'job' => 'Net::SSH::ssh_cmd' };  # should be neater
+    my $queue = new FS::queue { 'job' => 'Net::SSH::ssh_cmd' };
+    # should be neater
     my $error = $queue->insert("root\@$machine",
       "sed -e '/^$destination/d' " .
         "< $vpopdir/domains/$domain/$username/.qmail" .
@@ -302,7 +307,11 @@ sub replace {
   foreach my $vpopmailmachine ( @vpopmailmachines ) {
     my($machine, $vpopdir, $vpopuid, $vpopgid) =
       split(/\s+/, $vpopmailmachine);
-    my $queue = new FS::queue { 'job' => 'Net::SSH::ssh_cmd' };  # should be neater
+    my $queue = new FS::queue {
+      'svcnum' => $new->svcnum,
+      'job'    => 'Net::SSH::ssh_cmd',
+    };
+    # should be neater
     my $error = $queue->insert("root\@$machine",
       "sed -e '/^$destination/d' " .
         "< $vpopdir/domains/$old_domain/$old_username/.qmail" .
@@ -332,7 +341,11 @@ sub replace {
   
   foreach my $vpopmailmachine ( @vpopmailmachines ) {
     my($machine, $vpopdir, $vpopuid, $vpopgid) = split(/\s+/, $vpopmailmachine);
-    my $queue = new FS::queue { 'job' => 'Net::SSH::ssh_cmd' };  # should be neater
+    my $queue = new FS::queue {
+      'svcnum' => $new->svcnum,
+      'job'    => 'Net::SSH::ssh_cmd',
+    };
+    # should be neater
     my $error = $queue->insert("root\@$machine","[ -d $vpopdir/domains/$domain/$username ] && { echo \"$destination\" >> $vpopdir/domains/$domain/$username/.qmail; chown $vpopuid:$vpopgid $vpopdir/domains/$domain/$username/.qmail; }") 
       unless $nossh_hack;
     if ( $error ) {
@@ -439,7 +452,7 @@ sub dstsvc_acct {
 
 =head1 VERSION
 
-$Id: svc_forward.pm,v 1.10 2002-02-17 19:07:32 jeff Exp $
+$Id: svc_forward.pm,v 1.11 2002-02-20 01:03:09 ivan Exp $
 
 =head1 BUGS