error messages can have other chars
[freeside.git] / FS / FS / queue.pm
index 5719eff..d35dc88 100644 (file)
@@ -1,13 +1,14 @@
 package FS::queue;
 
 use strict;
-use vars qw( @ISA @EXPORT_OK $conf );
+use vars qw( @ISA @EXPORT_OK $conf $jobnums);
 use Exporter;
 use FS::UID;
 use FS::Conf;
 use FS::Record qw( qsearch qsearchs dbh );
 #use FS::queue;
 use FS::queue_arg;
+use FS::queue_depend;
 use FS::cust_svc;
 
 @ISA = qw(FS::Record);
@@ -17,6 +18,8 @@ $FS::UID::callback{'FS::queue'} = sub {
   $conf = new FS::Conf;
 };
 
+$jobnums = '';
+
 =head1 NAME
 
 FS::queue - Object methods for queue records
@@ -117,6 +120,8 @@ sub insert {
     }
   }
 
+  push @$jobnums, $self->jobnum if $jobnums;
+
   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 
   '';
@@ -144,7 +149,8 @@ sub delete {
   local $FS::UID::AutoCommit = 0;
   my $dbh = dbh;
 
-  my @args = qsearch( 'queue_arg', { 'jobnum' => $self->jobnum } );
+  my @del = qsearch( 'queue_arg', { 'jobnum' => $self->jobnum } );
+  push @del, qsearch( 'queue_depend', { 'depend_jobnum' => $self->jobnum } );
 
   my $error = $self->SUPER::delete;
   if ( $error ) {
@@ -152,8 +158,8 @@ sub delete {
     return $error;
   }
 
-  foreach my $arg ( @args ) {
-    $error = $arg->delete;
+  foreach my $del ( @del ) {
+    $error = $del->delete;
     if ( $error ) {
       $dbh->rollback if $oldAutoCommit;
       return $error;
@@ -190,7 +196,7 @@ sub check {
     || $self->ut_anything('job')
     || $self->ut_numbern('_date')
     || $self->ut_enum('status',['', qw( new locked failed )])
-    || $self->ut_textn('statustext')
+    || $self->ut_anything('statustext')
     || $self->ut_numbern('svcnum')
   ;
   return $error if $error;
@@ -206,6 +212,8 @@ sub check {
 
 =item args
 
+Returns a list of the arguments associated with this job.
+
 =cut
 
 sub args {
@@ -228,6 +236,44 @@ sub cust_svc {
   qsearchs('cust_svc', { 'svcnum' => $self->svcnum } );
 }
 
+=item queue_depend
+
+Returns the FS::queue_depend objects associated with this job, if any.
+
+=cut
+
+sub queue_depend {
+  my $self = shift;
+  qsearch('queue_depend', { 'jobnum' => $self->jobnum } );
+}
+
+
+=item depend_insert OTHER_JOBNUM
+
+Inserts a dependancy for this job - it will not be run until the other job
+specified completes.  If there is an error, returns the error, otherwise
+returns false.
+
+When using job dependancies, you should wrap the insertion of all relevant jobs
+in a database transaction.  
+
+=cut
+
+sub depend_insert {
+  my($self, $other_jobnum) = @_;
+  my $queue_depend = new FS::queue_depend ( {
+    'jobnum'        => $self->jobnum,
+    'depend_jobnum' => $other_jobnum,
+  } );
+  $queue_depend->insert;
+}
+
+=back
+
+=head1 SUBROUTINES
+
+=over 4
+
 =item joblisting HASHREF NOACTIONS
 
 =cut
@@ -236,6 +282,7 @@ sub joblisting {
   my($hashref, $noactions) = @_;
 
   use Date::Format;
+  use HTML::Entities;
   use FS::CGI;
 
   my @queue = qsearch( 'queue', $hashref );
@@ -266,7 +313,9 @@ END
 
     my $args;
     if ( $dangerous || $queue->job !~ /^FS::part_export::/ || !$noactions ) {
-      $args = join(' ', $queue->args);
+      $args = encode_entities( join(' ',
+        map { length($_)<54 ? $_ : substr($_,0,32)."..."  } $queue->args #1&g
+      ) );
     } else {
       $args = '';
     }
@@ -274,6 +323,11 @@ END
     my $date = time2str( "%a %b %e %T %Y", $queue->_date );
     my $status = $queue->status;
     $status .= ': '. $queue->statustext if $queue->statustext;
+    my @queue_depend = $queue->queue_depend;
+    $status .= ' (waiting for '.
+               join(', ', map { $_->depend_jobnum } @queue_depend ). 
+               ')'
+      if @queue_depend;
     my $changable = $dangerous
          || ( ! $noactions && $status =~ /^failed/ || $status =~ /^locked/ );
     if ( $changable ) {
@@ -331,10 +385,12 @@ END
 
 =head1 VERSION
 
-$Id: queue.pm,v 1.11 2002-04-13 08:51:54 ivan Exp $
+$Id: queue.pm,v 1.15 2002-07-02 06:48:59 ivan Exp $
 
 =head1 BUGS
 
+$jobnums global
+
 =head1 SEE ALSO
 
 L<FS::Record>, schema.html from the base documentation.