|
Lines 1-5
Link Here
|
| 1 |
package Koha::BackgroundJob; |
1 |
package Koha::BackgroundJob; |
| 2 |
|
2 |
|
|
|
3 |
# This file is part of Koha. |
| 4 |
# |
| 5 |
# Koha is free software; you can redistribute it and/or modify it |
| 6 |
# under the terms of the GNU General Public License as published by |
| 7 |
# the Free Software Foundation; either version 3 of the License, or |
| 8 |
# (at your option) any later version. |
| 9 |
# |
| 10 |
# Koha is distributed in the hope that it will be useful, but |
| 11 |
# WITHOUT ANY WARRANTY; without even the implied warranty of |
| 12 |
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
| 13 |
# GNU General Public License for more details. |
| 14 |
# |
| 15 |
# You should have received a copy of the GNU General Public License |
| 16 |
# along with Koha; if not, see <http://www.gnu.org/licenses>. |
| 17 |
|
| 3 |
use Modern::Perl; |
18 |
use Modern::Perl; |
| 4 |
use JSON qw( encode_json decode_json ); |
19 |
use JSON qw( encode_json decode_json ); |
| 5 |
use Carp qw( croak ); |
20 |
use Carp qw( croak ); |
|
Lines 13-18
use Koha::BackgroundJob::BatchUpdateAuthority;
Link Here
|
| 13 |
|
28 |
|
| 14 |
use base qw( Koha::Object ); |
29 |
use base qw( Koha::Object ); |
| 15 |
|
30 |
|
|
|
31 |
=head1 NAME |
| 32 |
|
| 33 |
Koha::BackgroundJob - Koha BackgroundJob Object class |
| 34 |
|
| 35 |
This is a base class for BackgroundJob, some methods must be subclassed. |
| 36 |
|
| 37 |
Example of usage: |
| 38 |
|
| 39 |
Producer: |
| 40 |
my $job_id = Koha::BackgroundJob->enqueue( |
| 41 |
{ |
| 42 |
job_type => $job_type, |
| 43 |
job_size => $job_size, |
| 44 |
job_args => $job_args |
| 45 |
} |
| 46 |
); |
| 47 |
|
| 48 |
Consumer: |
| 49 |
Koha::BackgrounJobs->find($job_id)->process; |
| 50 |
See also C<misc/background_jobs_worker.pl> for a full example |
| 51 |
|
| 52 |
=head1 API |
| 53 |
|
| 54 |
=head2 Class methods |
| 55 |
|
| 56 |
=head3 connect |
| 57 |
|
| 58 |
Connect to the message broker using default guest/guest credential |
| 59 |
|
| 60 |
=cut |
| 61 |
|
| 16 |
sub connect { |
62 |
sub connect { |
| 17 |
my ( $self ); |
63 |
my ( $self ); |
| 18 |
my $stomp = Net::Stomp->new( { hostname => 'localhost', port => '61613' } ); |
64 |
my $stomp = Net::Stomp->new( { hostname => 'localhost', port => '61613' } ); |
|
Lines 20-25
sub connect {
Link Here
|
| 20 |
return $stomp; |
66 |
return $stomp; |
| 21 |
} |
67 |
} |
| 22 |
|
68 |
|
|
|
69 |
=head3 enqueue |
| 70 |
|
| 71 |
Enqueue a new job. It will insert a new row in the DB table and notify the broker that a new job has been enqueued. |
| 72 |
|
| 73 |
C<job_size> is the size of the job |
| 74 |
C<job_args> is the arguments of the job. It's a structure that will be JSON encoded. |
| 75 |
|
| 76 |
Return the job_id of the newly created job. |
| 77 |
|
| 78 |
=cut |
| 79 |
|
| 23 |
sub enqueue { |
80 |
sub enqueue { |
| 24 |
my ( $self, $params ) = @_; |
81 |
my ( $self, $params ) = @_; |
| 25 |
|
82 |
|
|
Lines 61-66
sub enqueue {
Link Here
|
| 61 |
return $job_id; |
118 |
return $job_id; |
| 62 |
} |
119 |
} |
| 63 |
|
120 |
|
|
|
121 |
=head3 process |
| 122 |
|
| 123 |
Process the job! |
| 124 |
|
| 125 |
=cut |
| 126 |
|
| 64 |
sub process { |
127 |
sub process { |
| 65 |
my ( $self, $args ) = @_; |
128 |
my ( $self, $args ) = @_; |
| 66 |
|
129 |
|
|
Lines 72-79
sub process {
Link Here
|
| 72 |
: Koha::Exceptions::Exception->throw('->process called without valid job_type'); |
135 |
: Koha::Exceptions::Exception->throw('->process called without valid job_type'); |
| 73 |
} |
136 |
} |
| 74 |
|
137 |
|
|
|
138 |
=head3 job_type |
| 139 |
|
| 140 |
Return the job type of the job. Must be a string. |
| 141 |
|
| 142 |
=cut |
| 143 |
|
| 75 |
sub job_type { croak "This method must be subclassed" } |
144 |
sub job_type { croak "This method must be subclassed" } |
| 76 |
|
145 |
|
|
|
146 |
=head3 messages |
| 147 |
|
| 148 |
Messages let during the processing of the job. |
| 149 |
|
| 150 |
=cut |
| 151 |
|
| 77 |
sub messages { |
152 |
sub messages { |
| 78 |
my ( $self ) = @_; |
153 |
my ( $self ) = @_; |
| 79 |
|
154 |
|
|
Lines 86-91
sub messages {
Link Here
|
| 86 |
return @messages; |
161 |
return @messages; |
| 87 |
} |
162 |
} |
| 88 |
|
163 |
|
|
|
164 |
=head3 report |
| 165 |
|
| 166 |
Report of the job. |
| 167 |
|
| 168 |
=cut |
| 169 |
|
| 89 |
sub report { |
170 |
sub report { |
| 90 |
my ( $self ) = @_; |
171 |
my ( $self ) = @_; |
| 91 |
|
172 |
|
|
Lines 93-98
sub report {
Link Here
|
| 93 |
return $data_dump->{report}; |
174 |
return $data_dump->{report}; |
| 94 |
} |
175 |
} |
| 95 |
|
176 |
|
|
|
177 |
=head3 cancel |
| 178 |
|
| 179 |
Cancel a job. |
| 180 |
|
| 181 |
=cut |
| 182 |
|
| 96 |
sub cancel { |
183 |
sub cancel { |
| 97 |
my ( $self ) = @_; |
184 |
my ( $self ) = @_; |
| 98 |
$self->status('cancelled')->store; |
185 |
$self->status('cancelled')->store; |