X-Git-Url: http://git.freeside.biz/gitweb/?p=freeside.git;a=blobdiff_plain;f=FS%2FFS%2Fqueue.pm;h=f42d998375181bb7c39a4c1b947ea11464a7788a;hp=51dd9affed316af0aa41244743a14274a36e0267;hb=6cf964d0dc008621fb30fd2da28e2c44f29c6364;hpb=f5266a4d07d116efd732f433d0f4f3a47b143a7d diff --git a/FS/FS/queue.pm b/FS/FS/queue.pm index 51dd9affe..f42d99837 100644 --- a/FS/FS/queue.pm +++ b/FS/FS/queue.pm @@ -1,11 +1,26 @@ package FS::queue; use strict; -use vars qw( @ISA ); +use vars qw( @ISA @EXPORT_OK $DEBUG $conf $jobnums); +use Exporter; +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; @ISA = qw(FS::Record); +@EXPORT_OK = qw( joblisting ); + +$DEBUG = 0; + +$FS::UID::callback{'FS::queue'} = sub { + $conf = new FS::Conf; +}; + +$jobnums = ''; =head1 NAME @@ -39,6 +54,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) + =back =head1 METHODS @@ -68,6 +89,7 @@ created (see L). =cut +#false laziness w/part_export.pm sub insert { my $self = shift; @@ -100,6 +122,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; ''; @@ -108,11 +135,47 @@ sub insert { =item delete -Delete this record from the database. +Delete this record from the database. Any corresponding queue_arg records are +deleted as well =cut -# the delete method can be inherited from FS::Record +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 $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; + if ( $error ) { + $dbh->rollback if $oldAutoCommit; + return $error; + } + } + + $dbh->commit or die $dbh->errstr if $oldAutoCommit; + + ''; + +} =item replace OLD_RECORD @@ -138,32 +201,260 @@ sub check { || $self->ut_anything('job') || $self->ut_numbern('_date') || $self->ut_enum('status',['', qw( new locked failed )]) + || $self->ut_anything('statustext') + || $self->ut_numbern('svcnum') ; return $error if $error; + $error = $self->ut_foreign_keyn('svcnum', 'cust_svc', 'svcnum'); + $self->svcnum('') if $error; + $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 } ); + map $_->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. +(Dependancies that must complete before this job can be run). + +=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; +} + +=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 VERSION +=head1 SUBROUTINES -$Id: queue.pm,v 1.1 2001-09-11 00:08:18 ivan Exp $ +=over 4 + +=item joblisting HASHREF NOACTIONS + +=cut + +sub joblisting { + my($hashref, $noactions) = @_; + + use Date::Format; + use HTML::Entities; + use FS::CGI; + + my @queue = qsearch( 'queue', $hashref ); + return '' unless scalar(@queue); + + my $p = FS::CGI::popurl(2); + + my $html = qq!
!. + FS::CGI::table(). < + Job + Args + Date + Status +END + $html .= 'Account' unless $hashref->{svcnum}; + $html .= ''; + + my $dangerous = $conf->exists('queue_dangerous_controls'); + + my $areboxes = 0; + + foreach my $queue ( sort { + $a->getfield('jobnum') <=> $b->getfield('jobnum') + } @queue ) { + my $queue_hashref = $queue->hashref; + my $jobnum = $queue->jobnum; + + 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; + 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! ( retry |!. + qq! remove )!; + } + my $cust_svc = $queue->cust_svc; + + $html .= < + $jobnum + $queue_hashref->{job} + $args + $date + $status +END + + unless ( $hashref->{svcnum} ) { + my $account; + if ( $cust_svc ) { + my $table = $cust_svc->part_svc->svcdb; + my $label = ( $cust_svc->label )[1]; + $account = qq!$label!; + } else { + $account = ''; + } + $html .= "$account"; + } + + if ( $changable ) { + $areboxes=1; + $html .= + qq!!; + + } + + $html .= ''; + +} + + $html .= ''; + + if ( $areboxes ) { + $html .= '
'. + '
'; + } + + $html; + +} + +=back =head1 BUGS +$jobnums global + =head1 SEE ALSO L, schema.html from the base documentation.