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);
28 # set the version for version checking
33 C4::BackgroundJob - manage long-running jobs
34 initiated from the web staff interface
40 # start tracking a job
41 my $job = C4::BackgroundJob->new($sessionID, $job_name, $job_invoker, $num_work_units);
42 my $jobID = $job->id();
43 $job->progress($work_units_processed);
44 $job->finish($job_result_hashref);
46 # get status and results of a job
47 my $job = C4::BackgroundJob->fetch($sessionID, $jobID);
48 my $max_work_units = $job->size();
49 my $work_units_processed = $job->progress();
50 my $job_status = $job->status();
51 my $job_name = $job->name();
52 my $job_invoker = $job->invoker();
53 my $results_hashref = $job->results();
57 This module manages tracking the progress and results
58 of (potentially) long-running jobs initiated from
59 the staff user interface. Such jobs can include
60 batch MARC and patron record imports.
72 my $job = C4::BackgroundJob->new($sessionID, $job_name, $job_invoker, $num_work_units);
76 Create a new job object and set its status to 'running'. C<$num_work_units>
77 should be a number representing the size of the job; the units of the
78 job size are up to the caller and could be number of records,
85 my ($sessionID, $job_name, $job_invoker, $num_work_units) = @_;
88 $self->{'sessionID'} = $sessionID;
89 $self->{'name'} = $job_name;
90 $self->{'invoker'} = $job_invoker;
91 $self->{'size'} = $num_work_units;
92 $self->{'progress'} = 0;
93 $self->{'status'} = "running";
94 $self->{'jobID'} = Digest::MD5::md5_hex(Digest::MD5::md5_hex(time().{}.rand().{}.$$));
102 # store object in CGI session
106 my $prefix = "job_" . $self->{'jobID'};
107 my $session = get_session($self->{'sessionID'});
108 $session->param($prefix, $self);
116 my $jobID = $job->id();
120 Read-only accessor for job ID.
126 return $self->{'jobID'};
133 my $name = $job->name();
138 Read/write accessor for job name.
145 $self->{'name'} = shift;
148 return $self->{'name'};
156 my $invoker = $job->invoker();
157 $job->invoker($invoker);
161 Read/write accessor for job invoker.
168 $self->{'invoker'} = shift;
171 return $self->{'invoker'};
179 my $progress = $job->progress();
180 $job->progress($progress);
184 Read/write accessor for job progress.
191 $self->{'progress'} = shift;
194 return $self->{'progress'};
202 my $status = $job->status();
206 Read-only accessor for job status.
212 return $self->{'status'};
219 my $size = $job->size();
224 Read/write accessor for job size.
231 $self->{'size'} = shift;
234 return $self->{'size'};
242 $job->finish($results_hashref);
246 Mark the job as finished, setting its status to 'completed'.
247 C<$results_hashref> should be a reference to a hash containing
248 the results of the job.
254 my $results_hashref = shift;
255 $self->{'status'} = 'completed';
256 $self->{'results'} = $results_hashref;
264 my $results_hashref = $job->results();
268 Retrieve the results of the current job. Returns undef
269 if the job status is not 'completed'.
275 return undef unless $self->{'status'} eq 'completed';
276 return $self->{'results'};
283 my $job = C4::BackgroundJob->fetch($sessionID, $jobID);
287 Retrieve a job that has been serialized to the database.
288 Returns C<undef> if the job does not exist in the current
295 my $sessionID = shift;
298 my $session = get_session($sessionID);
299 my $prefix = "job_$jobID";
300 unless (defined $session->param($prefix)) {
303 my $self = $session->param($prefix);
310 Koha Development Team <info@koha.org>
312 Galen Charlton <galen.charlton@liblime.com>