Jonathan Druart
19a977dc7b
This is the fourth and last patch set to remove C4::Branch. The real purpose of this patch is to standardise and refactor some code which is related to the libraries selection/display. Its unconfessed purpose is to remove the C4::Branch package. Before this patch set, only 6 subroutines still existed in the C4::Branch package: - GetBranchName - GetBranchesLoop - mybranch - onlymine - GetBranches - GetBranch GetBranchName basically returns the branchname for a given branchcode. The branchname is only used for a display purpose and we don't need to retrieve it in package or pl scripts (unless for a few exceptions). We have a `Branches` template plugin with a `GetName` method which does exactly this job. To achieve this removal, we will use this template plugin and delete the GetBranchName from pl and pm files. The `Branches.all()` will now select the library of the logged in user if no `selected` parameter has been passed. This new behavior could cause regressions, for instance there are some places where we do not want an option preselected (batch item modification for instance), keep that in mind when testing. GetBranchesLoop took 3 parameters: $branch and $onlymine. The first one was used to set a "selected" flag, for a display purpose: select an option in the libraries dropdown lists. The second one was useless: If not passed or set to 0, the `C4::Branch::onlymine` subroutine was called. This onlymine flag was use to know if the logged in user was able to see other libraries infos. A patron can see the infos from other libraries if IndependentBranches is not set OR if he has the superlibrarian permission. Prior to this patch set, the "onlymine test" was done on different places (neworderempty.pl, additem.pl, holidays.pl, etc.), including the Branches TT plugin. In this patch set, this test is only done on one place (C4::Context::only_my_library, code moved from C4::Branch::onlymine). To accomplish the same job as this subroutine, we just need to call the `Branches.all()` method from the `Branches` TT plugin. It already accepts a `selected` parameter to set a flag on the option to select. To avoid the repetitive [% IF selected %]<option selected="selected">[% ELSE %]<option>[% END %] pattern, a new `html_helpers` TT include file has been created, it defines an `options_for_libraries` block, which takes a `selected` parameter. We could imagine to use this include file for other selects. The 'mybranch` and `onlymine` subroutines of the C4::Branch package have been moved to C4::Context. onlymine has been renamed with only_my_library. There are only 4 occurrences of it, against 11 before this patch set. There 2 subroutines are Context-centric and it makes sense to put them in `C4::Context` (at least it's the least worst place!) GetBranches is the tricky part of this patch set: It retrieves all the libraries, independently of the value of IndependentBranches. To keep the same way as the existing calls of `Branches.all()`, I have added a `unfiltered` parameter. If set, the `Branches.all()` will call a usual Koha::Libraries->search method, otherwise Koha::Libraries->search_filtered will be called. This new method will check if the logged in user is allowed to see other libraries or only its library. Note that this `GetBranches` subroutine also created a `category` key: it allowed to get the list of groups (of libraries) where this library existed. Thanks to a previous patch set (bug 15295), this value was not used anymore (I may have missed something!). Note that the only use of `GetBranch` was buggy (see bug 15746). Test plan (for the whole patch set): The best way to test this whole patch set is to test with 2 instances: 1 with the patch set applied, 1 using master, to be sure there is no regression. It would be good to test the same with `IndependentBranches` and the without `IndependentBranches`. No difference should be found. The tester must focus on the library dropdowns on as many forms as possible. You will notice changes in the order of the options: the libraries will now be ordered by branchname (instead of branchcode in some places). A special attention will be given to the following page: - acqui/neworderempty.pl - catalogue/search.pl - members/members-home.pl (header?) - opac/opac-topissues.pl - tools/holidays.pl - admin/branch_transfer_limits.pl - admin/item_circulation_alerts.pl - rotating_collections/transferCollection.pl - suggestion/suggestion.pl - tools/export.pl Notes for QA: - There are 2 FIXMEs in the patch set, I have kept the existing behavior, but I am not sure it's the good one. Feel free to open a bug report and I will fill a patch if you think it's not correct. Otherwise, remove the FIXME lines in a follow-up patch. - The whole patch set is huge and makes a lot of changes. But it finally will tremendously reduce the number of lines: 716 insertions for 1910 deletions Signed-off-by: Owen Leonard <oleonard@myacpl.org> Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
384 lines
14 KiB
Perl
Executable file
384 lines
14 KiB
Perl
Executable file
#!/usr/bin/perl
|
|
|
|
# Copyright 2012 BibLibre
|
|
#
|
|
# 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>.
|
|
|
|
# modborrowers.pl
|
|
#
|
|
# Batch Edit Patrons
|
|
# Modification for patron's fields:
|
|
# surname firstname branchcode categorycode city state zipcode country sort1
|
|
# sort2 dateenrolled dateexpiry borrowernotes
|
|
# And for patron attributes.
|
|
|
|
use Modern::Perl;
|
|
use CGI qw ( -utf8 );
|
|
use C4::Auth;
|
|
use C4::Branch;
|
|
use C4::Koha;
|
|
use C4::Members;
|
|
use C4::Members::Attributes;
|
|
use C4::Members::AttributeTypes qw/GetAttributeTypes_hashref/;
|
|
use C4::Output;
|
|
use List::MoreUtils qw /any uniq/;
|
|
use Koha::DateUtils qw( dt_from_string );
|
|
use Koha::List::Patron;
|
|
use Koha::Patron::Categories;
|
|
|
|
my $input = new CGI;
|
|
my $op = $input->param('op') || 'show_form';
|
|
my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
|
|
{ template_name => "tools/modborrowers.tt",
|
|
query => $input,
|
|
type => "intranet",
|
|
authnotrequired => 0,
|
|
flagsrequired => { tools => "edit_patrons" },
|
|
}
|
|
);
|
|
|
|
my %cookies = parse CGI::Cookie($cookie);
|
|
my $sessionID = $cookies{'CGISESSID'}->value;
|
|
my $dbh = C4::Context->dbh;
|
|
|
|
# Show borrower informations
|
|
if ( $op eq 'show' ) {
|
|
my $filefh = $input->upload('uploadfile');
|
|
my $filecontent = $input->param('filecontent');
|
|
my $patron_list_id = $input->param('patron_list_id');
|
|
my @borrowers;
|
|
my @cardnumbers;
|
|
my @notfoundcardnumbers;
|
|
|
|
# Get cardnumbers from a file or the input area
|
|
my @contentlist;
|
|
if ($filefh) {
|
|
while ( my $content = <$filefh> ) {
|
|
$content =~ s/[\r\n]*$//g;
|
|
push @cardnumbers, $content if $content;
|
|
}
|
|
} elsif ( $patron_list_id ) {
|
|
my ($list) = GetPatronLists( { patron_list_id => $patron_list_id } );
|
|
|
|
@cardnumbers =
|
|
$list->patron_list_patrons()->search_related('borrowernumber')
|
|
->get_column('cardnumber')->all();
|
|
|
|
} else {
|
|
if ( my $list = $input->param('cardnumberlist') ) {
|
|
push @cardnumbers, split( /\s\n/, $list );
|
|
}
|
|
}
|
|
|
|
my $max_nb_attr = 0;
|
|
for my $cardnumber ( @cardnumbers ) {
|
|
my $borrower = GetBorrowerInfos( cardnumber => $cardnumber );
|
|
if ( $borrower ) {
|
|
$max_nb_attr = scalar( @{ $borrower->{patron_attributes} } )
|
|
if scalar( @{ $borrower->{patron_attributes} } ) > $max_nb_attr;
|
|
push @borrowers, $borrower;
|
|
} else {
|
|
push @notfoundcardnumbers, $cardnumber;
|
|
}
|
|
}
|
|
|
|
# Just for a correct display
|
|
for my $borrower ( @borrowers ) {
|
|
my $length = scalar( @{ $borrower->{patron_attributes} } );
|
|
push @{ $borrower->{patron_attributes} }, {} for ( $length .. $max_nb_attr - 1);
|
|
}
|
|
|
|
# Construct the patron attributes list
|
|
my @patron_attributes_values;
|
|
my @patron_attributes_codes;
|
|
my $patron_attribute_types = C4::Members::AttributeTypes::GetAttributeTypes_hashref('all');
|
|
my @patron_categories = Koha::Patron::Categories->search_limited({}, {order_by => ['description']});
|
|
for ( values %$patron_attribute_types ) {
|
|
my $attr_type = C4::Members::AttributeTypes->fetch( $_->{code} );
|
|
# TODO Repeatable attributes are not correctly managed and can cause data lost.
|
|
# This should be implemented.
|
|
next if $attr_type->{repeatable};
|
|
next if $attr_type->{unique_id}; # Don't display patron attributes that must be unqiue
|
|
my $options = $attr_type->authorised_value_category
|
|
? GetAuthorisedValues( $attr_type->authorised_value_category )
|
|
: undef;
|
|
push @patron_attributes_values,
|
|
{
|
|
attribute_code => $_->{code},
|
|
options => $options,
|
|
};
|
|
|
|
my $category_code = $_->{category_code};
|
|
my ( $category_lib ) = map {
|
|
( defined $category_code and $_->categorycode eq $category_code ) ? $_->description : ()
|
|
} @patron_categories;
|
|
push @patron_attributes_codes,
|
|
{
|
|
attribute_code => $_->{code},
|
|
attribute_lib => $_->{description},
|
|
category_lib => $category_lib,
|
|
type => $attr_type->authorised_value_category ? 'select' : 'text',
|
|
};
|
|
}
|
|
|
|
my @attributes_header = ();
|
|
for ( 1 .. scalar( $max_nb_attr ) ) {
|
|
push @attributes_header, { attribute => "Attributes $_" };
|
|
}
|
|
$template->param( borrowers => \@borrowers );
|
|
$template->param( attributes_header => \@attributes_header );
|
|
@notfoundcardnumbers = map { { cardnumber => $_ } } @notfoundcardnumbers;
|
|
$template->param( notfoundcardnumbers => \@notfoundcardnumbers )
|
|
if @notfoundcardnumbers;
|
|
|
|
# Construct drop-down list values
|
|
my $branches = GetBranchesLoop;
|
|
my @branches_option;
|
|
push @branches_option, { value => $_->{value}, lib => $_->{branchname} } for @$branches;
|
|
unshift @branches_option, { value => "", lib => "" };
|
|
my @categories_option;
|
|
push @categories_option, { value => $_->categorycode, lib => $_->description } for @patron_categories;
|
|
unshift @categories_option, { value => "", lib => "" };
|
|
my $bsort1 = GetAuthorisedValues("Bsort1");
|
|
my @sort1_option;
|
|
push @sort1_option, { value => $_->{authorised_value}, lib => $_->{lib} } for @$bsort1;
|
|
unshift @sort1_option, { value => "", lib => "" }
|
|
if @sort1_option;
|
|
my $bsort2 = GetAuthorisedValues("Bsort2");
|
|
my @sort2_option;
|
|
push @sort2_option, { value => $_->{authorised_value}, lib => $_->{lib} } for @$bsort2;
|
|
unshift @sort2_option, { value => "", lib => "" }
|
|
if @sort2_option;
|
|
|
|
my @mandatoryFields = split( /\|/, C4::Context->preference("BorrowerMandatoryField") );
|
|
|
|
my @fields = (
|
|
{
|
|
name => "surname",
|
|
type => "text",
|
|
mandatory => ( grep /surname/, @mandatoryFields ) ? 1 : 0
|
|
}
|
|
,
|
|
{
|
|
name => "firstname",
|
|
type => "text",
|
|
mandatory => ( grep /firstname/, @mandatoryFields ) ? 1 : 0,
|
|
}
|
|
,
|
|
{
|
|
name => "branchcode",
|
|
type => "select",
|
|
option => \@branches_option,
|
|
mandatory => ( grep /branchcode/, @mandatoryFields ) ? 1 : 0,
|
|
}
|
|
,
|
|
{
|
|
name => "categorycode",
|
|
type => "select",
|
|
option => \@categories_option,
|
|
mandatory => ( grep /categorycode/, @mandatoryFields ) ? 1 : 0,
|
|
}
|
|
,
|
|
{
|
|
name => "city",
|
|
type => "text",
|
|
mandatory => ( grep /city/, @mandatoryFields ) ? 1 : 0,
|
|
}
|
|
,
|
|
{
|
|
name => "state",
|
|
type => "text",
|
|
mandatory => ( grep /state/, @mandatoryFields ) ? 1 : 0,
|
|
}
|
|
,
|
|
{
|
|
name => "zipcode",
|
|
type => "text",
|
|
mandatory => ( grep /zipcode/, @mandatoryFields ) ? 1 : 0,
|
|
}
|
|
,
|
|
{
|
|
name => "country",
|
|
type => "text",
|
|
mandatory => ( grep /country/, @mandatoryFields ) ? 1 : 0,
|
|
}
|
|
,
|
|
{
|
|
name => "sort1",
|
|
type => @sort1_option ? "select" : "text",
|
|
option => \@sort1_option,
|
|
mandatory => ( grep /sort1/, @mandatoryFields ) ? 1 : 0,
|
|
}
|
|
,
|
|
{
|
|
name => "sort2",
|
|
type => @sort2_option ? "select" : "text",
|
|
option => \@sort2_option,
|
|
mandatory => ( grep /sort2/, @mandatoryFields ) ? 1 : 0,
|
|
}
|
|
,
|
|
{
|
|
name => "dateenrolled",
|
|
type => "date",
|
|
mandatory => ( grep /dateenrolled/, @mandatoryFields ) ? 1 : 0,
|
|
}
|
|
,
|
|
{
|
|
name => "dateexpiry",
|
|
type => "date",
|
|
mandatory => ( grep /dateexpiry/, @mandatoryFields ) ? 1 : 0,
|
|
}
|
|
,
|
|
{
|
|
name => "borrowernotes",
|
|
type => "text",
|
|
mandatory => ( grep /borrowernotes/, @mandatoryFields ) ? 1 : 0,
|
|
}
|
|
,
|
|
{
|
|
name => "opacnote",
|
|
type => "text",
|
|
mandatory => ( grep /opacnote/, @mandatoryFields ) ? 1 : 0,
|
|
}
|
|
);
|
|
|
|
$template->param('patron_attributes_codes', \@patron_attributes_codes);
|
|
$template->param('patron_attributes_values', \@patron_attributes_values);
|
|
|
|
$template->param( fields => \@fields );
|
|
}
|
|
|
|
# Process modifications
|
|
if ( $op eq 'do' ) {
|
|
|
|
my @disabled = $input->multi_param('disable_input');
|
|
my $infos;
|
|
for my $field ( qw/surname firstname branchcode categorycode city state zipcode country sort1 sort2 dateenrolled dateexpiry borrowernotes opacnote/ ) {
|
|
my $value = $input->param($field);
|
|
$infos->{$field} = $value if $value;
|
|
$infos->{$field} = "" if grep { /^$field$/ } @disabled;
|
|
}
|
|
|
|
for my $field ( qw( dateenrolled dateexpiry ) ) {
|
|
$infos->{$field} = dt_from_string($infos->{$field}) if $infos->{$field};
|
|
}
|
|
|
|
my @attributes = $input->multi_param('patron_attributes');
|
|
my @attr_values = $input->multi_param('patron_attributes_value');
|
|
|
|
my @errors;
|
|
my @borrowernumbers = $input->multi_param('borrowernumber');
|
|
# For each borrower selected
|
|
for my $borrowernumber ( @borrowernumbers ) {
|
|
# If at least one field are filled, we want to modify the borrower
|
|
if ( defined $infos ) {
|
|
$infos->{borrowernumber} = $borrowernumber;
|
|
my $success = ModMember(%$infos);
|
|
if (!$success) {
|
|
my $borrowerinfo = GetBorrowerInfos( borrowernumber => $borrowernumber );
|
|
$infos->{cardnumber} = $borrowerinfo->{cardnumber} || '';
|
|
push @errors, { error => "can_not_update", borrowernumber => $infos->{borrowernumber}, cardnumber => $infos->{cardnumber} };
|
|
}
|
|
}
|
|
|
|
#
|
|
my $borrower_categorycode = GetBorrowerCategorycode $borrowernumber;
|
|
my $i=0;
|
|
for ( @attributes ) {
|
|
my $attribute;
|
|
$attribute->{code} = $_;
|
|
$attribute->{attribute} = $attr_values[$i];
|
|
my $attr_type = C4::Members::AttributeTypes->fetch( $_ );
|
|
# If this borrower is not in the category of this attribute, we don't want to modify this attribute
|
|
++$i and next if $attr_type->{category_code} and $attr_type->{category_code} ne $borrower_categorycode;
|
|
my $valuename = "attr" . $i . "_value";
|
|
if ( grep { /^$valuename$/ } @disabled ) {
|
|
# The attribute is disabled, we remove it for this borrower !
|
|
eval {
|
|
C4::Members::Attributes::DeleteBorrowerAttribute( $borrowernumber, $attribute );
|
|
};
|
|
push @errors, { error => $@ } if $@;
|
|
} else {
|
|
# Attribute's value is empty, we don't want to modify it
|
|
++$i and next if not $attribute->{attribute};
|
|
|
|
eval {
|
|
C4::Members::Attributes::UpdateBorrowerAttribute( $borrowernumber, $attribute );
|
|
};
|
|
push @errors, { error => $@ } if $@;
|
|
}
|
|
$i++;
|
|
}
|
|
}
|
|
$op = "show_results"; # We have process modifications, the user want to view its
|
|
|
|
# Construct the results list
|
|
my @borrowers;
|
|
my $max_nb_attr = 0;
|
|
for my $borrowernumber ( @borrowernumbers ) {
|
|
my $borrower = GetBorrowerInfos( borrowernumber => $borrowernumber );
|
|
if ( $borrower ) {
|
|
$max_nb_attr = scalar( @{ $borrower->{patron_attributes} } )
|
|
if scalar( @{ $borrower->{patron_attributes} } ) > $max_nb_attr;
|
|
push @borrowers, $borrower;
|
|
}
|
|
}
|
|
my @patron_attributes_option;
|
|
for my $borrower ( @borrowers ) {
|
|
push @patron_attributes_option, { value => "$_->{code}", lib => $_->{code} } for @{ $borrower->{patron_attributes} };
|
|
my $length = scalar( @{ $borrower->{patron_attributes} } );
|
|
push @{ $borrower->{patron_attributes} }, {} for ( $length .. $max_nb_attr - 1);
|
|
}
|
|
|
|
my @attributes_header = ();
|
|
for ( 1 .. scalar( $max_nb_attr ) ) {
|
|
push @attributes_header, { attribute => "Attributes $_" };
|
|
}
|
|
|
|
$template->param( borrowers => \@borrowers );
|
|
$template->param( attributes_header => \@attributes_header );
|
|
|
|
$template->param( borrowers => \@borrowers );
|
|
$template->param( errors => \@errors );
|
|
} else {
|
|
|
|
$template->param( patron_lists => [ GetPatronLists() ] );
|
|
}
|
|
|
|
$template->param(
|
|
op => $op,
|
|
);
|
|
output_html_with_http_headers $input, $cookie, $template->output;
|
|
exit;
|
|
|
|
sub GetBorrowerInfos {
|
|
my ( %info ) = @_;
|
|
my $borrower = GetMember( %info );
|
|
if ( $borrower ) {
|
|
for ( qw(dateenrolled dateexpiry) ) {
|
|
my $userdate = $borrower->{$_};
|
|
unless ($userdate && $userdate ne "0000-00-00" and $userdate ne "9999-12-31") {
|
|
$borrower->{$_} = '';
|
|
next;
|
|
}
|
|
$borrower->{$_} = $userdate || '';
|
|
}
|
|
$borrower->{category_description} = Koha::Patron::Categories->find( $borrower->{categorycode} )->{description};
|
|
my $attr_loop = C4::Members::Attributes::GetBorrowerAttributes( $borrower->{borrowernumber} );
|
|
$borrower->{patron_attributes} = $attr_loop;
|
|
}
|
|
return $borrower;
|
|
}
|