X-Git-Url: http://git.freeside.biz/gitweb/?a=blobdiff_plain;f=FS%2FFS%2Fqueue.pm;h=1f2abe3ae4ef3e2b640ca04ce8c1fd0634f64731;hb=94a66b78bcda5605d7ee5eb7c3e692fb2fe5cf2c;hp=df92c5654f23b2f79584b3e18db3add21e42a62c;hpb=b26a63c1a75b80652506f39a99a6786193d956bf;p=freeside.git

diff --git a/FS/FS/queue.pm b/FS/FS/queue.pm
index df92c5654..1f2abe3ae 100644
--- a/FS/FS/queue.pm
+++ b/FS/FS/queue.pm
@@ -1,9 +1,11 @@
 package FS::queue;
 
 use strict;
-use vars qw( @ISA @EXPORT_OK $conf );
+use vars qw( @ISA @EXPORT_OK $DEBUG $conf $jobnums);
 use Exporter;
-use FS::UID;
+use MIME::Base64;
+use Storable qw( nfreeze thaw );
+use FS::UID qw(myconnect);
 use FS::Conf;
 use FS::Record qw( qsearch qsearchs dbh );
 #use FS::queue;
@@ -14,10 +16,14 @@ use FS::cust_svc;
 @ISA = qw(FS::Record);
 @EXPORT_OK = qw( joblisting );
 
+$DEBUG = 0;
+
 $FS::UID::callback{'FS::queue'} = sub {
   $conf = new FS::Conf;
 };
 
+$jobnums = '';
+
 =head1 NAME
 
 FS::queue - Object methods for queue records
@@ -44,17 +50,40 @@ FS::Record.  The following fields are currently supported:
 
 =over 4
 
-=item jobnum - primary key
+=item jobnum
+
+Primary key
+
+=item job
+
+Fully-qualified subroutine name
+
+=item status
+
+Job status (new, locked, or failed)
 
-=item job - fully-qualified subroutine name
+=item statustext
 
-=item status - job status
+Freeform text status message
 
-=item statustext - freeform text status message
+=item _date
 
-=item _date - UNIX timestamp
+UNIX timestamp
 
-=item svcnum - optional link to service (see L<FS::cust_svc>)
+=item svcnum
+
+Optional link to service (see L<FS::cust_svc>).
+
+=item custnum
+
+Optional link to customer (see L<FS::cust_main>).
+
+=item secure
+
+Secure flag, 'Y' indicates that when using encryption, the job needs to be
+run on a machine with the private key.
+
+=cut
 
 =back
 
@@ -64,7 +93,7 @@ FS::Record.  The following fields are currently supported:
 
 =item new HASHREF
 
-Creates a new job.  To add the example to the database, see L<"insert">.
+Creates a new job.  To add the job to the database, see L<"insert">.
 
 Note that this stores the hash reference, not a distinct copy of the hash it
 points to.  You can ask the object for a copy with the I<hash> method.
@@ -87,7 +116,7 @@ created (see L<FS::queue_arg>).
 
 #false laziness w/part_export.pm
 sub insert {
-  my $self = shift;
+  my( $self, @args ) = @_;
 
   local $SIG{HUP} = 'IGNORE';
   local $SIG{INT} = 'IGNORE';
@@ -100,16 +129,26 @@ sub insert {
   local $FS::UID::AutoCommit = 0;
   my $dbh = dbh;
 
+  my %args = ();
+  { 
+    no warnings "misc";
+    %args = @args;
+  }
+
+  $self->custnum( $args{'custnum'} ) if $args{'custnum'};
+
   my $error = $self->SUPER::insert;
   if ( $error ) {
     $dbh->rollback if $oldAutoCommit;
     return $error;
   }
 
-  foreach my $arg ( @_ ) {
+  foreach my $arg ( @args ) {
+    my $freeze = ref($arg) ? 'Y' : '';
     my $queue_arg = new FS::queue_arg ( {
       'jobnum' => $self->jobnum,
-      'arg'    => $arg,
+      'frozen' => $freeze,
+      'arg'    => $freeze ? encode_base64(nfreeze($arg)) : $arg,# always freeze?
     } );
     $error = $queue_arg->insert;
     if ( $error ) {
@@ -118,6 +157,11 @@ sub insert {
     }
   }
 
+  if ( $jobnums ) {
+    warn "jobnums global is active: $jobnums\n" if $DEBUG;
+    push @$jobnums, $self->jobnum;
+  }
+
   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 
   '';
@@ -192,7 +236,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;
@@ -203,7 +247,7 @@ sub check {
   $self->status('new') unless $self->status;
   $self->_date(time) unless $self->_date;
 
-  ''; #no error
+  $self->SUPER::check;
 }
 
 =item args
@@ -214,11 +258,12 @@ Returns a list of the arguments associated with this job.
 
 sub args {
   my $self = shift;
-  map $_->arg, qsearch( 'queue_arg',
-                        { 'jobnum' => $self->jobnum },
-                        '',
-                        'ORDER BY argnum'
-                      );
+  map { $_->frozen ? thaw(decode_base64($_->arg)) : $_->arg }
+    qsearch( 'queue_arg',
+             { 'jobnum' => $self->jobnum },
+             '',
+             'ORDER BY argnum'
+           );
 }
 
 =item cust_svc
@@ -235,6 +280,7 @@ sub cust_svc {
 =item queue_depend
 
 Returns the FS::queue_depend objects associated with this job, if any.
+(Dependancies that must complete before this job can be run).
 
 =cut
 
@@ -243,7 +289,6 @@ sub queue_depend {
   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
@@ -257,13 +302,78 @@ in a database transaction.
 
 sub depend_insert {
   my($self, $other_jobnum) = @_;
-  my $queue_depend = new FS::queue_depend (
+  my $queue_depend = new FS::queue_depend ( {
     'jobnum'        => $self->jobnum,
     'depend_jobnum' => $other_jobnum,
-  );
+  } );
   $queue_depend->insert;
 }
 
+=item queue_depended
+
+Returns the FS::queue_depend objects that associate other jobs with this job,
+if any.  (The jobs that are waiting for this job to complete before they can
+run).
+
+=cut
+
+sub queue_depended {
+  my $self = shift;
+  qsearch('queue_depend', { 'depend_jobnum' => $self->jobnum } );
+}
+
+=item depended_delete
+
+Deletes the other queued jobs (FS::queue objects) that are waiting for this
+job, if any.  If there is an error, returns the error, otherwise returns false.
+
+=cut
+
+sub depended_delete {
+  my $self = shift;
+  my $error;
+  foreach my $job (
+    map { qsearchs('queue', { 'jobnum' => $_->jobnum } ) } $self->queue_depended
+  ) {
+    $error = $job->depended_delete;
+    return $error if $error;
+    $error = $job->delete;
+    return $error if $error
+  }
+}
+
+=item update_statustext VALUE
+
+Updates the statustext value of this job to supplied value, in the database.
+If there is an error, returns the error, otherwise returns false.
+
+=cut
+
+use vars qw($_update_statustext_dbh);
+sub update_statustext {
+  my( $self, $statustext ) = @_;
+  return '' if $statustext eq $self->statustext;
+  warn "updating statustext for $self to $statustext" if $DEBUG;
+
+  $_update_statustext_dbh ||= myconnect;
+
+  my $sth = $_update_statustext_dbh->prepare(
+    'UPDATE queue set statustext = ? WHERE jobnum = ?'
+  ) or return $_update_statustext_dbh->errstr;
+
+  $sth->execute($statustext, $self->jobnum) or return $sth->errstr;
+  $_update_statustext_dbh->commit or die $_update_statustext_dbh->errstr;
+  $self->statustext($statustext);
+  '';
+
+  #my $new = new FS::queue { $self->hash };
+  #$new->statustext($statustext);
+  #my $error = $new->replace($self);
+  #return $error if $error;
+  #$self->statustext($statustext);
+  #'';
+}
+
 =back
 
 =head1 SUBROUTINES
@@ -278,6 +388,7 @@ sub joblisting {
   my($hashref, $noactions) = @_;
 
   use Date::Format;
+  use HTML::Entities;
   use FS::CGI;
 
   my @queue = qsearch( 'queue', $hashref );
@@ -308,7 +419,7 @@ END
 
     my $args;
     if ( $dangerous || $queue->job !~ /^FS::part_export::/ || !$noactions ) {
-      $args = join(' ', $queue->args);
+      $args = encode_entities( join(' ', $queue->args) );
     } else {
       $args = '';
     }
@@ -318,7 +429,7 @@ END
     $status .= ': '. $queue->statustext if $queue->statustext;
     my @queue_depend = $queue->queue_depend;
     $status .= ' (waiting for '.
-               join(', ', map { $_->other_jobnum } @queue_depend ). 
+               join(', ', map { $_->depend_jobnum } @queue_depend ). 
                ')'
       if @queue_depend;
     my $changable = $dangerous
@@ -376,12 +487,10 @@ END
 
 =back
 
-=head1 VERSION
-
-$Id: queue.pm,v 1.13 2002-05-15 14:00:32 ivan Exp $
-
 =head1 BUGS
 
+$jobnums global
+
 =head1 SEE ALSO
 
 L<FS::Record>, schema.html from the base documentation.