4 use vars qw( @ISA @EXPORT_OK );
6 use FS::Record qw( qsearch qsearchs dbh );
11 @ISA = qw(FS::Record);
12 @EXPORT_OK = qw( joblisting );
16 FS::queue - Object methods for queue records
22 $record = new FS::queue \%hash;
23 $record = new FS::queue { 'column' => 'value' };
25 $error = $record->insert;
27 $error = $new_record->replace($old_record);
29 $error = $record->delete;
31 $error = $record->check;
35 An FS::queue object represents an queued job. FS::queue inherits from
36 FS::Record. The following fields are currently supported:
40 =item jobnum - primary key
42 =item job - fully-qualified subroutine name
44 =item status - job status
46 =item statustext - freeform text status message
48 =item _date - UNIX timestamp
50 =item svcnum - optional link to service (see L<FS::cust_svc>)
60 Creates a new job. To add the example to the database, see L<"insert">.
62 Note that this stores the hash reference, not a distinct copy of the hash it
63 points to. You can ask the object for a copy with the I<hash> method.
67 # the new method can be inherited from FS::Record, if a table method is defined
69 sub table { 'queue'; }
71 =item insert [ ARGUMENT, ARGUMENT... ]
73 Adds this record to the database. If there is an error, returns the error,
74 otherwise returns false.
76 If any arguments are supplied, a queue_arg record for each argument is also
77 created (see L<FS::queue_arg>).
84 local $SIG{HUP} = 'IGNORE';
85 local $SIG{INT} = 'IGNORE';
86 local $SIG{QUIT} = 'IGNORE';
87 local $SIG{TERM} = 'IGNORE';
88 local $SIG{TSTP} = 'IGNORE';
89 local $SIG{PIPE} = 'IGNORE';
91 my $oldAutoCommit = $FS::UID::AutoCommit;
92 local $FS::UID::AutoCommit = 0;
95 my $error = $self->SUPER::insert;
97 $dbh->rollback if $oldAutoCommit;
101 foreach my $arg ( @_ ) {
102 my $queue_arg = new FS::queue_arg ( {
103 'jobnum' => $self->jobnum,
106 $error = $queue_arg->insert;
108 $dbh->rollback if $oldAutoCommit;
113 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
121 Delete this record from the database. Any corresponding queue_arg records are
129 local $SIG{HUP} = 'IGNORE';
130 local $SIG{INT} = 'IGNORE';
131 local $SIG{QUIT} = 'IGNORE';
132 local $SIG{TERM} = 'IGNORE';
133 local $SIG{TSTP} = 'IGNORE';
134 local $SIG{PIPE} = 'IGNORE';
136 my $oldAutoCommit = $FS::UID::AutoCommit;
137 local $FS::UID::AutoCommit = 0;
140 my @args = qsearch( 'queue_arg', { 'jobnum' => $self->jobnum } );
142 my $error = $self->SUPER::delete;
144 $dbh->rollback if $oldAutoCommit;
148 foreach my $arg ( @args ) {
149 $error = $arg->delete;
151 $dbh->rollback if $oldAutoCommit;
156 $dbh->commit or die $dbh->errstr if $oldAutoCommit;
162 =item replace OLD_RECORD
164 Replaces the OLD_RECORD with this one in the database. If there is an error,
165 returns the error, otherwise returns false.
169 # the replace method can be inherited from FS::Record
173 Checks all fields to make sure this is a valid job. If there is
174 an error, returns the error, otherwise returns false. Called by the insert
182 $self->ut_numbern('jobnum')
183 || $self->ut_anything('job')
184 || $self->ut_numbern('_date')
185 || $self->ut_enum('status',['', qw( new locked failed )])
186 || $self->ut_textn('statustext')
187 || $self->ut_numbern('svcnum')
189 return $error if $error;
191 $error = $self->ut_foreign_keyn('svcnum', 'cust_svc', 'svcnum');
192 $self->svcnum('') if $error;
194 $self->status('new') unless $self->status;
195 $self->_date(time) unless $self->_date;
206 map $_->arg, qsearch( 'queue_arg',
207 { 'jobnum' => $self->jobnum },
215 Returns the FS::cust_svc object associated with this job, if any.
221 qsearchs('cust_svc', { 'svcnum' => $self->svcnum } );
224 =item joblisting HASHREF
229 my($hashref, $noactions) = @_;
234 my $html = FS::CGI::table(). <<END;
236 <TH COLSPAN=2>Job</TH>
244 my $p = FS::CGI::popurl(2);
245 foreach my $queue ( sort {
246 $a->getfield('jobnum') <=> $b->getfield('jobnum')
247 } qsearch( 'queue', $hashref ) ) {
248 my $hashref = $queue->hashref;
249 my $jobnum = $queue->jobnum;
250 my $args = join(' ', $queue->args);
251 my $date = time2str( "%a %b %e %T %Y", $queue->_date );
252 my $status = $queue->status;
253 $status .= ': '. $queue->statustext if $queue->statustext;
254 if ( ! $noactions && $status =~ /^failed/ || $status =~ /^locked/ ) {
256 qq! ( <A HREF="$p/misc/queue.cgi?jobnum=$jobnum&action=new">retry</A> |!.
257 qq! <A HREF="$p/misc/queue.cgi?jobnum=$jobnum&action=del">remove</A> )!;
259 my $cust_svc = $queue->cust_svc;
262 my $table = $cust_svc->part_svc->svcdb;
263 my $label = ( $cust_svc->label )[1];
264 $account = qq!<A HREF="../view/$table.cgi?!. $queue->svcnum.
272 <TD>$hashref->{job}</TD>
292 $Id: queue.pm,v 1.6 2002-02-22 06:42:28 ivan Exp $
298 L<FS::Record>, schema.html from the base documentation.