From a44f11afc40bdfc3273710e09eb7de0d82dc928f Mon Sep 17 00:00:00 2001 From: Michael Hafen Date: Fri, 27 Jan 2023 11:14:32 -0700 Subject: [PATCH] Bug 32730: Add Patron Lists tab to patron details and circulation pages Content-Type: text/plain; charset="utf-8" Test Plan: 1. Apply patch 2. create a patron list if there aren't any 3. search for a patron 4. observe the "Patron lists" tab showing the list that the patron is not in 5. try adding the patron to the list and removing them from the list to be sure the feature has full operation 6. click "Check Out" on the side bar menu to navigate to the circulation page for this patron 7. observe the "Patron lists" tab, and verify it operates as it did on the patron details page Bug 32730: (follow-up) Minor corrections by Owen Leonard This patch corrects an instance of an incorrect capital letter ("Patron Lists" -> "Patron lists") and makes minor tweaks to indentation. --- Koha/Patron.pm | 23 ++ circ/circulation.pl | 7 +- .../prog/en/modules/circ/circulation.tt | 21 ++ .../prog/en/modules/members/moremember.tt | 21 ++ .../modules/patron_lists/patron-lists-tab.tt | 204 ++++++++++++++++++ members/moremember.pl | 2 + patron_lists/patron-lists-tab.pl | 91 ++++++++ t/db_dependent/PatronLists.t | 8 +- 8 files changed, 375 insertions(+), 2 deletions(-) create mode 100644 koha-tmpl/intranet-tmpl/prog/en/modules/patron_lists/patron-lists-tab.tt create mode 100755 patron_lists/patron-lists-tab.pl diff --git a/Koha/Patron.pm b/Koha/Patron.pm index 9a532af2f6..07b7962ea9 100644 --- a/Koha/Patron.pm +++ b/Koha/Patron.pm @@ -1452,6 +1452,29 @@ sub get_enrollable_clubs { return Koha::Clubs->get_enrollable($params); } + +=head3 get_lists_with_patron + +my @lists = $patron->get_lists_with_patron; + +=cut + +sub get_lists_with_patron { + my ( $self ) = @_; + my $borrowernumber = $self->borrowernumber; + + return Koha::Database->new()->schema()->resultset('PatronList')->search( + { + 'patron_list_patrons.borrowernumber' => $borrowernumber, + }, + { + join => 'patron_list_patrons', + collapse => 1, + order_by => 'name', + } + ); +} + =head3 account_locked my $is_locked = $patron->account_locked diff --git a/circ/circulation.pl b/circ/circulation.pl index 61065c726d..b4103968dd 100755 --- a/circ/circulation.pl +++ b/circ/circulation.pl @@ -622,7 +622,11 @@ if ( C4::Context->preference("ExportCircHistory") ) { $template->param(csv_profiles => Koha::CsvProfiles->search({ type => 'marc' })); } -my $has_modifications = Koha::Patron::Modifications->search( { borrowernumber => $borrowernumber } )->count; +my ( $has_modifications, $patron_lists_count); +if ( $patron ) { + $has_modifications = Koha::Patron::Modifications->search( { borrowernumber => $borrowernumber } )->count; + $patron_lists_count = $patron->get_lists_with_patron->count(); +} $template->param( debt_confirmed => $debt_confirmed, SpecifyDueDate => $duedatespec_allow, @@ -630,6 +634,7 @@ $template->param( todaysdate => dt_from_string()->set(hour => 23)->set(minute => 59), restriction_types => scalar Koha::Patron::Restriction::Types->search(), has_modifications => $has_modifications, + patron_lists_count => $patron_lists_count, override_high_holds => $override_high_holds, nopermission => scalar $query->param('nopermission'), autoswitched => $autoswitched, 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 ffb0a930d8..846f96ef33 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/circ/circulation.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/circ/circulation.tt @@ -894,6 +894,14 @@ [% END %] + + [% IF CAN_user_tools_manage_patron_lists || patron_lists_count %] +
  • + + Patron lists ([% patron_lists_count | html %]) + +
  • + [% END %]
    @@ -909,6 +917,12 @@
    [% END %] + [% IF CAN_user_tools_manage_patron_lists || patron_lists_count %] +
    + Loading... +
    + [% END %] + [% INCLUDE "patron-restrictions-tab.inc" %]
    @@ -1117,6 +1131,13 @@ }); } + if ( $('#pat_lists-tab').length ) { + $('#pat_lists-tab-link').on('click', function() { + $('#pat_lists-tab').text(_("Loading...")); + $('#pat_lists-tab').load('/cgi-bin/koha/patron_lists/patron-lists-tab.pl?borrowernumber=[% patron.borrowernumber | html %]'); + }); + } + // listen submit to trigger qslip on empty checkout $('#mainform').bind('submit',function() { if ($('#barcode').val() == '') { 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 9134f2cf37..6e779fde8b 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/modules/members/moremember.tt +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/members/moremember.tt @@ -738,6 +738,14 @@ [% END %] + + [% IF CAN_user_tools_manage_patron_lists || patron_lists_count %] +
  • + + Patron lists ([% patron_lists_count | html %]) + +
  • + [% END %]
    @@ -788,6 +796,12 @@
    [% END %] + [% IF CAN_user_tools_manage_patron_lists || patron_lists_count %] +
    + Loading... +
    + [% END %] + [% INCLUDE 'patron-restrictions-tab.inc' %] [% IF ( CAN_user_circulate_circulate_remaining_permissions ) %] @@ -942,6 +956,13 @@ }); } + if ( $('#pat_lists-tab').length ) { + $('#pat_lists-tab-link').on('click', function() { + $('#pat_lists-tab').text(_("Loading...")); + $('#pat_lists-tab').load('/cgi-bin/koha/patron_lists/patron-lists-tab.pl?borrowernumber=[% patron.borrowernumber | html %]'); + }); + } + $("#finesholdsissues a[data-toggle='tab']").on("shown.bs.tab", function(e){ var oTable = $('div.dataTables_wrapper > table', $(e.target.hash) ).dataTable(); if ( oTable.length > 0 ) { diff --git a/koha-tmpl/intranet-tmpl/prog/en/modules/patron_lists/patron-lists-tab.tt b/koha-tmpl/intranet-tmpl/prog/en/modules/patron_lists/patron-lists-tab.tt new file mode 100644 index 0000000000..8efe1eadc3 --- /dev/null +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/patron_lists/patron-lists-tab.tt @@ -0,0 +1,204 @@ +[% USE KohaDates %] + +[% IF no_access_to_patron %] + Patron not in your library group +[% END %] + +[% IF in_lists %] +
    +

    Patron lists with this patron

    + + + + + + + + [% IF CAN_user_tools_manage_patron_lists %] + + [% END %] + + + + + [% FOREACH l IN in_lists %] + [% SET shared_by_other = l.owner.id != logged_in_user.id %] + + + + + [% IF CAN_user_tools_manage_patron_lists %] + + [% END %] + + [% END %] + +
    NamePatrons in listSharedActions
    + [% IF CAN_user_tools_manage_patron_lists %] + [% l.name | html %] + [% ELSE %] + [% l.name | html %] + [% END %] + [% l.patron_list_patrons_rs.count || 0 | html %] + [% IF l.shared %] + [% IF shared_by_other %] + by [% INCLUDE 'patron-title.inc' patron=l.owner %] + [% ELSE %] + by you + [% END %] + [% END %] + +
    + + Actions + + +
    +
    +
    + +[% IF available_lists %] +
    +[% END %] +[% END %] + +[% IF available_lists %] +
    +

    Patron lists without this patron

    + + + + + + + + [% IF CAN_user_tools_manage_patron_lists %] + + [% END %] + + + + + [% FOREACH l IN available_lists %] + [% SET shared_by_other = l.owner.id != logged_in_user.id %] + + + + + [% IF CAN_user_tools_manage_patron_lists %] + + [% END %] + + [% END %] + +
    NamePatrons in listSharedActions
    + [% IF CAN_user_tools_manage_patron_lists %] + [% l.name | html %] + [% ELSE %] + [% l.name | html %] + [% END %] + [% l.patron_list_patrons_rs.count || 0 | html %] + [% IF l.shared %] + [% IF shared_by_other %] + by [% INCLUDE 'patron-title.inc' patron=l.owner %] + [% ELSE %] + by you + [% END %] + [% END %] + +
    + + Actions + + +
    +
    +
    +[% END %] + + diff --git a/members/moremember.pl b/members/moremember.pl index 6d5b3b2e03..daa548949b 100755 --- a/members/moremember.pl +++ b/members/moremember.pl @@ -270,6 +270,7 @@ elsif ( $patron->is_going_to_expire ) { my $has_modifications = Koha::Patron::Modifications->search( { borrowernumber => $borrowernumber } )->count; +my $patron_lists_count = $patron->get_lists_with_patron->count(); $template->param( patron => $patron, @@ -286,6 +287,7 @@ $template->param( logged_in_user => $logged_in_user, files => Koha::Patron::Files->new( borrowernumber => $borrowernumber ) ->GetFilesInfo(), has_modifications => $has_modifications, + patron_lists_count => $patron_lists_count, ); if ( C4::Context->preference('UseRecalls') ) { diff --git a/patron_lists/patron-lists-tab.pl b/patron_lists/patron-lists-tab.pl new file mode 100755 index 0000000000..ee2e749782 --- /dev/null +++ b/patron_lists/patron-lists-tab.pl @@ -0,0 +1,91 @@ +#!/usr/bin/perl + +# Copyright 2023 Washington County School District +# +# 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 . + +use Modern::Perl; + +use CGI; + +use C4::Auth qw( get_template_and_user ); +use C4::Output qw( output_html_with_http_headers ); + +use Koha::Patrons; +use Koha::List::Patron qw( GetPatronLists AddPatronsToList DelPatronsFromList ); + +my $cgi = CGI->new; + +my ( $template, $loggedinuser, $cookie, $userflags ) = get_template_and_user( + { + template_name => "patron_lists/patron-lists-tab.tt", + query => $cgi, + type => "intranet", + flagsrequired => [ { circulate => 'circulate_remaining_permissions' }, { borrowers => '*' }, { tools => 'manage_patron_lists' } ], + } +); + +my $logged_in_user = Koha::Patrons->find( { borrowernumber => $loggedinuser } ); +my $patronnumber = $cgi->param('borrowernumber'); +my $patron = Koha::Patrons->find($patronnumber); +my ( @in_lists, %list_id_lookup, @available_lists ); + +my $list_id = $cgi->param('patron_list_id'); +my @patrons_to_add = $cgi->multi_param('patrons_to_add'); +my @patrons_to_remove = $cgi->multi_param('patrons_to_remove'); + +if ( ! $logged_in_user->can_see_patron_infos($patron) ) { + $template->param('no_access_to_patron' => 1); +} +else { + my $has_perms = C4::Auth::haspermission($logged_in_user->userid, {'tools'=>'manage_patron_lists'}); + if ( $list_id && $has_perms ) { + my ($list) = GetPatronLists( { patron_list_id => $list_id } ); + + if (@patrons_to_add) { + AddPatronsToList( { list => $list, cardnumbers => \@patrons_to_add } ); + } + + if (@patrons_to_remove) { + DelPatronsFromList( { list => $list, patron_list_patrons => \@patrons_to_remove } ); + } + } + + if ( $patron ) { + @in_lists = $patron->get_lists_with_patron; + foreach my $list ( @in_lists ) { + my @existing = $list->patron_list_patrons; + for my $plp ( @existing ) { + if ( $plp->borrowernumber->borrowernumber == $patronnumber ) { + $list_id_lookup{$list->patron_list_id} = $plp->patron_list_patron_id; + last; + } + } + } + } + @available_lists = GetPatronLists(); + @available_lists = grep { ! $list_id_lookup{$_->patron_list_id} } @available_lists; +} + +$template->param( + in_lists => \@in_lists, + list_id_lookup => \%list_id_lookup, + available_lists => \@available_lists, + borrowernumber => $patronnumber, + cardnumber => $patron->cardnumber, +); + +output_html_with_http_headers( $cgi, $cookie, $template->output ); diff --git a/t/db_dependent/PatronLists.t b/t/db_dependent/PatronLists.t index 82bab67c85..b2edc8d8ff 100755 --- a/t/db_dependent/PatronLists.t +++ b/t/db_dependent/PatronLists.t @@ -17,13 +17,14 @@ use Modern::Perl; -use Test::More tests => 11; +use Test::More tests => 12; use t::lib::TestBuilder; use t::lib::Mocks; use Koha::Database; use Koha::List::Patron qw( AddPatronList AddPatronsToList DelPatronList DelPatronsFromList GetPatronLists ModPatronList ); +use Koha::Patrons; my $schema = Koha::Database->schema; $schema->storage->txn_begin; @@ -98,6 +99,11 @@ DelPatronsFromList( $list1->discard_changes(); is( $list1->patron_list_patrons()->count(), 0, 'DelPatronsFromList works.' ); +my $patron = $builder->build_object({ class => 'Koha::Patrons' }); +AddPatronsToList({list => $list2,borrowernumbers => [ $patron->borrowernumber ]}); +@lists = $patron->get_lists_with_patron; +is( scalar @lists, 1, 'get_lists_with_patron works' ); + @lists = GetPatronLists( { owner => $owner } ); is( scalar @lists, $list_count_original + 2, 'GetPatronLists works' ); -- 2.34.1