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" };
37 use Koha::Script -cron;
40 use C4::Search::History;
44 use Koha::UploadedFiles;
48 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 ] [--statistics DAYS] [--deleted-catalog DAYS] [--deleted-patrons DAYS] [--old-issues DAYS] [--old-reserves DAYS] [--transfers DAYS]
50 -h --help prints this help message, and exits, ignoring all
52 --sessions purge the sessions table. If you use this while users
53 are logged into Koha, they will have to reconnect.
54 --sessdays DAYS purge only sessions older than DAYS days.
55 -v --verbose will cause the script to give you a bit more information
57 --zebraqueue DAYS purge completed zebraqueue entries older than DAYS days.
58 Defaults to 30 days if no days specified.
59 -m --mail DAYS purge items from the mail queue that are older than DAYS days.
60 Defaults to 30 days if no days specified.
61 --merged purged completed entries from need_merge_authorities.
62 --import DAYS purge records from import tables older than DAYS days.
63 Defaults to 60 days if no days specified.
64 --z3950 purge records from import tables that are the result
66 --fees DAYS purge entries accountlines older than DAYS days, where
67 amountoutstanding is 0 or NULL.
68 In the case of --fees, DAYS must be greater than
70 --logs DAYS purge entries from action_logs older than DAYS days.
71 Defaults to 180 days if no days specified.
72 --searchhistory DAYS purge entries from search_history older than DAYS days.
73 Defaults to 30 days if no days specified
74 --list-invites DAYS purge (unaccepted) list share invites older than DAYS
75 days. Defaults to 14 days if no days specified.
76 --restrictions DAYS purge patrons restrictions expired since more than DAYS days.
77 Defaults to 30 days if no days specified.
78 --all-restrictions purge all expired patrons restrictions.
79 --del-exp-selfreg Delete expired self registration accounts
80 --del-unv-selfreg DAYS Delete unverified self registrations older than DAYS
81 --unique-holidays DAYS Delete all unique holidays older than DAYS
82 --temp-uploads Delete temporary uploads.
83 --temp-uploads-days DAYS Override the corresponding preference value.
84 --uploads-missing FLAG Delete upload records for missing files when FLAG is true, count them otherwise
85 --oauth-tokens Delete expired OAuth2 tokens
86 --statistics DAYS Purge entries from statistics older than DAYS days.
87 --deleted-catalog DAYS Purge deleted catalog older than DAYS
88 in tables deleteditems, deletedbiblioitems, deletedbiblio_metadata and deletedbiblio
89 --deleted-patrons DAYS Purge deleted patrons older than DAYS days.
90 --old-issues DAYS Purge old issues older than DAYS days.
91 --old-reserves DAYS Purge old reserves older than DAYS days.
92 --transfers DAYS Purge arrived items transfers older than DAYS days.
108 my $pListShareInvites;
114 my $special_holidays_days;
116 my $temp_uploads_days;
128 'sessions' => \$sessions,
129 'sessdays:i' => \$sess_days,
130 'v|verbose' => \$verbose,
131 'm|mail:i' => \$mail,
132 'zebraqueue:i' => \$zebraqueue_days,
133 'merged' => \$purge_merged,
134 'import:i' => \$pImport,
137 'fees:i' => \$fees_days,
138 'searchhistory:i' => \$pSearchhistory,
139 'list-invites:i' => \$pListShareInvites,
140 'restrictions:i' => \$pDebarments,
141 'all-restrictions' => \$allDebarments,
142 'del-exp-selfreg' => \$pExpSelfReg,
143 'del-unv-selfreg' => \$pUnvSelfReg,
144 'unique-holidays:i' => \$special_holidays_days,
145 'temp-uploads' => \$temp_uploads,
146 'temp-uploads-days:i' => \$temp_uploads_days,
147 'uploads-missing:i' => \$uploads_missing,
148 'oauth-tokens' => \$oauth_tokens,
149 'statistics:i' => \$pStatistics,
150 'deleted-catalog:i' => \$pDeletedCatalog,
151 'deleted-patrons:i' => \$pDeletedPatrons,
152 'old-issues:i' => \$pOldIssues,
153 'old-reserves:i' => \$pOldReserves,
154 'transfers:i' => \$pTransfers,
158 $sessions = 1 if $sess_days && $sess_days > 0;
159 $pImport = DEFAULT_IMPORT_PURGEDAYS if defined($pImport) && $pImport == 0;
160 $pLogs = DEFAULT_LOGS_PURGEDAYS if defined($pLogs) && $pLogs == 0;
161 $zebraqueue_days = DEFAULT_ZEBRAQ_PURGEDAYS if defined($zebraqueue_days) && $zebraqueue_days == 0;
162 $mail = DEFAULT_MAIL_PURGEDAYS if defined($mail) && $mail == 0;
163 $pSearchhistory = DEFAULT_SEARCHHISTORY_PURGEDAYS if defined($pSearchhistory) && $pSearchhistory == 0;
164 $pListShareInvites = DEFAULT_SHARE_INVITATION_EXPIRY_DAYS if defined($pListShareInvites) && $pListShareInvites == 0;
165 $pDebarments = DEFAULT_DEBARMENTS_PURGEDAYS if defined($pDebarments) && $pDebarments == 0;
180 || $pListShareInvites
185 || $special_holidays_days
187 || defined $uploads_missing
196 print "You did not specify any cleanup work for the script to do.\n\n";
200 if ($pDebarments && $allDebarments) {
201 print "You can not specify both --restrictions and --all-restrictions.\n\n";
207 my $dbh = C4::Context->dbh();
212 if ( $sessions && !$sess_days ) {
214 print "Session purge triggered.\n";
215 $sth = $dbh->prepare(q{ SELECT COUNT(*) FROM sessions });
216 $sth->execute() or die $dbh->errstr;
217 my @count_arr = $sth->fetchrow_array;
218 print "$count_arr[0] entries will be deleted.\n";
220 $sth = $dbh->prepare(q{ TRUNCATE sessions });
221 $sth->execute() or die $dbh->errstr;
223 print "Done with session purge.\n";
226 elsif ( $sessions && $sess_days > 0 ) {
227 print "Session purge triggered with days>$sess_days.\n" if $verbose;
229 print "Done with session purge with days>$sess_days.\n" if $verbose;
232 if ($zebraqueue_days) {
234 print "Zebraqueue purge triggered for $zebraqueue_days days.\n" if $verbose;
235 $sth = $dbh->prepare(
237 SELECT id,biblio_auth_number,server,time
239 WHERE done=1 AND time < date_sub(curdate(), INTERVAL ? DAY)
242 $sth->execute($zebraqueue_days) or die $dbh->errstr;
243 $sth2 = $dbh->prepare(q{ DELETE FROM zebraqueue WHERE id=? });
244 while ( my $record = $sth->fetchrow_hashref ) {
245 $sth2->execute( $record->{id} ) or die $dbh->errstr;
248 print "$count records were deleted.\nDone with zebraqueue purge.\n" if $verbose;
252 print "Mail queue purge triggered for $mail days.\n" if $verbose;
253 $sth = $dbh->prepare(
255 DELETE FROM message_queue
256 WHERE time_queued < date_sub(curdate(), INTERVAL ? DAY)
259 $sth->execute($mail) or die $dbh->errstr;
262 print "$count messages were deleted from the mail queue.\nDone with message_queue purge.\n" if $verbose;
266 print "Purging completed entries from need_merge_authorities.\n" if $verbose;
267 $sth = $dbh->prepare(q{ DELETE FROM need_merge_authorities WHERE done=1 });
268 $sth->execute() or die $dbh->errstr;
269 print "Done with purging need_merge_authorities.\n" if $verbose;
273 print "Purging records from import tables.\n" if $verbose;
275 print "Done with purging import tables.\n" if $verbose;
279 print "Purging Z39.50 records from import tables.\n" if $verbose;
281 print "Done with purging Z39.50 records from import tables.\n" if $verbose;
285 print "Purging records from action_logs.\n" if $verbose;
286 $sth = $dbh->prepare(
288 DELETE FROM action_logs
289 WHERE timestamp < date_sub(curdate(), INTERVAL ? DAY)
292 $sth->execute($pLogs) or die $dbh->errstr;
293 print "Done with purging action_logs.\n" if $verbose;
297 print "Purging records from accountlines.\n" if $verbose;
298 purge_zero_balance_fees( $fees_days );
299 print "Done purging records from accountlines.\n" if $verbose;
302 if ($pSearchhistory) {
303 print "Purging records older than $pSearchhistory from search_history.\n" if $verbose;
304 C4::Search::History::delete({ interval => $pSearchhistory });
305 print "Done with purging search_history.\n" if $verbose;
308 if ($pListShareInvites) {
309 print "Purging unaccepted list share invites older than $pListShareInvites days.\n" if $verbose;
310 $sth = $dbh->prepare(
312 DELETE FROM virtualshelfshares
313 WHERE invitekey IS NOT NULL
314 AND (sharedate + INTERVAL ? DAY) < NOW()
317 $sth->execute($pListShareInvites);
318 print "Done with purging unaccepted list share invites.\n" if $verbose;
322 print "Expired patrons restrictions purge triggered for $pDebarments days.\n" if $verbose;
323 $count = PurgeDebarments($pDebarments);
324 print "$count restrictions were deleted.\nDone with restrictions purge.\n" if $verbose;
328 print "All expired patrons restrictions purge triggered.\n" if $verbose;
329 $count = PurgeDebarments(0);
330 print "$count restrictions were deleted.\nDone with all restrictions purge.\n" if $verbose;
333 # Handle unsubscribe requests from GDPR consent form, depends on UnsubscribeReflectionDelay preference
334 Koha::Patrons->search_unsubscribed->lock({ expire => 1, remove => 1, verbose => $verbose });
335 # Anonymize patron data, depending on PatronAnonymizeDelay
336 Koha::Patrons->search_anonymize_candidates({ locked => 1 })->anonymize({ verbose => $verbose });
337 # Remove patron data, depending on PatronRemovalDelay (will raise an exception if problem encountered
338 eval { Koha::Patrons->search_anonymized->delete({ move => 1, verbose => $verbose }) };
342 DeleteExpiredSelfRegs();
345 DeleteUnverifiedSelfRegs( $pUnvSelfReg );
348 if ($special_holidays_days) {
349 DeleteSpecialHolidays( abs($special_holidays_days) );
352 if( $temp_uploads ) {
353 # Delete temporary uploads, governed by a pref (unless you override)
354 print "Purging temporary uploads.\n" if $verbose;
355 Koha::UploadedFiles->delete_temporary({
356 defined($temp_uploads_days)
357 ? ( override_pref => $temp_uploads_days )
360 print "Done purging temporary uploads.\n" if $verbose;
363 if( defined $uploads_missing ) {
364 print "Looking for missing uploads\n" if $verbose;
365 my $keep = $uploads_missing == 1 ? 0 : 1;
366 my $count = Koha::UploadedFiles->delete_missing({ keep_record => $keep });
368 print "Counted $count missing uploaded files\n";
370 print "Removed $count records for missing uploads\n";
375 require Koha::OAuthAccessTokens;
377 my $count = int Koha::OAuthAccessTokens->search({ expires => { '<=', time } })->delete;
378 say "Removed $count expired OAuth2 tokens" if $verbose;
382 print "Purging statistics older than $pStatistics days.\n" if $verbose;
383 $sth = $dbh->prepare(
385 DELETE FROM statistics
386 WHERE datetime < DATE_SUB(CURDATE(), INTERVAL ? DAY)
389 $sth->execute($pStatistics);
390 print "Done with purging statistics.\n" if $verbose;
393 if ($pDeletedCatalog) {
394 print "Purging deleted catalog older than $pDeletedCatalog days.\n" if $verbose;
395 my $sth1 = $dbh->prepare(
397 DELETE FROM deleteditems
398 WHERE timestamp < DATE_SUB(CURDATE(), INTERVAL ? DAY)
401 my $sth2 = $dbh->prepare(
403 DELETE FROM deletedbiblioitems
404 WHERE timestamp < DATE_SUB(CURDATE(), INTERVAL ? DAY)
407 my $sth3 = $dbh->prepare(
409 DELETE FROM deletedbiblio
410 WHERE timestamp < DATE_SUB(CURDATE(), INTERVAL ? DAY)
413 # deletedbiblio_metadata is managed by FK with deletedbiblio
414 $sth1->execute($pDeletedCatalog);
415 $sth2->execute($pDeletedCatalog);
416 $sth3->execute($pDeletedCatalog);
417 print "Done with purging deleted catalog.\n" if $verbose;
420 if ($pDeletedPatrons) {
421 print "Purging deleted patrons older than $pDeletedPatrons days.\n" if $verbose;
422 $sth = $dbh->prepare(
424 DELETE FROM deletedborrowers
425 WHERE updated_on < DATE_SUB(CURDATE(), INTERVAL ? DAY)
428 $sth->execute($pDeletedPatrons);
429 print "Done with purging deleted patrons.\n" if $verbose;
433 print "Purging old issues older than $pOldIssues days.\n" if $verbose;
434 $sth = $dbh->prepare(
436 DELETE FROM old_issues
437 WHERE timestamp < DATE_SUB(CURDATE(), INTERVAL ? DAY)
440 $sth->execute($pOldIssues);
441 print "Done with purging old issues.\n" if $verbose;
445 print "Purging old reserves older than $pOldReserves days.\n" if $verbose;
446 $sth = $dbh->prepare(
448 DELETE FROM old_reserves
449 WHERE timestamp < DATE_SUB(CURDATE(), INTERVAL ? DAY)
452 $sth->execute($pOldReserves);
453 print "Done with purging old reserves.\n" if $verbose;
457 print "Purging arrived item transfers older than $pTransfers days.\n" if $verbose;
458 $sth = $dbh->prepare(
460 DELETE FROM branchtransfers
461 WHERE datearrived < DATE_SUB(CURDATE(), INTERVAL ? DAY)
464 $sth->execute($pTransfers);
465 print "Done with purging transfers.\n" if $verbose;
470 sub RemoveOldSessions {
471 my ( $id, $a_session, $limit, $lasttime );
472 $limit = time() - 24 * 3600 * $sess_days;
474 $sth = $dbh->prepare(q{ SELECT id, a_session FROM sessions });
475 $sth->execute or die $dbh->errstr;
476 $sth->bind_columns( \$id, \$a_session );
477 $sth2 = $dbh->prepare(q{ DELETE FROM sessions WHERE id=? });
480 while ( $sth->fetch ) {
482 if ( $a_session =~ /lasttime:\s+'?(\d+)/ ) {
485 elsif ( $a_session =~ /(ATIME|CTIME):\s+'?(\d+)/ ) {
488 if ( $lasttime && $lasttime < $limit ) {
489 $sth2->execute($id) or die $dbh->errstr;
494 print "$count sessions were deleted.\n";
498 sub PurgeImportTables {
500 #First purge import_records
501 #Delete cascades to import_biblios, import_items and import_record_matches
502 $sth = $dbh->prepare(
504 DELETE FROM import_records
505 WHERE upload_timestamp < date_sub(curdate(), INTERVAL ? DAY)
508 $sth->execute($pImport) or die $dbh->errstr;
510 # Now purge import_batches
511 # Timestamp cannot be used here without care, because records are added
512 # continuously to batches without updating timestamp (Z39.50 search).
513 # So we only delete older empty batches.
514 # This delete will therefore not have a cascading effect.
515 $sth = $dbh->prepare(
518 FROM import_batches ba
519 LEFT JOIN import_records re ON re.import_batch_id=ba.import_batch_id
520 WHERE re.import_record_id IS NULL AND
521 ba.upload_timestamp < date_sub(curdate(), INTERVAL ? DAY)
524 $sth->execute($pImport) or die $dbh->errstr;
528 $sth = $dbh->prepare(
530 DELETE FROM import_batches
531 WHERE batch_type = 'z3950'
534 $sth->execute() or die $dbh->errstr;
537 sub PurgeDebarments {
538 require Koha::Patron::Debarments;
541 $sth = $dbh->prepare(
543 SELECT borrower_debarment_id
544 FROM borrower_debarments
545 WHERE expiration < date_sub(curdate(), INTERVAL ? DAY)
548 $sth->execute($days) or die $dbh->errstr;
549 while ( my ($borrower_debarment_id) = $sth->fetchrow_array ) {
550 Koha::Patron::Debarments::DelDebarment($borrower_debarment_id);
556 sub DeleteExpiredSelfRegs {
557 my $cnt= C4::Members::DeleteExpiredOpacRegistrations();
558 print "Removed $cnt expired self-registered borrowers\n" if $verbose;
561 sub DeleteUnverifiedSelfRegs {
562 my $cnt= C4::Members::DeleteUnverifiedOpacRegistrations( $_[0] );
563 print "Removed $cnt unverified self-registrations\n" if $verbose;
566 sub DeleteSpecialHolidays {
569 my $sth = $dbh->prepare(q{
570 DELETE FROM special_holidays
571 WHERE DATE( CONCAT( year, '-', month, '-', day ) ) < DATE_SUB( CAST(NOW() AS DATE), INTERVAL ? DAY );
573 my $count = $sth->execute( $days ) + 0;
574 print "Removed $count unique holidays\n" if $verbose;