From 1637f7fbbfc2fba88000094a8e5ef6be52342550 Mon Sep 17 00:00:00 2001
From: Aleisha Amohia <aleishaamohia@hotmail.com>
Date: Tue, 14 Nov 2017 21:39:43 +0000
Subject: [PATCH] Bug 19532: Show recalls on intranet side

This patch
- adds Recall tab to the Check out section of member account, and to the
Details section of member account
- Functionality to cancel recalls on staff side
- Fixing cancel on OPAC side (before I was deleting the whole recall
instead of cancelling)
- Fixing validation when checking whether a recall can be placed on an
item that has been recalled by this borrower before. If the old recall
is expired or cancelled then they can make a recall again.

Signed-off-by: Nick Clemens <nick@bywatersolutions.com>
---
 Koha/Recall.pm                                | 26 +++++++
 circ/circulation.pl                           |  7 +-
 .../prog/en/includes/recalls.inc              | 76 +++++++++++++++++++
 .../prog/en/modules/circ/circulation.tt       |  9 +++
 .../prog/en/modules/members/moremember.tt     |  4 +
 koha-tmpl/intranet-tmpl/prog/js/recalls.js    | 29 +++++++
 members/moremember.pl                         |  8 +-
 opac/opac-recall.pl                           |  5 +-
 svc/recall                                    | 51 +++++++++++++
 9 files changed, 210 insertions(+), 5 deletions(-)
 create mode 100644 koha-tmpl/intranet-tmpl/prog/en/includes/recalls.inc
 create mode 100644 koha-tmpl/intranet-tmpl/prog/js/recalls.js
 create mode 100755 svc/recall

diff --git a/Koha/Recall.pm b/Koha/Recall.pm
index 64779c8943..dccb069651 100644
--- a/Koha/Recall.pm
+++ b/Koha/Recall.pm
@@ -123,6 +123,32 @@ sub is_requested {
     return $status && $status eq 'R';
 }
 
+=head3 is_overdue
+
+Returns true if recall is overdue
+
+=cut
+
+sub is_overdue {
+    my ($self) = @_;
+
+    my $status = $self->status;
+    return $status && $status eq 'O';
+}
+
+=head3 is_cancelled
+
+Returns true if recall is cancelled
+
+=cut
+
+sub is_cancelled {
+    my ($self) = @_;
+
+    my $status = $self->status;
+    return $status && $status eq 'C';
+}
+
 =head1 AUTHOR
 
 Aleisha Amohia <aleisha@catalyst.net.nz>
diff --git a/circ/circulation.pl b/circ/circulation.pl
index 5c858f717c..908ee6c441 100755
--- a/circ/circulation.pl
+++ b/circ/circulation.pl
@@ -56,6 +56,7 @@ use Koha::Patron::Messages;
 use Koha::SearchEngine;
 use Koha::SearchEngine::Search;
 use Koha::Patron::Modifications;
+use Koha::Recalls;
 
 use Date::Calc qw(
   Today
@@ -460,13 +461,17 @@ if (@$barcodes) {
 
 ##################################################################################
 # BUILD HTML
-# show all reserves of this borrower, and the position of the reservation ....
+# show all recalls and reserves of this borrower, and the position of the reservation ....
 if ($patron) {
     my $holds = Koha::Holds->search( { borrowernumber => $borrowernumber } ); # FIXME must be Koha::Patron->holds
     my $waiting_holds = $holds->waiting;
+
+    my $recalls = Koha::Recalls->search({ borrowernumber => $borrowernumber });
+
     $template->param(
         holds_count  => $holds->count(),
         WaitingHolds => $waiting_holds,
+        recalls => $recalls
     );
 }
 
diff --git a/koha-tmpl/intranet-tmpl/prog/en/includes/recalls.inc b/koha-tmpl/intranet-tmpl/prog/en/includes/recalls.inc
new file mode 100644
index 0000000000..9ee1342f84
--- /dev/null
+++ b/koha-tmpl/intranet-tmpl/prog/en/includes/recalls.inc
@@ -0,0 +1,76 @@
+<div id="recalls">
+[% IF recalls.count %]
+    <table id="recalls-table" class="table table-bordered table-striped">
+        <thead>
+            <tr>
+                <th class="recall-title anti-the">Title</th>
+                <th class="recall-date psort title-string">Placed on</th>
+                <th class="recall-expiry title-string">Expires on</th>
+                <th class="recall-branch">Pickup location</th>
+                <th class="recall-status">Status</th>
+                <th class="recall-cancel">Cancel</th>
+            </tr>
+        </thead>
+
+        <tbody>
+            [% FOREACH recall IN recalls %]
+                <tr>
+                    <td class="recall-title">
+                        <a class="recall-title" href="/cgi-bin/koha/catalogue/detail.pl?biblionumber=[% recall.biblionumber %]">
+                            [% recall.biblio.title %]
+                            [% FOREACH s IN recall.biblio.subtitles %]
+                                [% s %]
+                            [% END %]
+                            [% recall.item.enumchron %]
+                        </a>
+                        [% recall.biblio.author %]
+                    </td>
+
+                    <td class="recall-date">
+                        [% recall.recalldate | $KohaDates %]
+                    </td>
+
+                    <td class="recall-expiry">
+                        [% IF ( recall.is_waiting ) %]
+                            [% IF ( recall.expirationdate ) %]
+                                [% recall.expirationdate | $KohaDates %]
+                            [% ELSE %]
+                                Never expires
+                            [% END %]
+                        [% ELSIF ( recall.has_expired && recall.expirationdate ) %]
+                            [% recall.expirationdate | $KohaDates %]
+                        [% ELSE %]
+                            -
+                        [% END %]
+                    </td>
+
+                    <td class="recall-branch">
+                        [% recall.branch.branchname %]
+                    </td>
+
+                    <td class="recall-status">
+                        [% IF ( recall.is_requested ) %]
+                            Requested
+                        [% ELSIF ( recall.is_waiting ) %]
+                            Ready for pickup
+                        [% ELSIF ( recall.has_expired ) %]
+                            Expired
+                        [% END %]
+                    </td>
+
+                    <td class="recall-cancel">
+                        [% IF ( !recall.cancellationdate ) %]
+                            <a class="btn btn-sm btn-danger" id="cancel_recall" data-id="[% recall.recall_id %]"><i class="fa fa-times"></i> Cancel</a>
+                        [% ELSE %]
+                            Cancelled
+                        [% END %]
+                    </td>
+
+                </tr>
+            [% END %]
+        </tbody>
+    </table>
+    [% ELSE %]
+        Patron has no current recalls.
+    [% END %]
+</div>
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/circ/circulation.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/circ/circulation.tt
index 6700b0e581..2a5d5dc55c 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/circ/circulation.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/circ/circulation.tt
@@ -819,6 +819,10 @@ No patron matched <span class="ex">[% message | html %]</span>
         [% END %]
     </li>
 
+    [% IF recalls.count %]
+        <li><a href="#recalls" id+"recalls-tab">[% recalls.count %] Recall(s)</a></li>
+    [% END %]
+
     [% IF Koha.Preference('ArticleRequests') %]
         <li>
             <a href="#article-requests" id="article-requests-tab"> [% patron.article_requests_current.count | html %] Article requests</a>
@@ -930,6 +934,10 @@ No patron matched <span class="ex">[% message | html %]</span>
 [% END %]
 </div> <!-- reservesloop -->
 
+[% IF recalls.count %]
+    [% INCLUDE 'recalls.inc' %]
+[% END %]
+
 [% IF Koha.Preference('ArticleRequests') %]
     [% INCLUDE 'patron-article-requests.inc' %]
 [% END %]
@@ -986,6 +994,7 @@ No patron matched <span class="ex">[% message | html %]</span>
     [% Asset.js("js/checkouts.js") | $raw %]
     [% Asset.js("js/holds.js") | $raw %]
     [% Asset.js("js/circ-patron-search-results.js") | $raw %]
+    [% Asset.js("js/recalls.js") | $raw %]
     <script type="text/javascript">
         /* Set some variable needed in circulation.js */
         var MSG_DT_LOADING_RECORDS = _("Loading... you may continue scanning.");
diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/members/moremember.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/members/moremember.tt
index 6e15e3c4d1..e7a155b999 100644
--- a/koha-tmpl/intranet-tmpl/prog/en/modules/members/moremember.tt
+++ b/koha-tmpl/intranet-tmpl/prog/en/modules/members/moremember.tt
@@ -777,6 +777,9 @@
                                 [% END %]
                             </div> [% # /div#reserves %]
                         [% END %]
+                        [% IF recalls %]
+                            [% INCLUDE 'recalls.inc' %]
+                        [% END %]
 
                         [% IF Koha.Preference('ArticleRequests') %]
                             [% INCLUDE 'patron-article-requests.inc' %]
@@ -806,6 +809,7 @@
     [% INCLUDE 'str/members-menu.inc' %]
     [% Asset.js("js/members-menu.js") | $raw %]
     [% Asset.js("js/messaging-preference-form.js") | $raw %]
+    [% Asset.js("js/recalls.js") | $raw %]
     <script>
         /* Set some variable needed in circulation.js */
         var interface = "[% interface | html %]";
diff --git a/koha-tmpl/intranet-tmpl/prog/js/recalls.js b/koha-tmpl/intranet-tmpl/prog/js/recalls.js
new file mode 100644
index 0000000000..1d29668b8e
--- /dev/null
+++ b/koha-tmpl/intranet-tmpl/prog/js/recalls.js
@@ -0,0 +1,29 @@
+$(document).ready(function() {
+
+        $("#cancel_recall").click(function(e){
+            if (confirmDelete(_("Are you sure you want to remove this recall?"))){
+                var $self = $(this);
+                var $recall_id = $(this).data('id');
+                var ajaxData = {
+                    'recall_id': $recall_id,
+                };
+
+                $.ajax({
+                    url: '/cgi-bin/koha/svc/recall',
+                    type: 'POST',
+                    dataType: 'json',
+                    data: ajaxData,
+                })
+                .done(function(data) {
+                    var message = "";
+                    if(data.success == 0) {
+                        message = "The recall may have already been cancelled. Please refresh the page.";
+                    } else {
+                        message = "Cancelled"
+                    }
+                    $self.parent().html(message);
+                });
+            }
+        });
+
+});
diff --git a/members/moremember.pl b/members/moremember.pl
index 9f06882b8f..41f8b86a97 100755
--- a/members/moremember.pl
+++ b/members/moremember.pl
@@ -55,6 +55,7 @@ use Koha::AuthorisedValues;
 use Koha::CsvProfiles;
 use Koha::Patron::Debarments qw(GetDebarments);
 use Koha::Patron::Messages;
+use Koha::Recalls;
 #use Smart::Comments;
 #use Data::Dumper;
 use DateTime;
@@ -230,11 +231,14 @@ if ( $data->{dateofbirth} ) {
 
 ### ###############################################################################
 # BUILD HTML
-# show all reserves of this borrower, and the position of the reservation ....
+# show all recalls and reserves of this borrower, and the position of the reservation ....
 if ($borrowernumber) {
+    my $recalls = Koha::Recalls->search({ borrowernumber => $borrowernumber });
     $template->param(
         holds_count => Koha::Database->new()->schema()->resultset('Reserve')
-          ->count( { borrowernumber => $borrowernumber } ) );
+          ->count( { borrowernumber => $borrowernumber } ),
+        recalls => $recalls
+    );
 }
 
 # Generate CSRF token for upload and delete image buttons
diff --git a/opac/opac-recall.pl b/opac/opac-recall.pl
index 09e15d6a44..76a324cf2e 100755
--- a/opac/opac-recall.pl
+++ b/opac/opac-recall.pl
@@ -53,8 +53,9 @@ if ($op eq 'request'){
     # can't place recall if not logged in
         $error = 'notloggedin';
         print $query->redirect('/cgi-bin/koha/opac-detail.pl?biblionumber='.$item->biblionumber);
-    } elsif (defined $recalled && $recalled->borrowernumber == $borrowernumber){
+    } elsif ( defined $recalled && $recalled->borrowernumber == $borrowernumber && ($recalled->is_requested || $recalled->is_waiting || $recalled->is_overdue) ){
     # can't place a recall on an item that this borrower has already recalled
+    # if recall is expired or cancelled, user may recall again
         $error = 'duplicate';
     } else {
     # can recall
@@ -87,7 +88,7 @@ if ($op eq 'request'){
     }
 } elsif ($op eq 'cancel'){
     my $recall_id = $query->param('recall_id');
-    Koha::Recalls->find($recall_id)->delete;
+    Koha::Recalls->find($recall_id)->update({ cancellationdate => dt_from_string(), status => 'C' });
     print $query->redirect('/cgi-bin/koha/opac-user.pl');
 }
 
diff --git a/svc/recall b/svc/recall
new file mode 100755
index 0000000000..5a9c9a8bab
--- /dev/null
+++ b/svc/recall
@@ -0,0 +1,51 @@
+#!/usr/bin/perl
+
+# Copyright 2017 Aleisha Amohia <aleisha@catalyst.net.nz>
+#
+# 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, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+
+use Modern::Perl;
+
+use CGI;
+use JSON qw(encode_json);
+
+use C4::Context;
+use C4::Auth qw(check_cookie_auth);
+use C4::Output qw(output_with_http_headers);
+use Koha::Recalls;
+use Koha::DateUtils;
+
+my $input = new CGI;
+
+my ( $auth_status, $sessionID ) =
+  check_cookie_auth( $input->cookie('CGISESSID'), { circulate => 'circulate_remaining_permissions' } );
+
+if ( $auth_status ne "ok" ) {
+    print $input->header(-type => 'text/plain', -status => '403 Forbidden');
+    exit 0;
+}
+
+my $recall_id = $input->param('recall_id');
+my $recall = Koha::Recalls->find($recall_id);
+unless ($recall) {
+    my $json = encode_json( { success => 0 } );
+    output_with_http_headers( $input, undef, $json, "json" );
+    exit;
+}
+
+$recall->update({ cancellationdate => dt_from_string(), status => 'C' });
+my $json = encode_json( { success => 1 } );
+output_with_http_headers( $input, undef, $json, "json" );
-- 
2.19.1