From 22d340a2b3d35230dc27182c028cfc333e9a4696 Mon Sep 17 00:00:00 2001
From: Charles Farmer <charles.farmer@inLibro.com>
Date: Sat, 5 May 2018 22:38:37 -0400
Subject: [PATCH] Bug 12532 - Send emails to guarantee and guarantor

Checks for the syspref "RedirectGuaranteeEmail" in Koha::Patrons::notice_email_address.
When enabled, emails to a patron with a guarantor will be sent to both guarantor and guarantee.

It does not affect values in the message_queue table.

Test plan:

Before applying
1) Search, or create, a patron with guarantor
2) Enable checkout emails
3) Checkout an item. An email should be sent only to the guarantee
4) Apply this patch
5) Run updatedatabase.pl
6) Enable 'RedirectGuaranteeEmail'
7) Go through step 1) to 3). Email should now be sent to both.
8) Run t/db_dependant/Members.t

Sponsored by: Ville de Victoriaville

Bug 12532 - (follow-up) clean up
---
 C4/Letters.pm                                 |  8 +++-
 Koha/Patron.pm                                | 23 ++++++++++-
 ...g_12532-RedirectGuaranteeEmail_syspref.sql |  2 +
 installer/data/mysql/mandatory/sysprefs.sql   |  1 +
 .../en/modules/admin/preferences/patrons.pref |  6 +++
 t/db_dependent/Members.t                      | 39 ++++++++++++++++++-
 6 files changed, 74 insertions(+), 5 deletions(-)
 mode change 100644 => 100755 Koha/Patron.pm
 create mode 100644 installer/data/mysql/atomicupdate/bug_12532-RedirectGuaranteeEmail_syspref.sql

diff --git a/C4/Letters.pm b/C4/Letters.pm
index 9383b71a3f..aa2aa5f8d5 100644
--- a/C4/Letters.pm
+++ b/C4/Letters.pm
@@ -1319,14 +1319,18 @@ sub _send_message_by_email {
 
     my $patron = Koha::Patrons->find( $message->{borrowernumber} );
     my $to_address = $message->{'to_address'};
-    unless ($to_address) {
-        unless ($patron) {
+
+    my $use_garantor = C4::Context->preference('RedirectGuaranteeEmail');
+    if($use_garantor || !$to_address) {
+        unless ($patron or $to_address) {
             warn "FAIL: No 'to_address' and INVALID borrowernumber ($message->{borrowernumber})";
             _set_message_status( { message_id => $message->{'message_id'},
                                    status     => 'failed' } );
             return;
         }
+        if ($patron) {
         $to_address = $patron->notice_email_address;
+        }
         unless ($to_address) {  
             # warn "FAIL: No 'to_address' and no email for " . ($member->{surname} ||'') . ", borrowernumber ($message->{borrowernumber})";
             # warning too verbose for this more common case?
diff --git a/Koha/Patron.pm b/Koha/Patron.pm
old mode 100644
new mode 100755
index 64e8fac486..0c402ace66
--- a/Koha/Patron.pm
+++ b/Koha/Patron.pm
@@ -1231,14 +1231,33 @@ Returns the empty string if no email address.
 
 sub notice_email_address{
     my ( $self ) = @_;
+    my $address;
+    my $guarantor_address;
 
     my $which_address = C4::Context->preference("AutoEmailPrimaryAddress");
     # if syspref is set to 'first valid' (value == OFF), look up email address
     if ( $which_address eq 'OFF' ) {
-        return $self->first_valid_email_address;
+        $address = $self->first_valid_email_address;
+    } else {
+        $address = $self->$which_address || '';
     }
 
-    return $self->$which_address || '';
+    my $use_guarantor = C4::Context->preference('RedirectGuaranteeEmail');
+    if ($use_guarantor) {
+        my $guarantor = $self->guarantor;
+        if ($guarantor) {
+            if ( $which_address eq 'OFF' ) {
+                $guarantor_address = $guarantor->first_valid_email_address;
+            } else {
+                $guarantor_address = $guarantor->$which_address || '';
+            }
+            if ($address){
+                $address .= ', ';
+            }
+                $address .=  $guarantor_address if $guarantor_address;
+        }
+    }
+    return $address;
 }
 
 =head3 first_valid_email_address
diff --git a/installer/data/mysql/atomicupdate/bug_12532-RedirectGuaranteeEmail_syspref.sql b/installer/data/mysql/atomicupdate/bug_12532-RedirectGuaranteeEmail_syspref.sql
new file mode 100644
index 0000000000..e3de7b1303
--- /dev/null
+++ b/installer/data/mysql/atomicupdate/bug_12532-RedirectGuaranteeEmail_syspref.sql
@@ -0,0 +1,2 @@
+INSERT IGNORE INTO systempreferences (variable, value, explanation, options, type)
+VALUES ('RedirectGuaranteeEmail','0',NULL,'Enable the ability to redirect guarantee email messages to guarantor.','YesNo');
\ No newline at end of file
diff --git a/installer/data/mysql/mandatory/sysprefs.sql b/installer/data/mysql/mandatory/sysprefs.sql
index 2ea427bdd2..e816867d3b 100644
--- a/installer/data/mysql/mandatory/sysprefs.sql
+++ b/installer/data/mysql/mandatory/sysprefs.sql
@@ -541,6 +541,7 @@ INSERT INTO systempreferences ( `variable`, `value`, `options`, `explanation`, `
 ('RandomizeHoldsQueueWeight','0',NULL,'if ON, the holds queue in circulation will be randomized, either based on all location codes, or by the location codes specified in StaticHoldsQueueWeight','YesNo'),
 ('RecordStaffUserOnCheckout','0',NULL,'If ON, when an item is checked out, the user who checked out the item is recorded','YesNo'),
 ('RecordLocalUseOnReturn','0',NULL,'If ON, statistically record returns of unissued items as local use, instead of return','YesNo'),
+('RedirectGuaranteeEmail', '0', NULL, 'Enable the ability to redirect guarantee email messages to guarantor.', 'YesNo'),
 ('RefundLostOnReturnControl','CheckinLibrary','CheckinLibrary|ItemHomeBranch|ItemHoldingBranch','If a lost item is returned, choose which branch to pick rules for refunding.','Choice'),
 ('RenewAccruingItemWhenPaid','0','','If enabled, when the fines on an item accruing is paid off, attempt to renew that item. If the syspref "RenewalPeriodBase" is set to "due date", renewed items may still be overdue','YesNo'),
 ('RenewAccruingItemInOpac','0','','If enabled, when the fines on an item accruing is paid off in the OPAC via a payment plugin, attempt to renew that item. If the syspref "RenewalPeriodBase" is set to "due date", renewed items may still be overdue','YesNo'),
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/patrons.pref b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/patrons.pref
index b618fdfe4e..5499295133 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/patrons.pref
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/admin/preferences/patrons.pref
@@ -298,6 +298,12 @@ Patrons:
                yes: Allow
                no: "Don't allow"
          - staff to set the ability for a patron's checkouts to be viewed by linked patrons in the OPAC.
+     -
+         - pref: RedirectGuaranteeEmail
+           choices:
+               yes: Enable
+               no: Disable
+         - sending emails to both guarantees and their guarantor. This does not affect patrons without guarantors.
      -
          - pref: AllowStaffToSetFinesVisibilityForGuarantor
            choices:
diff --git a/t/db_dependent/Members.t b/t/db_dependent/Members.t
index cac634f252..a4dd0d507a 100755
--- a/t/db_dependent/Members.t
+++ b/t/db_dependent/Members.t
@@ -17,7 +17,7 @@
 
 use Modern::Perl;
 
-use Test::More tests => 48;
+use Test::More tests => 50;
 use Test::MockModule;
 use Test::Exception;
 
@@ -119,6 +119,43 @@ C4::Context->clear_syspref_cache();
 $checkcardnum=C4::Members::checkcardnumber($IMPOSSIBLE_CARDNUMBER, "");
 is ($checkcardnum, "2", "Card number is too long");
 
+# Test notice_email_address
+# Add Guarantor for testing
+my $GUARANTOR_EMAIL = "Robert\@email.com";
+%data = (
+    cardnumber => "2997924548",
+    firstname =>  "Robert",
+    surname => "Tables",
+    categorycode => $patron_category->{categorycode},
+    branchcode => $BRANCHCODE,
+    dateofbirth => '',
+    dateexpiry => '9999-12-31',
+    userid => 'bobbytables',
+    email => $GUARANTOR_EMAIL
+);
+
+$member->{guarantorid} = Koha::Patron->new(\%data)->store->borrowernumber;
+$patron->set($member)->store;
+
+$member = Koha::Patrons->find( { cardnumber => $CARDNUMBER } );
+t::lib::Mocks::mock_preference( 'RedirectGuaranteeEmail', '0' );
+t::lib::Mocks::mock_preference( 'AutoEmailPrimaryAddress', 'OFF' );
+C4::Context->clear_syspref_cache();
+
+my $notice_email = $member->notice_email_address;
+is ($notice_email, $EMAIL, "notice_email_address returns correct value when AutoEmailPrimaryAddress is off");
+
+t::lib::Mocks::mock_preference( 'AutoEmailPrimaryAddress', 'emailpro' );
+C4::Context->clear_syspref_cache();
+
+$notice_email = $member->notice_email_address;
+is ($notice_email, $EMAILPRO, "notice_email_address returns correct value when AutoEmailPrimaryAddress is emailpro");
+
+t::lib::Mocks::mock_preference( 'AutoEmailPrimaryAddress', 'OFF' );
+t::lib::Mocks::mock_preference( 'RedirectGuaranteeEmail', '1' );
+C4::Context->clear_syspref_cache();
+$notice_email = $member->notice_email_address;
+is ($notice_email, $EMAIL . ", " . $GUARANTOR_EMAIL, "notice_email_address returns correct value when RedirectGuaranteeEmail is enabled");
 
 # Add a new borrower
 %data = (
-- 
2.25.1