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/;
30 # set the version for version checking
35 C4::BackgroundJob - manage long-running jobs
36 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();
55 This module manages tracking the progress and results
56 of (potentially) long-running jobs initiated from
57 the staff user interface. Such jobs can include
58 batch MARC and patron record imports.
64 my $job = C4::BackgroundJob->new($sessionID, $job_name, $job_invoker, $num_work_units);
66 Create a new job object and set its status to 'running'. C<$num_work_units>
67 should be a number representing the size of the job; the units of the
68 job size are up to the caller and could be number of records,
75 my ($sessionID, $job_name, $job_invoker, $num_work_units) = @_;
78 $self->{'sessionID'} = $sessionID;
79 $self->{'name'} = $job_name;
80 $self->{'invoker'} = $job_invoker;
81 $self->{'size'} = $num_work_units;
82 $self->{'progress'} = 0;
83 $self->{'status'} = "running";
84 $self->{'jobID'} = Digest::MD5::md5_hex(Digest::MD5::md5_hex(time().{}.rand().{}.$$));
85 $self->{'extra_values'} = {};
93 # store object in CGI session
97 my $prefix = "job_" . $self->{'jobID'};
98 my $session = get_session($self->{'sessionID'});
99 $session->param($prefix, $self);
105 my $jobID = $job->id();
107 Read-only accessor for job ID.
113 return $self->{'jobID'};
118 my $name = $job->name();
121 Read/write accessor for job name.
128 $self->{'name'} = shift;
131 return $self->{'name'};
137 my $invoker = $job->invoker();
138 i $job->invoker($invoker);
140 Read/write accessor for job invoker.
147 $self->{'invoker'} = shift;
150 return $self->{'invoker'};
156 my $progress = $job->progress();
157 $job->progress($progress);
159 Read/write accessor for job progress.
166 $self->{'progress'} = shift;
169 return $self->{'progress'};
175 my $status = $job->status();
177 Read-only accessor for job status.
183 return $self->{'status'};
188 my $size = $job->size();
191 Read/write accessor for job size.
198 $self->{'size'} = shift;
201 return $self->{'size'};
207 $job->finish($results_hashref);
209 Mark the job as finished, setting its status to 'completed'.
210 C<$results_hashref> should be a reference to a hash containing
211 the results of the job.
217 my $results_hashref = shift;
218 $self->{'status'} = 'completed';
219 $self->{'results'} = $results_hashref;
225 my $results_hashref = $job->results();
227 Retrieve the results of the current job. Returns undef
228 if the job status is not 'completed'.
234 return unless $self->{'status'} eq 'completed';
235 return $self->{'results'};
240 my $job = C4::BackgroundJob->fetch($sessionID, $jobID);
242 Retrieve a job that has been serialized to the database.
243 Returns C<undef> if the job does not exist in the current
250 my $sessionID = shift;
253 my $session = get_session($sessionID);
254 my $prefix = "job_$jobID";
255 unless (defined $session->param($prefix)) {
258 my $self = $session->param($prefix);
267 =item $job->set($hashref);
271 Set some variables into the hashref.
272 These variables can be retrieved using the get method.
277 my ($self, $hashref) = @_;
278 while ( my ($k, $v) = each %$hashref ) {
279 $self->{extra_values}->{$k} = $v;
289 =item $value = $job->get($key);
293 Get a variable which has been previously stored with the set method.
298 my ($self, $key) = @_;
299 return $self->{extra_values}->{$key};
311 Clear the job from the current session.
317 get_session($self->{sessionID})->clear('job_' . $self->{jobID});
326 Koha Development Team <http://koha-community.org/>
328 Galen Charlton <galen.charlton@liblime.com>