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 BEGIN {
  23     # find Koha's Perl modules
  24     # test carefully before changing this
  25     use FindBin;
  26     eval { require "$FindBin::Bin/../kohalib.pl" };
  27 }
  28
  29 use Koha::Script -cron;
  30 use C4::Letters;
  31 use C4::Log;
  32 use Getopt::Long;
  33 use Try::Tiny;
  34
  35 my $username = undef;
  36 my $password = undef;
  37 my $limit    = undef;
  38 my $method = 'LOGIN';
  39 my $help = 0;
  40 my $verbose = 0;
  41 my $type = q{};
  42 my $letter_code;
  43
  44 GetOptions(
  45     'u|username:s'      => \$username,
  46     'p|password:s'      => \$password,
  47     'l|limit:s'         => \$limit,
  48     'm|method:s'        => \$method,
  49     'h|help|?'          => \$help,
  50     'v|verbose'         => \$verbose,
  51     't|type:s'          => \$type,
  52     'c|code:s'          => \$letter_code,
  53 );
  54 my $usage = << 'ENDUSAGE';
  55
  56 This script processes the message queue in the message_queue database
  57 table. It sends out the messages in that queue and marks them
  58 appropriately to indicate success or failure. It is recommended that
  59 you run this regularly from cron, especially if you are using the
  60 advance_notices.pl script.
  61
  62 This script has the following parameters :
  63     -u --username: username of mail account
  64     -p --password: password of mail account
  65     -t --type: If supplied, only processes this type of message ( email, sms )
  66     -c --code: If supplied, only processes messages with this letter code
  67     -l --limit: The maximum number of messages to process for this run
  68     -m --method: authentication method required by SMTP server (See perldoc Sendmail.pm for supported authentication types.)
  69     -h --help: this message
  70     -v --verbose: provides verbose output to STDOUT
  71 ENDUSAGE
  72
  73 die $usage if $help;
  74
  75 cronlogaction();
  76
  77 if ( C4::Context->config("enable_plugins") ) {
  78     my @plugins = Koha::Plugins->new->GetPlugins({
  79         method => 'before_send_messages',
  80     });
  81
  82     if (@plugins) {
  83         foreach my $plugin ( @plugins ) {
  84             try {
  85                 $plugin->before_send_messages();
  86             }
  87             catch {
  88                 warn "$_";
  89             };
  90         }
  91     }
  92 }
  93
  94 C4::Letters::SendQueuedMessages(
  95     {
  96         verbose     => $verbose,
  97         username    => $username,
  98         password    => $password,
  99         method      => $method,
 100         limit       => $limit,
 101         type        => $type,
 102         letter_code => $letter_code,
 103     }
 104 );
 105