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 my $command_line_options = join(" ",@ARGV);
  39
  40 GetOptions(
  41     'u|username:s'      => \$username,
  42     'p|password:s'      => \$password,
  43     'l|limit:s'         => \$limit,
  44     'm|method:s'        => \$method,
  45     'h|help|?'          => \$help,
  46     'v|verbose'         => \$verbose,
  47     't|type:s'          => \$type,
  48     'c|code:s'          => \$letter_code,
  49 );
  50 my $usage = << 'ENDUSAGE';
  51
  52 This script processes the message queue in the message_queue database
  53 table. It sends out the messages in that queue and marks them
  54 appropriately to indicate success or failure. It is recommended that
  55 you run this regularly from cron, especially if you are using the
  56 advance_notices.pl script.
  57
  58 This script has the following parameters :
  59     -u --username: username of mail account
  60     -p --password: password of mail account
  61     -t --type: If supplied, only processes this type of message ( email, sms )
  62     -c --code: If supplied, only processes messages with this letter code
  63     -l --limit: The maximum number of messages to process for this run
  64     -m --method: authentication method required by SMTP server (See perldoc Sendmail.pm for supported authentication types.)
  65     -h --help: this message
  66     -v --verbose: provides verbose output to STDOUT
  67 ENDUSAGE
  68
  69 die $usage if $help;
  70
  71 my $script_handler = Koha::Script->new({ script => $0 });
  72
  73 try {
  74     $script_handler->lock_exec;
  75 }
  76 catch {
  77     my $message = "Skipping execution of $0 ($_)";
  78     print STDERR "$message\n"
  79         if $verbose;
  80     cronlogaction( $message );
  81     exit;
  82 };
  83
  84 cronlogaction({ info => $command_line_options });
  85
  86 if ( C4::Context->config("enable_plugins") ) {
  87     my @plugins = Koha::Plugins->new->GetPlugins({
  88         method => 'before_send_messages',
  89     });
  90
  91     if (@plugins) {
  92         foreach my $plugin ( @plugins ) {
  93             try {
  94                 $plugin->before_send_messages(
  95                     {
  96                         verbose     => $verbose,
  97                         limit       => $limit,
  98                         type        => $type,
  99                         letter_code => $letter_code,
 100                     }
 101                 );
 102             }
 103             catch {
 104                 warn "$_";
 105             };
 106         }
 107     }
 108 }
 109
 110 C4::Letters::SendQueuedMessages(
 111     {
 112         verbose     => $verbose,
 113         username    => $username,
 114         password    => $password,
 115         method      => $method,
 116         limit       => $limit,
 117         type        => $type,
 118         letter_code => $letter_code,
 119     }
 120 );
 121
 122 cronlogaction({ action => 'End', info => "COMPLETED" });