misc/background_jobs_worker.pl

   1 #!/usr/bin/perl
   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
  18 =head1 NAME
  19
  20 background_jobs_worker.pl - Worker script that will process background jobs
  21
  22 =head1 SYNOPSIS
  23
  24 ./background_jobs_worker.pl [--queue QUEUE] [-m|--max-processes MAX_PROCESSES]
  25
  26 =head1 DESCRIPTION
  27
  28 This script will connect to the Stomp server (RabbitMQ) and subscribe to the queues passed in parameter (or the 'default' queue),
  29 or if a Stomp server is not active it will poll the database every 10s for new jobs in the passed queue.
  30
  31 You can specify some queues only (using --queue, which is repeatable) if you want to run several workers that will handle their own jobs.
  32
  33 --m --max-processes specifies how many jobs to process simultaneously
  34
  35 Max processes will be set from the command line option, the environment variable MAX_PROCESSES, or the koha-conf file, in that order of precedence.
  36 By default the script will only run one job at a time.
  37
  38 =head1 OPTIONS
  39
  40 =over
  41
  42 =item B<--queue>
  43
  44 Repeatable. Give the job queues this worker will process.
  45
  46 The different values available are:
  47
  48     default
  49     long_tasks
  50
  51 =back
  52
  53 =cut
  54
  55 use Modern::Perl;
  56 use JSON qw( decode_json );
  57 use Try::Tiny;
  58 use Pod::Usage;
  59 use Getopt::Long;
  60 use Parallel::ForkManager;
  61
  62 use Koha::Logger;
  63 use Koha::BackgroundJobs;
  64 use C4::Context;
  65
  66 my ( $help, @queues );
  67
  68 my $max_processes = $ENV{MAX_PROCESSES};
  69 $max_processes ||= C4::Context->config('background_jobs_worker')->{max_processes} if C4::Context->config('background_jobs_worker');
  70 $max_processes ||= 1;
  71
  72 GetOptions(
  73     'm|max-processes=i' => \$max_processes,
  74     'h|help' => \$help,
  75     'queue=s' => \@queues,
  76 ) || pod2usage(1);
  77
  78
  79 pod2usage(0) if $help;
  80
  81 unless (@queues) {
  82     push @queues, 'default';
  83 }
  84
  85 my $conn;
  86 try {
  87     $conn = Koha::BackgroundJob->connect;
  88 } catch {
  89     warn sprintf "Cannot connect to the message broker, the jobs will be processed anyway (%s)", $_;
  90 };
  91
  92 my $pm = Parallel::ForkManager->new($max_processes);
  93
  94 if ( $conn ) {
  95     # FIXME cf note in Koha::BackgroundJob about $namespace
  96     my $namespace = C4::Context->config('memcached_namespace');
  97     for my $queue (@queues) {
  98         $conn->subscribe({
  99             destination => sprintf("/queue/%s-%s", $namespace, $queue),
 100             ack => 'client',
 101             'prefetch-count' => 1,
 102         });
 103     }
 104 }
 105 while (1) {
 106     if ( $conn ) {
 107         my $frame = $conn->receive_frame;
 108         if ( !defined $frame ) {
 109             # maybe log connection problems
 110             next;    # will reconnect automatically
 111         }
 112
 113         my $args = try {
 114             my $body = $frame->body;
 115             decode_json($body); # TODO Should this be from_json? Check utf8 flag.
 116         } catch {
 117             Koha::Logger->get({ interface => 'worker' })->warn(sprintf "Frame not processed - %s", $_);
 118             return;
 119         } finally {
 120             $conn->ack( { frame => $frame } );
 121         };
 122
 123         next unless $args;
 124
 125         # FIXME This means we need to have create the DB entry before
 126         # It could work in a first step, but then we will want to handle job that will be created from the message received
 127         my $job = Koha::BackgroundJobs->find($args->{job_id});
 128
 129         unless ( $job ) {
 130             Koha::Logger->get({ interface => 'worker' })->warn(sprintf "No job found for id=%s", $args->{job_id});
 131             next;
 132         }
 133
 134         $pm->start and next;
 135         process_job( $job, $args );
 136         $pm->finish;
 137
 138     } else {
 139         my $jobs = Koha::BackgroundJobs->search({ status => 'new', queue => \@queues });
 140         while ( my $job = $jobs->next ) {
 141             my $args = try {
 142                 $job->json->decode($job->data);
 143             } catch {
 144                 Koha::Logger->get({ interface => 'worker' })->warn(sprintf "Cannot decode data for job id=%s", $job->id);
 145                 $job->status('failed')->store;
 146                 return;
 147             };
 148
 149             next unless $args;
 150
 151             $pm->start and next;
 152             process_job( $job, { job_id => $job->id, %$args } );
 153             $pm->finish;
 154
 155         }
 156         sleep 10;
 157     }
 158 }
 159 $conn->disconnect;
 160 $pm->wait_all_children;
 161
 162 sub process_job {
 163     my ( $job, $args ) = @_;
 164     try {
 165         $job->process( $args );
 166     } catch {
 167         $job->status('failed')->store;
 168     };
 169 }