/
cleanborrowers.pl
executable file
·235 lines (200 loc) · 7.44 KB
/
cleanborrowers.pl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
#!/usr/bin/perl
# 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>.
#
# Written by Antoine Farnault antoine@koha-fr.org on Nov. 2006.
=head1 cleanborrowers.pl
This script allows to do 2 things.
=over 2
=item * Anonymise the borrowers' issues if issue is older than a given date. see C<datefilter1>.
=item * Delete the borrowers who has not borrowed since a given date. see C<datefilter2>.
=back
=cut
use Modern::Perl;
use CGI qw ( -utf8 );
use C4::Auth;
use C4::Output;
use C4::Members;
use C4::Circulation; # AnonymiseIssueHistory.
use Koha::DateUtils qw( dt_from_string output_pref );
use Koha::Patron::Categories;
use Koha::Patrons;
use Date::Calc qw/Today Add_Delta_YM/;
use Koha::Patrons;
use Koha::List::Patron;
my $cgi = new CGI;
# Fetch the paramater list as a hash in scalar context:
# * returns paramater list as tied hash ref
# * we can edit the values by changing the key
# * multivalued CGI paramaters are returned as a packaged string separated by "\0" (null)
my $params = $cgi->Vars;
my $step = $params->{step} || 1;
my $not_borrowed_since = # the date which filter on issue history.
$params->{not_borrowed_since}
? dt_from_string $params->{not_borrowed_since}
: undef;
my $last_issue_date = # the date which filter on borrowers last issue.
$params->{last_issue_date}
? dt_from_string $params->{last_issue_date}
: undef;
my $borrower_dateexpiry =
$params->{borrower_dateexpiry}
? dt_from_string $params->{borrower_dateexpiry}
: undef;
my $borrower_lastseen =
$params->{borrower_lastseen}
? dt_from_string $params->{borrower_lastseen}
: undef;
my $patron_list_id = $params->{patron_list_id};
my $borrower_categorycode = $params->{'borrower_categorycode'} || q{};
# getting the template
my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
{ template_name => "tools/cleanborrowers.tt",
query => $cgi,
type => "intranet",
authnotrequired => 0,
flagsrequired => { tools => 'delete_anonymize_patrons', catalogue => 1 },
}
);
my $branch = $params->{ branch } || '*';
$template->param( current_branch => $branch );
$template->param( OnlyMine => C4::Context->only_my_library );
if ( $step == 2 ) {
my %checkboxes = map { $_ => 1 } split /\0/, $params->{'checkbox'};
my $patrons_to_delete;
if ( $checkboxes{borrower} ) {
$patrons_to_delete = GetBorrowersToExpunge(
_get_selection_params(
$not_borrowed_since,
$borrower_dateexpiry,
$borrower_lastseen,
$borrower_categorycode,
$patron_list_id,
$branch
)
);
}
_skip_borrowers_with_nonzero_balance($patrons_to_delete);
my $patrons_to_anonymize =
$checkboxes{issue}
? $branch eq '*'
? Koha::Patrons->search_patrons_to_anonymise( { before => $last_issue_date } )
: Koha::Patrons->search_patrons_to_anonymise( { before => $last_issue_date, library => $branch } )
: undef;
$template->param(
patrons_to_delete => $patrons_to_delete,
patrons_to_anonymize => $patrons_to_anonymize,
patron_list_id => $patron_list_id,
);
}
elsif ( $step == 3 ) {
my $do_delete = $params->{'do_delete'};
my $do_anonym = $params->{'do_anonym'};
my ( $totalDel, $totalAno, $radio ) = ( 0, 0, 0 );
# delete members
if ($do_delete) {
my $patrons_to_delete = GetBorrowersToExpunge(
_get_selection_params(
$not_borrowed_since,
$borrower_dateexpiry,
$borrower_lastseen,
$borrower_categorycode,
$patron_list_id,
$branch
)
);
_skip_borrowers_with_nonzero_balance($patrons_to_delete);
$totalDel = scalar(@$patrons_to_delete);
$radio = $params->{'radio'};
for ( my $i = 0 ; $i < $totalDel ; $i++ ) {
$radio eq 'testrun' && last;
my $borrowernumber = $patrons_to_delete->[$i]->{'borrowernumber'};
my $patron = Koha::Patrons->find($borrowernumber);
$radio eq 'trash' && $patron->move_to_deleted;
$patron->delete;
}
$template->param(
do_delete => '1',
TotalDel => $totalDel
);
}
# Anonymising all members
if ($do_anonym) {
#FIXME: anonymisation errors are not handled
my $rows = Koha::Patrons->search_patrons_to_anonymise( { before => $last_issue_date } )->anonymise_issue_history( { before => $last_issue_date } );
$template->param(
do_anonym => $rows,
);
}
$template->param(
trash => ( $radio eq "trash" ) ? (1) : (0),
testrun => ( $radio eq "testrun" ) ? 1: 0,
);
} else { # $step == 1
my @all_lists = GetPatronLists();
my @non_empty_lists;
foreach my $list (@all_lists){
my @patrons = $list->patron_list_patrons();
if( scalar @patrons ) { push(@non_empty_lists,$list) }
}
$template->param( patron_lists => [ @non_empty_lists ] );
}
my $patron_categories = Koha::Patron::Categories->search_limited({}, {order_by => ['description']});
$template->param(
step => $step,
not_borrowed_since => $not_borrowed_since,
borrower_dateexpiry => $borrower_dateexpiry,
borrower_lastseen => $borrower_lastseen,
last_issue_date => $last_issue_date,
borrower_categorycodes => $patron_categories,
borrower_categorycode => $borrower_categorycode,
);
#writing the template
output_html_with_http_headers $cgi, $cookie, $template->output;
sub _skip_borrowers_with_nonzero_balance {
my $borrowers = shift;
my $balance;
@$borrowers = map {
my $patron = Koha::Patrons->find( $_->{borrowernumber} );
my $balance = $patron->account->balance;
(defined $balance && $balance != 0) ? (): ($_);
} @$borrowers;
}
sub _get_selection_params {
my ($not_borrowed_since, $borrower_dateexpiry, $borrower_lastseen,
$borrower_categorycode, $patron_list_id, $branch) = @_;
my $params = {};
$params->{not_borrowed_since} = output_pref({
dt => $not_borrowed_since,
dateformat => 'iso',
dateonly => 1
}) if $not_borrowed_since;
$params->{expired_before} = output_pref({
dt => $borrower_dateexpiry,
dateformat => 'iso',
dateonly => 1
}) if $borrower_dateexpiry;
$params->{last_seen} = output_pref({
dt => $borrower_lastseen,
dateformat => 'iso',
dateonly => 1
}) if $borrower_lastseen;
$params->{category_code} = $borrower_categorycode if $borrower_categorycode;
$params->{patron_list_id} = $patron_list_id if $patron_list_id;
if ( defined $branch and $branch ne '*' ) {
$params->{ branchcode } = $branch;
}
return $params;
};