#
# This file is part of Koha.
#
-# Koha is free software; you can redistribute it and/or modify it under the
-# terms of the GNU General Public License as published by the Free Software
-# Foundation; either version 2 of the License, or (at your option) any later
-# version.
+# Koha is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
#
-# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
-# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
-# A PARTICULAR PURPOSE. See the GNU General Public License for more details.
+# Koha is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
#
-# You should have received a copy of the GNU General Public License along with
-# Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
-# Suite 330, Boston, MA 02111-1307 USA
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
use strict;
+#use warnings; FIXME - Bug 2505
use C4::Context;
use C4::Auth qw/get_session/;
use Digest::MD5;
-use vars qw($VERSION);
-# set the version for version checking
-$VERSION = 3.00;
=head1 NAME
=head1 SYNOPSIS
-=over 4
-
-# start tracking a job
-my $job = C4::BackgroundJob->new($sessionID, $job_name, $job_invoker, $num_work_units);
-my $jobID = $job->id();
-$job->progress($work_units_processed);
-$job->finish($job_result_hashref);
-
-# get status and results of a job
-my $job = C4::BackgroundJob->fetch($sessionID, $jobID);
-my $max_work_units = $job->size();
-my $work_units_processed = $job->progress();
-my $job_status = $job->status();
-my $job_name = $job->name();
-my $job_invoker = $job->invoker();
-my $results_hashref = $job->results();
-
-=back
+ # start tracking a job
+ my $job = C4::BackgroundJob->new($sessionID, $job_name, $job_invoker, $num_work_units);
+ my $jobID = $job->id();
+ $job->progress($work_units_processed);
+ $job->finish($job_result_hashref);
+
+ # get status and results of a job
+ my $job = C4::BackgroundJob->fetch($sessionID, $jobID);
+ my $max_work_units = $job->size();
+ my $work_units_processed = $job->progress();
+ my $job_status = $job->status();
+ my $job_name = $job->name();
+ my $job_invoker = $job->invoker();
+ my $results_hashref = $job->results();
This module manages tracking the progress and results
of (potentially) long-running jobs initiated from
the staff user interface. Such jobs can include
batch MARC and patron record imports.
-=cut
-
=head1 METHODS
-=cut
-
=head2 new
-=over 4
-
-my $job = C4::BackgroundJob->new($sessionID, $job_name, $job_invoker, $num_work_units);
-
-=back
+ my $job = C4::BackgroundJob->new($sessionID, $job_name, $job_invoker, $num_work_units);
Create a new job object and set its status to 'running'. C<$num_work_units>
should be a number representing the size of the job; the units of the
$self->{'progress'} = 0;
$self->{'status'} = "running";
$self->{'jobID'} = Digest::MD5::md5_hex(Digest::MD5::md5_hex(time().{}.rand().{}.$$));
+ $self->{'extra_values'} = {};
bless $self, $class;
$self->_serialize();
my $prefix = "job_" . $self->{'jobID'};
my $session = get_session($self->{'sessionID'});
- $session->param("$prefix.name", $self->{'name'});
- $session->param("$prefix.invoker", $self->{'invoker'});
- $session->param("$prefix.size", $self->{'size'});
- $session->param("$prefix.progress", $self->{'size'});
- $session->param("$prefix.status", $self->{'size'});
- if (exists $self->{'results'}) {
- my @keys = ();
- foreach my $key (keys %{ $self->{'results'} }) {
- $session->param("$prefix.results.$key", $self->{'results'}->{$key});
- push @keys, $key;
- }
- $session->param("$prefix.results_keys", join("\t", @keys));
- }
+ $session->param($prefix, $self);
$session->flush();
}
=head2 id
-=over 4
-
-my $jobID = $job->id();
-
-=back
+ my $jobID = $job->id();
Read-only accessor for job ID.
sub id {
my $self = shift;
- return $self->{'id'};
+ return $self->{'jobID'};
}
=head2 name
-=over 4
-
-my $name = $job->name();
-$job->name($name);
-
-=back
+ my $name = $job->name();
+ $job->name($name);
Read/write accessor for job name.
=head2 invoker
-=over 4
-
-my $invoker = $job->invoker();
-$job->invoker($invoker);
-
-=back
+ my $invoker = $job->invoker();
+i $job->invoker($invoker);
Read/write accessor for job invoker.
=head2 progress
-=over 4
-
-my $progress = $job->progress();
-$job->progress($progress);
-
-=back
+ my $progress = $job->progress();
+ $job->progress($progress);
Read/write accessor for job progress.
=head2 status
-=over 4
-
-my $status = $job->status();
-
-=back
+ my $status = $job->status();
Read-only accessor for job status.
=head2 size
-=over 4
-
-my $size = $job->size();
-$job->size($size);
-
-=back
+ my $size = $job->size();
+ $job->size($size);
Read/write accessor for job size.
=head2 finish
-=over 4
-
-$job->finish($results_hashref);
-
-=back
+ $job->finish($results_hashref);
Mark the job as finished, setting its status to 'completed'.
C<$results_hashref> should be a reference to a hash containing
sub finish {
my $self = shift;
my $results_hashref = shift;
- my $self->{'status'} = 'completed';
- my $self->{'results'} = $results_hashref;
+ $self->{'status'} = 'completed';
+ $self->{'results'} = $results_hashref;
$self->_serialize();
}
=head2 results
-=over 4
-
-my $results_hashref = $job->results();
-
-=back
+ my $results_hashref = $job->results();
Retrieve the results of the current job. Returns undef
if the job status is not 'completed'.
sub results {
my $self = shift;
- return undef unless $self->{'status'} eq 'completed';
+ return unless $self->{'status'} eq 'completed';
return $self->{'results'};
}
=head2 fetch
-=over 4
-
-my $job = C4::BackgroundJob->fetch($sessionID, $jobID);
-
-=back
+ my $job = C4::BackgroundJob->fetch($sessionID, $jobID);
Retrieve a job that has been serialized to the database.
Returns C<undef> if the job does not exist in the current
my $session = get_session($sessionID);
my $prefix = "job_$jobID";
- unless (defined $session->param("$prefix.name")) {
- return undef;
+ unless (defined $session->param($prefix)) {
+ return;
}
- my $self = {};
-
- $self->{'name'} = $session->param("$prefix.name");
- $self->{'status'} = $session->param("$prefix.status");
- $self->{'invoker'} = $session->param("$prefix.invoker");
- $self->{'size'} = $session->param("$prefix.size");
- $self->{'progress'} = $session->param("$prefix.progress");
- if (defined(my $keys = $session->param("$prefix.results_keys"))) {
- my @keys = split /\t/, $keys;
- $self->{'results'} = {};
- foreach my $key (@keys) {
- $self->{'results'}->{$key} = $session->param("$prefix.results.$key");
- }
- }
-
+ my $self = $session->param($prefix);
bless $self, $class;
return $self;
}
+=head2 set
+
+=over 4
+
+=item $job->set($hashref);
+
+=back
+
+Set some variables into the hashref.
+These variables can be retrieved using the get method.
+
+=cut
+
+sub set {
+ my ($self, $hashref) = @_;
+ while ( my ($k, $v) = each %$hashref ) {
+ $self->{extra_values}->{$k} = $v;
+ }
+ $self->_serialize();
+ return;
+}
+
+=head2 get
+
+=over 4
+
+=item $value = $job->get($key);
+
+=back
+
+Get a variable which has been previously stored with the set method.
+
+=cut
+
+sub get {
+ my ($self, $key) = @_;
+ return $self->{extra_values}->{$key};
+}
+
+
+=head2 clear
+
+=over 4
+
+=item $job->clear();
+
+=back
+
+Clear the job from the current session.
+
+=cut
+
+sub clear {
+ my $self = shift;
+ get_session($self->{sessionID})->clear('job_' . $self->{jobID});
+}
+
+
+1;
+__END__
+
=head1 AUTHOR
-Koha Development Team <info@koha.org>
+Koha Development Team <http://koha-community.org/>
Galen Charlton <galen.charlton@liblime.com>
projects / koha.git / blobdiff