misc/import_patrons.pl

   1 #!/usr/bin/perl
   2
   3 # Parts copyright 2014 ByWater Solutions
   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 use Modern::Perl;
  21
  22 use Getopt::Long;
  23 use Pod::Usage;
  24
  25 use Koha::Script;
  26 use Koha::Patrons::Import;
  27 my $Import = Koha::Patrons::Import->new();
  28
  29 my $csv_file;
  30 my $matchpoint;
  31 my $overwrite_cardnumber;
  32 my %defaults;
  33 my $ext_preserve = 0;
  34 my $confirm;
  35 my $verbose      = 0;
  36 my $help;
  37
  38 GetOptions(
  39     'c|confirm'                     => \$confirm,
  40     'f|file=s'                      => \$csv_file,
  41     'm|matchpoint=s'                => \$matchpoint,
  42     'd|default=s'                   => \%defaults,
  43     'o|overwrite'                   => \$overwrite_cardnumber,
  44     'p|preserve-extended-attributes' => \$ext_preserve,
  45     'v|verbose+'                    => \$verbose,
  46     'h|help|?'                      => \$help,
  47 ) or pod2usage(2);
  48
  49 pod2usage(1) if $help;
  50 pod2usage(q|--file is required|) unless $csv_file;
  51 pod2usage(q|--matchpoint is required|) unless $matchpoint;
  52
  53 warn "Running in dry-run mode, provide --confirm to apply the changes\n" unless $confirm;
  54
  55 my $handle;
  56 open( $handle, "<", $csv_file ) or die $!;
  57
  58 my $return = $Import->import_patrons(
  59     {
  60         file                         => $handle,
  61         defaults                     => \%defaults,
  62         matchpoint                   => $matchpoint,
  63         overwrite_cardnumber         => $overwrite_cardnumber,
  64         preserve_extended_attributes => $ext_preserve,
  65         dry_run                      => !$confirm,
  66     }
  67 );
  68
  69 my $feedback    = $return->{feedback};
  70 my $errors      = $return->{errors};
  71 my $imported    = $return->{imported};
  72 my $overwritten = $return->{overwritten};
  73 my $alreadyindb = $return->{already_in_db};
  74 my $invalid     = $return->{invalid};
  75
  76 if ($verbose) {
  77     my $total = $imported + $alreadyindb + $invalid + $overwritten;
  78     say q{};
  79     say "Import complete:";
  80     say "Imported:    $imported";
  81     say "Overwritten: $overwritten";
  82     say "Skipped:     $alreadyindb";
  83     say "Invalid:     $invalid";
  84     say "Total:       $total";
  85     say q{};
  86 }
  87
  88 if ($verbose > 1 ) {
  89     say "Errors:";
  90     say Data::Dumper::Dumper( $errors );
  91 }
  92
  93 if ($verbose > 2 ) {
  94     say "Feedback:";
  95     say Data::Dumper::Dumper( $feedback );
  96 }
  97
  98 =head1 NAME
  99
 100 import_patrons.pl - CLI script to import patrons data into Koha
 101
 102 =head1 SYNOPSIS
 103
 104 import_patrons.pl --file /path/to/patrons.csv --matchpoint cardnumber --confirm [--default branchcode=MPL] [--overwrite] [--preserve-extended-attributes] [--verbose]
 105
 106 =head1 OPTIONS
 107
 108 =over 8
 109
 110 =item B<-h|--help>
 111
 112 Prints a brief help message and exits
 113
 114 =item B<-c|--confirm>
 115
 116 Confirms you really want to import these patrons, otherwise prints this help
 117
 118 =item B<-f|--file>
 119
 120 Path to the CSV file of patrons to import
 121
 122 =item B<-c|--matchpoint>
 123
 124 Field on which to match incoming patrons to existing patrons
 125
 126 =item B<-d|--default>
 127
 128 Set defaults to patron fields, repeatable e.g. --default branchcode=MPL --default categorycode=PT
 129
 130 =item B<-o|--overwrite>
 131
 132 Overwrite existing patrons with new data if a match is found
 133
 134 =item B<-p|--preserve-extended-attributes>
 135
 136 Retain extended patron attributes for existing patrons being overwritten
 137
 138 =item B<-v|--verbose>
 139
 140 Be verbose
 141
 142 Multiple -v options increase the verbosity
 143
 144 2 repetitions or above will report lines in error
 145
 146 3 repetitions or above will report feedback
 147
 148 =back
 149
 150 =cut