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