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