tools/modborrowers.pl

   1 #!/usr/bin/perl
   2
   3 # Copyright 2012 BibLibre
   4 #
   5 # This file is part of Koha.
   6 #
   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.
  11 #
  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.
  16 #
  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>.
  19
  20 # modborrowers.pl
  21 #
  22 # Batch Edit Patrons
  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.
  27
  28 use Modern::Perl;
  29 use CGI qw ( -utf8 );
  30 use C4::Auth qw( get_template_and_user );
  31 use C4::Koha qw( GetAuthorisedValues );
  32 use C4::Members;
  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 );
  36 use Koha::Libraries;
  37 use Koha::Patron::Categories;
  38 use Koha::Patron::Debarments qw( AddDebarment DelDebarment );
  39 use Koha::Patrons;
  40 use List::MoreUtils qw(uniq);
  41
  42 my $input = CGI->new;
  43 my $op = $input->param('op') || 'show_form';
  44 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
  45     {   template_name   => "tools/modborrowers.tt",
  46         query           => $input,
  47         type            => "intranet",
  48         flagsrequired   => { tools => "edit_patrons" },
  49     }
  50 );
  51
  52 my $logged_in_user = Koha::Patrons->find( $loggedinuser );
  53
  54 $template->param( CanUpdatePasswordExpiration => 1 ) if $logged_in_user->is_superlibrarian;
  55
  56 my $dbh       = C4::Context->dbh;
  57
  58 # Show borrower informations
  59 if ( $op eq 'show' ) {
  60     my @borrowers;
  61     my @patronidnumbers;
  62     my @notfoundcardnumbers;
  63     my $useborrowernumbers = 0;
  64
  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 $cardnumberuploadfile = $input->param('cardnumberuploadfile') ){
  70         # User uploaded a file of card numbers
  71         binmode $cardnumberuploadfile, ':encoding(UTF-8)';
  72         while ( my $content = <$cardnumberuploadfile> ) {
  73             next unless $content;
  74             $content =~ s/[\r\n]*$//;
  75             push @patronidnumbers, $content if $content;
  76         }
  77     } elsif ( my $borrowernumberlist = $input->param('borrowernumberlist') ){
  78         # User submitted a list of borrowernumbers
  79         $useborrowernumbers = 1;
  80         push @patronidnumbers, split( /\s\n/, $borrowernumberlist );
  81     } elsif ( my $borrowernumberuploadfile = $input->param('borrowernumberuploadfile') ){
  82         # User uploaded a file of borrowernumbers
  83         $useborrowernumbers = 1;
  84         binmode $borrowernumberuploadfile, ':encoding(UTF-8)';
  85         while ( my $content = <$borrowernumberuploadfile> ) {
  86             next unless $content;
  87             $content =~ s/[\r\n]*$//;
  88             push @patronidnumbers, $content if $content;
  89         }
  90     } elsif ( my $patron_list_id = $input->param('patron_list_id') ){
  91         # User selected a patron list
  92         my ($list) = GetPatronLists( { patron_list_id => $patron_list_id } );
  93         @patronidnumbers =
  94           $list->patron_list_patrons()->search_related('borrowernumber')
  95           ->get_column('cardnumber')->all();
  96     }
  97
  98     my $max_nb_attr = 0;
  99
 100     # Make sure there is only one of each patron id number
 101     @patronidnumbers = uniq( @patronidnumbers );
 102
 103     for my $patronidnumber ( @patronidnumbers ) {
 104         my $patron;
 105         if( $useborrowernumbers == 1 ){
 106             $patron = Koha::Patrons->find( { borrowernumber => $patronidnumber } );
 107         } else {
 108             $patron = Koha::Patrons->find( { cardnumber => $patronidnumber } );
 109         }
 110         if ( $patron ) {
 111             if ( $logged_in_user->can_see_patron_infos( $patron ) ) {
 112                 my $borrower = $patron->unblessed;
 113                 my $attributes = $patron->extended_attributes;
 114                 $borrower->{patron_attributes} = $attributes->as_list;
 115                 $borrower->{patron_attributes_count} = $attributes->count;
 116                 $max_nb_attr = $borrower->{patron_attributes_count} if $borrower->{patron_attributes_count} > $max_nb_attr;
 117                 push @borrowers, $borrower;
 118             } else {
 119                 push @notfoundcardnumbers, $patronidnumber;
 120             }
 121         } else {
 122             push @notfoundcardnumbers, $patronidnumber;
 123         }
 124     }
 125
 126     # Just for a correct display
 127     for my $borrower ( @borrowers ) {
 128         my $length = $borrower->{patron_attributes_count};
 129         push @{ $borrower->{patron_attributes} }, {} for ( $length .. $max_nb_attr - 1);
 130     }
 131
 132     # Construct the patron attributes list
 133     my @patron_attributes_values;
 134     my @patron_attributes_codes;
 135     my $library_id = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
 136     my $patron_attribute_types = Koha::Patron::Attribute::Types->search_with_library_limits({}, {}, $library_id);
 137     my @patron_categories = Koha::Patron::Categories->search_with_library_limits({}, {order_by => ['description']})->as_list;
 138     while ( my $attr_type = $patron_attribute_types->next ) {
 139         next if $attr_type->unique_id; # Don't display patron attributes that must be unqiue
 140         my $options = $attr_type->authorised_value_category
 141             ? GetAuthorisedValues( $attr_type->authorised_value_category )
 142             : undef;
 143         push @patron_attributes_values,
 144             {
 145                 attribute_code => $attr_type->code,
 146                 options        => $options,
 147             };
 148
 149         my $category_code = $attr_type->category_code;
 150         my ($category_lib) =
 151             map { ( defined $category_code and $attr_type->category_code eq $_->categorycode ) ? $_->description : () }
 152             @patron_categories;
 153         push @patron_attributes_codes,
 154             {
 155                 attribute_code => $attr_type->code,
 156                 attribute_lib  => $attr_type->description,
 157                 category_lib   => $category_lib,
 158                 type           => $attr_type->authorised_value_category ? 'select' : 'text',
 159             };
 160     }
 161
 162     my @attributes_header = ();
 163     for ( 1 .. scalar( $max_nb_attr ) ) {
 164         push @attributes_header, { attribute => "Attributes $_" };
 165     }
 166     $template->param( borrowers => \@borrowers );
 167     $template->param( attributes_header => \@attributes_header );
 168     @notfoundcardnumbers = map { { cardnumber => $_ } } @notfoundcardnumbers;
 169     $template->param( notfoundcardnumbers => \@notfoundcardnumbers )
 170         if @notfoundcardnumbers;
 171     $template->param( useborrowernumbers => $useborrowernumbers );
 172
 173     # Construct drop-down list values
 174     my $branches = Koha::Libraries->search({}, { order_by => ['branchname'] })->unblessed;
 175     my @branches_option;
 176     push @branches_option, { value => $_->{branchcode}, lib => $_->{branchname} } for @$branches;
 177     unshift @branches_option, { value => "", lib => "" };
 178     my @categories_option;
 179     push @categories_option, { value => $_->categorycode, lib => $_->description } for @patron_categories;
 180     unshift @categories_option, { value => "", lib => "" };
 181     my $bsort1 = GetAuthorisedValues("Bsort1");
 182     my @sort1_option;
 183     push @sort1_option, { value => $_->{authorised_value}, lib => $_->{lib} } for @$bsort1;
 184     unshift @sort1_option, { value => "", lib => "" }
 185         if @sort1_option;
 186     my $bsort2 = GetAuthorisedValues("Bsort2");
 187     my @sort2_option;
 188     push @sort2_option, { value => $_->{authorised_value}, lib => $_->{lib} } for @$bsort2;
 189     unshift @sort2_option, { value => "", lib => "" }
 190         if @sort2_option;
 191
 192     my @mandatoryFields = split( /\|/, C4::Context->preference("BorrowerMandatoryField") );
 193
 194     my @fields = (
 195         {
 196             name => "surname",
 197             type => "text",
 198             mandatory => ( grep /surname/, @mandatoryFields ) ? 1 : 0
 199         }
 200         ,
 201         {
 202             name => "firstname",
 203             type => "text",
 204             mandatory => ( grep /firstname/, @mandatoryFields ) ? 1 : 0,
 205         }
 206         ,
 207         {
 208             name => "branchcode",
 209             type => "select",
 210             option => \@branches_option,
 211             mandatory => ( grep /branchcode/, @mandatoryFields ) ? 1 : 0,
 212         }
 213         ,
 214         {
 215             name => "categorycode",
 216             type => "select",
 217             option => \@categories_option,
 218             mandatory => ( grep /categorycode/, @mandatoryFields ) ? 1 : 0,
 219         }
 220         ,
 221         {
 222             name => "streetnumber",
 223             type => "text",
 224             mandatory => ( grep /streetnumber/, @mandatoryFields ) ? 1 : 0,
 225         }
 226         ,
 227         {
 228             name => "address",
 229             type => "text",
 230             mandatory => ( grep /address/, @mandatoryFields ) ? 1 : 0,
 231         }
 232         ,
 233         {
 234             name => "address2",
 235             type => "text",
 236             mandatory => ( grep /address2/, @mandatoryFields ) ? 1 : 0,
 237         }
 238         ,
 239         {
 240             name => "city",
 241             type => "text",
 242             mandatory => ( grep /city/, @mandatoryFields ) ? 1 : 0,
 243         }
 244         ,
 245         {
 246             name => "state",
 247             type => "text",
 248             mandatory => ( grep /state/, @mandatoryFields ) ? 1 : 0,
 249         }
 250         ,
 251         {
 252             name => "zipcode",
 253             type => "text",
 254             mandatory => ( grep /zipcode/, @mandatoryFields ) ? 1 : 0,
 255         }
 256         ,
 257         {
 258             name => "country",
 259             type => "text",
 260             mandatory => ( grep /country/, @mandatoryFields ) ? 1 : 0,
 261         }
 262         ,
 263         {
 264             name => "email",
 265             type => "text",
 266             mandatory => ( grep /email/, @mandatoryFields ) ? 1 : 0,
 267         }
 268         ,
 269         {
 270             name => "phone",
 271             type => "text",
 272             mandatory => ( grep /phone/, @mandatoryFields ) ? 1 : 0,
 273         }
 274         ,
 275         {
 276             name => "mobile",
 277             type => "text",
 278             mandatory => ( grep /mobile/, @mandatoryFields ) ? 1 : 0,
 279         }
 280         ,
 281         {
 282             name => "sort1",
 283             type => @sort1_option ? "select" : "text",
 284             option => \@sort1_option,
 285             mandatory => ( grep /sort1/, @mandatoryFields ) ? 1 : 0,
 286         }
 287         ,
 288         {
 289             name => "sort2",
 290             type => @sort2_option ? "select" : "text",
 291             option => \@sort2_option,
 292             mandatory => ( grep /sort2/, @mandatoryFields ) ? 1 : 0,
 293         }
 294         ,
 295         {
 296             name => "dateenrolled",
 297             type => "date",
 298             mandatory => ( grep /dateenrolled/, @mandatoryFields ) ? 1 : 0,
 299         }
 300         ,
 301         {
 302             name => "dateexpiry",
 303             type => "date",
 304             mandatory => ( grep /dateexpiry/, @mandatoryFields ) ? 1 : 0,
 305         }
 306         ,
 307         {
 308             name => "borrowernotes",
 309             type => "text",
 310             mandatory => ( grep /borrowernotes/, @mandatoryFields ) ? 1 : 0,
 311         }
 312         ,
 313         {
 314             name => "opacnote",
 315             type => "text",
 316             mandatory => ( grep /opacnote/, @mandatoryFields ) ? 1 : 0,
 317         }
 318         ,
 319         {
 320             name => "debarred",
 321             type => "date",
 322             mandatory => ( grep /debarred/, @mandatoryFields ) ? 1 : 0,
 323         }
 324         ,
 325         {
 326             name => "debarredcomment",
 327             type => "text",
 328             mandatory => ( grep /debarredcomment/, @mandatoryFields ) ? 1 : 0,
 329         },
 330     );
 331
 332     push @fields, { name => "password_expiration_date", type => "date" } if $logged_in_user->is_superlibrarian;
 333
 334     $template->param('patron_attributes_codes', \@patron_attributes_codes);
 335     $template->param('patron_attributes_values', \@patron_attributes_values);
 336
 337     $template->param( fields => \@fields );
 338 }
 339
 340 # Process modifications
 341 if ( $op eq 'do' ) {
 342
 343     my @disabled = $input->multi_param('disable_input');
 344     my $infos;
 345     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/ ) {
 346         my $value = $input->param($field);
 347         $infos->{$field} = $value if $value;
 348         $infos->{$field} = "" if grep { $_ eq $field } @disabled;
 349     }
 350
 351     for my $field ( qw( dateenrolled dateexpiry debarred password_expiration_date ) ) {
 352         $infos->{$field} = dt_from_string($infos->{$field}) if $infos->{$field};
 353     }
 354
 355     delete $infos->{password_expiration_date} unless $logged_in_user->is_superlibrarian;
 356
 357     my @errors;
 358     my @borrowernumbers = $input->multi_param('borrowernumber');
 359     # For each borrower selected
 360     for my $borrowernumber ( @borrowernumbers ) {
 361
 362         # If at least one field are filled, we want to modify the borrower
 363         if ( defined $infos ) {
 364             # If a debarred date or debarred comment has been submitted make a new debarment
 365             if ( $infos->{debarred} || $infos->{debarredcomment} ) {
 366                 AddDebarment(
 367                     {
 368                         borrowernumber => $borrowernumber,
 369                         type           => 'MANUAL',
 370                         comment        => $infos->{debarredcomment},
 371                         expiration     => $infos->{debarred},
 372                     });
 373             }
 374
 375             # If debarment date or debarment comment are disabled then remove all debarrments
 376             my $patron = Koha::Patrons->find( $borrowernumber );
 377             if ( grep { /debarred/ } @disabled ) {
 378                 eval {
 379                    my $debarrments = $patron->restrictions;
 380                    while( my $debarment = $debarrments->next ) {
 381                       DelDebarment( $debarment->borrower_debarment_id );
 382                    }
 383                 };
 384             }
 385
 386             $infos->{borrowernumber} = $borrowernumber;
 387             eval { $patron->set($infos)->store; };
 388             if ( $@ ) { # FIXME We could provide better error handling here
 389                 $infos->{cardnumber} = $patron ? $patron->cardnumber || '' : '';
 390                 push @errors, { error => "can_not_update", borrowernumber => $infos->{borrowernumber}, cardnumber => $infos->{cardnumber} };
 391             }
 392         }
 393
 394         my $patron = Koha::Patrons->find( $borrowernumber );
 395         my @attributes = $input->multi_param('patron_attributes');
 396         my @attr_values = $input->multi_param('patron_attributes_value');
 397         my $attributes;
 398         my $i = 0;
 399         for my $code ( @attributes ) {
 400             push @{ $attributes->{$code}->{values} }, shift @attr_values; # Handling repeatables
 401             $attributes->{$code}->{disabled} = grep { $_ eq sprintf("attr%s_value", ++$i) } @disabled;
 402         }
 403
 404         for my $code ( keys %$attributes ) {
 405             my $attr_type = Koha::Patron::Attribute::Types->find($code);
 406
 407             next unless $attr_type;
 408
 409             # If this borrower is not in the category of this attribute, we don't want to modify this attribute
 410             next if $attr_type->category_code and $attr_type->category_code ne $patron->categorycode;
 411
 412             if ( $attributes->{$code}->{disabled} ) {
 413                 # The attribute is disabled, we remove it for this borrower !
 414                 eval {
 415                     $patron->extended_attributes->search({'me.code' => $code})->filter_by_branch_limitations->delete;
 416                 };
 417                 push @errors, { error => $@ } if $@;
 418             } else {
 419                 eval {
 420                     $patron->extended_attributes->search({'me.code' => $code})->filter_by_branch_limitations->delete;
 421                     $patron->add_extended_attribute({ code => $code, attribute => $_ }) for @{$attributes->{$code}->{values}};
 422                 };
 423                 push @errors, { error => $@ } if $@;
 424             }
 425         }
 426     }
 427     $op = "show_results"; # We have process modifications, the user want to view its
 428
 429     # Construct the results list
 430     my @borrowers;
 431     my $max_nb_attr = 0;
 432     for my $borrowernumber ( @borrowernumbers ) {
 433         my $patron = Koha::Patrons->find( $borrowernumber );
 434         if ( $patron ) {
 435             my $category_description = $patron->category->description;
 436             my $borrower = $patron->unblessed;
 437             $borrower->{category_description} = $category_description;
 438             my $attributes = $patron->extended_attributes;
 439             $borrower->{patron_attributes} = $attributes->as_list;
 440             $max_nb_attr = $attributes->count if $attributes->count > $max_nb_attr;
 441             push @borrowers, $borrower;
 442         }
 443     }
 444     my @patron_attributes_option;
 445     for my $borrower ( @borrowers ) {
 446         push @patron_attributes_option, { value => "$_->{code}", lib => $_->{code} } for @{ $borrower->{patron_attributes} };
 447         my $length = scalar( @{ $borrower->{patron_attributes} } );
 448         push @{ $borrower->{patron_attributes} }, {} for ( $length .. $max_nb_attr - 1);
 449     }
 450
 451     my @attributes_header = ();
 452     for ( 1 .. scalar( $max_nb_attr ) ) {
 453         push @attributes_header, { attribute => "Attributes $_" };
 454     }
 455
 456     $template->param( borrowers => \@borrowers );
 457     $template->param( attributes_header => \@attributes_header );
 458
 459     $template->param( errors => \@errors );
 460 } else {
 461
 462     $template->param( patron_lists => [ GetPatronLists() ] );
 463 }
 464
 465 $template->param(
 466     op => $op,
 467 );
 468 output_html_with_http_headers $input, $cookie, $template->output;
 469 exit;