3 # Copyright 2012 BibLibre
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
23 # Modification for patron's fields:
24 # surname firstname branchcode categorycode city state zipcode country sort1
25 # sort2 dateenrolled dateexpiry borrowernotes
26 # And for patron attributes.
30 use C4::Auth qw( get_template_and_user );
31 use C4::Koha qw( GetAuthorisedValues );
33 use C4::Output qw( output_html_with_http_headers );
34 use Koha::DateUtils qw( dt_from_string );
35 use Koha::List::Patron qw( GetPatronLists );
37 use Koha::Patron::Categories;
38 use Koha::Patron::Debarments qw( AddDebarment DelDebarment );
40 use List::MoreUtils qw(uniq);
43 my $op = $input->param('op') || 'show_form';
44 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
45 { template_name => "tools/modborrowers.tt",
48 flagsrequired => { tools => "edit_patrons" },
52 my $logged_in_user = Koha::Patrons->find( $loggedinuser );
54 $template->param( CanUpdatePasswordExpiration => 1 ) if $logged_in_user->is_superlibrarian;
56 my $dbh = C4::Context->dbh;
58 # Show borrower informations
59 if ( $op eq 'cud-show' ) {
62 my @notfoundcardnumbers;
63 my $useborrowernumbers = 0;
65 # Get cardnumbers from a file or the input area
66 if( my $cardnumberlist = $input->param('cardnumberlist') ){
67 # User submitted a list of card numbers
68 push @patronidnumbers, split( /\s\n/, $cardnumberlist );
69 } elsif ( my @cardnumbers = $input->multi_param('cardnumber') ) {
70 @patronidnumbers = @cardnumbers;
71 } elsif ( my $cardnumberuploadfile = $input->param('cardnumberuploadfile') ){
72 # User uploaded a file of card numbers
73 binmode $cardnumberuploadfile, ':encoding(UTF-8)';
74 while ( my $content = <$cardnumberuploadfile> ) {
76 $content =~ s/[\r\n]*$//;
77 push @patronidnumbers, $content if $content;
79 } elsif ( my $borrowernumberlist = $input->param('borrowernumberlist') ){
80 # User submitted a list of borrowernumbers
81 $useborrowernumbers = 1;
82 push @patronidnumbers, split( /\s\n/, $borrowernumberlist );
83 } elsif ( my $borrowernumberuploadfile = $input->param('borrowernumberuploadfile') ){
84 # User uploaded a file of borrowernumbers
85 $useborrowernumbers = 1;
86 binmode $borrowernumberuploadfile, ':encoding(UTF-8)';
87 while ( my $content = <$borrowernumberuploadfile> ) {
89 $content =~ s/[\r\n]*$//;
90 push @patronidnumbers, $content if $content;
92 } elsif ( my $patron_list_id = $input->param('patron_list_id') ){
93 # User selected a patron list
94 my ($list) = GetPatronLists( { patron_list_id => $patron_list_id } );
96 $list->patron_list_patrons()->search_related('borrowernumber')
97 ->get_column('cardnumber')->all();
102 # Make sure there is only one of each patron id number
103 @patronidnumbers = uniq( @patronidnumbers );
105 for my $patronidnumber ( @patronidnumbers ) {
107 if( $useborrowernumbers == 1 ){
108 $patron = Koha::Patrons->find( { borrowernumber => $patronidnumber } );
110 $patron = Koha::Patrons->find( { cardnumber => $patronidnumber } );
113 if ( $logged_in_user->can_see_patron_infos( $patron ) ) {
114 my $borrower = $patron->unblessed;
115 my $attributes = $patron->extended_attributes;
116 $borrower->{patron_attributes} = $attributes->as_list;
117 $borrower->{patron_attributes_count} = $attributes->count;
118 $max_nb_attr = $borrower->{patron_attributes_count} if $borrower->{patron_attributes_count} > $max_nb_attr;
119 push @borrowers, $borrower;
121 push @notfoundcardnumbers, $patronidnumber;
124 push @notfoundcardnumbers, $patronidnumber;
128 # Just for a correct display
129 for my $borrower ( @borrowers ) {
130 my $length = $borrower->{patron_attributes_count};
131 push @{ $borrower->{patron_attributes} }, {} for ( $length .. $max_nb_attr - 1);
134 # Construct the patron attributes list
135 my @patron_attributes_values;
136 my @patron_attributes_codes;
137 my $library_id = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
138 my $patron_attribute_types = Koha::Patron::Attribute::Types->search_with_library_limits({}, {}, $library_id);
139 my @patron_categories = Koha::Patron::Categories->search_with_library_limits({}, {order_by => ['description']})->as_list;
140 while ( my $attr_type = $patron_attribute_types->next ) {
141 next if $attr_type->unique_id; # Don't display patron attributes that must be unqiue
142 my $options = $attr_type->authorised_value_category
143 ? GetAuthorisedValues( $attr_type->authorised_value_category )
145 push @patron_attributes_values,
147 attribute_code => $attr_type->code,
151 my $category_code = $attr_type->category_code;
153 map { ( defined $category_code and $attr_type->category_code eq $_->categorycode ) ? $_->description : () }
155 push @patron_attributes_codes,
157 attribute_code => $attr_type->code,
158 attribute_lib => $attr_type->description,
159 category_lib => $category_lib,
160 type => $attr_type->authorised_value_category ? 'cud-select' : 'text',
164 my @attributes_header = ();
165 for ( 1 .. scalar( $max_nb_attr ) ) {
166 push @attributes_header, { attribute => "Attributes $_" };
168 $template->param( borrowers => \@borrowers );
169 $template->param( attributes_header => \@attributes_header );
170 @notfoundcardnumbers = map { { cardnumber => $_ } } @notfoundcardnumbers;
171 $template->param( notfoundcardnumbers => \@notfoundcardnumbers )
172 if @notfoundcardnumbers;
173 $template->param( useborrowernumbers => $useborrowernumbers );
175 # Construct drop-down list values
176 my $branches = Koha::Libraries->search({}, { order_by => ['branchname'] })->unblessed;
178 push @branches_option, { value => $_->{branchcode}, lib => $_->{branchname} } for @$branches;
179 unshift @branches_option, { value => "", lib => "" };
180 my @categories_option;
181 push @categories_option, { value => $_->categorycode, lib => $_->description } for @patron_categories;
182 unshift @categories_option, { value => "", lib => "" };
183 my $bsort1 = GetAuthorisedValues("Bsort1");
185 push @sort1_option, { value => $_->{authorised_value}, lib => $_->{lib} } for @$bsort1;
186 unshift @sort1_option, { value => "", lib => "" }
188 my $bsort2 = GetAuthorisedValues("Bsort2");
190 push @sort2_option, { value => $_->{authorised_value}, lib => $_->{lib} } for @$bsort2;
191 unshift @sort2_option, { value => "", lib => "" }
194 my @mandatoryFields = split( /\|/, C4::Context->preference("BorrowerMandatoryField") );
200 mandatory => ( grep /surname/, @mandatoryFields ) ? 1 : 0
206 mandatory => ( grep /firstname/, @mandatoryFields ) ? 1 : 0,
210 name => "branchcode",
212 option => \@branches_option,
213 mandatory => ( grep /branchcode/, @mandatoryFields ) ? 1 : 0,
217 name => "categorycode",
219 option => \@categories_option,
220 mandatory => ( grep /categorycode/, @mandatoryFields ) ? 1 : 0,
224 name => "streetnumber",
226 mandatory => ( grep /streetnumber/, @mandatoryFields ) ? 1 : 0,
232 mandatory => ( grep /address/, @mandatoryFields ) ? 1 : 0,
238 mandatory => ( grep /address2/, @mandatoryFields ) ? 1 : 0,
244 mandatory => ( grep /city/, @mandatoryFields ) ? 1 : 0,
250 mandatory => ( grep /state/, @mandatoryFields ) ? 1 : 0,
256 mandatory => ( grep /zipcode/, @mandatoryFields ) ? 1 : 0,
262 mandatory => ( grep /country/, @mandatoryFields ) ? 1 : 0,
268 mandatory => ( grep /email/, @mandatoryFields ) ? 1 : 0,
274 mandatory => ( grep /phone/, @mandatoryFields ) ? 1 : 0,
280 mandatory => ( grep /mobile/, @mandatoryFields ) ? 1 : 0,
285 type => @sort1_option ? "select" : "text",
286 option => \@sort1_option,
287 mandatory => ( grep /sort1/, @mandatoryFields ) ? 1 : 0,
292 type => @sort2_option ? "select" : "text",
293 option => \@sort2_option,
294 mandatory => ( grep /sort2/, @mandatoryFields ) ? 1 : 0,
298 name => "dateenrolled",
300 mandatory => ( grep /dateenrolled/, @mandatoryFields ) ? 1 : 0,
304 name => "dateexpiry",
306 mandatory => ( grep /dateexpiry/, @mandatoryFields ) ? 1 : 0,
310 name => "borrowernotes",
312 mandatory => ( grep /borrowernotes/, @mandatoryFields ) ? 1 : 0,
318 mandatory => ( grep /opacnote/, @mandatoryFields ) ? 1 : 0,
324 mandatory => ( grep /debarred/, @mandatoryFields ) ? 1 : 0,
328 name => "debarredcomment",
330 mandatory => ( grep /debarredcomment/, @mandatoryFields ) ? 1 : 0,
334 push @fields, { name => "password_expiration_date", type => "date" } if $logged_in_user->is_superlibrarian;
336 $template->param('patron_attributes_codes', \@patron_attributes_codes);
337 $template->param('patron_attributes_values', \@patron_attributes_values);
339 $template->param( fields => \@fields );
343 # Process modifications
344 if ( $op eq 'cud-do' ) {
346 my @disabled = $input->multi_param('disable_input');
348 for my $field ( qw/surname firstname branchcode categorycode streetnumber address address2 city state zipcode country email phone mobile sort1 sort2 dateenrolled dateexpiry password_expiration_date borrowernotes opacnote debarred debarredcomment/ ) {
349 my $value = $input->param($field);
350 $infos->{$field} = $value if $value;
351 $infos->{$field} = "" if grep { $_ eq $field } @disabled;
354 for my $field ( qw( dateenrolled dateexpiry debarred password_expiration_date ) ) {
355 $infos->{$field} = dt_from_string($infos->{$field}) if $infos->{$field};
358 delete $infos->{password_expiration_date} unless $logged_in_user->is_superlibrarian;
361 my @borrowernumbers = $input->multi_param('borrowernumber');
362 # For each borrower selected
363 for my $borrowernumber ( @borrowernumbers ) {
365 # If at least one field are filled, we want to modify the borrower
366 if ( defined $infos ) {
367 # If a debarred date or debarred comment has been submitted make a new debarment
368 if ( $infos->{debarred} || $infos->{debarredcomment} ) {
371 borrowernumber => $borrowernumber,
373 comment => $infos->{debarredcomment},
374 expiration => $infos->{debarred},
378 # If debarment date or debarment comment are disabled then remove all debarrments
379 my $patron = Koha::Patrons->find( $borrowernumber );
380 if ( grep { /debarred/ } @disabled ) {
382 my $debarrments = $patron->restrictions;
383 while( my $debarment = $debarrments->next ) {
384 DelDebarment( $debarment->borrower_debarment_id );
389 $infos->{borrowernumber} = $borrowernumber;
390 eval { $patron->set($infos)->store; };
391 if ( $@ ) { # FIXME We could provide better error handling here
392 $infos->{cardnumber} = $patron ? $patron->cardnumber || '' : '';
393 push @errors, { error => "can_not_update", borrowernumber => $infos->{borrowernumber}, cardnumber => $infos->{cardnumber} };
397 my $patron = Koha::Patrons->find( $borrowernumber );
398 my @attributes = $input->multi_param('patron_attributes');
399 my @attr_values = $input->multi_param('patron_attributes_value');
402 for my $code ( @attributes ) {
403 push @{ $attributes->{$code}->{values} }, shift @attr_values; # Handling repeatables
404 $attributes->{$code}->{disabled} = grep { $_ eq sprintf("attr%s_value", ++$i) } @disabled;
407 for my $code ( keys %$attributes ) {
408 my $attr_type = Koha::Patron::Attribute::Types->find($code);
410 next unless $attr_type;
412 # If this borrower is not in the category of this attribute, we don't want to modify this attribute
413 next if $attr_type->category_code and $attr_type->category_code ne $patron->categorycode;
415 if ( $attributes->{$code}->{disabled} ) {
416 # The attribute is disabled, we remove it for this borrower !
418 $patron->extended_attributes->search({'me.code' => $code})->filter_by_branch_limitations->delete;
420 push @errors, { error => $@ } if $@;
423 $patron->extended_attributes->search({'me.code' => $code})->filter_by_branch_limitations->delete;
424 $patron->add_extended_attribute({ code => $code, attribute => $_ }) for @{$attributes->{$code}->{values}};
426 push @errors, { error => $@ } if $@;
430 $op = "show_results"; # We have process modifications, the user want to view its
432 # Construct the results list
435 for my $borrowernumber ( @borrowernumbers ) {
436 my $patron = Koha::Patrons->find( $borrowernumber );
438 my $category_description = $patron->category->description;
439 my $borrower = $patron->unblessed;
440 $borrower->{category_description} = $category_description;
441 my $attributes = $patron->extended_attributes;
442 $borrower->{patron_attributes} = $attributes->as_list;
443 $max_nb_attr = $attributes->count if $attributes->count > $max_nb_attr;
444 push @borrowers, $borrower;
447 my @patron_attributes_option;
448 for my $borrower ( @borrowers ) {
449 push @patron_attributes_option, { value => "$_->{code}", lib => $_->{code} } for @{ $borrower->{patron_attributes} };
450 my $length = scalar( @{ $borrower->{patron_attributes} } );
451 push @{ $borrower->{patron_attributes} }, {} for ( $length .. $max_nb_attr - 1);
454 my @attributes_header = ();
455 for ( 1 .. scalar( $max_nb_attr ) ) {
456 push @attributes_header, { attribute => "Attributes $_" };
459 $template->param( borrowers => \@borrowers );
460 $template->param( attributes_header => \@attributes_header );
462 $template->param( errors => \@errors );
465 $template->param( patron_lists => [ GetPatronLists() ] );
471 output_html_with_http_headers $input, $cookie, $template->output;