3 # Parts copyright 2014 ByWater Solutions
5 # This file is part of Koha.
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.
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.
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>.
22 use Getopt::Long qw( GetOptions );
23 use Pod::Usage qw( pod2usage );
26 use Koha::Patrons::Import;
27 my $Import = Koha::Patrons::Import->new();
31 my $overwrite_cardnumber;
32 my $overwrite_passwords;
40 my $update_dateexpiry;
41 my $update_dateexpiry_from_today;
42 my $update_dateexpiry_from_existing;
45 'c|confirm' => \$confirm,
46 'f|file=s' => \$csv_file,
47 'm|matchpoint=s' => \$matchpoint,
48 'd|default=s' => \%defaults,
49 'o|overwrite' => \$overwrite_cardnumber,
50 'op|overwrite_passwords' => \$overwrite_passwords,
51 'ue|update-expiration' => \$update_dateexpiry,
52 'et|expiration-from-today' => \$update_dateexpiry_from_today,
53 'ee|expiration-from-existing' => \$update_dateexpiry_from_existing,
54 'en|email-new' => \$welcome_new,
55 'p|preserve-extended-attributes' => \$ext_preserve,
56 'pf|preserve-field=s' => \@preserve_fields,
57 'v|verbose+' => \$verbose,
61 pod2usage(1) if $help;
62 pod2usage(q|--ee and --et are mutually exclusive|) if $update_dateexpiry_from_today && $update_dateexpiry_from_existing;
63 pod2usage(q|--file is required|) unless $csv_file;
64 pod2usage(q|--matchpoint is required|) unless $matchpoint;
66 warn "Running in dry-run mode, provide --confirm to apply the changes\n" unless $confirm;
69 open( $handle, "<", $csv_file ) or die $!;
71 my $return = $Import->import_patrons(
74 defaults => \%defaults,
75 matchpoint => $matchpoint,
76 overwrite_cardnumber => $overwrite_cardnumber,
77 overwrite_passwords => $overwrite_passwords,
78 preserve_extended_attributes => $ext_preserve,
79 preserve_fields => \@preserve_fields,
80 update_dateexpiry => $update_dateexpiry,
81 update_dateexpiry_from_today => $update_dateexpiry_from_today,
82 update_dateexpiry_from_existing => $update_dateexpiry_from_existing,
83 send_welcome => $welcome_new,
88 my $feedback = $return->{feedback};
89 my $errors = $return->{errors};
90 my $imported = $return->{imported};
91 my $overwritten = $return->{overwritten};
92 my $alreadyindb = $return->{already_in_db};
93 my $invalid = $return->{invalid};
96 my $total = $imported + $alreadyindb + $invalid + $overwritten;
98 say "Import complete:";
99 say "Imported: $imported";
100 say "Overwritten: $overwritten";
101 say "Skipped: $alreadyindb";
102 say "Invalid: $invalid";
107 if ( $verbose > 1 ) {
109 say Data::Dumper::Dumper($errors);
112 if ( $verbose > 2 ) {
114 say Data::Dumper::Dumper($feedback);
119 import_patrons.pl - CLI script to import patrons data into Koha
123 import_patrons.pl --file /path/to/patrons.csv --matchpoint cardnumber --confirm [--default branchcode=MPL] [--overwrite] [--preserve-field <column>] [--preserve-extended-attributes] [--update-expiration] [--expiration-from-today] [--verbose]
131 Prints a brief help message and exits
133 =item B<-c|--confirm>
135 Confirms you really want to import these patrons, otherwise prints this help
139 Path to the CSV file of patrons to import
141 =item B<-m|--matchpoint>
143 Field on which to match incoming patrons to existing patrons
145 =item B<-d|--default>
147 Set defaults to patron fields, repeatable e.g. --default branchcode=MPL --default categorycode=PT
149 =item B<-k|--preserve-field>
151 Prevent specified patron fields for existing patrons from being overwritten
153 =item B<-o|--overwrite>
155 Overwrite existing patrons with new data if a match is found
157 =item B<-p|--preserve-extended-attributes>
159 Retain extended patron attributes for existing patrons being overwritten
161 =item B<-en|--email-new>
163 Send the WELCOME notice email to new users
165 =item B<-ue|--update-expiration>
167 If a matching patron is found, extend the expiration date of their account using the patron's enrollment date as the base
169 =item B<-et|--expiration-from-today>
171 If a matching patron is found, extend the expiration date of their account using today's date as the base
172 Cannot by used in conjunction with --expiration-from-existing
174 =item B<-ee|--expiration-from-existing>
176 If a matching patron is found, extend the expiration date of their account using the patron's current expiration date as the base
177 Cannot by used in conjunction with --expiration-from-today
179 =item B<-v|--verbose>
183 Multiple -v options increase the verbosity
185 2 repetitions or above will report lines in error
187 3 repetitions or above will report feedback