package FS::queue;
+use base qw(FS::Record);
use strict;
-use vars qw( @ISA @EXPORT_OK $conf $jobnums);
+use vars qw( @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;
use FS::queue_arg;
use FS::queue_depend;
-use FS::cust_svc;
+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;
};
=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 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 _date
+
+UNIX timestamp
+
+=item svcnum
-=item job - fully-qualified subroutine name
+Optional link to service (see L<FS::cust_svc>).
-=item status - job status
+=item custnum
-=item statustext - freeform text status message
+Optional link to customer (see L<FS::cust_main>).
-=item _date - UNIX timestamp
+=item secure
-=item svcnum - optional link to service (see L<FS::cust_svc>)
+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
=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.
#false laziness w/part_export.pm
sub insert {
- my $self = shift;
+ my( $self, @args ) = @_;
local $SIG{HUP} = 'IGNORE';
local $SIG{INT} = 'IGNORE';
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 ) {
}
}
- push @$jobnums, $self->jobnum if $jobnums;
+ if ( $jobnums ) {
+ warn "jobnums global is active: $jobnums\n" if $DEBUG;
+ push @$jobnums, $self->jobnum;
+ }
$dbh->commit or die $dbh->errstr if $oldAutoCommit;
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 @del = qsearch( 'queue_arg', { 'jobnum' => $self->jobnum } );
- push @del, qsearch( 'queue_depend', { 'depend_jobnum' => $self->jobnum } );
-
- my $error = $self->SUPER::delete;
- if ( $error ) {
- $dbh->rollback if $oldAutoCommit;
- return $error;
- }
-
- foreach my $del ( @del ) {
- $error = $del->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;
+
'';
}
$self->ut_numbern('jobnum')
|| $self->ut_anything('job')
|| $self->ut_numbern('_date')
- || $self->ut_enum('status',['', qw( new locked failed )])
+ || $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;
$self->status('new') unless $self->status;
$self->_date(time) unless $self->_date;
- ''; #no error
+ $self->SUPER::check;
}
=item args
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.
-=cut
-
-sub cust_svc {
- my $self = shift;
- 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 } );
-}
-
+(Dependancies that must complete before this job can be run).
=item depend_insert 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->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
my $args;
if ( $dangerous || $queue->job !~ /^FS::part_export::/ || !$noactions ) {
- $args = encode_entities( join(' ',
- map { length($_)<54 ? $_ : substr($_,0,32)."..." } $queue->args #1&g
- ) );
+ $args = encode_entities( join(' ', $queue->args) );
} else {
$args = '';
}
=back
-=head1 VERSION
-
-$Id: queue.pm,v 1.15 2002-07-02 06:48:59 ivan Exp $
-
=head1 BUGS
$jobnums global
projects / freeside.git / blobdiff