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;
45 use Koha::Old::Biblios;
47 use Koha::Old::Biblioitems;
48 use Koha::Old::Checkouts;
50 use Koha::Old::Patrons;
51 use Koha::Item::Transfers;
52 use Koha::PseudonymizedTransactions;
56 Usage: $0 [-h|--help] [--confirm] [--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]
58 -h --help prints this help message, and exits, ignoring all
60 --confirm Confirmation flag, the script will be running in dry-run mode is not set.
61 --sessions purge the sessions table. If you use this while users
62 are logged into Koha, they will have to reconnect.
63 --sessdays DAYS purge only sessions older than DAYS days.
64 -v --verbose will cause the script to give you a bit more information
66 --zebraqueue DAYS purge completed zebraqueue entries older than DAYS days.
67 Defaults to 30 days if no days specified.
68 -m --mail DAYS purge items from the mail queue that are older than DAYS days.
69 Defaults to 30 days if no days specified.
70 --merged purged completed entries from need_merge_authorities.
71 --import DAYS purge records from import tables older than DAYS days.
72 Defaults to 60 days if no days specified.
73 --z3950 purge records from import tables that are the result
75 --fees DAYS purge entries accountlines older than DAYS days, where
76 amountoutstanding is 0 or NULL.
77 In the case of --fees, DAYS must be greater than
79 --logs DAYS purge entries from action_logs older than DAYS days.
80 Defaults to 180 days if no days specified.
81 --searchhistory DAYS purge entries from search_history older than DAYS days.
82 Defaults to 30 days if no days specified
83 --list-invites DAYS purge (unaccepted) list share invites older than DAYS
84 days. Defaults to 14 days if no days specified.
85 --restrictions DAYS purge patrons restrictions expired since more than DAYS days.
86 Defaults to 30 days if no days specified.
87 --all-restrictions purge all expired patrons restrictions.
88 --del-exp-selfreg Delete expired self registration accounts
89 --del-unv-selfreg DAYS Delete unverified self registrations older than DAYS
90 --unique-holidays DAYS Delete all unique holidays older than DAYS
91 --temp-uploads Delete temporary uploads.
92 --temp-uploads-days DAYS Override the corresponding preference value.
93 --uploads-missing FLAG Delete upload records for missing files when FLAG is true, count them otherwise
94 --oauth-tokens Delete expired OAuth2 tokens
95 --statistics DAYS Purge statistics entries more than DAYS days old.
96 This table is used to build reports, make sure you are aware of the consequences of this before using it!
97 --deleted-catalog DAYS Purge catalog records deleted more then DAYS days ago
98 (from tables deleteditems, deletedbiblioitems, deletedbiblio_metadata and deletedbiblio).
99 --deleted-patrons DAYS Purge patrons deleted more than DAYS days ago.
100 --old-issues DAYS Purge checkouts (old_issues) returned more than DAYS days ago.
101 --old-reserves DAYS Purge reserves (old_reserves) more than DAYS old.
102 --transfers DAYS Purge transfers completed more than DAYS day ago.
103 --pseudo-transactions DAYS Purge the pseudonymized transactions that have been originally created more than DAYS days ago
104 DAYS is optional and can be replaced by:
105 --pseudo-transactions-from YYYY-MM-DD and/or --pseudo-transactions-to YYYY-MM-DD
122 my $pListShareInvites;
128 my $special_holidays_days;
130 my $temp_uploads_days;
139 my ( $pPseudoTransactions, $pPseudoTransactionsFrom, $pPseudoTransactionsTo );
143 'confirm' => \$confirm,
144 'sessions' => \$sessions,
145 'sessdays:i' => \$sess_days,
146 'v|verbose' => \$verbose,
147 'm|mail:i' => \$mail,
148 'zebraqueue:i' => \$zebraqueue_days,
149 'merged' => \$purge_merged,
150 'import:i' => \$pImport,
153 'fees:i' => \$fees_days,
154 'searchhistory:i' => \$pSearchhistory,
155 'list-invites:i' => \$pListShareInvites,
156 'restrictions:i' => \$pDebarments,
157 'all-restrictions' => \$allDebarments,
158 'del-exp-selfreg' => \$pExpSelfReg,
159 'del-unv-selfreg' => \$pUnvSelfReg,
160 'unique-holidays:i' => \$special_holidays_days,
161 'temp-uploads' => \$temp_uploads,
162 'temp-uploads-days:i' => \$temp_uploads_days,
163 'uploads-missing:i' => \$uploads_missing,
164 'oauth-tokens' => \$oauth_tokens,
165 'statistics:i' => \$pStatistics,
166 'deleted-catalog:i' => \$pDeletedCatalog,
167 'deleted-patrons:i' => \$pDeletedPatrons,
168 'old-issues:i' => \$pOldIssues,
169 'old-reserves:i' => \$pOldReserves,
170 'transfers:i' => \$pTransfers,
171 'pseudo-transactions:i' => \$pPseudoTransactions,
172 'pseudo-transactions-from:s' => \$pPseudoTransactionsFrom,
173 'pseudo-transactions-to:s' => \$pPseudoTransactionsTo,
177 $sessions = 1 if $sess_days && $sess_days > 0;
178 $pImport = DEFAULT_IMPORT_PURGEDAYS if defined($pImport) && $pImport == 0;
179 $pLogs = DEFAULT_LOGS_PURGEDAYS if defined($pLogs) && $pLogs == 0;
180 $zebraqueue_days = DEFAULT_ZEBRAQ_PURGEDAYS if defined($zebraqueue_days) && $zebraqueue_days == 0;
181 $mail = DEFAULT_MAIL_PURGEDAYS if defined($mail) && $mail == 0;
182 $pSearchhistory = DEFAULT_SEARCHHISTORY_PURGEDAYS if defined($pSearchhistory) && $pSearchhistory == 0;
183 $pListShareInvites = DEFAULT_SHARE_INVITATION_EXPIRY_DAYS if defined($pListShareInvites) && $pListShareInvites == 0;
184 $pDebarments = DEFAULT_DEBARMENTS_PURGEDAYS if defined($pDebarments) && $pDebarments == 0;
199 || $pListShareInvites
204 || $special_holidays_days
206 || defined $uploads_missing
214 || defined $pPseudoTransactions
215 || $pPseudoTransactionsFrom
216 || $pPseudoTransactionsTo
218 print "You did not specify any cleanup work for the script to do.\n\n";
222 if ($pDebarments && $allDebarments) {
223 print "You can not specify both --restrictions and --all-restrictions.\n\n";
227 say "Confirm flag not passed, running in dry-run mode..." unless $confirm;
229 cronlogaction() unless $confirm;
231 my $dbh = C4::Context->dbh();
236 if ( $sessions && !$sess_days ) {
238 print "Session purge triggered.\n";
239 $sth = $dbh->prepare(q{ SELECT COUNT(*) FROM sessions });
240 $sth->execute() or die $dbh->errstr;
241 my @count_arr = $sth->fetchrow_array;
242 print "$count_arr[0] entries will be deleted.\n";
245 $sth = $dbh->prepare(q{ TRUNCATE sessions });
246 $sth->execute() or die $dbh->errstr;
249 print "Done with session purge.\n";
252 elsif ( $sessions && $sess_days > 0 ) {
253 print "Session purge triggered with days>$sess_days.\n" if $verbose;
254 RemoveOldSessions() if $confirm;
255 print "Done with session purge with days>$sess_days.\n" if $verbose;
258 if ($zebraqueue_days) {
260 print "Zebraqueue purge triggered for $zebraqueue_days days.\n" if $verbose;
261 $sth = $dbh->prepare(
263 SELECT id,biblio_auth_number,server,time
265 WHERE done=1 AND time < date_sub(curdate(), INTERVAL ? DAY)
269 $sth->execute($zebraqueue_days) or die $dbh->errstr;
271 $sth2 = $dbh->prepare(q{ DELETE FROM zebraqueue WHERE id=? });
272 while ( my $record = $sth->fetchrow_hashref ) {
274 $sth2->execute( $record->{id} ) or die $dbh->errstr;
278 print "$count records were deleted.\nDone with zebraqueue purge.\n" if $verbose;
282 print "Mail queue purge triggered for $mail days.\n" if $verbose;
283 $sth = $dbh->prepare(
285 DELETE FROM message_queue
286 WHERE time_queued < date_sub(curdate(), INTERVAL ? DAY)
290 $sth->execute($mail) or die $dbh->errstr;
293 print "$count messages were deleted from the mail queue.\nDone with message_queue purge.\n" if $verbose;
297 print "Purging completed entries from need_merge_authorities.\n" if $verbose;
299 $sth = $dbh->prepare(q{ DELETE FROM need_merge_authorities WHERE done=1 });
300 $sth->execute() or die $dbh->errstr;
302 print "Done with purging need_merge_authorities.\n" if $verbose;
306 print "Purging records from import tables.\n" if $verbose;
307 PurgeImportTables() if $confirm;
308 print "Done with purging import tables.\n" if $verbose;
312 print "Purging Z39.50 records from import tables.\n" if $verbose;
313 PurgeZ3950() if $confirm;
314 print "Done with purging Z39.50 records from import tables.\n" if $verbose;
318 print "Purging records from action_logs.\n" if $verbose;
319 $sth = $dbh->prepare(
321 DELETE FROM action_logs
322 WHERE timestamp < date_sub(curdate(), INTERVAL ? DAY)
326 $sth->execute($pLogs) or die $dbh->errstr;
328 print "Done with purging action_logs.\n" if $verbose;
332 print "Purging records from accountlines.\n" if $verbose;
333 purge_zero_balance_fees( $fees_days ) if $confirm;
334 print "Done purging records from accountlines.\n" if $verbose;
337 if ($pSearchhistory) {
338 print "Purging records older than $pSearchhistory from search_history.\n" if $verbose;
339 C4::Search::History::delete({ interval => $pSearchhistory }) if $confirm;
340 print "Done with purging search_history.\n" if $verbose;
343 if ($pListShareInvites) {
344 print "Purging unaccepted list share invites older than $pListShareInvites days.\n" if $verbose;
345 $sth = $dbh->prepare(
347 DELETE FROM virtualshelfshares
348 WHERE invitekey IS NOT NULL
349 AND (sharedate + INTERVAL ? DAY) < NOW()
353 $sth->execute($pListShareInvites);
355 print "Done with purging unaccepted list share invites.\n" if $verbose;
359 print "Expired patrons restrictions purge triggered for $pDebarments days.\n" if $verbose;
360 $count = PurgeDebarments($pDebarments, $confirm);
361 print "$count restrictions were deleted.\nDone with restrictions purge.\n" if $verbose;
365 print "All expired patrons restrictions purge triggered.\n" if $verbose;
366 $count = PurgeDebarments(0, $confirm);
367 print "$count restrictions were deleted.\nDone with all restrictions purge.\n" if $verbose;
370 # Handle unsubscribe requests from GDPR consent form, depends on UnsubscribeReflectionDelay preference
371 my $unsubscribed_patrons = Koha::Patrons->search_unsubscribed;
372 $count = $unsubscribed_patrons->count;
373 $unsubscribed_patrons->lock( { expire => 1, remove => 1 } ) if $confirm;
374 say sprintf "Locked %d patrons", $count if $verbose;
376 # Anonymize patron data, depending on PatronAnonymizeDelay
377 my $anonymize_candidates = Koha::Patrons->search_anonymize_candidates( { locked => 1 } );
378 $count = $anonymize_candidates->count;
379 $anonymize_candidates->anonymize if $confirm;
380 say sprintf "Anonymized %s patrons", $count if $verbose;
382 # Remove patron data, depending on PatronRemovalDelay (will raise an exception if problem encountered
383 my $anonymized_patrons = Koha::Patrons->search_anonymized;
384 $count = $anonymized_patrons->count;
386 $anonymized_patrons->delete( { move => 1 } );
391 say sprintf "Deleted %d patrons", $count;
394 say sprintf "Deleted %d patrons", $count;
397 # FIXME The output for dry-run mode needs to be improved
398 # But non trivial changes to C4::Members need to be done before.
401 DeleteExpiredSelfRegs();
402 } elsif ( $verbose ) {
403 say "self-registered borrowers may be deleted";
408 DeleteUnverifiedSelfRegs( $pUnvSelfReg );
409 } elsif ( $verbose ) {
410 say "unverified self-registrations may be deleted";
414 if ($special_holidays_days) {
416 DeleteSpecialHolidays( abs($special_holidays_days) );
417 } elsif ( $verbose ) {
418 say "self-registered borrowers may be deleted";
422 if( $temp_uploads ) {
423 # Delete temporary uploads, governed by a pref (unless you override)
424 print "Purging temporary uploads.\n" if $verbose;
426 Koha::UploadedFiles->delete_temporary({
427 defined($temp_uploads_days)
428 ? ( override_pref => $temp_uploads_days )
432 print "Done purging temporary uploads.\n" if $verbose;
435 if( defined $uploads_missing ) {
436 print "Looking for missing uploads\n" if $verbose;
438 my $keep = $uploads_missing == 1 ? 0 : 1;
439 my $count = Koha::UploadedFiles->delete_missing({ keep_record => $keep });
441 print "Counted $count missing uploaded files\n";
443 print "Removed $count records for missing uploads\n";
446 # FIXME need to create a filter_by_missing method (then call ->delete) instead of delete_missing
447 say "Dry-run mode cannot guess how many uploads would have been deleted";
452 require Koha::OAuthAccessTokens;
454 my $tokens = Koha::OAuthAccessTokens->search({ expires => { '<=', time } });
455 my $count = $tokens->count;
456 $tokens->delete if $confirm;
457 say sprintf "Removed %s expired OAuth2 tokens", $count if $verbose;
461 print "Purging statistics older than $pStatistics days.\n" if $verbose;
462 my $statistics = Koha::Statistics->filter_by_last_update(
463 { timestamp_column_name => 'datetime', days => $pStatistics } );
464 my $count = $statistics->count;
465 $statistics->delete if $confirm;
466 say sprintf "Done with purging %s statistics.", $count if $verbose;
469 if ($pDeletedCatalog) {
470 print "Purging deleted catalog older than $pDeletedCatalog days.\n"
472 my $old_items = Koha::Old::Items->filter_by_last_update( { days => $pDeletedCatalog } );
473 my $old_biblioitems = Koha::Old::Biblioitems->filter_by_last_update( { days => $pDeletedCatalog } );
474 my $old_biblios = Koha::Old::Biblios->filter_by_last_update( { days => $pDeletedCatalog } );
475 my ( $c_i, $c_bi, $c_b ) =
476 ( $old_items->count, $old_biblioitems->count, $old_biblios->count );
479 $old_biblioitems->delete;
480 $old_biblios->delete;
483 "Done with purging deleted catalog (%d items, %d biblioitems, %d biblios).",
488 if ($pDeletedPatrons) {
489 print "Purging deleted patrons older than $pDeletedPatrons days.\n" if $verbose;
490 my $old_patrons = Koha::Old::Patrons->filter_by_last_update(
491 { timestamp_column_name => 'updated_on', days => $pDeletedPatrons } );
492 my $count = $old_patrons->count;
493 $old_patrons->delete if $confirm;
494 say sprintf "Done with purging %d deleted patrons.", $count if $verbose;
498 print "Purging old checkouts older than $pOldIssues days.\n" if $verbose;
499 my $old_checkouts = Koha::Old::Checkouts->filter_by_last_update( { days => $pOldIssues } );
500 my $count = $old_checkouts->count;
501 $old_checkouts->delete if $confirm;
502 say sprintf "Done with purging %d old checkouts.", $count if $verbose;
506 print "Purging old reserves older than $pOldReserves days.\n" if $verbose;
507 my $old_reserves = Koha::Old::Holds->filter_by_last_update( { days => $pOldReserves } );
508 my $count = $old_reserves->count;
509 $old_reserves->delete if $verbose;
510 say sprintf "Done with purging %d old reserves.", $count if $verbose;
514 print "Purging arrived item transfers older than $pTransfers days.\n" if $verbose;
515 my $transfers = Koha::Item::Transfers->filter_by_last_update(
517 timestamp_column_name => 'datearrived',
521 my $count = $transfers->count;
522 $transfers->delete if $verbose;
523 say sprintf "Done with purging %d transfers.", $count if $verbose;
526 if (defined $pPseudoTransactions or $pPseudoTransactionsFrom or $pPseudoTransactionsTo ) {
527 print "Purging pseudonymized transactions\n" if $verbose;
528 my $anonymized_transactions = Koha::PseudonymizedTransactions->filter_by_last_update(
530 timestamp_column_name => 'datetime',
531 ( defined $pPseudoTransactions ? ( days => $pPseudoTransactions ) : () ),
532 ( $pPseudoTransactionsFrom ? ( from => $pPseudoTransactionsFrom ) : () ),
533 ( $pPseudoTransactionsTo ? ( to => $pPseudoTransactionsTo ) : () ),
536 my $count = $anonymized_transactions->count;
537 $anonymized_transactions->delete if $confirm;
538 say sprintf "Done with purging %d pseudonymized transactions.", $count if $verbose;
543 sub RemoveOldSessions {
544 my ( $id, $a_session, $limit, $lasttime );
545 $limit = time() - 24 * 3600 * $sess_days;
547 $sth = $dbh->prepare(q{ SELECT id, a_session FROM sessions });
548 $sth->execute or die $dbh->errstr;
549 $sth->bind_columns( \$id, \$a_session );
550 $sth2 = $dbh->prepare(q{ DELETE FROM sessions WHERE id=? });
553 while ( $sth->fetch ) {
555 if ( $a_session =~ /lasttime:\s+'?(\d+)/ ) {
558 elsif ( $a_session =~ /(ATIME|CTIME):\s+'?(\d+)/ ) {
561 if ( $lasttime && $lasttime < $limit ) {
562 $sth2->execute($id) or die $dbh->errstr;
567 print "$count sessions were deleted.\n";
571 sub PurgeImportTables {
573 #First purge import_records
574 #Delete cascades to import_biblios, import_items and import_record_matches
575 $sth = $dbh->prepare(
577 DELETE FROM import_records
578 WHERE upload_timestamp < date_sub(curdate(), INTERVAL ? DAY)
581 $sth->execute($pImport) or die $dbh->errstr;
583 # Now purge import_batches
584 # Timestamp cannot be used here without care, because records are added
585 # continuously to batches without updating timestamp (Z39.50 search).
586 # So we only delete older empty batches.
587 # This delete will therefore not have a cascading effect.
588 $sth = $dbh->prepare(
591 FROM import_batches ba
592 LEFT JOIN import_records re ON re.import_batch_id=ba.import_batch_id
593 WHERE re.import_record_id IS NULL AND
594 ba.upload_timestamp < date_sub(curdate(), INTERVAL ? DAY)
597 $sth->execute($pImport) or die $dbh->errstr;
601 $sth = $dbh->prepare(
603 DELETE FROM import_batches
604 WHERE batch_type = 'z3950'
607 $sth->execute() or die $dbh->errstr;
610 sub PurgeDebarments {
611 require Koha::Patron::Debarments;
612 my ( $days, $doit ) = @_;
614 $sth = $dbh->prepare(
616 SELECT borrower_debarment_id
617 FROM borrower_debarments
618 WHERE expiration < date_sub(curdate(), INTERVAL ? DAY)
621 $sth->execute($days) or die $dbh->errstr;
622 while ( my ($borrower_debarment_id) = $sth->fetchrow_array ) {
623 Koha::Patron::Debarments::DelDebarment($borrower_debarment_id) if $doit;
629 sub DeleteExpiredSelfRegs {
630 my $cnt= C4::Members::DeleteExpiredOpacRegistrations();
631 print "Removed $cnt expired self-registered borrowers\n" if $verbose;
634 sub DeleteUnverifiedSelfRegs {
635 my $cnt= C4::Members::DeleteUnverifiedOpacRegistrations( $_[0] );
636 print "Removed $cnt unverified self-registrations\n" if $verbose;
639 sub DeleteSpecialHolidays {
642 my $sth = $dbh->prepare(q{
643 DELETE FROM special_holidays
644 WHERE DATE( CONCAT( year, '-', month, '-', day ) ) < DATE_SUB( CAST(NOW() AS DATE), INTERVAL ? DAY );
646 my $count = $sth->execute( $days ) + 0;
647 print "Removed $count unique holidays\n" if $verbose;