Attachment 173430 Details for Bug 37869 – Bug 37869: Move plugin hook before_send_messages to SendQueuedMessages

[patch] Bug 37869: Move plugin hook before_send_messages to SendQueuedMessages

Bug-37869-Move-plugin-hook-beforesendmessages-to-S.patch (text/plain), 3.61 KB, created by Martin Renvoize (ashimema) on 2024-10-28 08:13:09 UTC

(hide)

Description:

Filename:

MIME Type:

Creator: Martin Renvoize (ashimema)

Created: 2024-10-28 08:13:09 UTC

Size: 3.61 KB

patch

obsolete

>From b0cb7e89ad4bddffb2211273b5bb6980d2d43a47 Mon Sep 17 00:00:00 2001
>From: Kyle M Hall <kyle@bywatersolutions.com>
>Date: Mon, 9 Sep 2024 14:18:07 +0000
>Subject: [PATCH] Bug 37869: Move plugin hook before_send_messages to
> SendQueuedMessages
>
>Most messages in Koha are handled by process_message_queue.pl. This script calls before_send_messages which calls the plugin hook before_send_messages. This works for nearly all messages, but some messages like WELCOME notices are triggered immediately and do not way to for process_message_queue.pl to run. We should move the triggering of before_send_messages into SendQueuedMessages so it is always handled.
>
>Test Plan:
>1) Install version 2.5.1 of the kitchen sink plugin
>2) Run process_messsage_queue.pl and also trigger a WELCOME notice
>3) Note the "Plugin hook before_send_message called with the params" message in the logs for the former but not the latter
>4) Apply this patch
>5) Repeat step 2, note there the message also shows in the logs for the WELCOME notice!
>
>Signed-off-by: David Nind <david@davidnind.com>
>Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
>---
> C4/Letters.pm                          | 18 +++++++++++++++++
> misc/cronjobs/process_message_queue.pl | 27 +-------------------------
> 2 files changed, 19 insertions(+), 26 deletions(-)
>
>diff --git a/C4/Letters.pm b/C4/Letters.pm
>index 7bdbfc9bf24..4fb28fdcce3 100644
>--- a/C4/Letters.pm
>+++ b/C4/Letters.pm
>@@ -1021,6 +1021,24 @@ sub SendQueuedMessages {
>     Koha::Exceptions::BadParameter->throw("Parameter message_id cannot be empty if passed.")
>         if ( exists( $params->{message_id} ) && !$params->{message_id} );
> 
>+    if ( C4::Context->config("enable_plugins") ) {
>+        my @plugins = Koha::Plugins->new->GetPlugins({
>+            method => 'before_send_messages',
>+        });
>+
>+        if (@plugins) {
>+            foreach my $plugin ( @plugins ) {
>+                try {
>+                    $plugin->before_send_messages($params);
>+                }
>+                catch {
>+                    warn "$_";
>+                    exit 1 if $params->{exit_on_plugin_failure};
>+                };
>+            }
>+        }
>+    }
>+
>     my $smtp_transports = {};
> 
>     my $count_messages = 0;
>diff --git a/misc/cronjobs/process_message_queue.pl b/misc/cronjobs/process_message_queue.pl
>index 0c4ff176f7e..031b965fe4e 100755
>--- a/misc/cronjobs/process_message_queue.pl
>+++ b/misc/cronjobs/process_message_queue.pl
>@@ -92,32 +92,6 @@ cronlogaction({ info => $command_line_options });
> # Remove empty elements, see bug 37075
> @letter_code = grep { $_ ne q{} } @letter_code;
> 
>-if ( C4::Context->config("enable_plugins") ) {
>-    my @plugins = Koha::Plugins->new->GetPlugins({
>-        method => 'before_send_messages',
>-    });
>-
>-    if (@plugins) {
>-        foreach my $plugin ( @plugins ) {
>-            try {
>-                $plugin->before_send_messages(
>-                    {
>-                        verbose     => $verbose,
>-                        limit       => $limit,
>-                        type        => \@type,
>-                        letter_code => \@letter_code,
>-                        where       => $where,
>-                    }
>-                );
>-            }
>-            catch {
>-                warn "$_";
>-                exit 1 if $exit_on_plugin_failure;
>-            };
>-        }
>-    }
>-}
>-
> C4::Letters::SendQueuedMessages(
>     {
>         verbose     => $verbose,
>@@ -128,6 +102,7 @@ C4::Letters::SendQueuedMessages(
>         type        => \@type,
>         letter_code => \@letter_code,
>         where       => $where,
>+        exit_on_plugin_failure => $exit_on_plugin_failure,
>     }
> );
> 
>-- 
>2.47.0

Actions: View | Diff | Splinter Review

Attachments on bug 37869: 171217 | 171218 | 172323 | 172324 | 172325 | 173072 | 173073 | 173074 | 173429 | 173430 | 173431