misc/cronjobs/cleanup_database.pl

   1 #!/usr/bin/perl
   2
   3 # Copyright 2009 PTFS, Inc.
   4 #
   5 # This file is part of Koha.
   6 #
   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.
  11 #
  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.
  16 #
  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>.
  19
  20 use Modern::Perl;
  21
  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;
  29
  30 BEGIN {
  31     # find Koha's Perl modules
  32     # test carefully before changing this
  33     use FindBin;
  34     eval { require "$FindBin::Bin/../kohalib.pl" };
  35 }
  36
  37 use Koha::Script -cron;
  38 use C4::Context;
  39 use C4::Search;
  40 use C4::Search::History;
  41 use Getopt::Long;
  42 use C4::Log;
  43 use C4::Accounts;
  44 use Koha::UploadedFiles;
  45
  46 sub usage {
  47     print STDERR <<USAGE;
  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]
  49
  50    -h --help          prints this help message, and exits, ignoring all
  51                       other options
  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
  56                       about the run.
  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
  65                       of Z39.50 searches
  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
  69                       or equal to 1.
  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 USAGE
  91     exit $_[0];
  92 }
  93
  94 my $help;
  95 my $sessions;
  96 my $sess_days;
  97 my $verbose;
  98 my $zebraqueue_days;
  99 my $mail;
 100 my $purge_merged;
 101 my $pImport;
 102 my $pLogs;
 103 my $pSearchhistory;
 104 my $pZ3950;
 105 my $pListShareInvites;
 106 my $pDebarments;
 107 my $allDebarments;
 108 my $pExpSelfReg;
 109 my $pUnvSelfReg;
 110 my $fees_days;
 111 my $special_holidays_days;
 112 my $temp_uploads;
 113 my $temp_uploads_days;
 114 my $uploads_missing;
 115 my $oauth_tokens;
 116 my $pStatistics;
 117 my $pDeletedCatalog;
 118 my $pDeletedPatrons;
 119
 120 GetOptions(
 121     'h|help'            => \$help,
 122     'sessions'          => \$sessions,
 123     'sessdays:i'        => \$sess_days,
 124     'v|verbose'         => \$verbose,
 125     'm|mail:i'          => \$mail,
 126     'zebraqueue:i'      => \$zebraqueue_days,
 127     'merged'            => \$purge_merged,
 128     'import:i'          => \$pImport,
 129     'z3950'             => \$pZ3950,
 130     'logs:i'            => \$pLogs,
 131     'fees:i'            => \$fees_days,
 132     'searchhistory:i'   => \$pSearchhistory,
 133     'list-invites:i'    => \$pListShareInvites,
 134     'restrictions:i'    => \$pDebarments,
 135     'all-restrictions'  => \$allDebarments,
 136     'del-exp-selfreg'   => \$pExpSelfReg,
 137     'del-unv-selfreg'   => \$pUnvSelfReg,
 138     'unique-holidays:i' => \$special_holidays_days,
 139     'temp-uploads'      => \$temp_uploads,
 140     'temp-uploads-days:i' => \$temp_uploads_days,
 141     'uploads-missing:i' => \$uploads_missing,
 142     'oauth-tokens'      => \$oauth_tokens,
 143     'statistics:i'      => \$pStatistics,
 144     'deleted-catalog:i' => \$pDeletedCatalog,
 145     'deleted-patrons:i' => \$pDeletedPatrons,
 146 ) || usage(1);
 147
 148 # Use default values
 149 $sessions          = 1                                    if $sess_days                  && $sess_days > 0;
 150 $pImport           = DEFAULT_IMPORT_PURGEDAYS             if defined($pImport)           && $pImport == 0;
 151 $pLogs             = DEFAULT_LOGS_PURGEDAYS               if defined($pLogs)             && $pLogs == 0;
 152 $zebraqueue_days   = DEFAULT_ZEBRAQ_PURGEDAYS             if defined($zebraqueue_days)   && $zebraqueue_days == 0;
 153 $mail              = DEFAULT_MAIL_PURGEDAYS               if defined($mail)              && $mail == 0;
 154 $pSearchhistory    = DEFAULT_SEARCHHISTORY_PURGEDAYS      if defined($pSearchhistory)    && $pSearchhistory == 0;
 155 $pListShareInvites = DEFAULT_SHARE_INVITATION_EXPIRY_DAYS if defined($pListShareInvites) && $pListShareInvites == 0;
 156 $pDebarments       = DEFAULT_DEBARMENTS_PURGEDAYS         if defined($pDebarments)       && $pDebarments == 0;
 157
 158 if ($help) {
 159     usage(0);
 160 }
 161
 162 unless ( $sessions
 163     || $zebraqueue_days
 164     || $mail
 165     || $purge_merged
 166     || $pImport
 167     || $pLogs
 168     || $fees_days
 169     || $pSearchhistory
 170     || $pZ3950
 171     || $pListShareInvites
 172     || $pDebarments
 173     || $allDebarments
 174     || $pExpSelfReg
 175     || $pUnvSelfReg
 176     || $special_holidays_days
 177     || $temp_uploads
 178     || defined $uploads_missing
 179     || $oauth_tokens
 180     || $pStatistics
 181     || $pDeletedCatalog
 182     || $pDeletedPatrons
 183 ) {
 184     print "You did not specify any cleanup work for the script to do.\n\n";
 185     usage(1);
 186 }
 187
 188 if ($pDebarments && $allDebarments) {
 189     print "You can not specify both --restrictions and --all-restrictions.\n\n";
 190     usage(1);
 191 }
 192
 193 cronlogaction();
 194
 195 my $dbh = C4::Context->dbh();
 196 my $sth;
 197 my $sth2;
 198 my $count;
 199
 200 if ( $sessions && !$sess_days ) {
 201     if ($verbose) {
 202         print "Session purge triggered.\n";
 203         $sth = $dbh->prepare(q{ SELECT COUNT(*) FROM sessions });
 204         $sth->execute() or die $dbh->errstr;
 205         my @count_arr = $sth->fetchrow_array;
 206         print "$count_arr[0] entries will be deleted.\n";
 207     }
 208     $sth = $dbh->prepare(q{ TRUNCATE sessions });
 209     $sth->execute() or die $dbh->errstr;
 210     if ($verbose) {
 211         print "Done with session purge.\n";
 212     }
 213 }
 214 elsif ( $sessions && $sess_days > 0 ) {
 215     print "Session purge triggered with days>$sess_days.\n" if $verbose;
 216     RemoveOldSessions();
 217     print "Done with session purge with days>$sess_days.\n" if $verbose;
 218 }
 219
 220 if ($zebraqueue_days) {
 221     $count = 0;
 222     print "Zebraqueue purge triggered for $zebraqueue_days days.\n" if $verbose;
 223     $sth = $dbh->prepare(
 224         q{
 225             SELECT id,biblio_auth_number,server,time
 226             FROM zebraqueue
 227             WHERE done=1 AND time < date_sub(curdate(), INTERVAL ? DAY)
 228         }
 229     );
 230     $sth->execute($zebraqueue_days) or die $dbh->errstr;
 231     $sth2 = $dbh->prepare(q{ DELETE FROM zebraqueue WHERE id=? });
 232     while ( my $record = $sth->fetchrow_hashref ) {
 233         $sth2->execute( $record->{id} ) or die $dbh->errstr;
 234         $count++;
 235     }
 236     print "$count records were deleted.\nDone with zebraqueue purge.\n" if $verbose;
 237 }
 238
 239 if ($mail) {
 240     print "Mail queue purge triggered for $mail days.\n" if $verbose;
 241     $sth = $dbh->prepare(
 242         q{
 243             DELETE FROM message_queue
 244             WHERE time_queued < date_sub(curdate(), INTERVAL ? DAY)
 245         }
 246     );
 247     $sth->execute($mail) or die $dbh->errstr;
 248     $count = $sth->rows;
 249     $sth->finish;
 250     print "$count messages were deleted from the mail queue.\nDone with message_queue purge.\n" if $verbose;
 251 }
 252
 253 if ($purge_merged) {
 254     print "Purging completed entries from need_merge_authorities.\n" if $verbose;
 255     $sth = $dbh->prepare(q{ DELETE FROM need_merge_authorities WHERE done=1 });
 256     $sth->execute() or die $dbh->errstr;
 257     print "Done with purging need_merge_authorities.\n" if $verbose;
 258 }
 259
 260 if ($pImport) {
 261     print "Purging records from import tables.\n" if $verbose;
 262     PurgeImportTables();
 263     print "Done with purging import tables.\n" if $verbose;
 264 }
 265
 266 if ($pZ3950) {
 267     print "Purging Z39.50 records from import tables.\n" if $verbose;
 268     PurgeZ3950();
 269     print "Done with purging Z39.50 records from import tables.\n" if $verbose;
 270 }
 271
 272 if ($pLogs) {
 273     print "Purging records from action_logs.\n" if $verbose;
 274     $sth = $dbh->prepare(
 275         q{
 276             DELETE FROM action_logs
 277             WHERE timestamp < date_sub(curdate(), INTERVAL ? DAY)
 278         }
 279     );
 280     $sth->execute($pLogs) or die $dbh->errstr;
 281     print "Done with purging action_logs.\n" if $verbose;
 282 }
 283
 284 if ($fees_days) {
 285     print "Purging records from accountlines.\n" if $verbose;
 286     purge_zero_balance_fees( $fees_days );
 287     print "Done purging records from accountlines.\n" if $verbose;
 288 }
 289
 290 if ($pSearchhistory) {
 291     print "Purging records older than $pSearchhistory from search_history.\n" if $verbose;
 292     C4::Search::History::delete({ interval => $pSearchhistory });
 293     print "Done with purging search_history.\n" if $verbose;
 294 }
 295
 296 if ($pListShareInvites) {
 297     print "Purging unaccepted list share invites older than $pListShareInvites days.\n" if $verbose;
 298     $sth = $dbh->prepare(
 299         q{
 300             DELETE FROM virtualshelfshares
 301             WHERE invitekey IS NOT NULL
 302             AND (sharedate + INTERVAL ? DAY) < NOW()
 303         }
 304     );
 305     $sth->execute($pListShareInvites);
 306     print "Done with purging unaccepted list share invites.\n" if $verbose;
 307 }
 308
 309 if ($pDebarments) {
 310     print "Expired patrons restrictions purge triggered for $pDebarments days.\n" if $verbose;
 311     $count = PurgeDebarments($pDebarments);
 312     print "$count restrictions were deleted.\nDone with restrictions purge.\n" if $verbose;
 313 }
 314
 315 if($allDebarments) {
 316     print "All expired patrons restrictions purge triggered.\n" if $verbose;
 317     $count = PurgeDebarments(0);
 318     print "$count restrictions were deleted.\nDone with all restrictions purge.\n" if $verbose;
 319 }
 320
 321 # Handle unsubscribe requests from GDPR consent form, depends on UnsubscribeReflectionDelay preference
 322 Koha::Patrons->search_unsubscribed->lock({ expire => 1, remove => 1, verbose => $verbose });
 323 # Anonymize patron data, depending on PatronAnonymizeDelay
 324 Koha::Patrons->search_anonymize_candidates({ locked => 1 })->anonymize({ verbose => $verbose });
 325 # Remove patron data, depending on PatronRemovalDelay (will raise an exception if problem encountered
 326 eval { Koha::Patrons->search_anonymized->delete({ move => 1, verbose => $verbose }) };
 327 warn $@ if $@;
 328
 329 if( $pExpSelfReg ) {
 330     DeleteExpiredSelfRegs();
 331 }
 332 if( $pUnvSelfReg ) {
 333     DeleteUnverifiedSelfRegs( $pUnvSelfReg );
 334 }
 335
 336 if ($special_holidays_days) {
 337     DeleteSpecialHolidays( abs($special_holidays_days) );
 338 }
 339
 340 if( $temp_uploads ) {
 341     # Delete temporary uploads, governed by a pref (unless you override)
 342     print "Purging temporary uploads.\n" if $verbose;
 343     Koha::UploadedFiles->delete_temporary({
 344         defined($temp_uploads_days)
 345             ? ( override_pref => $temp_uploads_days )
 346             : ()
 347     });
 348     print "Done purging temporary uploads.\n" if $verbose;
 349 }
 350
 351 if( defined $uploads_missing ) {
 352     print "Looking for missing uploads\n" if $verbose;
 353     my $keep = $uploads_missing == 1 ? 0 : 1;
 354     my $count = Koha::UploadedFiles->delete_missing({ keep_record => $keep });
 355     if( $keep ) {
 356         print "Counted $count missing uploaded files\n";
 357     } else {
 358         print "Removed $count records for missing uploads\n";
 359     }
 360 }
 361
 362 if ($oauth_tokens) {
 363     require Koha::OAuthAccessTokens;
 364
 365     my $count = int Koha::OAuthAccessTokens->search({ expires => { '<=', time } })->delete;
 366     say "Removed $count expired OAuth2 tokens" if $verbose;
 367 }
 368
 369 if ($pStatistics) {
 370     print "Purging statistics older than $pStatistics days.\n" if $verbose;
 371     $sth = $dbh->prepare(
 372         q{
 373             DELETE FROM statistics
 374             WHERE datetime < DATE_SUB(CURDATE(), INTERVAL ? DAY)
 375         }
 376     );
 377     $sth->execute($pStatistics);
 378     print "Done with purging statistics.\n" if $verbose;
 379 }
 380
 381 if ($pDeletedCatalog) {
 382     print "Purging deleted catalog older than $pDeletedCatalog days.\n" if $verbose;
 383     my $sth1 = $dbh->prepare(
 384         q{
 385             DELETE FROM deleteditems
 386             WHERE timestamp < DATE_SUB(CURDATE(), INTERVAL ? DAY)
 387         }
 388     );
 389     my $sth2 = $dbh->prepare(
 390         q{
 391             DELETE FROM deletedbiblioitems
 392             WHERE timestamp < DATE_SUB(CURDATE(), INTERVAL ? DAY)
 393         }
 394     );
 395     my $sth3 = $dbh->prepare(
 396         q{
 397             DELETE FROM deletedbiblio
 398             WHERE timestamp < DATE_SUB(CURDATE(), INTERVAL ? DAY)
 399         }
 400     );
 401     # deletedbiblio_metadata is managed by FK with deletedbiblio
 402     $sth1->execute($pDeletedCatalog);
 403     $sth2->execute($pDeletedCatalog);
 404     $sth3->execute($pDeletedCatalog);
 405     print "Done with purging deleted catalog.\n" if $verbose;
 406 }
 407
 408 if ($pDeletedPatrons) {
 409     print "Purging deleted patrons older than $pDeletedPatrons days.\n" if $verbose;
 410     $sth = $dbh->prepare(
 411         q{
 412             DELETE FROM deletedborrowers
 413             WHERE updated_on < DATE_SUB(CURDATE(), INTERVAL ? DAY)
 414         }
 415     );
 416     $sth->execute($pDeletedPatrons);
 417     print "Done with purging deleted patrons.\n" if $verbose;
 418 }
 419
 420 exit(0);
 421
 422 sub RemoveOldSessions {
 423     my ( $id, $a_session, $limit, $lasttime );
 424     $limit = time() - 24 * 3600 * $sess_days;
 425
 426     $sth = $dbh->prepare(q{ SELECT id, a_session FROM sessions });
 427     $sth->execute or die $dbh->errstr;
 428     $sth->bind_columns( \$id, \$a_session );
 429     $sth2  = $dbh->prepare(q{ DELETE FROM sessions WHERE id=? });
 430     $count = 0;
 431
 432     while ( $sth->fetch ) {
 433         $lasttime = 0;
 434         if ( $a_session =~ /lasttime:\s+'?(\d+)/ ) {
 435             $lasttime = $1;
 436         }
 437         elsif ( $a_session =~ /(ATIME|CTIME):\s+'?(\d+)/ ) {
 438             $lasttime = $2;
 439         }
 440         if ( $lasttime && $lasttime < $limit ) {
 441             $sth2->execute($id) or die $dbh->errstr;
 442             $count++;
 443         }
 444     }
 445     if ($verbose) {
 446         print "$count sessions were deleted.\n";
 447     }
 448 }
 449
 450 sub PurgeImportTables {
 451
 452     #First purge import_records
 453     #Delete cascades to import_biblios, import_items and import_record_matches
 454     $sth = $dbh->prepare(
 455         q{
 456             DELETE FROM import_records
 457             WHERE upload_timestamp < date_sub(curdate(), INTERVAL ? DAY)
 458         }
 459     );
 460     $sth->execute($pImport) or die $dbh->errstr;
 461
 462     # Now purge import_batches
 463     # Timestamp cannot be used here without care, because records are added
 464     # continuously to batches without updating timestamp (Z39.50 search).
 465     # So we only delete older empty batches.
 466     # This delete will therefore not have a cascading effect.
 467     $sth = $dbh->prepare(
 468         q{
 469             DELETE ba
 470             FROM import_batches ba
 471             LEFT JOIN import_records re ON re.import_batch_id=ba.import_batch_id
 472             WHERE re.import_record_id IS NULL AND
 473             ba.upload_timestamp < date_sub(curdate(), INTERVAL ? DAY)
 474         }
 475     );
 476     $sth->execute($pImport) or die $dbh->errstr;
 477 }
 478
 479 sub PurgeZ3950 {
 480     $sth = $dbh->prepare(
 481         q{
 482             DELETE FROM import_batches
 483             WHERE batch_type = 'z3950'
 484         }
 485     );
 486     $sth->execute() or die $dbh->errstr;
 487 }
 488
 489 sub PurgeDebarments {
 490     require Koha::Patron::Debarments;
 491     my $days = shift;
 492     $count = 0;
 493     $sth   = $dbh->prepare(
 494         q{
 495             SELECT borrower_debarment_id
 496             FROM borrower_debarments
 497             WHERE expiration < date_sub(curdate(), INTERVAL ? DAY)
 498         }
 499     );
 500     $sth->execute($days) or die $dbh->errstr;
 501     while ( my ($borrower_debarment_id) = $sth->fetchrow_array ) {
 502         Koha::Patron::Debarments::DelDebarment($borrower_debarment_id);
 503         $count++;
 504     }
 505     return $count;
 506 }
 507
 508 sub DeleteExpiredSelfRegs {
 509     my $cnt= C4::Members::DeleteExpiredOpacRegistrations();
 510     print "Removed $cnt expired self-registered borrowers\n" if $verbose;
 511 }
 512
 513 sub DeleteUnverifiedSelfRegs {
 514     my $cnt= C4::Members::DeleteUnverifiedOpacRegistrations( $_[0] );
 515     print "Removed $cnt unverified self-registrations\n" if $verbose;
 516 }
 517
 518 sub DeleteSpecialHolidays {
 519     my ( $days ) = @_;
 520
 521     my $sth = $dbh->prepare(q{
 522         DELETE FROM special_holidays
 523         WHERE DATE( CONCAT( year, '-', month, '-', day ) ) < DATE_SUB( CAST(NOW() AS DATE), INTERVAL ? DAY );
 524     });
 525     my $count = $sth->execute( $days ) + 0;
 526     print "Removed $count unique holidays\n" if $verbose;
 527 }