797 lines
30 KiB
Perl
797 lines
30 KiB
Perl
package Koha::Patrons::Import;
|
|
|
|
# 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 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, see <http://www.gnu.org/licenses>.
|
|
|
|
use Modern::Perl;
|
|
use Moo;
|
|
|
|
use Carp qw( carp );
|
|
use Text::CSV;
|
|
use Encode qw( decode_utf8 );
|
|
use Try::Tiny qw( catch try );
|
|
|
|
use C4::Letters qw( GetPreparedLetter EnqueueLetter );
|
|
|
|
use Koha::Libraries;
|
|
use Koha::Patrons;
|
|
use Koha::Patron::Categories;
|
|
use Koha::Patron::Debarments qw( AddDebarment );
|
|
use Koha::Policy::Patrons::Cardnumber;
|
|
use Koha::DateUtils qw( dt_from_string output_pref );
|
|
|
|
=head1 NAME
|
|
|
|
Koha::Patrons::Import - Perl Module containing import_patrons method exported from import_borrowers script.
|
|
|
|
=head1 SYNOPSIS
|
|
|
|
use Koha::Patrons::Import;
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
This module contains one method for importing patrons in bulk.
|
|
|
|
=head1 FUNCTIONS
|
|
|
|
=head2 import_patrons
|
|
|
|
my $return = Koha::Patrons::Import::import_patrons($params);
|
|
|
|
Applies various checks and imports patrons in bulk from a csv file.
|
|
|
|
Further pod documentation needed here.
|
|
|
|
=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,
|
|
default => sub { Text::CSV->new( { binary => 1, } ); },
|
|
);
|
|
|
|
sub import_patrons {
|
|
my ( $self, $params ) = @_;
|
|
|
|
my $handle = $params->{file};
|
|
unless ($handle) { carp('No file handle passed in!'); return; }
|
|
|
|
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 $update_dateexpiry = $params->{update_dateexpiry};
|
|
my $update_dateexpiry_from_today = $params->{update_dateexpiry_from_today};
|
|
my $update_dateexpiry_from_existing = $params->{update_dateexpiry_from_existing};
|
|
|
|
my $extended = C4::Context->preference('ExtendedPatronAttributes');
|
|
my $set_messaging_prefs = C4::Context->preference('EnhancedMessagingPreferences');
|
|
|
|
my $schema = Koha::Database->new->schema;
|
|
$schema->storage->txn_begin if $dry_run;
|
|
|
|
my @columnkeys = $self->set_column_keys($extended);
|
|
my @feedback;
|
|
my @errors;
|
|
|
|
my $imported = 0;
|
|
my $alreadyindb = 0;
|
|
my $overwritten = 0;
|
|
my $invalid = 0;
|
|
my @imported_borrowers;
|
|
my $matchpoint_attr_type = $self->set_attribute_types( { extended => $extended, matchpoint => $matchpoint, } );
|
|
|
|
# Use header line to construct key to column map
|
|
my %csvkeycol;
|
|
my $borrowerline = <$handle>;
|
|
my @csvcolumns =
|
|
$self->prepare_columns( { headerrow => $borrowerline, keycol => \%csvkeycol, errors => \@errors, } );
|
|
push( @feedback, { feedback => 1, name => 'headerrow', value => join( ', ', @csvcolumns ) } );
|
|
|
|
my @criticals = qw( surname ); # there probably should be others - rm branchcode && categorycode
|
|
LINE: while ( my $borrowerline = <$handle> ) {
|
|
my $line_number = $.;
|
|
my %borrower;
|
|
my @missing_criticals;
|
|
|
|
my $status = $self->text_csv->parse($borrowerline);
|
|
my @columns = $self->text_csv->fields();
|
|
if ( !$status ) {
|
|
push @missing_criticals, { badparse => 1, line => $line_number, lineraw => decode_utf8($borrowerline) };
|
|
} elsif ( @columns == @columnkeys ) {
|
|
@borrower{@columnkeys} = @columns;
|
|
|
|
# MJR: try to fill blanks gracefully by using default values
|
|
foreach my $key (@columnkeys) {
|
|
if ( $borrower{$key} !~ /\S/ ) {
|
|
$borrower{$key} = $defaults->{$key};
|
|
}
|
|
}
|
|
} else {
|
|
|
|
# MJR: try to recover gracefully by using default values
|
|
foreach my $key (@columnkeys) {
|
|
if ( defined( $csvkeycol{$key} ) and $columns[ $csvkeycol{$key} ] =~ /\S/ ) {
|
|
$borrower{$key} = $columns[ $csvkeycol{$key} ];
|
|
} elsif ( $defaults->{$key} ) {
|
|
$borrower{$key} = $defaults->{$key};
|
|
} elsif ( scalar grep { $key eq $_ } @criticals ) {
|
|
|
|
# a critical field is undefined
|
|
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 "";
|
|
|
|
$borrower{protected} = 0 unless $borrower{protected};
|
|
|
|
# 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 );
|
|
|
|
# Check if branch code exists and if it matches to a branch name. Pushing error to missing_criticals otherwise.
|
|
$self->check_branch_code( $borrower{branchcode}, $borrowerline, $line_number, \@missing_criticals );
|
|
|
|
# Popular spreadsheet applications make it difficult to force date outputs to be zero-padded, but we require it.
|
|
$self->format_dates(
|
|
{
|
|
borrower => \%borrower, lineraw => $borrowerline, line => $line_number,
|
|
missing_criticals => \@missing_criticals,
|
|
}
|
|
);
|
|
|
|
if (@missing_criticals) {
|
|
foreach (@missing_criticals) {
|
|
$_->{borrowernumber} = $borrower{borrowernumber} || 'UNDEF';
|
|
$_->{surname} = $borrower{surname} || 'UNDEF';
|
|
}
|
|
$invalid++;
|
|
( 25 > scalar @errors ) and push @errors, { missing_criticals => \@missing_criticals };
|
|
|
|
# The first 25 errors are enough. Keeping track of 30,000+ would destroy performance.
|
|
next LINE;
|
|
}
|
|
|
|
# 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};
|
|
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 );
|
|
if ( defined($matchpoint) && ( $matchpoint eq 'cardnumber' ) && ( $borrower{'cardnumber'} ) ) {
|
|
$patron = Koha::Patrons->find( { cardnumber => $borrower{'cardnumber'} } );
|
|
} elsif ( defined($matchpoint) && ( $matchpoint eq 'userid' ) && ( $borrower{'userid'} ) ) {
|
|
$patron = Koha::Patrons->find( { userid => $borrower{userid} } );
|
|
} elsif ($extended) {
|
|
if ( defined($matchpoint_attr_type) ) {
|
|
foreach my $attr (@$patron_attributes) {
|
|
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;
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
if ( $patron && $update_dateexpiry_from_existing ) {
|
|
$patron->dateexpiry(
|
|
Koha::Patron::Categories->find( $borrower{categorycode} )->get_expiry_date( $patron->dateexpiry ) );
|
|
delete $borrower{dateexpiry};
|
|
}
|
|
|
|
my $is_new = 0;
|
|
if ($patron) {
|
|
$member = $patron->unblessed;
|
|
$borrowernumber = $member->{'borrowernumber'};
|
|
} else {
|
|
$member = {};
|
|
$is_new = 1;
|
|
}
|
|
|
|
my $is_valid = Koha::Policy::Patrons::Cardnumber->is_valid( $borrower{cardnumber}, $patron );
|
|
unless ($is_valid) {
|
|
push @errors,
|
|
{
|
|
invalid_cardnumber => 1,
|
|
borrowernumber => $borrowernumber,
|
|
cardnumber => $borrower{cardnumber}
|
|
};
|
|
$invalid++;
|
|
next;
|
|
}
|
|
|
|
# Check if the userid provided does not exist yet
|
|
if (
|
|
defined($matchpoint)
|
|
and $matchpoint ne 'userid'
|
|
and exists $borrower{userid}
|
|
and $borrower{userid}
|
|
and not(
|
|
$borrowernumber
|
|
? $patron->userid( $borrower{userid} )->has_valid_userid
|
|
: Koha::Patron->new( { userid => $borrower{userid} } )->has_valid_userid
|
|
)
|
|
)
|
|
{
|
|
push @errors, { duplicate_userid => 1, userid => $borrower{userid} };
|
|
$invalid++;
|
|
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
|
|
unless ($overwrite_cardnumber) {
|
|
$alreadyindb++;
|
|
push(
|
|
@feedback,
|
|
{
|
|
already_in_db => 1,
|
|
value => $borrower{'surname'} . ' / ' . $borrowernumber
|
|
}
|
|
);
|
|
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 unless we are forcing overwrite!
|
|
next if $col eq 'password' && !$overwrite_passwords;
|
|
next if $col eq 'dateexpiry' && $update_dateexpiry;
|
|
|
|
$borrower{$col} = $member->{$col} if $col eq 'dateexpiry' && !$columns[ $csvkeycol{$col} ];
|
|
|
|
unless ( exists( $csvkeycol{$col} ) || $defaults->{$col} ) {
|
|
$borrower{$col} = $member->{$col} if ( $member->{$col} );
|
|
}
|
|
}
|
|
|
|
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,
|
|
{
|
|
# TODO We can raise a better error
|
|
name => 'lastinvalid',
|
|
value => $borrower{'surname'} . ' / ' . $borrowernumber
|
|
}
|
|
);
|
|
}
|
|
} 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,
|
|
}
|
|
);
|
|
}
|
|
|
|
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,
|
|
}
|
|
);
|
|
}
|
|
|
|
$imported++;
|
|
push @imported_borrowers, $patron->borrowernumber; #for patronlist
|
|
push(
|
|
@feedback,
|
|
{
|
|
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 };
|
|
}
|
|
push(
|
|
@errors,
|
|
{
|
|
name => 'lastinvalid',
|
|
value => $borrower{'surname'} . ' / Create patron',
|
|
}
|
|
);
|
|
};
|
|
}
|
|
|
|
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(
|
|
{
|
|
letter => $letter,
|
|
borrowernumber => $patron->id,
|
|
to_address => $emailaddr,
|
|
message_transport_type => 'email'
|
|
}
|
|
);
|
|
};
|
|
if ($@) {
|
|
push @errors, { welcome_email_err => 1, borrowernumber => $borrowernumber };
|
|
} else {
|
|
push(
|
|
@feedback,
|
|
{
|
|
feedback => 1,
|
|
name => 'welcome_sent',
|
|
value => $borrower{'surname'} . ' / ' . $borrowernumber . ' / ' . $emailaddr
|
|
}
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
# 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 {
|
|
Koha::Patron::Relationship->new(
|
|
{
|
|
guarantee_id => $borrowernumber,
|
|
relationship => $guarantor_relationship,
|
|
guarantor_id => $guarantor_id,
|
|
}
|
|
)->store();
|
|
}
|
|
}
|
|
}
|
|
|
|
$schema->storage->txn_rollback if $dry_run;
|
|
|
|
return {
|
|
feedback => \@feedback,
|
|
errors => \@errors,
|
|
imported => $imported,
|
|
overwritten => $overwritten,
|
|
already_in_db => $alreadyindb,
|
|
invalid => $invalid,
|
|
imported_borrowers => \@imported_borrowers,
|
|
};
|
|
}
|
|
|
|
=head2 prepare_columns
|
|
|
|
my @csvcolumns = $self->prepare_columns({headerrow => $borrowerline, keycol => \%csvkeycol, errors => \@errors, });
|
|
|
|
Returns an array of all column key and populates a hash of colunm key positions.
|
|
|
|
=cut
|
|
|
|
sub prepare_columns {
|
|
my ( $self, $params ) = @_;
|
|
|
|
my $status = $self->text_csv->parse( $params->{headerrow} );
|
|
unless ($status) {
|
|
push( @{ $params->{errors} }, { badheader => 1, line => 1, lineraw => $params->{headerrow} } );
|
|
return;
|
|
}
|
|
|
|
my @csvcolumns = $self->text_csv->fields();
|
|
my $col = 0;
|
|
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++;
|
|
}
|
|
|
|
return @csvcolumns;
|
|
}
|
|
|
|
=head2 set_attribute_types
|
|
|
|
my $matchpoint_attr_type = $self->set_attribute_types({ extended => $extended, matchpoint => $matchpoint, });
|
|
|
|
Returns an attribute type based on matchpoint parameter.
|
|
|
|
=cut
|
|
|
|
sub set_attribute_types {
|
|
my ( $self, $params ) = @_;
|
|
|
|
my $attribute_type;
|
|
if ( $params->{extended} ) {
|
|
$attribute_type = Koha::Patron::Attribute::Types->find( $params->{matchpoint} );
|
|
}
|
|
|
|
return $attribute_type;
|
|
}
|
|
|
|
=head2 set_column_keys
|
|
|
|
my @columnkeys = set_column_keys($extended);
|
|
|
|
Returns an array of borrowers' table columns.
|
|
|
|
=cut
|
|
|
|
sub set_column_keys {
|
|
my ( $self, $extended ) = @_;
|
|
|
|
my @columnkeys = map { $_ ne 'borrowernumber' ? $_ : () } Koha::Patrons->columns();
|
|
push( @columnkeys, 'patron_attributes' ) if $extended;
|
|
push( @columnkeys, qw( guarantor_relationship guarantor_id ) );
|
|
|
|
return @columnkeys;
|
|
}
|
|
|
|
=head2 generate_patron_attributes
|
|
|
|
my $patron_attributes = generate_patron_attributes($extended, $borrower{patron_attributes}, $feedback);
|
|
|
|
Returns a Koha::Patron::Attributes as expected by Koha::Patron->extended_attributes
|
|
|
|
=cut
|
|
|
|
sub generate_patron_attributes {
|
|
my ( $self, $extended, $string, $feedback ) = @_;
|
|
|
|
unless ($extended) { return; }
|
|
unless ( defined $string ) { return; }
|
|
|
|
# Fixup double quotes in case we are passed smart quotes
|
|
$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, formula => "empty" } ); # 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
|
|
|
|
check_branch_code($borrower{branchcode}, $borrowerline, $line_number, \@missing_criticals);
|
|
|
|
Pushes a 'missing_criticals' error entry if no branch code or branch code does not map to a branch name.
|
|
|
|
=cut
|
|
|
|
sub check_branch_code {
|
|
my ( $self, $branchcode, $borrowerline, $line_number, $missing_criticals ) = @_;
|
|
|
|
# No branch code
|
|
unless ($branchcode) {
|
|
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 => decode_utf8($borrowerline),
|
|
value => $branchcode, branch_map => 1,
|
|
}
|
|
);
|
|
}
|
|
}
|
|
|
|
=head2 check_borrower_category
|
|
|
|
check_borrower_category($borrower{categorycode}, $borrowerline, $line_number, \@missing_criticals);
|
|
|
|
Pushes a 'missing_criticals' error entry if no category code or category code does not map to a known category.
|
|
|
|
=cut
|
|
|
|
sub check_borrower_category {
|
|
my ( $self, $categorycode, $borrowerline, $line_number, $missing_criticals ) = @_;
|
|
|
|
# No branch code
|
|
unless ($categorycode) {
|
|
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 => decode_utf8($borrowerline),
|
|
value => $categorycode, category_map => 1,
|
|
}
|
|
);
|
|
}
|
|
}
|
|
|
|
=head2 format_dates
|
|
|
|
format_dates({borrower => \%borrower, lineraw => $lineraw, line => $line_number, missing_criticals => \@missing_criticals, });
|
|
|
|
Pushes a 'missing_criticals' error entry for each of the 3 date types dateofbirth, dateenrolled and dateexpiry if it can not
|
|
be formatted to the chosen date format. Populates the correctly formatted date otherwise.
|
|
|
|
=cut
|
|
|
|
sub format_dates {
|
|
my ( $self, $params ) = @_;
|
|
|
|
foreach my $date_type (qw(dateofbirth dateenrolled dateexpiry date_renewed)) {
|
|
my $template = $params->{borrower}->{$date_type} or next();
|
|
my $formatted_date =
|
|
eval { output_pref( { dt => dt_from_string($template), dateonly => 1, dateformat => 'iso' } ); };
|
|
|
|
if ($formatted_date) {
|
|
$params->{borrower}->{$date_type} = $formatted_date;
|
|
} else {
|
|
$params->{borrower}->{$date_type} = '';
|
|
push(
|
|
@{ $params->{missing_criticals} },
|
|
{
|
|
key => $date_type, line => $params->{line}, lineraw => decode_utf8( $params->{lineraw} ),
|
|
bad_date => 1
|
|
}
|
|
);
|
|
}
|
|
}
|
|
}
|
|
|
|
1;
|
|
|
|
=head1 AUTHOR
|
|
|
|
Koha Team
|
|
|
|
=cut
|