5 use Pod::Usage qw( pod2usage );
6 use Getopt::Long qw( GetOptions );
8 use Koha::Script -cron;
9 use C4::Members qw( GetBorrowersToExpunge );
10 use Koha::DateUtils qw( dt_from_string );
12 use C4::Log qw( cronlogaction );
14 my ( $help, $verbose, $not_borrowed_since, $expired_before, $last_seen,
15 @category_code, $branchcode, $file, $confirm );
19 'v|verbose' => \$verbose,
20 'not_borrowed_since:s' => \$not_borrowed_since,
21 'expired_before:s' => \$expired_before,
22 'last_seen:s' => \$last_seen,
23 'category_code:s' => \@category_code,
24 'library:s' => \$branchcode,
26 'c|confirm' => \$confirm,
33 $not_borrowed_since = dt_from_string( $not_borrowed_since, 'iso' )
34 if $not_borrowed_since;
36 $expired_before = dt_from_string( $expired_before, 'iso' )
39 if ( $last_seen and not C4::Context->preference('TrackLastPatronActivity') ) {
40 pod2usage(q{The --last_seen option cannot be used with TrackLastPatronActivity turned off});
43 unless ( $not_borrowed_since or $expired_before or $last_seen or @category_code or $branchcode or $file ) {
44 pod2usage(q{At least one filter is mandatory});
51 open(my $fh, '<:encoding(UTF-8)', $file) or die "Could not open file $file' $!";
52 while (my $line = <$fh>) {
54 my %fm = ('borrowernumber' => $line);
56 push @file_members, $fm_ref;
62 if ( $not_borrowed_since or $expired_before or $last_seen or @category_code or $branchcode ) {
63 $members = GetBorrowersToExpunge(
65 not_borrowed_since => $not_borrowed_since,
66 expired_before => $expired_before,
67 last_seen => $last_seen,
68 category_code => \@category_code,
69 branchcode => $branchcode,
74 if ($members and @file_members) {
76 for my $member (@$members) {
77 for my $fm (@file_members) {
78 if ($member->{borrowernumber} eq $fm->{borrowernumber}) {
79 push @filtered_members, $fm;
83 $members = \@filtered_members;
86 if (!defined $members and @file_members) {
87 $members = \@file_members;
91 say "Doing a dry run; no patron records will actually be deleted.";
92 say "Run again with --confirm to delete the records.";
96 say scalar(@$members) . " patrons match conditions" if $verbose;;
98 my $anonymous_patron = C4::Context->preference("AnonymousPatron");
100 for my $member (@$members) {
101 print "Testing that we can delete patron $member->{borrowernumber}... "
104 my $borrowernumber = $member->{borrowernumber};
105 my $patron = Koha::Patrons->find( $borrowernumber );
107 say "Cannot delete: Patron with borrowernumber $borrowernumber does not exist";
110 if ( my $charges = $patron->account->non_issues_charges ) { # And what if we owe to this patron?
111 say "Cannot delete patron $borrowernumber: patron has $charges in fines" if $verbose;
115 if ( $anonymous_patron ) {
116 if ( $patron->id eq $anonymous_patron ) {
117 say "Cannot delete patron $borrowernumber: patron is AnonymousPatron";
123 my $deleted = eval { $patron->move_to_deleted; };
124 if ($@ or not $deleted) {
125 say "Cannot delete patron $borrowernumber, cannot move it" . ( $@ ? ": ($@)" : "" ) if $verbose;
129 eval { $patron->delete };
131 say "Cannot delete patron $borrowernumber: $@)";
136 say "OK" if $verbose;
140 say $confirm ? "$deleted patrons deleted" : "$deleted patrons would have been deleted" if $verbose;
144 delete_patrons - This script deletes patrons
148 delete_patrons.pl [-h|--help] [-v|--verbose] [-c|--confirm] [--not_borrowed_since=DATE] [--expired_before=DATE] [--last-seen=DATE] [--category_code=CAT] [--category_code=CAT ...] [--library=LIBRARY] [--file=FILE]
150 Dates should be in ISO format, e.g., 2013-07-19, and can be generated
151 with `date -d '-3 month' --iso-8601`.
153 The options to select the patron records to delete are cumulative. For
154 example, supplying both --expired_before and --library specifies that
155 that patron records must meet both conditions to be selected for deletion.
163 Print a brief help message
165 =item B<--not_borrowed_since>
167 Delete patrons who have not borrowed since this date.
169 =item B<--expired_before>
171 Delete patrons with an account expired before this date.
175 Delete patrons who have not been connected since this date.
177 The system preference TrackLastPatronActivity must be enabled to use this option.
179 =item B<--category_code>
181 Delete patrons who have this category code.
183 Can be used multiple times for additional category codes.
187 Delete patrons in this library.
191 Delete patrons whose borrower numbers are in this file. If other criteria are defined
192 it will only delete those in the file that match those criteria.
194 =item B<-c|--confirm>
196 This flag must be provided in order for the script to actually
197 delete patron records. If it is not supplied, the script will
198 only report on the patron records it would have deleted.
200 =item B<-v|--verbose>
208 Jonathan Druart <jonathan.druart@biblibre.com>
212 Copyright 2013 BibLibre
216 This file is part of Koha.
218 # Koha is free software; you can redistribute it and/or modify it
219 # under the terms of the GNU General Public License as published by
220 # the Free Software Foundation; either version 3 of the License, or
221 # (at your option) any later version.
223 # Koha is distributed in the hope that it will be useful, but
224 # WITHOUT ANY WARRANTY; without even the implied warranty of
225 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
226 # GNU General Public License for more details.
228 # You should have received a copy of the GNU General Public License
229 # along with Koha; if not, see <http://www.gnu.org/licenses>.