1 package Koha::BackgroundJob;
3 # This file is part of Koha.
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.
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.
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>.
19 use JSON qw( decode_json encode_json );
20 use Encode qw( encode_utf8 );
23 use Try::Tiny qw( catch try );
26 use Koha::DateUtils qw( dt_from_string );
29 use Koha::Exceptions::BackgroundJob;
31 use base qw( Koha::Object );
35 Koha::BackgroundJob - Koha BackgroundJob Object class
37 This is a base class for BackgroundJob, some methods must be subclassed.
42 my $job_id = Koha::BackgroundJob->enqueue(
44 job_type => $job_type,
45 job_size => $job_size,
51 Koha::BackgrounJobs->find($job_id)->process;
52 See also C<misc/background_jobs_worker.pl> for a full example
60 Connect to the message broker using default guest/guest credential
66 my $hostname = 'localhost';
68 my $config = C4::Context->config('message_broker');
74 $hostname = $config->{hostname} if $config->{hostname};
75 $port = $config->{port} if $config->{port};
76 $credentials->{login} = $config->{username} if $config->{username};
77 $credentials->{passcode} = $config->{password} if $config->{password};
78 $credentials->{host} = $config->{vhost} if $config->{vhost};
80 my $stomp = Net::Stomp->new( { hostname => $hostname, port => $port } );
81 $stomp->connect( $credentials );
87 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.
89 C<job_size> is the size of the job
90 C<job_args> is the arguments of the job. It's a structure that will be JSON encoded.
92 Return the job_id of the newly created job.
97 my ( $self, $params ) = @_;
99 my $job_type = $self->job_type;
100 my $job_size = $params->{job_size};
101 my $job_args = $params->{job_args};
102 my $job_context = $params->{job_context} // C4::Context->userenv;
103 my $job_queue = $params->{job_queue} // 'default';
105 my $borrowernumber = (C4::Context->userenv) ? C4::Context->userenv->{number} : undef;
106 $job_context->{interface} = C4::Context->interface;
107 my $json_context = encode_json $job_context;
108 my $json_args = encode_json $job_args;
117 context => $json_context,
118 enqueued_on => dt_from_string,
119 borrowernumber => $borrowernumber,
123 $job_args->{job_id} = $self->id;
127 $conn = $self->connect;
129 warn "Cannot connect to broker " . $_;
133 $json_args = encode_json $job_args;
135 # This namespace is wrong, it must be a vhost instead.
136 # But to do so it needs to be created on the server => much more work when a new Koha instance is created.
137 # Also, here we just want the Koha instance's name, but it's not in the config...
138 # Picking a random id (memcached_namespace) from the config
139 my $namespace = C4::Context->config('memcached_namespace');
140 $conn->send_with_receipt( { destination => sprintf("/queue/%s-%s", $namespace, $job_queue), body => $json_args } )
141 or Koha::Exceptions::Exception->throw('Job has not been enqueued');
143 $self->status('failed')->store;
144 if ( ref($_) eq 'Koha::Exceptions::Exception' ) {
147 warn sprintf "The job has not been sent to the message broker: (%s)", $_;
161 my ( $self, $args ) = @_;
163 return {} if ref($self) ne 'Koha::BackgroundJob';
165 my $derived_class = $self->_derived_class;
169 if ( $self->context ) {
170 my $context = decode_json($self->context);
171 C4::Context->_new_userenv(-1);
172 C4::Context->interface( $context->{interface} );
173 C4::Context->set_userenv(
174 $context->{number}, $context->{id},
175 $context->{cardnumber}, $context->{firstname},
176 $context->{surname}, $context->{branch},
177 $context->{branchname}, $context->{flags},
178 $context->{emailaddress}, undef,
179 $context->{desk_id}, $context->{desk_name},
180 $context->{register_id}, $context->{register_name}
184 Koha::Logger->get->warn("A background job didn't have context defined (" . $self->id . ")");
187 return $derived_class->process( $args );
194 Marks the job as started.
201 Koha::Exceptions::BackgroundJob::InconsistentStatus->throw(
202 current_status => $self->status,
203 expected_status => 'new'
204 ) unless $self->status eq 'new';
208 started_on => \'NOW()',
219 Makes the job record a step has taken place.
226 Koha::Exceptions::BackgroundJob::InconsistentStatus->throw(
227 current_status => $self->status,
228 expected_status => 'started'
229 ) unless $self->status eq 'started';
231 # reached the end of the tasks already
232 Koha::Exceptions::BackgroundJob::StepOutOfBounds->throw()
233 unless $self->progress < $self->size;
235 return $self->progress( $self->progress + 1 )->store;
242 Makes the job record as finished. If the job status is I<cancelled>, it is kept.
247 my ( $self, $data ) = @_;
249 $self->status('finished') unless $self->status eq 'cancelled';
253 ended_on => \'NOW()',
254 data => encode_json($data),
261 my $job_data = $self->decoded_data;
263 Returns the decoded JSON contents from $self->data.
270 return $self->data ? decode_json( $self->data ) : undef;
273 =head3 set_encoded_data
275 $self->set_encoded_data( $data );
277 Serializes I<$data> as a JSON string and sets the I<data> attribute with it.
281 sub set_encoded_data {
282 my ( $self, $data ) = @_;
284 return $self->data( $data ? encode_json($data) : undef );
289 Return the job type of the job. Must be a string.
293 sub job_type { croak "This method must be subclassed" }
297 Messages let during the processing of the job.
305 my $data_dump = decode_json encode_utf8 $self->data;
306 if ( exists $data_dump->{messages} ) {
307 @messages = @{ $data_dump->{messages} };
322 my $data_dump = decode_json encode_utf8 $self->data;
323 return $data_dump->{report} || {};
326 =head3 additional_report
328 Build additional variables for the job detail view.
332 sub additional_report {
335 return {} if ref($self) ne 'Koha::BackgroundJob';
337 my $derived_class = $self->_derived_class;
339 return $derived_class->additional_report;
350 $self->status('cancelled')->store;
353 =head2 Internal methods
355 =head3 _derived_class
361 my $job_type = $self->type;
363 my $class = $self->type_to_class_mapping->{$job_type};
365 Koha::Exception->throw($job_type . ' is not a valid job_type')
368 eval "require $class";
369 return $class->_new_from_dbic( $self->_result );
372 =head3 type_to_class_mapping
374 my $mapping = Koha::BackgrounJob->new->type_to_class_mapping;
376 Returns the available types to class mappings.
380 sub type_to_class_mapping {
383 my $plugins_mapping = ( C4::Context->config("enable_plugins") ) ? $self->plugin_types_to_classes : {};
385 return ($plugins_mapping)
386 ? { %{ $self->core_types_to_classes }, %$plugins_mapping }
387 : $self->core_types_to_classes;
390 =head3 core_types_to_classes
392 my $mappings = Koha::BackgrounJob->new->core_types_to_classes
394 Returns the core background jobs types to class mappings.
398 sub core_types_to_classes {
400 batch_authority_record_deletion => 'Koha::BackgroundJob::BatchDeleteAuthority',
401 batch_authority_record_modification => 'Koha::BackgroundJob::BatchUpdateAuthority',
402 batch_biblio_record_deletion => 'Koha::BackgroundJob::BatchDeleteBiblio',
403 batch_biblio_record_modification => 'Koha::BackgroundJob::BatchUpdateBiblio',
404 batch_item_record_deletion => 'Koha::BackgroundJob::BatchDeleteItem',
405 batch_item_record_modification => 'Koha::BackgroundJob::BatchUpdateItem',
406 batch_hold_cancel => 'Koha::BackgroundJob::BatchCancelHold',
407 update_elastic_index => 'Koha::BackgroundJob::UpdateElasticIndex',
408 update_holds_queue_for_biblios => 'Koha::BackgroundJob::BatchUpdateBiblioHoldsQueue',
412 =head3 plugin_types_to_classes
414 my $mappings = Koha::BackgroundJob->new->plugin_types_to_classes
416 Returns the plugin-defined background jobs types to class mappings.
420 sub plugin_types_to_classes {
423 unless ( exists $self->{_plugin_mapping} ) {
424 my @plugins = Koha::Plugins->new()->GetPlugins( { method => 'background_tasks', } );
426 foreach my $plugin (@plugins) {
428 my $tasks = $plugin->background_tasks;
429 my $metadata = $plugin->get_metadata;
431 unless ( $metadata->{namespace} ) {
432 Koha::Logger->get->warn(
433 q{A plugin includes the 'background_tasks' method, }
434 . q{but doesn't provide the required 'namespace' }
435 . qq{method ($plugin->{class})} );
439 my $namespace = $metadata->{namespace};
441 foreach my $type ( keys %{$tasks} ) {
442 my $class = $tasks->{$type};
444 # skip if conditions not met
445 next unless $type and $class;
447 my $key = "plugin_$namespace" . "_$type";
449 $self->{_plugin_mapping}->{$key} = $tasks->{$type};
454 return $self->{_plugin_mapping};
462 return 'BackgroundJob';