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;
  31 use C4::Branch;
  32 use C4::Koha;
  33 use C4::Members;
  34 use C4::Members::Attributes;
  35 use C4::Members::AttributeTypes qw/GetAttributeTypes_hashref/;
  36 use C4::Output;
  37 use List::MoreUtils qw /any uniq/;
  38 use Koha::DateUtils qw( dt_from_string );
  39 use Koha::List::Patron;
  40
  41 my $input = new CGI;
  42 my $op = $input->param('op') || 'show_form';
  43 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
  44     {   template_name   => "tools/modborrowers.tt",
  45         query           => $input,
  46         type            => "intranet",
  47         authnotrequired => 0,
  48         flagsrequired   => { tools => "edit_patrons" },
  49     }
  50 );
  51
  52 my %cookies   = parse CGI::Cookie($cookie);
  53 my $sessionID = $cookies{'CGISESSID'}->value;
  54 my $dbh       = C4::Context->dbh;
  55
  56 # Show borrower informations
  57 if ( $op eq 'show' ) {
  58     my $filefh         = $input->upload('uploadfile');
  59     my $filecontent    = $input->param('filecontent');
  60     my $patron_list_id = $input->param('patron_list_id');
  61     my @borrowers;
  62     my @cardnumbers;
  63     my @notfoundcardnumbers;
  64
  65     # Get cardnumbers from a file or the input area
  66     my @contentlist;
  67     if ($filefh) {
  68         while ( my $content = <$filefh> ) {
  69             $content =~ s/[\r\n]*$//g;
  70             push @cardnumbers, $content if $content;
  71         }
  72     } elsif ( $patron_list_id ) {
  73         my ($list) = GetPatronLists( { patron_list_id => $patron_list_id } );
  74
  75         @cardnumbers =
  76           $list->patron_list_patrons()->search_related('borrowernumber')
  77           ->get_column('cardnumber')->all();
  78
  79     } else {
  80         if ( my $list = $input->param('cardnumberlist') ) {
  81             push @cardnumbers, split( /\s\n/, $list );
  82         }
  83     }
  84
  85     my $max_nb_attr = 0;
  86     for my $cardnumber ( @cardnumbers ) {
  87         my $borrower = GetBorrowerInfos( cardnumber => $cardnumber );
  88         if ( $borrower ) {
  89             $max_nb_attr = scalar( @{ $borrower->{patron_attributes} } )
  90                 if scalar( @{ $borrower->{patron_attributes} } ) > $max_nb_attr;
  91             push @borrowers, $borrower;
  92         } else {
  93             push @notfoundcardnumbers, $cardnumber;
  94         }
  95     }
  96
  97     # Just for a correct display
  98     for my $borrower ( @borrowers ) {
  99         my $length = scalar( @{ $borrower->{patron_attributes} } );
 100         push @{ $borrower->{patron_attributes} }, {} for ( $length .. $max_nb_attr - 1);
 101     }
 102
 103     # Construct the patron attributes list
 104     my @patron_attributes_values;
 105     my @patron_attributes_codes;
 106     my $patron_attribute_types = C4::Members::AttributeTypes::GetAttributeTypes_hashref('all');
 107     my $patron_categories = C4::Members::GetBorrowercategoryList;
 108     for ( values %$patron_attribute_types ) {
 109         my $attr_type = C4::Members::AttributeTypes->fetch( $_->{code} );
 110         # TODO Repeatable attributes are not correctly managed and can cause data lost.
 111         # This should be implemented.
 112         next if $attr_type->{repeatable};
 113         my $options = $attr_type->authorised_value_category
 114             ? GetAuthorisedValues( $attr_type->authorised_value_category )
 115             : undef;
 116         push @patron_attributes_values,
 117             {
 118                 attribute_code => $_->{code},
 119                 options        => $options,
 120             };
 121
 122         my $category_code = $_->{category_code};
 123         my ( $category_lib ) = map {
 124             ( defined $category_code and $_->{categorycode} eq $category_code ) ? $_->{description} : ()
 125         } @$patron_categories;
 126         push @patron_attributes_codes,
 127             {
 128                 attribute_code => $_->{code},
 129                 attribute_lib  => $_->{description},
 130                 category_lib   => $category_lib,
 131                 type           => $attr_type->authorised_value_category ? 'select' : 'text',
 132             };
 133     }
 134
 135     my @attributes_header = ();
 136     for ( 1 .. scalar( $max_nb_attr ) ) {
 137         push @attributes_header, { attribute => "Attributes $_" };
 138     }
 139     $template->param( borrowers => \@borrowers );
 140     $template->param( attributes_header => \@attributes_header );
 141     @notfoundcardnumbers = map { { cardnumber => $_ } } @notfoundcardnumbers;
 142     $template->param( notfoundcardnumbers => \@notfoundcardnumbers )
 143         if @notfoundcardnumbers;
 144
 145     # Construct drop-down list values
 146     my $branches = GetBranchesLoop;
 147     my @branches_option;
 148     push @branches_option, { value => $_->{value}, lib => $_->{branchname} } for @$branches;
 149     unshift @branches_option, { value => "", lib => "" };
 150     my $categories = GetBorrowercategoryList;
 151     my @categories_option;
 152     push @categories_option, { value => $_->{categorycode}, lib => $_->{description} } for @$categories;
 153     unshift @categories_option, { value => "", lib => "" };
 154     my $bsort1 = GetAuthorisedValues("Bsort1");
 155     my @sort1_option;
 156     push @sort1_option, { value => $_->{authorised_value}, lib => $_->{lib} } for @$bsort1;
 157     unshift @sort1_option, { value => "", lib => "" }
 158         if @sort1_option;
 159     my $bsort2 = GetAuthorisedValues("Bsort2");
 160     my @sort2_option;
 161     push @sort2_option, { value => $_->{authorised_value}, lib => $_->{lib} } for @$bsort2;
 162     unshift @sort2_option, { value => "", lib => "" }
 163         if @sort2_option;
 164
 165     my @mandatoryFields = split( /\|/, C4::Context->preference("BorrowerMandatoryField") );
 166
 167     my @fields = (
 168         {
 169             name => "surname",
 170             type => "text",
 171             mandatory => ( grep /surname/, @mandatoryFields ) ? 1 : 0
 172         }
 173         ,
 174         {
 175             name => "firstname",
 176             type => "text",
 177             mandatory => ( grep /firstname/, @mandatoryFields ) ? 1 : 0,
 178         }
 179         ,
 180         {
 181             name => "branchcode",
 182             type => "select",
 183             option => \@branches_option,
 184             mandatory => ( grep /branchcode/, @mandatoryFields ) ? 1 : 0,
 185         }
 186         ,
 187         {
 188             name => "categorycode",
 189             type => "select",
 190             option => \@categories_option,
 191             mandatory => ( grep /categorycode/, @mandatoryFields ) ? 1 : 0,
 192         }
 193         ,
 194         {
 195             name => "city",
 196             type => "text",
 197             mandatory => ( grep /city/, @mandatoryFields ) ? 1 : 0,
 198         }
 199         ,
 200         {
 201             name => "state",
 202             type => "text",
 203             mandatory => ( grep /state/, @mandatoryFields ) ? 1 : 0,
 204         }
 205         ,
 206         {
 207             name => "zipcode",
 208             type => "text",
 209             mandatory => ( grep /zipcode/, @mandatoryFields ) ? 1 : 0,
 210         }
 211         ,
 212         {
 213             name => "country",
 214             type => "text",
 215             mandatory => ( grep /country/, @mandatoryFields ) ? 1 : 0,
 216         }
 217         ,
 218         {
 219             name => "sort1",
 220             type => @sort1_option ? "select" : "text",
 221             option => \@sort1_option,
 222             mandatory => ( grep /sort1/, @mandatoryFields ) ? 1 : 0,
 223         }
 224         ,
 225         {
 226             name => "sort2",
 227             type => @sort2_option ? "select" : "text",
 228             option => \@sort2_option,
 229             mandatory => ( grep /sort2/, @mandatoryFields ) ? 1 : 0,
 230         }
 231         ,
 232         {
 233             name => "dateenrolled",
 234             type => "date",
 235             mandatory => ( grep /dateenrolled/, @mandatoryFields ) ? 1 : 0,
 236         }
 237         ,
 238         {
 239             name => "dateexpiry",
 240             type => "date",
 241             mandatory => ( grep /dateexpiry/, @mandatoryFields ) ? 1 : 0,
 242         }
 243         ,
 244         {
 245             name => "borrowernotes",
 246             type => "text",
 247             mandatory => ( grep /borrowernotes/, @mandatoryFields ) ? 1 : 0,
 248         }
 249     );
 250
 251     $template->param('patron_attributes_codes', \@patron_attributes_codes);
 252     $template->param('patron_attributes_values', \@patron_attributes_values);
 253
 254     $template->param( fields => \@fields );
 255 }
 256
 257 # Process modifications
 258 if ( $op eq 'do' ) {
 259
 260     my @disabled = $input->param('disable_input');
 261     my $infos;
 262     for my $field ( qw/surname firstname branchcode categorycode city state zipcode country sort1 sort2 dateenrolled dateexpiry borrowernotes/ ) {
 263         my $value = $input->param($field);
 264         $infos->{$field} = $value if $value;
 265         $infos->{$field} = "" if grep { /^$field$/ } @disabled;
 266     }
 267
 268     for my $field ( qw( dateenrolled dateexpiry ) ) {
 269         $infos->{$field} = dt_from_string($infos->{$field}) if $infos->{$field};
 270     }
 271
 272     my @attributes = $input->param('patron_attributes');
 273     my @attr_values = $input->param('patron_attributes_value');
 274
 275     my @errors;
 276     my @borrowernumbers = $input->param('borrowernumber');
 277     # For each borrower selected
 278     for my $borrowernumber ( @borrowernumbers ) {
 279         # If at least one field are filled, we want to modify the borrower
 280         if ( defined $infos ) {
 281             $infos->{borrowernumber} = $borrowernumber;
 282             my $success = ModMember(%$infos);
 283             if (!$success) {
 284                 my $borrowerinfo = GetBorrowerInfos( borrowernumber => $borrowernumber );
 285                 $infos->{cardnumber} = $borrowerinfo->{cardnumber} || '';
 286                 push @errors, { error => "can_not_update", borrowernumber => $infos->{borrowernumber}, cardnumber => $infos->{cardnumber} };
 287             }
 288         }
 289
 290         #
 291         my $borrower_categorycode = GetBorrowerCategorycode $borrowernumber;
 292         my $i=0;
 293         for ( @attributes ) {
 294             my $attribute;
 295             $attribute->{code} = $_;
 296             $attribute->{attribute} = $attr_values[$i];
 297             my $attr_type = C4::Members::AttributeTypes->fetch( $_ );
 298             # If this borrower is not in the category of this attribute, we don't want to modify this attribute
 299             ++$i and next if $attr_type->{category_code} and $attr_type->{category_code} ne $borrower_categorycode;
 300             my $valuename = "attr" . $i . "_value";
 301             if ( grep { /^$valuename$/ } @disabled ) {
 302                 # The attribute is disabled, we remove it for this borrower !
 303                 eval {
 304                     C4::Members::Attributes::DeleteBorrowerAttribute( $borrowernumber, $attribute );
 305                 };
 306                 push @errors, { error => $@ } if $@;
 307             } else {
 308                 # Attribute's value is empty, we don't want to modify it
 309                 ++$i and next if not $attribute->{attribute};
 310
 311                 eval {
 312                     C4::Members::Attributes::UpdateBorrowerAttribute( $borrowernumber, $attribute );
 313                 };
 314                 push @errors, { error => $@ } if $@;
 315             }
 316             $i++;
 317         }
 318     }
 319     $op = "show_results"; # We have process modifications, the user want to view its
 320
 321     # Construct the results list
 322     my @borrowers;
 323     my $max_nb_attr = 0;
 324     for my $borrowernumber ( @borrowernumbers ) {
 325         my $borrower = GetBorrowerInfos( borrowernumber => $borrowernumber );
 326         if ( $borrower ) {
 327             $max_nb_attr = scalar( @{ $borrower->{patron_attributes} } )
 328                 if scalar( @{ $borrower->{patron_attributes} } ) > $max_nb_attr;
 329             push @borrowers, $borrower;
 330         }
 331     }
 332     my @patron_attributes_option;
 333     for my $borrower ( @borrowers ) {
 334         push @patron_attributes_option, { value => "$_->{code}", lib => $_->{code} } for @{ $borrower->{patron_attributes} };
 335         my $length = scalar( @{ $borrower->{patron_attributes} } );
 336         push @{ $borrower->{patron_attributes} }, {} for ( $length .. $max_nb_attr - 1);
 337     }
 338
 339     my @attributes_header = ();
 340     for ( 1 .. scalar( $max_nb_attr ) ) {
 341         push @attributes_header, { attribute => "Attributes $_" };
 342     }
 343
 344     $template->param( borrowers => \@borrowers );
 345     $template->param( attributes_header => \@attributes_header );
 346
 347     $template->param( borrowers => \@borrowers );
 348     $template->param( errors => \@errors );
 349 } else {
 350
 351     $template->param( patron_lists => [ GetPatronLists() ] );
 352 }
 353
 354 $template->param(
 355     op => $op,
 356 );
 357 output_html_with_http_headers $input, $cookie, $template->output;
 358 exit;
 359
 360 sub GetBorrowerInfos {
 361     my ( %info ) = @_;
 362     my $borrower = GetMember( %info );
 363     if ( $borrower ) {
 364         $borrower->{branchname} = GetBranchName( $borrower->{branchcode} );
 365         for ( qw(dateenrolled dateexpiry) ) {
 366             my $userdate = $borrower->{$_};
 367             unless ($userdate && $userdate ne "0000-00-00" and $userdate ne "9999-12-31") {
 368                 $borrower->{$_} = '';
 369                 next;
 370             }
 371             $borrower->{$_} = $userdate || '';
 372         }
 373         $borrower->{category_description} = GetBorrowercategory( $borrower->{categorycode} )->{description};
 374         my $attr_loop = C4::Members::Attributes::GetBorrowerAttributes( $borrower->{borrowernumber} );
 375         $borrower->{patron_attributes} = $attr_loop;
 376     }
 377     return $borrower;
 378 }