1 package C4
::BackgroundJob
;
3 # Copyright (C) 2007 LibLime
4 # Galen Charlton <galen.charlton@liblime.com>
6 # This file is part of Koha.
8 # Koha is free software; you can redistribute it and/or modify it under the
9 # terms of the GNU General Public License as published by the Free Software
10 # Foundation; either version 2 of the License, or (at your option) any later
13 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
14 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
15 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License along with
18 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
19 # Suite 330, Boston, MA 02111-1307 USA
23 use C4
::Auth qw
/get_session/;
26 use vars
qw($VERSION);
29 # set the version for version checking
35 C4::BackgroundJob - manage long-running jobs
36 initiated from the web staff interface
42 # start tracking a job
43 my $job = C4::BackgroundJob->new($sessionID, $job_name, $job_invoker, $num_work_units);
44 my $jobID = $job->id();
45 $job->progress($work_units_processed);
46 $job->finish($job_result_hashref);
48 # get status and results of a job
49 my $job = C4::BackgroundJob->fetch($sessionID, $jobID);
50 my $max_work_units = $job->size();
51 my $work_units_processed = $job->progress();
52 my $job_status = $job->status();
53 my $job_name = $job->name();
54 my $job_invoker = $job->invoker();
55 my $results_hashref = $job->results();
59 This module manages tracking the progress and results
60 of (potentially) long-running jobs initiated from
61 the staff user interface. Such jobs can include
62 batch MARC and patron record imports.
74 my $job = C4::BackgroundJob->new($sessionID, $job_name, $job_invoker, $num_work_units);
78 Create a new job object and set its status to 'running'. C<$num_work_units>
79 should be a number representing the size of the job; the units of the
80 job size are up to the caller and could be number of records,
87 my ($sessionID, $job_name, $job_invoker, $num_work_units) = @_;
90 $self->{'sessionID'} = $sessionID;
91 $self->{'name'} = $job_name;
92 $self->{'invoker'} = $job_invoker;
93 $self->{'size'} = $num_work_units;
94 $self->{'progress'} = 0;
95 $self->{'status'} = "running";
96 $self->{'jobID'} = Digest::MD5::md5_hex(Digest::MD5::md5_hex(time().{}.rand().{}.$$));
104 # store object in CGI session
108 my $prefix = "job_" . $self->{'jobID'};
109 my $session = get_session($self->{'sessionID'});
110 $session->param($prefix, $self);
118 my $jobID = $job->id();
122 Read-only accessor for job ID.
128 return $self->{'jobID'};
135 my $name = $job->name();
140 Read/write accessor for job name.
147 $self->{'name'} = shift;
150 return $self->{'name'};
158 my $invoker = $job->invoker();
159 $job->invoker($invoker);
163 Read/write accessor for job invoker.
170 $self->{'invoker'} = shift;
173 return $self->{'invoker'};
181 my $progress = $job->progress();
182 $job->progress($progress);
186 Read/write accessor for job progress.
193 $self->{'progress'} = shift;
196 return $self->{'progress'};
204 my $status = $job->status();
208 Read-only accessor for job status.
214 return $self->{'status'};
221 my $size = $job->size();
226 Read/write accessor for job size.
233 $self->{'size'} = shift;
236 return $self->{'size'};
244 $job->finish($results_hashref);
248 Mark the job as finished, setting its status to 'completed'.
249 C<$results_hashref> should be a reference to a hash containing
250 the results of the job.
256 my $results_hashref = shift;
257 $self->{'status'} = 'completed';
258 $self->{'results'} = $results_hashref;
266 my $results_hashref = $job->results();
270 Retrieve the results of the current job. Returns undef
271 if the job status is not 'completed'.
277 return undef unless $self->{'status'} eq 'completed';
278 return $self->{'results'};
285 my $job = C4::BackgroundJob->fetch($sessionID, $jobID);
289 Retrieve a job that has been serialized to the database.
290 Returns C<undef> if the job does not exist in the current
297 my $sessionID = shift;
300 my $session = get_session($sessionID);
301 my $prefix = "job_$jobID";
302 unless (defined $session->param($prefix)) {
305 my $self = $session->param($prefix);
315 Koha Development Team <info@koha.org>
317 Galen Charlton <galen.charlton@liblime.com>