use Koha::Patron::Debarments;

use C4::Letters;

=head3 restrict_patron_when_notice_fails

Places a restriction (debarment) on patrons with failed SMS and email notices

restrict_patron_when_notice_fails($params);

=cut

sub restrict_patron_when_notice_fails {

    my ($self) = @_;

    # Set the appropriate restriction (debarment) comment depending if the failed

    # message is a SMS or email notice. If the failed notice is neither then

    # return without placing a restriction

    my $comment;

    if ($self->{'message_transport_type'} eq 'email') {

        $comment = 'Email address invalid';

    } elsif ($self->{'message_transport_type'} eq 'sms') {

        $comment = 'SMS number invalid';

    } else {

        return;

    }

    AddDebarment(

        {

            borrowernumber => $self->{'borrowernumber'},

            type           => 'SUSPENSION',

            comment        => $comment,

            expiration     => undef,

        }

    );

    return $self;

}

=head3 get_failed_notices

Retrieves all failed notices in the last 7 days and returns (as C4::Letters::_get_unsent_messages does) an array of matching hash

referenced rows from message_queue with some borrower information added

my $failed_notices = get_failed_notices();

=cut

sub get_failed_notices {

    my $dbh = C4::Context->dbh();

    my $statement = qq{

        SELECT mq.message_id, mq.borrowernumber, mq.subject, mq.content, mq.message_transport_type, mq.status, mq.time_queued, mq.from_address, mq.to_address, mq.content_type, b.branchcode, mq.letter_code

        FROM message_queue mq

        LEFT JOIN borrowers b ON b.borrowernumber = mq.borrowernumber

        WHERE status = ?

        AND mq.time_queued BETWEEN date_sub(now(),INTERVAL 1 WEEK) and now();

    };

    my $sth = $dbh->prepare($statement);

    my $result = $sth->execute('failed');

    return $sth->fetchall_arrayref({});

}

INSERT IGNORE INTO systempreferences (variable, value, options, explanation, type) VALUES ('RestrictPatronsWithFailedNotices', 0, "Do|Don't", 'If enabled then when SMS and email notices fail sending at the Koha level then a debarment will be applied to a patrons account', 'YesNo');

('RestrictPatronsWithFailedNotices', 0, "Do|Don't", 'If enabled then when SMS and email notices fail sending at the Koha level then a debarment will be applied to a patrons account', 'YesNo'),

    -

         - pref: RestrictPatronsWithFailedNotices

           choices:

               yes: Do

               no: "Don't"

         - "apply a restriction to a patron when their email and SMS messages fail sending at the Koha level."

         - "<br><strong>NOTE:</strong> This system preference requires the <code>misc/cronjobs/restrict_patrons_with_failed_notices.pl</code> cronjob. Ask your system administrator to schedule it."

#!/usr/bin/perl

use Modern::Perl;

use Getopt::Long;

use Pod::Usage;

use C4::Log;

use C4::Context;

use Koha::Patron::Debarments;

use Koha::Patrons;

use C4::Letters;

use Koha::Notice::Message;

# Getting options

my ($help, $verbose, $confirm, $type);

GetOptions(

    'h|help'    => \$help,

    'v|verbose' => \$verbose,

    'c|confirm' => \$confirm,

);

pod2usage(1) if $help;

$verbose = 1 unless $confirm;

if ( ! C4::Context->preference('RestrictPatronsWithFailedNotices') ) {

    warn <<'END_WARN';

The 'RestrictPatronsWithFailedNotices' syspref is off.

Therefore, it is unlikely that this script will actually place any restrictions

on patrons with failed SMS or email notices.

To change this, enable the 'RestrictPatronsWithFailedNotices' syspref.

END_WARN

}

cronlogaction();

my $failed_notices = Koha::Notice::Message::get_failed_notices();

if ( C4::Context->preference('RestrictPatronsWithFailedNotices') ) {

   if ( @$failed_notices ) {

        say "There are borrowers with failed SMS or email notices";

        foreach my $failed_notice ( @$failed_notices ) {

            # If failed notice is not a sms or email notice then skip to next failed notice

            next unless ($failed_notice->{message_transport_type} eq 'sms' || $failed_notice->{message_transport_type} eq 'email');

            # If failed sms or email notice has no recipient patron then skip to next failed

            # notice

            next unless $failed_notice->{borrowernumber};

            # Find the patron recipient of the failed SMS or email notice.

            my $patron  = Koha::Patrons->find( $failed_notice->{borrowernumber} );

            # Check if patron of failed SMS or email notice is already restricted due to having

            # this happen before. If they are already restricted due to having invalid SMS or

            # email address don't apply a new restriction (debarment) to their account.

            if ( @{ Koha::Patron::Debarments::GetDebarments({ borrowernumber => $patron->borrowernumber, comment  => 'SMS number invalid' }) } ) {

                say "Patron " . $patron->borrowernumber . ":" . " " . $patron->firstname . " " . $patron->surname . " " . "is currently restricted due to having an invalid SMS number. No new restriction applied";

                next;

            } elsif ( @{ Koha::Patron::Debarments::GetDebarments({ borrowernumber => $patron->borrowernumber, comment  => 'Email address invalid' }) }) {

                say "Patron " . $patron->borrowernumber . ":" . " " . $patron->firstname . " " . $patron->surname . " " . "is currently restricted due to having an invalid email address. No new restriction applied";

                next;

            }

            if ($confirm) {

                # Patron has not been previously restricted for having failed SMS

                # or email addresses apply a restriction now.

                say "Applying restriction to patron " . $patron->borrowernumber . ":" . " " . $patron->firstname . " " . $patron->surname;

                Koha::Notice::Message::restrict_patron_when_notice_fails($failed_notice);

            }

        }

   } else {

        say "There are no failed SMS or email notices";

   }

}

exit(0);

__END__

=head1 NAME

restrict_patrons_with_failed_notices.pl

=head1 SYNOPSIS

./restrict_patrons_with_failed_notices.pl -h

Use this script to creates a debarment for all patrons with failed SMS and email notices.

The 'RestrictPatronsWithFailedNotices' syspref must be enabled for this script to place restrictions to patrons accounts.

=head1 OPTIONS

=over 8

=item B<-h|--help>

Prints this help message

=item B<-v|--verbose>

Set the verbose flag

=item B<-c|--confirm>

The script will alter the database placing a restriction on patrons with failed SMS and email notices.

=back

=head1 AUTHOR

Alex Buckley <alexbuckley@catalyst.net.nz>

=head1 COPYRIGHT

Copyright 2019 Catalyst IT

=head1 LICENSE

This file is part of Koha.

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>.

=cut

# Test bug 23295 - Test the new subroutine Koha::Notice::Message::get_failed_notices()

my $dbh = C4::Context->dbh;

# Remove all existing messages in the message_queue

$dbh->do(q|DELETE FROM message_queue|);

# Make a patron

my $patron_category = $builder->build({ source => 'Category' })->{categorycode};

my $borrowernumber = Koha::Patron->new({

   firstname    => 'Jane',

   surname      => 'Smith',

   categorycode => $patron_category,

   branchcode   => $library->{branchcode},

   smsalertnumber => undef,

})->store->borrowernumber;

# With all notices removed from the message_queue table confirm get_failed_notices() returns 0

my $failed_notices = Koha::Notice::Message::get_failed_notices();

is( scalar @$failed_notices, 0, 'No failed notices currently exist');

# Add a failed notice to the message_queue table

$dbh->do(q|

    INSERT INTO message_queue(borrowernumber, subject, content, message_transport_type, status, letter_code)

    VALUES (?, 'subject', 'content', 'sms', 'failed', 'just_a_code')

    |, undef, $borrowernumber

);

# With one failed notice in the message_queue table confirm get_failed_notices() returns 1

my $failed_notices2 = Koha::Notice::Message::get_failed_notices();

is( scalar(@$failed_notices2), 1, 'One failed notice currently exists');

# Change failed notice status to 'pending'

$dbh->do(q|UPDATE message_queue SET status='pending'|);

# With the 1 failed notice in the message_queue table marked 'pending' confirm get_failed_notices() returns 0

my $failed_notices3 = Koha::Notice::Message::get_failed_notices();

is( scalar(@$failed_notices3), 0, 'No failed notices currently existing, now the notice has been marked pending');

# Test bug 23295 - Test the new subroutine Koha::Notice::Message::restrict_patron_when_notice_fails()

# Empty the borrower_debarments table

$dbh->do(q|DELETE FROM borrower_debarments|);

# Change the status of the notice back to 'failed'

$dbh->do(q|UPDATE message_queue SET status='failed'|);

my $failed_notices4 = Koha::Notice::Message::get_failed_notices();

# There should be one failed notice

if (@$failed_notices4) {

    # Restrict the borrower who has the failed notice

    foreach my $failed_notice (@$failed_notices4) {

        if ($failed_notice->{message_transport_type} eq 'sms' || $failed_notice->{message_transport_type} eq 'email') {

            Koha::Notice::Message::restrict_patron_when_notice_fails($failed_notice);

        }

    }

}

# Confirm that the restrict_patron_when_notice_fails() has added a restriction to the patron

is(@{ Koha::Patron::Debarments::GetDebarments({ borrowernumber => $borrowernumber, comment  => 'SMS number invalid' })}, 1, "Patron has a restriction placed on them");

# Restrict the borrower who has the failed notice

foreach my $failed_notice (@$failed_notices4) {

    if ($failed_notice->{message_transport_type} eq 'sms' || $failed_notice->{message_transport_type} eq 'email') {

        # If the borrower already has a debarment for failed SMS or email notice then don't apply

        # a new debarment to their account

        if ( @{ Koha::Patron::Debarments::GetDebarments({ borrowernumber => $borrowernumber, comment  => 'SMS number invalid' }) } ) {

            next;

        } elsif ( @{ Koha::Patron::Debarments::GetDebarments({ borrowernumber => $borrowernumber, comment  => 'Email address invalid' }) }) {

            next;

        }

        # Place the debarment if the borrower doesn't already have one for failed SMS or email

        # notice

        Koha::Notice::Message::restrict_patron_when_notice_fails($failed_notice);

    }

}

# Confirm that no new debarment is added to the borrower

is(@{ Koha::Patron::Debarments::GetDebarments({ borrowernumber => $borrowernumber, comment  => 'SMS number invalid' })}, 1, "No new restriction has been placed on the patron");