From 0f122a940078ed5be92d358d5c0d9c5883c1e7c5 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 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. Signed-off-by: Stina Hallin Signed-off-by: Kyle M Hall Edit: (tcohen) new files should be run through perltidy ALWAYS. Did it and squashed it here. Signed-off-by: Tomas Cohen Arazi --- Koha/Patron.pm | 23 +++ circ/circulation.pl | 7 +- .../prog/en/includes/patron-detail-tabs.inc | 12 ++ .../modules/patron_lists/patron-lists-tab.tt | 136 ++++++++++++++++++ .../prog/js/pages/circulation.js | 7 + members/moremember.pl | 2 + patron_lists/patron-lists-tab.pl | 92 ++++++++++++ t/db_dependent/PatronLists.t | 8 +- 8 files changed, 285 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 e5a2798bc1..5a71b56c03 100644 --- a/Koha/Patron.pm +++ b/Koha/Patron.pm @@ -1642,6 +1642,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 d68eb1ce5f..7f8c0ef080 100755 --- a/circ/circulation.pl +++ b/circ/circulation.pl @@ -638,7 +638,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, @@ -646,6 +650,7 @@ $template->param( today_due_date_and_time => 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/includes/patron-detail-tabs.inc b/koha-tmpl/intranet-tmpl/prog/en/includes/patron-detail-tabs.inc index 78ce636879..ba4fd3ee26 100644 --- a/koha-tmpl/intranet-tmpl/prog/en/includes/patron-detail-tabs.inc +++ b/koha-tmpl/intranet-tmpl/prog/en/includes/patron-detail-tabs.inc @@ -77,6 +77,12 @@ Clubs ([% enrollments.count | html %]/[% enrollable.count | html %]) [% END %] [% END %] + + [% IF CAN_user_tools_manage_patron_lists || patron_lists_count %] + [% WRAPPER tab_item tabname="pat_lists" %] + Patron lists ([% patron_lists_count | html %]) + [% END %] + [% END %] [% END # /WRAPPER tabs_nav %] @@ -130,6 +136,12 @@ [% END # /tab_panel# %] [% END %] + [% IF CAN_user_tools_manage_patron_lists || patron_lists_count %] + [% WRAPPER tab_panel tabname="pat_lists" %] + Loading... + [% END # /tab_panel# %] + [% END %] + [% WRAPPER tab_panel tabname="reldebarments" %] [% INCLUDE 'patron-restrictions-tab.inc' %] [% END # /tab_panel# %] 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..5739762977 --- /dev/null +++ b/koha-tmpl/intranet-tmpl/prog/en/modules/patron_lists/patron-lists-tab.tt @@ -0,0 +1,136 @@ +[% 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 && CAN_user_tools_manage_patron_lists %] +
+ Add patron to list + + +
+[% END %] + + diff --git a/koha-tmpl/intranet-tmpl/prog/js/pages/circulation.js b/koha-tmpl/intranet-tmpl/prog/js/pages/circulation.js index d05d87b5bc..574f3f90a2 100644 --- a/koha-tmpl/intranet-tmpl/prog/js/pages/circulation.js +++ b/koha-tmpl/intranet-tmpl/prog/js/pages/circulation.js @@ -99,6 +99,13 @@ $(document).ready(function() { $('#clubs_panel').load('/cgi-bin/koha/clubs/patron-clubs-tab.pl?borrowernumber=' + borrowernumber ); }); } + + if ( $('#pat_lists_panel').length ) { + $('#pat_lists-tab').on('click', function() { + $('#pat_lists_panel').text(_("Loading...")); + $('#pat_lists_panel').load('/cgi-bin/koha/patron_lists/patron-lists-tab.pl?borrowernumber=' + borrowernumber ); + }); + } }); function export_checkouts(format) { diff --git a/members/moremember.pl b/members/moremember.pl index 9770364804..7a419e9fb9 100755 --- a/members/moremember.pl +++ b/members/moremember.pl @@ -287,6 +287,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, @@ -303,6 +304,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..c7c3e2a5f2 --- /dev/null +++ b/patron_lists/patron-lists-tab.pl @@ -0,0 +1,92 @@ +#!/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.39.5