Bug 17600: Standardize our EXPORT_OK
[srvgit] / tools / modborrowers.pl
index 7009014..a12c81d 100755 (executable)
@@ -4,49 +4,52 @@
 #
 # 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 2 of the License, or (at your option) any later
-# version.
+# 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.
+# 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, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# 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 sort1 sort2 dateenrolled dateexpiry debarred debarredcomment borrowernotes
+# surname firstname branchcode categorycode city state zipcode country sort1
+# sort2 dateenrolled dateexpiry borrowernotes
 # And for patron attributes.
 
 use Modern::Perl;
-use CGI;
-use C4::Auth;
-use C4::Branch;
-use C4::Koha;
+use CGI qw ( -utf8 );
+use C4::Auth qw( get_template_and_user );
+use C4::Koha qw( GetAuthorisedValues );
 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::List::Patron;
-
-my $input = new CGI;
+use C4::Output qw( output_html_with_http_headers );
+use Koha::DateUtils qw( dt_from_string );
+use Koha::List::Patron qw( GetPatronLists );
+use Koha::Libraries;
+use Koha::Patron::Categories;
+use Koha::Patron::Debarments qw( AddDebarment DelDebarment GetDebarments );
+use Koha::Patrons;
+
+my $input = CGI->new;
 my $op = $input->param('op') || 'show_form';
 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
-    {   template_name   => "tools/modborrowers.tmpl",
+    {   template_name   => "tools/modborrowers.tt",
         query           => $input,
         type            => "intranet",
-        authnotrequired => 0,
         flagsrequired   => { tools => "edit_patrons" },
     }
 );
 
+my $logged_in_user = Koha::Patrons->find( $loggedinuser );
+
 my %cookies   = parse CGI::Cookie($cookie);
 my $sessionID = $cookies{'CGISESSID'}->value;
 my $dbh       = C4::Context->dbh;
@@ -61,7 +64,6 @@ if ( $op eq 'show' ) {
     my @notfoundcardnumbers;
 
     # Get cardnumbers from a file or the input area
-    my @contentlist;
     if ($filefh) {
         while ( my $content = <$filefh> ) {
             $content =~ s/[\r\n]*$//g;
@@ -82,11 +84,18 @@ if ( $op eq 'show' ) {
 
     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;
+        my $patron = Koha::Patrons->find( { cardnumber => $cardnumber } );
+        if ( $patron ) {
+            if ( $logged_in_user->can_see_patron_infos( $patron ) ) {
+                my $borrower = $patron->unblessed;
+                my $attributes = $patron->extended_attributes;
+                $borrower->{patron_attributes} = $attributes->as_list;
+                $borrower->{patron_attributes_count} = $attributes->count;
+                $max_nb_attr = $borrower->{patron_attributes_count} if $borrower->{patron_attributes_count} > $max_nb_attr;
+                push @borrowers, $borrower;
+            } else {
+                push @notfoundcardnumbers, $cardnumber;
+            }
         } else {
             push @notfoundcardnumbers, $cardnumber;
         }
@@ -94,34 +103,38 @@ if ( $op eq 'show' ) {
 
     # Just for a correct display
     for my $borrower ( @borrowers ) {
-        my $length = scalar( @{ $borrower->{patron_attributes} } );
+        my $length = $borrower->{patron_attributes_count};
         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 = C4::Members::GetBorrowercategoryList;
-    for ( values %$patron_attribute_types ) {
-        my $attr_type = C4::Members::AttributeTypes->fetch( $_->{code} );
+    my $library_id = C4::Context->userenv ? C4::Context->userenv->{'branch'} : undef;
+    my $patron_attribute_types = Koha::Patron::Attribute::Types->search_with_library_limits({}, {}, $library_id);
+    my @patron_categories = Koha::Patron::Categories->search_with_library_limits({}, {order_by => ['description']});
+    while ( my $attr_type = $patron_attribute_types->next ) {
+        # 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},
+                attribute_code => $attr_type->code,
                 options        => $options,
             };
 
-        my $category_code = $_->{category_code};
+        my $category_code = $attr_type->category_code;
         my ( $category_lib ) = map {
-            ( defined $category_code and $_->{categorycode} eq $category_code ) ? $_->{description} : ()
-        } @$patron_categories;
+            ( defined $category_code and $attr_type->category_code eq $category_code ) ? $attr_type->description : ()
+        } @patron_categories;
         push @patron_attributes_codes,
             {
-                attribute_code => $_->{code},
-                attribute_lib  => $_->{description},
+                attribute_code => $attr_type->code,
+                attribute_lib  => $attr_type->description,
                 category_lib   => $category_lib,
                 type           => $attr_type->authorised_value_category ? 'select' : 'text',
             };
@@ -138,13 +151,12 @@ if ( $op eq 'show' ) {
         if @notfoundcardnumbers;
 
     # Construct drop-down list values
-    my $branches = GetBranchesLoop;
+    my $branches = Koha::Libraries->search({}, { order_by => ['branchname'] })->unblessed;
     my @branches_option;
-    push @branches_option, { value => $_->{value}, lib => $_->{branchname} } for @$branches;
+    push @branches_option, { value => $_->{branchcode}, lib => $_->{branchname} } for @$branches;
     unshift @branches_option, { value => "", lib => "" };
-    my $categories = GetBorrowercategoryList;
     my @categories_option;
-    push @categories_option, { value => $_->{categorycode}, lib => $_->{description} } for @$categories;
+    push @categories_option, { value => $_->categorycode, lib => $_->description } for @patron_categories;
     unshift @categories_option, { value => "", lib => "" };
     my $bsort1 = GetAuthorisedValues("Bsort1");
     my @sort1_option;
@@ -169,7 +181,7 @@ if ( $op eq 'show' ) {
         {
             name => "firstname",
             type => "text",
-            mandatory => ( grep /surname/, @mandatoryFields ) ? 1 : 0,
+            mandatory => ( grep /firstname/, @mandatoryFields ) ? 1 : 0,
         }
         ,
         {
@@ -187,6 +199,66 @@ if ( $op eq 'show' ) {
         }
         ,
         {
+            name => "streetnumber",
+            type => "text",
+            mandatory => ( grep /streetnumber/, @mandatoryFields ) ? 1 : 0,
+        }
+        ,
+        {
+            name => "address",
+            type => "text",
+            mandatory => ( grep /address/, @mandatoryFields ) ? 1 : 0,
+        }
+        ,
+        {
+            name => "address2",
+            type => "text",
+            mandatory => ( grep /address2/, @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 => "email",
+            type => "text",
+            mandatory => ( grep /email/, @mandatoryFields ) ? 1 : 0,
+        }
+        ,
+        {
+            name => "phone",
+            type => "text",
+            mandatory => ( grep /phone/, @mandatoryFields ) ? 1 : 0,
+        }
+        ,
+        {
+            name => "mobile",
+            type => "text",
+            mandatory => ( grep /mobile/, @mandatoryFields ) ? 1 : 0,
+        }
+        ,
+        {
             name => "sort1",
             type => @sort1_option ? "select" : "text",
             option => \@sort1_option,
@@ -213,6 +285,18 @@ if ( $op eq 'show' ) {
         }
         ,
         {
+            name => "borrowernotes",
+            type => "text",
+            mandatory => ( grep /borrowernotes/, @mandatoryFields ) ? 1 : 0,
+        }
+        ,
+        {
+            name => "opacnote",
+            type => "text",
+            mandatory => ( grep /opacnote/, @mandatoryFields ) ? 1 : 0,
+        }
+        ,
+        {
             name => "debarred",
             type => "date",
             mandatory => ( grep /debarred/, @mandatoryFields ) ? 1 : 0,
@@ -222,13 +306,7 @@ if ( $op eq 'show' ) {
             name => "debarredcomment",
             type => "text",
             mandatory => ( grep /debarredcomment/, @mandatoryFields ) ? 1 : 0,
-        }
-        ,
-        {
-            name => "borrowernotes",
-            type => "text",
-            mandatory => ( grep /borrowernotes/, @mandatoryFields ) ? 1 : 0,
-        }
+        },
     );
 
     $template->param('patron_attributes_codes', \@patron_attributes_codes);
@@ -240,51 +318,81 @@ if ( $op eq 'show' ) {
 # Process modifications
 if ( $op eq 'do' ) {
 
-    my @disabled = $input->param('disable_input');
+    my @disabled = $input->multi_param('disable_input');
     my $infos;
-    for my $field ( qw/surname firstname branchcode categorycode sort1 sort2 dateenrolled dateexpiry debarred debarredcomment borrowernotes/ ) {
+    for my $field ( qw/surname firstname branchcode categorycode streetnumber address address2 city state zipcode country email phone mobile sort1 sort2 dateenrolled dateexpiry borrowernotes opacnote debarred debarredcomment/ ) {
         my $value = $input->param($field);
         $infos->{$field} = $value if $value;
-        $infos->{$field} = "" if grep { /^$field$/ } @disabled;
+        $infos->{$field} = "" if grep { $_ eq $field } @disabled;
+    }
+
+    for my $field ( qw( dateenrolled dateexpiry debarred ) ) {
+        $infos->{$field} = dt_from_string($infos->{$field}) if $infos->{$field};
     }
 
-    my @attributes = $input->param('patron_attributes');
-    my @attr_values = $input->param('patron_attributes_value');
+    my @attributes = $input->multi_param('patron_attributes');
+    my @attr_values = $input->multi_param('patron_attributes_value');
 
     my @errors;
-    my @borrowernumbers = $input->param('borrowernumber');
+    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 ) {
+            # If a debarred date or debarred comment has been submitted make a new debarment
+            if ( $infos->{debarred} || $infos->{debarredcomment} ) {
+                AddDebarment(
+                    {
+                        borrowernumber => $borrowernumber,
+                        type           => 'MANUAL',
+                        comment        => $infos->{debarredcomment},
+                        expiration     => $infos->{debarred},
+                    });
+            }
+
+            # If debarment date or debarment comment are disabled then remove all debarrments
+            if ( grep { /debarred/ } @disabled ) {
+                eval {
+                   my $debarrments = GetDebarments( { borrowernumber => $borrowernumber } );
+                   foreach my $debarment (@$debarrments) {
+                      DelDebarment( $debarment->{'borrower_debarment_id'} );
+                   }
+                };
+            }
+
             $infos->{borrowernumber} = $borrowernumber;
-            my $success = ModMember(%$infos);
-            push @errors, { error => "can_not_update", borrowernumber => $infos->{borrowernumber} } if not $success;
+            eval { Koha::Patrons->find( $borrowernumber )->set($infos)->store; };
+            if ( $@ ) { # FIXME We could provide better error handling here
+                my $patron = Koha::Patrons->find( $borrowernumber );
+                $infos->{cardnumber} = $patron ? $patron->cardnumber || '' : '';
+                push @errors, { error => "can_not_update", borrowernumber => $infos->{borrowernumber}, cardnumber => $infos->{cardnumber} };
+            }
         }
 
-        #
-        my $borrower_categorycode = GetBorrowerCategorycode $borrowernumber;
+        my $patron = Koha::Patrons->find( $borrowernumber );
         my $i=0;
         for ( @attributes ) {
+            next unless $_;
             my $attribute;
             $attribute->{code} = $_;
             $attribute->{attribute} = $attr_values[$i];
-            my $attr_type = C4::Members::AttributeTypes->fetch( $_ );
+            my $attr_type = Koha::Patron::Attribute::Types->find($_);
             # 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;
+            ++$i and next if $attr_type->category_code and $attr_type->category_code ne $patron->categorycode;
             my $valuename = "attr" . $i . "_value";
-            if ( grep { /^$valuename$/ } @disabled ) {
+            if ( grep { $_ eq $valuename } @disabled ) {
                 # The attribute is disabled, we remove it for this borrower !
                 eval {
-                    C4::Members::Attributes::DeleteBorrowerAttribute( $borrowernumber, $attribute );
+                    $patron->get_extended_attribute($attribute->{code})->delete;
                 };
                 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 );
+                    # Note:
+                    # We should not need to filter by branch, but stay on the safe side
+                    # Repeatable are not supported so we can do that - TODO
+                    $patron->extended_attributes->search({'me.code' => $attribute->{code}})->filter_by_branch_limitations->delete;
+                    $patron->add_extended_attribute($attribute);
                 };
                 push @errors, { error => $@ } if $@;
             }
@@ -297,10 +405,14 @@ if ( $op eq 'do' ) {
     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;
+        my $patron = Koha::Patrons->find( $borrowernumber );
+        if ( $patron ) {
+            my $category_description = $patron->category->description;
+            my $borrower = $patron->unblessed;
+            $borrower->{category_description} = $category_description;
+            my $attributes = $patron->extended_attributes;
+            $borrower->{patron_attributes} = $attributes->as_list;
+            $max_nb_attr = $attributes->count if $attributes->count > $max_nb_attr;
             push @borrowers, $borrower;
         }
     }
@@ -319,7 +431,6 @@ if ( $op eq 'do' ) {
     $template->param( borrowers => \@borrowers );
     $template->param( attributes_header => \@attributes_header );
 
-    $template->param( borrowers => \@borrowers );
     $template->param( errors => \@errors );
 } else {
 
@@ -331,23 +442,3 @@ $template->param(
 );
 output_html_with_http_headers $input, $cookie, $template->output;
 exit;
-
-sub GetBorrowerInfos {
-    my ( %info ) = @_;
-    my $borrower = GetMember( %info );
-    if ( $borrower ) {
-        $borrower->{branchname} = GetBranchName( $borrower->{branchcode} );
-        for ( qw(dateenrolled dateexpiry debarred) ) {
-            my $userdate = $borrower->{$_};
-            unless ($userdate && $userdate ne "0000-00-00" and $userdate ne "9999-12-31") {
-                $borrower->{$_} = '';
-                next;
-            }
-            $borrower->{$_} = $userdate || '';
-        }
-        $borrower->{category_description} = GetBorrowercategory( $borrower->{categorycode} )->{description};
-        my $attr_loop = C4::Members::Attributes::GetBorrowerAttributes( $borrower->{borrowernumber} );
-        $borrower->{patron_attributes} = $attr_loop;
-    }
-    return $borrower;
-}