X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fqueue.pm;h=a0654a13c94ebc55a705c31cb6a88ecba13e26e7;hp=69dc71a0bcf6bbfdccadb8ad995711d9714b730c;hb=57bb423fe457ba4e13726877f53bcdf944f828f8;hpb=dbb26e8eeae5866a4bb48f170229d019e32affef

diff --git a/FS/FS/queue.pm b/FS/FS/queue.pm
index 69dc71a0b..a0654a13c 100644
--- a/FS/FS/queue.pm
+++ b/FS/FS/queue.pm
@@ -1,16 +1,29 @@
 package FS::queue;
+use base qw(FS::Record);
 
 use strict;
-use vars qw( @ISA @EXPORT_OK );
+use vars qw( @EXPORT_OK $DEBUG $conf $jobnums);
 use Exporter;
+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;
 use FS::queue_arg;
-use FS::cust_svc;
+use FS::queue_depend;
+use FS::CGI qw(rooturl);
 
-@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
@@ -37,17 +50,58 @@ 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
+
+Freeform text status message
+
+=cut
+
+sub statustext {
+  my $self = shift;
+  if ( defined ( $_[0] ) ) {
+    $self->SUPER::statustext(@_);
+  } else {
+    my $value = $self->SUPER::statustext();
+    my $rooturl = rooturl();
+    $value =~ s/%%%ROOTURL%%%/$rooturl/g; 
+    $value;
+  }
+}
 
-=item status - job status
+=item _date
 
-=item statustext - freeform text status message
+UNIX timestamp
 
-=item _date - UNIX timestamp
+=item svcnum
 
-=item svcnum - optional link to service (see L<FS::cust_svc>)
+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.
+
+=item usernum
+
+For access_user that created the job
+
+=cut
 
 =back
 
@@ -57,7 +111,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.
@@ -78,8 +132,9 @@ created (see L<FS::queue_arg>).
 
 =cut
 
+#false laziness w/part_export.pm
 sub insert {
-  my $self = shift;
+  my( $self, @args ) = @_;
 
   local $SIG{HUP} = 'IGNORE';
   local $SIG{INT} = 'IGNORE';
@@ -92,16 +147,28 @@ sub insert {
   local $FS::UID::AutoCommit = 0;
   my $dbh = dbh;
 
+  my %args = ();
+  { 
+    no warnings "misc";
+    %args = @args;
+  }
+
+  $self->custnum( $args{'custnum'} ) if $args{'custnum'};
+
+  $self->usernum($FS::CurrentUser::CurrentUser->usernum) unless $self->usernum;
+
   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 ) {
@@ -110,6 +177,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;
 
   '';
@@ -126,35 +198,37 @@ deleted as well
 sub delete {
   my $self = shift;
 
-  local $SIG{HUP} = 'IGNORE';
-  local $SIG{INT} = 'IGNORE';
-  local $SIG{QUIT} = 'IGNORE';
-  local $SIG{TERM} = 'IGNORE';
-  local $SIG{TSTP} = 'IGNORE';
-  local $SIG{PIPE} = 'IGNORE';
+  my $reportname = '';
+  if ( $self->status =~/^done/ ) {
+    my $dropstring = rooturl(). '/misc/queued_report\?report=';
+    if ($self->statustext =~ /.*$dropstring([.\w]+)\>/) {
+      $reportname = "$FS::UID::cache_dir/cache.$FS::UID::datasrc/report.$1";
+    }
+  }
 
   my $oldAutoCommit = $FS::UID::AutoCommit;
   local $FS::UID::AutoCommit = 0;
   my $dbh = dbh;
 
-  my @args = qsearch( 'queue_arg', { 'jobnum' => $self->jobnum } );
-
-  my $error = $self->SUPER::delete;
-  if ( $error ) {
-    $dbh->rollback if $oldAutoCommit;
-    return $error;
-  }
-
-  foreach my $arg ( @args ) {
-    $error = $arg->delete;
+  foreach my $cust_pay_pending (qsearch('cust_pay_pending',{ jobnum => $self->jobnum })) {
+    $cust_pay_pending->set('jobnum','');
+    my $error = $cust_pay_pending->replace();
     if ( $error ) {
       $dbh->rollback if $oldAutoCommit;
       return $error;
     }
   }
 
+  my $error = $self->SUPER::delete;
+  if ( $error ) {
+    $dbh->rollback if $oldAutoCommit;
+    return $error;
+  }
+  
   $dbh->commit or die $dbh->errstr if $oldAutoCommit;
 
+  unlink $reportname if $reportname;
+
   '';
 
 }
@@ -182,9 +256,10 @@ sub check {
     $self->ut_numbern('jobnum')
     || $self->ut_anything('job')
     || $self->ut_numbern('_date')
-    || $self->ut_enum('status',['', qw( new locked failed )])
-    || $self->ut_textn('statustext')
+    || $self->ut_enum('status',['', qw( new locked failed done )])
+    || $self->ut_anything('statustext')
     || $self->ut_numbern('svcnum')
+    || $self->ut_foreign_keyn('usernum', 'access_user', 'usernum')
   ;
   return $error if $error;
 
@@ -194,34 +269,141 @@ sub check {
   $self->status('new') unless $self->status;
   $self->_date(time) unless $self->_date;
 
-  ''; #no error
+  $self->SUPER::check;
 }
 
 =item args
 
+Returns a list of the arguments associated with this job.
+
 =cut
 
 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
 
 Returns the FS::cust_svc object associated with this job, if any.
 
+=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).
+
+=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;
+}
+
+=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 cust_svc {
+sub queue_depended {
   my $self = shift;
-  qsearchs('cust_svc', { 'svcnum' => $self->svcnum } );
+  qsearch('queue_depend', { 'depend_jobnum' => $self->jobnum } );
 }
 
-=item joblisting HASHREF
+=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->get('statustext'); #avoid rooturl expansion
+  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->set('statustext', $statustext); #avoid rooturl expansion
+  '';
+
+  #my $new = new FS::queue { $self->hash };
+  #$new->statustext($statustext);
+  #my $error = $new->replace($self);
+  #return $error if $error;
+  #$self->statustext($statustext);
+  #'';
+}
+
+# not needed in 4
+#=item access_user
+#
+#Returns FS::access_user object (if any) associated with this user.
+#
+#Returns nothing if not found.
+#
+#=cut
+#
+#sub access_user {
+#  my $self = shift;
+#  my $usernum = $self->usernum || return ();
+#  return qsearchs('access_user',{ 'usernum' => $usernum }) || ();
+#}
+
+=back
+
+=head1 SUBROUTINES
+
+=over 4
+
+=item joblisting HASHREF NOACTIONS
 
 =cut
 
@@ -229,70 +411,109 @@ sub joblisting {
   my($hashref, $noactions) = @_;
 
   use Date::Format;
+  use HTML::Entities;
   use FS::CGI;
 
-  my $html = FS::CGI::table(). <<END;
+  my @queue = qsearch( 'queue', $hashref );
+  return '' unless scalar(@queue);
+
+  my $p = FS::CGI::popurl(2);
+
+  my $html = qq!<FORM ACTION="$p/misc/queue.cgi" METHOD="POST">!.
+             FS::CGI::table(). <<END;
       <TR>
         <TH COLSPAN=2>Job</TH>
         <TH>Args</TH>
         <TH>Date</TH>
         <TH>Status</TH>
-        <TH>Account</TH>
-      </TR>
 END
+  $html .= '<TH>Account</TH>' unless $hashref->{svcnum};
+  $html .= '</TR>';
+
+  my $dangerous = $conf->exists('queue_dangerous_controls');
+
+  my $areboxes = 0;
 
-  my $p = FS::CGI::popurl(2);
   foreach my $queue ( sort { 
     $a->getfield('jobnum') <=> $b->getfield('jobnum')
-  } qsearch( 'queue', $hashref ) ) {
-    my $hashref = $queue->hashref;
+  } @queue ) {
+    my $queue_hashref = $queue->hashref;
     my $jobnum = $queue->jobnum;
-    my $args = join(' ', $queue->args);
+
+    my $args;
+    if ( $dangerous || $queue->job !~ /^FS::part_export::/ || !$noactions ) {
+      $args = encode_entities( join(' ', $queue->args) );
+    } else {
+      $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/ ) {
+    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 ) {
       $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> )!;
+        qq! (&nbsp;<A HREF="$p/misc/queue.cgi?jobnum=$jobnum&action=new">retry</A>&nbsp;|!.
+        qq!&nbsp;<A HREF="$p/misc/queue.cgi?jobnum=$jobnum&action=del">remove</A>&nbsp;)!;
     }
     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>$queue_hashref->{job}</TD>
         <TD>$args</TD>
         <TD>$date</TD>
         <TD>$status</TD>
-        <TD>$account</TD>
-      </TR>
 END
 
+    unless ( $hashref->{svcnum} ) {
+      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 .= "<TD>$account</TD>";
+    }
+
+    if ( $changable ) {
+      $areboxes=1;
+      $html .=
+        qq!<TD><INPUT NAME="jobnum$jobnum" TYPE="checkbox" VALUE="1"></TD>!;
+
+    }
+
+    $html .= '</TR>';
+
 }
 
   $html .= '</TABLE>';
 
+  if ( $areboxes ) {
+    $html .= '<BR><INPUT TYPE="submit" NAME="action" VALUE="retry selected">'.
+             '<INPUT TYPE="submit" NAME="action" VALUE="remove selected"><BR>';
+  }
+
   $html;
 
 }
 
 =back
 
-=head1 VERSION
-
-$Id: queue.pm,v 1.5 2002-02-22 06:39:23 ivan Exp $
-
 =head1 BUGS
 
+$jobnums global
+
 =head1 SEE ALSO
 
 L<FS::Record>, schema.html from the base documentation.