misc/cronjobs/process_message_queue.pl

   1 #!/usr/bin/perl
   2
   3 # Copyright 2008 LibLime
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 use strict;
  21 use warnings;
  22
  23 use Koha::Script -cron;
  24 use C4::Letters qw( SendQueuedMessages );
  25 use C4::Log qw( cronlogaction );
  26 use Getopt::Long qw( GetOptions );
  27 use Try::Tiny qw( catch try );
  28
  29 my $username = undef;
  30 my $password = undef;
  31 my $limit    = undef;
  32 my $method = 'LOGIN';
  33 my $help = 0;
  34 my $verbose = 0;
  35 my $type = q{};
  36 my $letter_code;
  37
  38 GetOptions(
  39     'u|username:s'      => \$username,
  40     'p|password:s'      => \$password,
  41     'l|limit:s'         => \$limit,
  42     'm|method:s'        => \$method,
  43     'h|help|?'          => \$help,
  44     'v|verbose'         => \$verbose,
  45     't|type:s'          => \$type,
  46     'c|code:s'          => \$letter_code,
  47 );
  48 my $usage = << 'ENDUSAGE';
  49
  50 This script processes the message queue in the message_queue database
  51 table. It sends out the messages in that queue and marks them
  52 appropriately to indicate success or failure. It is recommended that
  53 you run this regularly from cron, especially if you are using the
  54 advance_notices.pl script.
  55
  56 This script has the following parameters :
  57     -u --username: username of mail account
  58     -p --password: password of mail account
  59     -t --type: If supplied, only processes this type of message ( email, sms )
  60     -c --code: If supplied, only processes messages with this letter code
  61     -l --limit: The maximum number of messages to process for this run
  62     -m --method: authentication method required by SMTP server (See perldoc Sendmail.pm for supported authentication types.)
  63     -h --help: this message
  64     -v --verbose: provides verbose output to STDOUT
  65 ENDUSAGE
  66
  67 die $usage if $help;
  68
  69 my $script_handler = Koha::Script->new({ script => $0 });
  70
  71 try {
  72     $script_handler->lock_exec;
  73 }
  74 catch {
  75     my $message = "Skipping execution of $0 ($_)";
  76     print STDERR "$message\n"
  77         if $verbose;
  78     cronlogaction( $message );
  79     exit;
  80 };
  81
  82 cronlogaction();
  83
  84 if ( C4::Context->config("enable_plugins") ) {
  85     my @plugins = Koha::Plugins->new->GetPlugins({
  86         method => 'before_send_messages',
  87     });
  88
  89     if (@plugins) {
  90         foreach my $plugin ( @plugins ) {
  91             try {
  92                 $plugin->before_send_messages(
  93                     {
  94                         verbose     => $verbose,
  95                         limit       => $limit,
  96                         type        => $type,
  97                         letter_code => $letter_code,
  98                     }
  99                 );
 100             }
 101             catch {
 102                 warn "$_";
 103             };
 104         }
 105     }
 106 }
 107
 108 C4::Letters::SendQueuedMessages(
 109     {
 110         verbose     => $verbose,
 111         username    => $username,
 112         password    => $password,
 113         method      => $method,
 114         limit       => $limit,
 115         type        => $type,
 116         letter_code => $letter_code,
 117     }
 118 );
 119