3 # Copyright 2011 BibLibre
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>.
20 # Script to export borrowers
24 use Getopt::Long qw(:config no_ignore_case);
29 binmode STDOUT, ":encoding(UTF-8)";
32 ( my $basename = $0 ) =~ s|.*/||;
36 Export patron informations in CSV format.
37 It prints to standard output. Use redirection to save CSV in a file.
40 $0 [--field=FIELD [--field=FIELD [...]]] [--separator=CHAR] [--show-header] [--where=CONDITION]
43 -f, --field=FIELD Field to export. It is repeatable and has to match
44 keys returned by the GetMemberDetails function.
45 If no field is specified, then all fields will be
47 -s, --separator=CHAR This character will be used to separate fields.
48 Some characters like | or ; will need to be escaped
49 in the parameter setting, like -s=\\| or -s=\\;
50 If no separator is specifield, a comma will be used.
51 -H, --show-header Print field names on first row
52 -w, --where=CONDITION Condition to filter borrowers to export
54 CONDITION must be enclosed by double quotes and
55 if needed, where value by single quotes.
56 example : --where "surname='De Lattre'"
57 -h, --help Show this help
70 'field|f=s' => \@fields,
71 'separator|s=s' => \$separator,
72 'show-header|H' => \$show_header,
73 'where|w=s' => \$where,
75 ) or print_usage, exit 1;
83 my $dbh = C4::Context->dbh;
84 my $query = "SELECT borrowernumber FROM borrowers";
85 $query .= " WHERE $where" if ($where);
86 $query .= " ORDER BY borrowernumber";
87 my $sth = $dbh->prepare($query);
90 unless ( $separator ) {
91 $separator = C4::Context->preference('delimiter') || ',';
92 $separator = "\t" if ($separator eq 'tabulation');
95 my $csv = Text::CSV->new( { sep_char => $separator, binary => 1 } );
97 # If the user did not specify any field to export, we assume he wants them all
98 # We retrieve the first borrower informations to get field names
99 my ($borrowernumber) = $sth->fetchrow_array or die "No borrower to export";
100 my $member = GetMemberDetails($borrowernumber);
101 @fields = keys %$member unless (@fields);
104 $csv->combine(@fields);
105 print $csv->string . "\n";
110 ( defined $member->{$_} and !ref $member->{$_} )
115 die "Invalid character at borrower $borrowernumber: ["
116 . $csv->error_input . "]\n"
117 if ( !defined( $csv->string ) );
118 print $csv->string . "\n";
120 while ( my $borrowernumber = $sth->fetchrow_array ) {
121 $member = GetMemberDetails($borrowernumber);
124 ( defined $member->{$_} and !ref $member->{$_} )
129 die "Invalid character at borrower $borrowernumber: ["
130 . $csv->error_input . "]\n"
131 if ( !defined( $csv->string ) );
132 print $csv->string . "\n";