# 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 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>.
use Modern::Perl;
use Moo;
-use namespace::clean;
-use Carp;
+use Carp qw( carp );
use Text::CSV;
+use Encode qw( decode_utf8 );
+use Try::Tiny qw( catch try );
-use C4::Members;
-use C4::Members::Attributes qw(:all);
-use C4::Members::AttributeTypes;
+use C4::Members qw( checkcardnumber );
+use C4::Letters qw( GetPreparedLetter EnqueueLetter );
use Koha::Libraries;
use Koha::Patrons;
use Koha::Patron::Categories;
-use Koha::Patron::Debarments;
-use Koha::DateUtils;
+use Koha::Patron::Debarments qw( AddDebarment );
+use Koha::DateUtils qw( dt_from_string output_pref );
=head1 NAME
=cut
has 'today_iso' => ( is => 'ro', lazy => 1,
+ # FIXME We shouldn't need to call output_pref here, passing a DateTime object should work
default => sub { output_pref( { dt => dt_from_string(), dateonly => 1, dateformat => 'iso' } ); }, );
has 'text_csv' => ( is => 'rw', lazy => 1,
my $matchpoint = $params->{matchpoint};
my $defaults = $params->{defaults};
+ my $preserve_fields = $params->{preserve_fields};
my $ext_preserve = $params->{preserve_extended_attributes};
my $overwrite_cardnumber = $params->{overwrite_cardnumber};
+ my $overwrite_passwords = $params->{overwrite_passwords};
+ my $dry_run = $params->{dry_run};
+ my $send_welcome = $params->{send_welcome};
my $extended = C4::Context->preference('ExtendedPatronAttributes');
my $set_messaging_prefs = C4::Context->preference('EnhancedMessagingPreferences');
+ my $update_dateexpiry = $params->{update_dateexpiry};
+ my $update_dateexpiry_from_today = $params->{update_dateexpiry_from_today};
+
+ my $schema = Koha::Database->new->schema;
+ $schema->storage->txn_begin if $dry_run;
my @columnkeys = $self->set_column_keys($extended);
my @feedback;
my $status = $self->text_csv->parse($borrowerline);
my @columns = $self->text_csv->fields();
if ( !$status ) {
- push @missing_criticals, { badparse => 1, line => $line_number, lineraw => $borrowerline };
+ push @missing_criticals, { badparse => 1, line => $line_number, lineraw => decode_utf8($borrowerline) };
}
elsif ( @columns == @columnkeys ) {
@borrower{@columnkeys} = @columns;
elsif ( scalar grep { $key eq $_ } @criticals ) {
# a critical field is undefined
- push @missing_criticals, { key => $key, line => $., lineraw => $borrowerline };
+ push @missing_criticals, { key => $key, line => $., lineraw => decode_utf8($borrowerline) };
}
else {
$borrower{$key} = '';
}
$borrower{cardnumber} = undef if $borrower{cardnumber} eq "";
+ $borrower{auth_method} = undef if $borrower{auth_method} eq "";
# Check if borrower category code exists and if it matches to a known category. Pushing error to missing_criticals otherwise.
$self->check_borrower_category($borrower{categorycode}, $borrowerline, $line_number, \@missing_criticals);
next LINE;
}
- # Set patron attributes if extended.
- my $patron_attributes = $self->set_patron_attributes($extended, $borrower{patron_attributes}, \@feedback);
+ # Generate patron attributes if extended.
+ my $patron_attributes = $self->generate_patron_attributes($extended, $borrower{patron_attributes}, \@feedback);
if( $extended ) { delete $borrower{patron_attributes}; } # Not really a field in borrowers.
# Default date enrolled and date expiry if not already set.
$borrower{dateenrolled} = $self->today_iso() unless $borrower{dateenrolled};
- $borrower{dateexpiry} = Koha::Patron::Categories->find( $borrower{categorycode} )->get_expiry_date( $borrower{dateenrolled} ) unless $borrower{dateexpiry};
+ my $expiration_start_date = $update_dateexpiry_from_today ? dt_from_string : $borrower{dateenrolled};
+ $borrower{dateexpiry} = Koha::Patron::Categories->find( $borrower{categorycode} )->get_expiry_date( $expiration_start_date ) if $update_dateexpiry;
my $borrowernumber;
my ( $member, $patron );
elsif ($extended) {
if ( defined($matchpoint_attr_type) ) {
foreach my $attr (@$patron_attributes) {
- if ( $attr->{code} eq $matchpoint and $attr->{value} ne '' ) {
- my @borrowernumbers = $matchpoint_attr_type->get_patrons( $attr->{value} );
+ if ( $attr->{code} eq $matchpoint and $attr->{attribute} ne '' ) {
+ my @borrowernumbers = Koha::Patron::Attributes->search(
+ {
+ code => $matchpoint_attr_type->code,
+ attribute => $attr->{attribute}
+ }
+ )->get_column('borrowernumber');
+
$borrowernumber = $borrowernumbers[0] if scalar(@borrowernumbers) == 1;
$patron = Koha::Patrons->find( $borrowernumber );
last;
}
}
+ my $is_new = 0;
if ($patron) {
$member = $patron->unblessed;
$borrowernumber = $member->{'borrowernumber'};
} else {
$member = {};
+ $is_new = 1;
}
if ( C4::Members::checkcardnumber( $borrower{cardnumber}, $borrowernumber ) ) {
next LINE;
}
+ my $guarantor_relationship = $borrower{guarantor_relationship};
+ delete $borrower{guarantor_relationship};
+ my $guarantor_id = $borrower{guarantor_id};
+ delete $borrower{guarantor_id};
+
+ # Remove warning for int datatype that cannot be null
+ # Argument "" isn't numeric in numeric eq (==) at /usr/share/perl5/DBIx/Class/Row.pm line 1018
+ for my $field (
+ qw( privacy privacy_guarantor_fines privacy_guarantor_checkouts anonymized login_attempts ))
+ {
+ delete $borrower{$field}
+ if exists $borrower{$field} and $borrower{$field} eq "";
+ }
+
+ my $success = 1;
if ($borrowernumber) {
# borrower exists
next LINE;
}
$borrower{'borrowernumber'} = $borrowernumber;
+
+ if ( $preserve_fields ) {
+ for my $field ( @$preserve_fields ) {
+ $borrower{$field} = $patron->$field;
+ }
+ }
+
for my $col ( keys %borrower ) {
# use values from extant patron unless our csv file includes this column or we provided a default.
# FIXME : You cannot update a field with a perl-evaluated false value using the defaults.
- # The password is always encrypted, skip it!
- next if $col eq 'password';
+ # The password is always encrypted, skip it unless we are forcing overwrite!
+ next if $col eq 'password' && !$overwrite_passwords;
unless ( exists( $csvkeycol{$col} ) || $defaults->{$col} ) {
$borrower{$col} = $member->{$col} if ( $member->{$col} );
}
}
- my $patron = Koha::Patrons->find( $borrowernumber );
- eval { $patron->set(\%borrower)->store };
- if ( $@ ) {
+ try {
+ $schema->storage->txn_do(sub {
+ $patron->set(\%borrower)->store;
+ # Don't add a new restriction if the existing 'combined' restriction matches this one
+ if ( $borrower{debarred} && ( ( $borrower{debarred} ne $member->{debarred} ) || ( $borrower{debarredcomment} ne $member->{debarredcomment} ) ) ) {
+
+ # Check to see if this debarment already exists
+ my $restrictions = $patron->restrictions->search(
+ {
+ expiration => $borrower{debarred},
+ comment => $borrower{debarredcomment}
+ }
+ );
+
+ # If it doesn't, then add it!
+ unless ($restrictions->count) {
+ AddDebarment(
+ {
+ borrowernumber => $borrowernumber,
+ expiration => $borrower{debarred},
+ comment => $borrower{debarredcomment}
+ }
+ );
+ }
+ }
+ if ($patron->category->category_type ne 'S' && $overwrite_passwords && defined $borrower{password} && $borrower{password} ne ''){
+ try {
+ $patron->set_password({ password => $borrower{password} });
+ }
+ catch {
+ if ( $_->isa('Koha::Exceptions::Password::TooShort') ) {
+ push @errors, { passwd_too_short => 1, borrowernumber => $borrowernumber, length => $_->{length}, min_length => $_->{min_length} };
+ }
+ elsif ( $_->isa('Koha::Exceptions::Password::WhitespaceCharacters') ) {
+ push @errors, { passwd_whitespace => 1, borrowernumber => $borrowernumber } ;
+ }
+ elsif ( $_->isa('Koha::Exceptions::Password::TooWeak') ) {
+ push @errors, { passwd_too_weak => 1, borrowernumber => $borrowernumber } ;
+ }
+ elsif ( $_->isa('Koha::Exceptions::Password::Plugin') ) {
+ push @errors, { passwd_plugin_err => 1, borrowernumber => $borrowernumber } ;
+ }
+ else {
+ push @errors, { passwd_unknown_err => 1, borrowernumber => $borrowernumber } ;
+ }
+ }
+ }
+ if ($extended && @$patron_attributes) {
+ if ($ext_preserve) {
+ $patron_attributes = $patron->extended_attributes->merge_and_replace_with( $patron_attributes );
+ }
+ # We do not want to filter by branch, maybe we should?
+ Koha::Patrons->find($borrowernumber)->extended_attributes->delete;
+ $patron->extended_attributes($patron_attributes);
+ }
+ $overwritten++;
+ push(
+ @feedback,
+ {
+ feedback => 1,
+ name => 'lastoverwritten',
+ value => $borrower{'surname'} . ' / ' . $borrowernumber
+ }
+ );
+ });
+ } catch {
$invalid++;
+ $success = 0;
+
+ my $patron_id = defined $matchpoint ? $borrower{$matchpoint} : $matchpoint_attr_type;
+ if ( $_->isa('Koha::Exceptions::Patron::Attribute::UniqueIDConstraint') ) {
+ push @errors, { patron_attribute_unique_id_constraint => 1, borrowernumber => $borrowernumber, attribute => $_->attribute };
+ } elsif ( $_->isa('Koha::Exceptions::Patron::Attribute::InvalidType') ) {
+ push @errors, { patron_attribute_invalid_type => 1, borrowernumber => $borrowernumber, attribute_type_code => $_->type };
+ } elsif ( $_->isa('Koha::Exceptions::Patron::Attribute::NonRepeatable') ) {
+ push @errors, { patron_attribute_non_repeatable => 1, borrowernumber => $borrowernumber, attribute => $_->attribute };
+ } else {
+ warn $_;
+ push @errors, { unknown_error => 1 };
+ }
push(
@errors,
value => $borrower{'surname'} . ' / ' . $borrowernumber
}
);
- next LINE;
}
- # Don't add a new restriction if the existing 'combined' restriction matches this one
- if ( $borrower{debarred} && ( ( $borrower{debarred} ne $member->{debarred} ) || ( $borrower{debarredcomment} ne $member->{debarredcomment} ) ) ) {
+ }
+ else {
+ try {
+ $schema->storage->txn_do(sub {
+ $patron = Koha::Patron->new(\%borrower)->store;
+ $borrowernumber = $patron->id;
+
+ if ( $patron->is_debarred ) {
+ AddDebarment(
+ {
+ borrowernumber => $patron->borrowernumber,
+ expiration => $patron->debarred,
+ comment => $patron->debarredcomment,
+ }
+ );
+ }
- # Check to see if this debarment already exists
- my $debarrments = GetDebarments(
- {
- borrowernumber => $borrowernumber,
- expiration => $borrower{debarred},
- comment => $borrower{debarredcomment}
+ if ($extended && @$patron_attributes) {
+ # FIXME Hum, we did not filter earlier and now we do?
+ $patron->extended_attributes->filter_by_branch_limitations->delete;
+ $patron->extended_attributes($patron_attributes);
+ }
+
+ if ($set_messaging_prefs) {
+ C4::Members::Messaging::SetMessagingPreferencesFromDefaults(
+ {
+ borrowernumber => $patron->borrowernumber,
+ categorycode => $patron->categorycode,
+ }
+ );
}
- );
- # If it doesn't, then add it!
- unless (@$debarrments) {
- AddDebarment(
+ $imported++;
+ push @imported_borrowers, $patron->borrowernumber; #for patronlist
+ push(
+ @feedback,
{
- borrowernumber => $borrowernumber,
- expiration => $borrower{debarred},
- comment => $borrower{debarredcomment}
+ feedback => 1,
+ name => 'lastimported',
+ value => $patron->surname . ' / ' . $patron->borrowernumber,
}
);
+ });
+ } catch {
+ $invalid++;
+ $success = 0;
+ my $patron_id = defined $matchpoint ? $borrower{$matchpoint} : $matchpoint_attr_type;
+ if ( $_->isa('Koha::Exceptions::Patron::Attribute::UniqueIDConstraint') ) {
+ push @errors, { patron_attribute_unique_id_constraint => 1, patron_id => $patron_id, attribute => $_->attribute };
+ } elsif ( $_->isa('Koha::Exceptions::Patron::Attribute::InvalidType') ) {
+ push @errors, { patron_attribute_invalid_type => 1, patron_id => $patron_id, attribute_type_code => $_->type };
+ } elsif ( $_->isa('Koha::Exceptions::Patron::Attribute::NonRepeatable') ) {
+ push @errors, { patron_attribute_non_repeatable => 1, patron_id => $patron_id, attribute => $_->attribute };
+
+ } else {
+ warn $_;
+ push @errors, { unknown_error => 1 };
}
- }
- if ($extended) {
- if ($ext_preserve) {
- my $old_attributes = GetBorrowerAttributes($borrowernumber);
- $patron_attributes = extended_attributes_merge( $old_attributes, $patron_attributes );
- }
- push @errors, { unknown_error => 1 }
- unless SetBorrowerAttributes( $borrower{'borrowernumber'}, $patron_attributes, 'no_branch_limit' );
- }
- $overwritten++;
- push(
- @feedback,
- {
- feedback => 1,
- name => 'lastoverwritten',
- value => $borrower{'surname'} . ' / ' . $borrowernumber
- }
- );
- }
- else {
- my $patron = eval {
- Koha::Patron->new(\%borrower)->store;
+ push(
+ @errors,
+ {
+ name => 'lastinvalid',
+ value => $borrower{'surname'} . ' / Create patron',
+ }
+ );
};
- unless ( $@ ) {
+ }
- if ( $patron->is_debarred ) {
- AddDebarment(
+ next LINE unless $success;
+
+ # Send WELCOME welcome email is the user is new and we're set to send mail
+ if ($send_welcome && $is_new) {
+ my $emailaddr = $patron->notice_email_address;
+
+ # if we manage to find a valid email address, send notice
+ if ($emailaddr) {
+ eval {
+ my $letter = GetPreparedLetter(
+ module => 'members',
+ letter_code => 'WELCOME',
+ branchcode => $patron->branchcode,,
+ lang => $patron->lang || 'default',
+ tables => {
+ 'branches' => $patron->branchcode,
+ 'borrowers' => $patron->borrowernumber,
+ },
+ want_librarian => 1,
+ ) or return;
+
+ my $message_id = EnqueueLetter(
{
- borrowernumber => $patron->borrowernumber,
- expiration => $patron->debarred,
- comment => $patron->debarredcomment,
+ letter => $letter,
+ borrowernumber => $patron->id,
+ to_address => $emailaddr,
+ message_transport_type => 'email'
}
);
- }
-
- if ($extended) {
- SetBorrowerAttributes( $patron->borrowernumber, $patron_attributes );
- }
-
- if ($set_messaging_prefs) {
- C4::Members::Messaging::SetMessagingPreferencesFromDefaults(
+ };
+ if ($@) {
+ push @errors, { welcome_email_err => 1, borrowernumber => $borrowernumber };
+ } else {
+ push(
+ @feedback,
{
- borrowernumber => $patron->borrowernumber,
- categorycode => $patron->categorycode,
+ feedback => 1,
+ name => 'welcome_sent',
+ value => $borrower{'surname'} . ' / ' . $borrowernumber . ' / ' . $emailaddr
}
);
}
+ }
+ }
- $imported++;
- push @imported_borrowers, $patron->borrowernumber; #for patronlist
- push(
- @feedback,
- {
- feedback => 1,
- name => 'lastimported',
- value => $patron->surname . ' / ' . $patron->borrowernumber,
- }
- );
+ # Add a guarantor if we are given a relationship
+ if ( $guarantor_id ) {
+ my $relationship = Koha::Patron::Relationships->find(
+ {
+ guarantee_id => $borrowernumber,
+ guarantor_id => $guarantor_id,
+ }
+ );
+
+ if ( $relationship ) {
+ $relationship->relationship( $guarantor_relationship );
+ $relationship->store();
}
else {
- $invalid++;
- push @errors, { unknown_error => 1 };
- push(
- @errors,
+ Koha::Patron::Relationship->new(
{
- name => 'lastinvalid',
- value => $borrower{'surname'} . ' / Create patron',
+ guarantee_id => $borrowernumber,
+ relationship => $guarantor_relationship,
+ guarantor_id => $guarantor_id,
}
- );
+ )->store();
}
}
}
+ $schema->storage->txn_rollback if $dry_run;
+
return {
feedback => \@feedback,
errors => \@errors,
foreach my $keycol (@csvcolumns) {
# columnkeys don't contain whitespace, but some stupid tools add it
$keycol =~ s/ +//g;
+ $keycol =~ s/^\N{BOM}//; # Strip BOM if exists, otherwise it will be part of first column key
$params->{keycol}->{$keycol} = $col++;
}
sub set_attribute_types {
my ($self, $params) = @_;
- my $attribute_types;
+ my $attribute_type;
if( $params->{extended} ) {
- $attribute_types = C4::Members::AttributeTypes->fetch($params->{matchpoint});
+ $attribute_type = Koha::Patron::Attribute::Types->find($params->{matchpoint});
}
- return $attribute_types;
+ return $attribute_type;
}
=head2 set_column_keys
my @columnkeys = map { $_ ne 'borrowernumber' ? $_ : () } Koha::Patrons->columns();
push( @columnkeys, 'patron_attributes' ) if $extended;
+ push( @columnkeys, qw( guarantor_relationship guarantor_id ) );
return @columnkeys;
}
-=head2 set_patron_attributes
+=head2 generate_patron_attributes
- my $patron_attributes = set_patron_attributes($extended, $borrower{patron_attributes}, $feedback);
+ my $patron_attributes = generate_patron_attributes($extended, $borrower{patron_attributes}, $feedback);
-Returns a reference to array of hashrefs data structure as expected by SetBorrowerAttributes.
+Returns a Koha::Patron::Attributes as expected by Koha::Patron->extended_attributes
=cut
-sub set_patron_attributes {
- my ($self, $extended, $patron_attributes, $feedback) = @_;
+sub generate_patron_attributes {
+ my ($self, $extended, $string, $feedback) = @_;
unless( $extended ) { return; }
- unless( defined($patron_attributes) ) { return; }
+ unless( defined $string ) { return; }
# Fixup double quotes in case we are passed smart quotes
- $patron_attributes =~ s/\xe2\x80\x9c/"/g;
- $patron_attributes =~ s/\xe2\x80\x9d/"/g;
-
- push (@$feedback, { feedback => 1, name => 'attribute string', value => $patron_attributes });
-
- my $result = extended_attributes_code_value_arrayref($patron_attributes);
-
- return $result;
+ $string =~ s/\xe2\x80\x9c/"/g;
+ $string =~ s/\xe2\x80\x9d/"/g;
+
+ push (@$feedback, { feedback => 1, name => 'attribute string', value => $string });
+ return [] unless $string; # Unit tests want the feedback, is it really needed?
+
+ my $csv = Text::CSV->new({binary => 1}); # binary needed for non-ASCII Unicode
+ my $ok = $csv->parse($string); # parse field again to get subfields!
+ my @list = $csv->fields();
+ my @patron_attributes =
+ sort { $a->{code} cmp $b->{code} || $a->{attribute} cmp $b->{attribute} }
+ map {
+ my @arr = split /:/, $_, 2;
+ { code => $arr[0], attribute => $arr[1] }
+ } @list;
+ return \@patron_attributes;
+ # TODO: error handling (check $ok)
}
=head2 check_branch_code
# No branch code
unless( $branchcode ) {
- push (@$missing_criticals, { key => 'branchcode', line => $line_number, lineraw => $borrowerline, });
+ push (@$missing_criticals, { key => 'branchcode', line => $line_number, lineraw => decode_utf8($borrowerline), });
return;
}
# look for branch code
my $library = Koha::Libraries->find( $branchcode );
unless( $library ) {
- push (@$missing_criticals, { key => 'branchcode', line => $line_number, lineraw => $borrowerline,
+ push (@$missing_criticals, { key => 'branchcode', line => $line_number, lineraw => decode_utf8($borrowerline),
value => $branchcode, branch_map => 1, });
}
}
# No branch code
unless( $categorycode ) {
- push (@$missing_criticals, { key => 'categorycode', line => $line_number, lineraw => $borrowerline, });
+ push (@$missing_criticals, { key => 'categorycode', line => $line_number, lineraw => decode_utf8($borrowerline), });
return;
}
# Looking for borrower category
my $category = Koha::Patron::Categories->find($categorycode);
unless( $category ) {
- push (@$missing_criticals, { key => 'categorycode', line => $line_number, lineraw => $borrowerline,
+ push (@$missing_criticals, { key => 'categorycode', line => $line_number, lineraw => decode_utf8($borrowerline),
value => $categorycode, category_map => 1, });
}
}
$params->{borrower}->{$date_type} = $formatted_date;
} else {
$params->{borrower}->{$date_type} = '';
- push (@{$params->{missing_criticals}}, { key => $date_type, line => $params->{line}, lineraw => $params->{lineraw}, bad_date => 1 });
+ push (@{$params->{missing_criticals}}, { key => $date_type, line => $params->{line}, lineraw => decode_utf8($params->{lineraw}), bad_date => 1 });
}
}
}
projects / koha-ffzg.git / blobdiff