3 # Copyright 2009 PTFS, Inc.
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 constant DEFAULT_ZEBRAQ_PURGEDAYS
=> 30;
23 use constant DEFAULT_MAIL_PURGEDAYS
=> 30;
24 use constant DEFAULT_IMPORT_PURGEDAYS
=> 60;
25 use constant DEFAULT_LOGS_PURGEDAYS
=> 180;
26 use constant DEFAULT_SEARCHHISTORY_PURGEDAYS
=> 30;
27 use constant DEFAULT_SHARE_INVITATION_EXPIRY_DAYS
=> 14;
28 use constant DEFAULT_DEBARMENTS_PURGEDAYS
=> 30;
31 # find Koha's Perl modules
32 # test carefully before changing this
34 eval { require "$FindBin::Bin/../kohalib.pl" };
39 use C4
::Search
::History
;
43 use Koha
::UploadedFiles
;
47 Usage: $0 [-h|--help] [--sessions] [--sessdays DAYS] [-v|--verbose] [--zebraqueue DAYS] [-m|--mail] [--merged] [--import DAYS] [--logs DAYS] [--searchhistory DAYS] [--restrictions DAYS] [--all-restrictions] [--fees DAYS] [--temp-uploads] [--temp-uploads-days DAYS] [--uploads-missing 0|1 ]
49 -h --help prints this help message, and exits, ignoring all
51 --sessions purge the sessions table. If you use this while users
52 are logged into Koha, they will have to reconnect.
53 --sessdays DAYS purge only sessions older than DAYS days.
54 -v --verbose will cause the script to give you a bit more information
56 --zebraqueue DAYS purge completed zebraqueue entries older than DAYS days.
57 Defaults to 30 days if no days specified.
58 -m --mail DAYS purge items from the mail queue that are older than DAYS days.
59 Defaults to 30 days if no days specified.
60 --merged purged completed entries from need_merge_authorities.
61 --import DAYS purge records from import tables older than DAYS days.
62 Defaults to 60 days if no days specified.
63 --z3950 purge records from import tables that are the result
65 --fees DAYS purge entries accountlines older than DAYS days, where
66 amountoutstanding is 0 or NULL.
67 In the case of --fees, DAYS must be greater than
69 WARNING: Fees and payments may not be deleted together.
70 This will not affect the account balance but may be
72 --logs DAYS purge entries from action_logs older than DAYS days.
73 Defaults to 180 days if no days specified.
74 --searchhistory DAYS purge entries from search_history older than DAYS days.
75 Defaults to 30 days if no days specified
76 --list-invites DAYS purge (unaccepted) list share invites older than DAYS
77 days. Defaults to 14 days if no days specified.
78 --restrictions DAYS purge patrons restrictions expired since more than DAYS days.
79 Defaults to 30 days if no days specified.
80 --all-restrictions purge all expired patrons restrictions.
81 --del-exp-selfreg Delete expired self registration accounts
82 --del-unv-selfreg DAYS Delete unverified self registrations older than DAYS
83 --unique-holidays DAYS Delete all unique holidays older than DAYS
84 --temp-uploads Delete temporary uploads.
85 --temp-uploads-days DAYS Override the corresponding preference value.
86 --uploads-missing FLAG Delete upload records for missing files when FLAG is true, count them otherwise
102 my $pListShareInvites;
108 my $special_holidays_days;
110 my $temp_uploads_days;
115 'sessions' => \
$sessions,
116 'sessdays:i' => \
$sess_days,
117 'v|verbose' => \
$verbose,
118 'm|mail:i' => \
$mail,
119 'zebraqueue:i' => \
$zebraqueue_days,
120 'merged' => \
$purge_merged,
121 'import:i' => \
$pImport,
124 'fees:i' => \
$fees_days,
125 'searchhistory:i' => \
$pSearchhistory,
126 'list-invites:i' => \
$pListShareInvites,
127 'restrictions:i' => \
$pDebarments,
128 'all-restrictions' => \
$allDebarments,
129 'del-exp-selfreg' => \
$pExpSelfReg,
130 'del-unv-selfreg' => \
$pUnvSelfReg,
131 'unique-holidays:i' => \
$special_holidays_days,
132 'temp-uploads' => \
$temp_uploads,
133 'temp-uploads-days:i' => \
$temp_uploads_days,
134 'uploads-missing:i' => \
$uploads_missing,
138 $sessions = 1 if $sess_days && $sess_days > 0;
139 $pImport = DEFAULT_IMPORT_PURGEDAYS
if defined($pImport) && $pImport == 0;
140 $pLogs = DEFAULT_LOGS_PURGEDAYS
if defined($pLogs) && $pLogs == 0;
141 $zebraqueue_days = DEFAULT_ZEBRAQ_PURGEDAYS
if defined($zebraqueue_days) && $zebraqueue_days == 0;
142 $mail = DEFAULT_MAIL_PURGEDAYS
if defined($mail) && $mail == 0;
143 $pSearchhistory = DEFAULT_SEARCHHISTORY_PURGEDAYS
if defined($pSearchhistory) && $pSearchhistory == 0;
144 $pListShareInvites = DEFAULT_SHARE_INVITATION_EXPIRY_DAYS
if defined($pListShareInvites) && $pListShareInvites == 0;
145 $pDebarments = DEFAULT_DEBARMENTS_PURGEDAYS
if defined($pDebarments) && $pDebarments == 0;
160 || $pListShareInvites
165 || $special_holidays_days
167 || defined $uploads_missing
169 print "You did not specify any cleanup work for the script to do.\n\n";
173 if ($pDebarments && $allDebarments) {
174 print "You can not specify both --restrictions and --all-restrictions.\n\n";
180 my $dbh = C4
::Context
->dbh();
185 if ( $sessions && !$sess_days ) {
187 print "Session purge triggered.\n";
188 $sth = $dbh->prepare(q{ SELECT COUNT(*) FROM sessions });
189 $sth->execute() or die $dbh->errstr;
190 my @count_arr = $sth->fetchrow_array;
191 print "$count_arr[0] entries will be deleted.\n";
193 $sth = $dbh->prepare(q{ TRUNCATE sessions });
194 $sth->execute() or die $dbh->errstr;
196 print "Done with session purge.\n";
199 elsif ( $sessions && $sess_days > 0 ) {
200 print "Session purge triggered with days>$sess_days.\n" if $verbose;
202 print "Done with session purge with days>$sess_days.\n" if $verbose;
205 if ($zebraqueue_days) {
207 print "Zebraqueue purge triggered for $zebraqueue_days days.\n" if $verbose;
208 $sth = $dbh->prepare(
210 SELECT id,biblio_auth_number,server,time
212 WHERE done=1 AND time < date_sub(curdate(), INTERVAL ? DAY)
215 $sth->execute($zebraqueue_days) or die $dbh->errstr;
216 $sth2 = $dbh->prepare(q{ DELETE FROM zebraqueue WHERE id=? });
217 while ( my $record = $sth->fetchrow_hashref ) {
218 $sth2->execute( $record->{id
} ) or die $dbh->errstr;
221 print "$count records were deleted.\nDone with zebraqueue purge.\n" if $verbose;
225 print "Mail queue purge triggered for $mail days.\n" if $verbose;
226 $sth = $dbh->prepare(
228 DELETE FROM message_queue
229 WHERE time_queued < date_sub(curdate(), INTERVAL ? DAY)
232 $sth->execute($mail) or die $dbh->errstr;
235 print "$count messages were deleted from the mail queue.\nDone with message_queue purge.\n" if $verbose;
239 print "Purging completed entries from need_merge_authorities.\n" if $verbose;
240 $sth = $dbh->prepare(q{ DELETE FROM need_merge_authorities WHERE done=1 });
241 $sth->execute() or die $dbh->errstr;
242 print "Done with purging need_merge_authorities.\n" if $verbose;
246 print "Purging records from import tables.\n" if $verbose;
248 print "Done with purging import tables.\n" if $verbose;
252 print "Purging Z39.50 records from import tables.\n" if $verbose;
254 print "Done with purging Z39.50 records from import tables.\n" if $verbose;
258 print "Purging records from action_logs.\n" if $verbose;
259 $sth = $dbh->prepare(
261 DELETE FROM action_logs
262 WHERE timestamp < date_sub(curdate(), INTERVAL ? DAY)
265 $sth->execute($pLogs) or die $dbh->errstr;
266 print "Done with purging action_logs.\n" if $verbose;
270 print "Purging records from accountlines.\n" if $verbose;
271 purge_zero_balance_fees
( $fees_days );
272 print "Done purging records from accountlines.\n" if $verbose;
275 if ($pSearchhistory) {
276 print "Purging records older than $pSearchhistory from search_history.\n" if $verbose;
277 C4
::Search
::History
::delete({ interval
=> $pSearchhistory });
278 print "Done with purging search_history.\n" if $verbose;
281 if ($pListShareInvites) {
282 print "Purging unaccepted list share invites older than $pListShareInvites days.\n" if $verbose;
283 $sth = $dbh->prepare(
285 DELETE FROM virtualshelfshares
286 WHERE invitekey IS NOT NULL
287 AND (sharedate + INTERVAL ? DAY) < NOW()
290 $sth->execute($pListShareInvites);
291 print "Done with purging unaccepted list share invites.\n" if $verbose;
295 print "Expired patrons restrictions purge triggered for $pDebarments days.\n" if $verbose;
296 $count = PurgeDebarments
($pDebarments);
297 print "$count restrictions were deleted.\nDone with restrictions purge.\n" if $verbose;
301 print "All expired patrons restrictions purge triggered.\n" if $verbose;
302 $count = PurgeDebarments
(0);
303 print "$count restrictions were deleted.\nDone with all restrictions purge.\n" if $verbose;
307 DeleteExpiredSelfRegs
();
310 DeleteUnverifiedSelfRegs
( $pUnvSelfReg );
313 if ($special_holidays_days) {
314 DeleteSpecialHolidays
( abs($special_holidays_days) );
317 if( $temp_uploads ) {
318 # Delete temporary uploads, governed by a pref (unless you override)
319 print "Purging temporary uploads.\n" if $verbose;
320 Koha
::UploadedFiles
->delete_temporary({
321 defined($temp_uploads_days)
322 ?
( override_pref
=> $temp_uploads_days )
325 print "Done purging temporary uploads.\n" if $verbose;
328 if( defined $uploads_missing ) {
329 print "Looking for missing uploads\n" if $verbose;
330 my $keep = $uploads_missing == 1 ?
0 : 1;
331 my $count = Koha
::UploadedFiles
->delete_missing({ keep_record
=> $keep });
333 print "Counted $count missing uploaded files\n";
335 print "Removed $count records for missing uploads\n";
341 sub RemoveOldSessions
{
342 my ( $id, $a_session, $limit, $lasttime );
343 $limit = time() - 24 * 3600 * $sess_days;
345 $sth = $dbh->prepare(q{ SELECT id, a_session FROM sessions });
346 $sth->execute or die $dbh->errstr;
347 $sth->bind_columns( \
$id, \
$a_session );
348 $sth2 = $dbh->prepare(q{ DELETE FROM sessions WHERE id=? });
351 while ( $sth->fetch ) {
353 if ( $a_session =~ /lasttime:\s+'?(\d+)/ ) {
356 elsif ( $a_session =~ /(ATIME|CTIME):\s+'?(\d+)/ ) {
359 if ( $lasttime && $lasttime < $limit ) {
360 $sth2->execute($id) or die $dbh->errstr;
365 print "$count sessions were deleted.\n";
369 sub PurgeImportTables
{
371 #First purge import_records
372 #Delete cascades to import_biblios, import_items and import_record_matches
373 $sth = $dbh->prepare(
375 DELETE FROM import_records
376 WHERE upload_timestamp < date_sub(curdate(), INTERVAL ? DAY)
379 $sth->execute($pImport) or die $dbh->errstr;
381 # Now purge import_batches
382 # Timestamp cannot be used here without care, because records are added
383 # continuously to batches without updating timestamp (Z39.50 search).
384 # So we only delete older empty batches.
385 # This delete will therefore not have a cascading effect.
386 $sth = $dbh->prepare(
389 FROM import_batches ba
390 LEFT JOIN import_records re ON re.import_batch_id=ba.import_batch_id
391 WHERE re.import_record_id IS NULL AND
392 ba.upload_timestamp < date_sub(curdate(), INTERVAL ? DAY)
395 $sth->execute($pImport) or die $dbh->errstr;
399 $sth = $dbh->prepare(
401 DELETE FROM import_batches
402 WHERE batch_type = 'z3950'
405 $sth->execute() or die $dbh->errstr;
408 sub PurgeDebarments
{
409 require Koha
::Patron
::Debarments
;
412 $sth = $dbh->prepare(
414 SELECT borrower_debarment_id
415 FROM borrower_debarments
416 WHERE expiration < date_sub(curdate(), INTERVAL ? DAY)
419 $sth->execute($days) or die $dbh->errstr;
420 while ( my ($borrower_debarment_id) = $sth->fetchrow_array ) {
421 Koha
::Patron
::Debarments
::DelDebarment
($borrower_debarment_id);
427 sub DeleteExpiredSelfRegs
{
428 my $cnt= C4
::Members
::DeleteExpiredOpacRegistrations
();
429 print "Removed $cnt expired self-registered borrowers\n" if $verbose;
432 sub DeleteUnverifiedSelfRegs
{
433 my $cnt= C4
::Members
::DeleteUnverifiedOpacRegistrations
( $_[0] );
434 print "Removed $cnt unverified self-registrations\n" if $verbose;
437 sub DeleteSpecialHolidays
{
440 my $sth = $dbh->prepare(q{
441 DELETE FROM special_holidays
442 WHERE DATE( CONCAT( year, '-', month, '-', day ) ) < DATE_SUB( CAST(NOW() AS DATE), INTERVAL ? DAY );
444 my $count = $sth->execute( $days ) + 0;
445 print "Removed $count unique holidays\n" if $verbose;