From 3324486d96126778d85691df0a75a26214522a9d Mon Sep 17 00:00:00 2001
From: Kyle Hall <kyle@bywatersolutions.com>
Date: Thu, 10 Feb 2022 12:19:22 -0500
Subject: [PATCH] Bug 30076: Add ability to check patron messaging preferences
from a notice
Some libraries want to be able to use a patron's messaging preferences to conditionally change the contents of a notice depending on the patron's other messaging preference. For example, a library has requested to have the note on the hold slip if the patron has requested phone messages for waiting holds. This really only entails adding a method to the Koha::Patron class to allow this type of looking.
Test plan:
1) Apply this patch
2) Enable item checkout notices for a patron for email, but not sms
3) Include the following in the notice:
TEST1: [% borrower.has_messaging_preference({ message_name => 'Item_Checkout', message_transport_type => 'email' }) %]
<br/>
TEST2: [% borrower.has_messaging_preference({ message_name => 'Item_Checkout', message_transport_type => 'sms' }) %]
4) Generate a checkout and notice for that patron
5) Note the generated notice has a 1 for TEST1, but not for TEST2
---
Koha/Patron.pm | 27 ++++++
t/db_dependent/Patron/Messaging.t | 137 ++++++++++++++++++++++++++++++
2 files changed, 164 insertions(+)
create mode 100755 t/db_dependent/Patron/Messaging.t
diff --git a/Koha/Patron.pm b/Koha/Patron.pm
index ddf4ebe5bbb..30aa3ec2ce8 100644
--- a/Koha/Patron.pm
+++ b/Koha/Patron.pm
@@ -2047,6 +2047,33 @@ sub safe_to_delete {
return Koha::Result::Boolean->new(1);
}
+=head3 has_messaging_preference
+
+my $bool = $patron->has_messaging_preference({
+ message_name => $message_name, # A value from message_attributes.message_name
+ message_transport_type => $message_transport_type, # email, sms, phone, itiva, etc...
+ wants_digest => $wants_digest, # 1 if you are looking for the digest version, don't pass if you just want either
+});
+
+=cut
+
+sub has_messaging_preference {
+ my ( $self, $params ) = @_;
+
+ my $message_name = $params->{message_name};
+ my $message_transport_type = $params->{message_transport_type};
+ my $wants_digest = $params->{wants_digest};
+
+ return $self->_result->search_related_rs(
+ 'borrower_message_preferences',
+ $params,
+ {
+ prefetch =>
+ [ 'borrower_message_transport_preferences', 'message_attribute' ]
+ }
+ )->count;
+}
+
=head2 Internal methods
=head3 _type
diff --git a/t/db_dependent/Patron/Messaging.t b/t/db_dependent/Patron/Messaging.t
new file mode 100755
index 00000000000..14a1f49164c
--- /dev/null
+++ b/t/db_dependent/Patron/Messaging.t
@@ -0,0 +1,137 @@
+#!/usr/bin/perl
+#
+# This file is part of Koha.
+#
+# Copyright (C) 2018 Andreas Jonsson <andreas.jonsson@kreablo.se>
+#
+# Koha is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
+#
+# Koha is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
+#
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
+
+use Modern::Perl;
+
+use Test::More tests => 1;
+use t::lib::TestBuilder;
+use t::lib::Mocks;
+use File::Spec;
+use File::Basename;
+
+use Koha::DateUtils qw( dt_from_string );
+
+my $schema = Koha::Database->new->schema;
+my $dbh = C4::Context->dbh;
+
+my $library;
+my $borrower;
+
+subtest 'Default behaviour tests' => sub {
+
+ plan tests => 3;
+
+ $schema->storage->txn_begin;
+
+ # Set only to avoid exception.
+ t::lib::Mocks::mock_preference( 'dateformat', 'metric' );
+
+ my $builder = t::lib::TestBuilder->new;
+
+ $library = $builder->build(
+ {
+ source => 'Branch',
+ }
+ );
+
+ $borrower = $builder->build(
+ {
+ source => 'Borrower',
+ value => {
+ branchcode => $library->{branchcode},
+ }
+ }
+ );
+
+ $dbh->do(<<DELETESQL);
+DELETE FROM letter
+ WHERE module='circulation'
+ AND code = 'PREDUEDGST'
+ AND message_transport_type='email'
+ AND branchcode=''
+DELETESQL
+
+ $dbh->do(<<DELETESQL);
+DELETE FROM message_attributes WHERE message_name = 'Advance_Notice'
+DELETESQL
+
+ my $message_attribute = $builder->build(
+ {
+ source => 'MessageAttribute',
+ value => {
+ message_name => 'Advance_Notice'
+ }
+ }
+ );
+
+ my $letter = $builder->build(
+ {
+ source => 'Letter',
+ value => {
+ module => 'circulation',
+ code => 'PREDUEDGST',
+ branchcode => '',
+ message_transport_type => 'email',
+ lang => 'default',
+ is_html => 0,
+ content => '<<count>> <<branches.branchname>>'
+ }
+ }
+ );
+ my $borrower_message_preference = $builder->build(
+ {
+ source => 'BorrowerMessagePreference',
+ value => {
+ borrowernumber => $borrower->{borrowernumber},
+ wants_digest => 1,
+ days_in_advance => 1,
+ message_attribute_id =>
+ $message_attribute->{message_attribute_id}
+ }
+ }
+ );
+
+ my $borrower_message_transport_preference = $builder->build(
+ {
+ source => 'BorrowerMessageTransportPreference',
+ value => {
+ borrower_message_preference_id => $borrower_message_preference
+ ->{borrower_message_preference_id},
+ message_transport_type => 'email'
+ }
+ }
+ );
+
+ my $borrower_message_transport_preference_1 = $builder->build(
+ {
+ source => 'BorrowerMessageTransportPreference',
+ value => {
+ borrower_message_preference_id => $borrower_message_preference
+ ->{borrower_message_preference_id},
+ message_transport_type => 'phone'
+ }
+ }
+ );
+
+ my $patron = Koha::Patrons->find( $borrower->{borrowernumber} );
+
+ is( $patron->has_messaging_preference({ message_name => 'Advance_Notice', message_transport_type => 'email' }), 1, "Patron has Advance_Notice email preference" );
+ is( $patron->has_messaging_preference({ message_name => 'Advance_Notice', message_transport_type => 'phone' }), 1, "Patron has Advance_Notice phone preference" );
+ is( $patron->has_messaging_preference({ message_name => 'Advance_Notice', message_transport_type => 'sms' }), 0, "Patron has no Advance_Notice sms preference" );
+};
--
2.30.2