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
9 # under the terms of the GNU General Public License as published by
10 # the Free Software Foundation; either version 3 of the License, or
11 # (at your option) any later version.
13 # Koha is distributed in the hope that it will be useful, but
14 # WITHOUT ANY WARRANTY; without even the implied warranty of
15 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
16 # GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License
19 # along with Koha; if not, see <http://www.gnu.org/licenses>.
22 #use warnings; FIXME - Bug 2505
24 use C4::Auth qw/get_session/;
34 C4::BackgroundJob - manage long-running jobs
35 initiated from the web staff interface
39 # start tracking a job
40 my $job = C4::BackgroundJob->new($sessionID, $job_name, $job_invoker, $num_work_units);
41 my $jobID = $job->id();
42 $job->progress($work_units_processed);
43 $job->finish($job_result_hashref);
45 # get status and results of a job
46 my $job = C4::BackgroundJob->fetch($sessionID, $jobID);
47 my $max_work_units = $job->size();
48 my $work_units_processed = $job->progress();
49 my $job_status = $job->status();
50 my $job_name = $job->name();
51 my $job_invoker = $job->invoker();
52 my $results_hashref = $job->results();
54 This module manages tracking the progress and results
55 of (potentially) long-running jobs initiated from
56 the staff user interface. Such jobs can include
57 batch MARC and patron record imports.
63 my $job = C4::BackgroundJob->new($sessionID, $job_name, $job_invoker, $num_work_units);
65 Create a new job object and set its status to 'running'. C<$num_work_units>
66 should be a number representing the size of the job; the units of the
67 job size are up to the caller and could be number of records,
74 my ($sessionID, $job_name, $job_invoker, $num_work_units) = @_;
77 $self->{'sessionID'} = $sessionID;
78 $self->{'name'} = $job_name;
79 $self->{'invoker'} = $job_invoker;
80 $self->{'size'} = $num_work_units;
81 $self->{'progress'} = 0;
82 $self->{'status'} = "running";
83 $self->{'jobID'} = Digest::MD5::md5_hex(Digest::MD5::md5_hex(time().{}.rand().{}.$$));
84 $self->{'extra_values'} = {};
92 # store object in CGI session
96 my $prefix = "job_" . $self->{'jobID'};
97 my $session = get_session($self->{'sessionID'});
98 $session->param($prefix, $self);
104 my $jobID = $job->id();
106 Read-only accessor for job ID.
112 return $self->{'jobID'};
117 my $name = $job->name();
120 Read/write accessor for job name.
127 $self->{'name'} = shift;
130 return $self->{'name'};
136 my $invoker = $job->invoker();
137 i $job->invoker($invoker);
139 Read/write accessor for job invoker.
146 $self->{'invoker'} = shift;
149 return $self->{'invoker'};
155 my $progress = $job->progress();
156 $job->progress($progress);
158 Read/write accessor for job progress.
165 $self->{'progress'} = shift;
168 return $self->{'progress'};
174 my $status = $job->status();
176 Read-only accessor for job status.
182 return $self->{'status'};
187 my $size = $job->size();
190 Read/write accessor for job size.
197 $self->{'size'} = shift;
200 return $self->{'size'};
206 $job->finish($results_hashref);
208 Mark the job as finished, setting its status to 'completed'.
209 C<$results_hashref> should be a reference to a hash containing
210 the results of the job.
216 my $results_hashref = shift;
217 $self->{'status'} = 'completed';
218 $self->{'results'} = $results_hashref;
224 my $results_hashref = $job->results();
226 Retrieve the results of the current job. Returns undef
227 if the job status is not 'completed'.
233 return unless $self->{'status'} eq 'completed';
234 return $self->{'results'};
239 my $job = C4::BackgroundJob->fetch($sessionID, $jobID);
241 Retrieve a job that has been serialized to the database.
242 Returns C<undef> if the job does not exist in the current
249 my $sessionID = shift;
252 my $session = get_session($sessionID);
253 my $prefix = "job_$jobID";
254 unless (defined $session->param($prefix)) {
257 my $self = $session->param($prefix);
266 =item $job->set($hashref);
270 Set some variables into the hashref.
271 These variables can be retrieved using the get method.
276 my ($self, $hashref) = @_;
277 while ( my ($k, $v) = each %$hashref ) {
278 $self->{extra_values}->{$k} = $v;
288 =item $value = $job->get($key);
292 Get a variable which has been previously stored with the set method.
297 my ($self, $key) = @_;
298 return $self->{extra_values}->{$key};
310 Clear the job from the current session.
316 get_session($self->{sessionID})->clear('job_' . $self->{jobID});
325 Koha Development Team <http://koha-community.org/>
327 Galen Charlton <galen.charlton@liblime.com>