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 C4::Context;
  38 use C4::Search;
  39 use C4::Search::History;
  40 use Getopt::Long;
  41 use C4::Log;
  42 use C4::Accounts;
  43 use Koha::UploadedFiles;
  44
  45 sub usage {
  46     print STDERR <<USAGE;
  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 ]
  48
  49    -h --help          prints this help message, and exits, ignoring all
  50                       other options
  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
  55                       about the run.
  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
  64                       of Z39.50 searches
  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
  68                       or equal to 1.
  69    --logs DAYS        purge entries from action_logs older than DAYS days.
  70                       Defaults to 180 days if no days specified.
  71    --searchhistory DAYS  purge entries from search_history older than DAYS days.
  72                          Defaults to 30 days if no days specified
  73    --list-invites  DAYS  purge (unaccepted) list share invites older than DAYS
  74                          days.  Defaults to 14 days if no days specified.
  75    --restrictions DAYS   purge patrons restrictions expired since more than DAYS days.
  76                          Defaults to 30 days if no days specified.
  77     --all-restrictions   purge all expired patrons restrictions.
  78    --del-exp-selfreg  Delete expired self registration accounts
  79    --del-unv-selfreg  DAYS  Delete unverified self registrations older than DAYS
  80    --unique-holidays DAYS  Delete all unique holidays older than DAYS
  81    --temp-uploads     Delete temporary uploads.
  82    --temp-uploads-days DAYS Override the corresponding preference value.
  83    --uploads-missing FLAG Delete upload records for missing files when FLAG is true, count them otherwise
  84 USAGE
  85     exit $_[0];
  86 }
  87
  88 my $help;
  89 my $sessions;
  90 my $sess_days;
  91 my $verbose;
  92 my $zebraqueue_days;
  93 my $mail;
  94 my $purge_merged;
  95 my $pImport;
  96 my $pLogs;
  97 my $pSearchhistory;
  98 my $pZ3950;
  99 my $pListShareInvites;
 100 my $pDebarments;
 101 my $allDebarments;
 102 my $pExpSelfReg;
 103 my $pUnvSelfReg;
 104 my $fees_days;
 105 my $special_holidays_days;
 106 my $temp_uploads;
 107 my $temp_uploads_days;
 108 my $uploads_missing;
 109
 110 GetOptions(
 111     'h|help'            => \$help,
 112     'sessions'          => \$sessions,
 113     'sessdays:i'        => \$sess_days,
 114     'v|verbose'         => \$verbose,
 115     'm|mail:i'          => \$mail,
 116     'zebraqueue:i'      => \$zebraqueue_days,
 117     'merged'            => \$purge_merged,
 118     'import:i'          => \$pImport,
 119     'z3950'             => \$pZ3950,
 120     'logs:i'            => \$pLogs,
 121     'fees:i'            => \$fees_days,
 122     'searchhistory:i'   => \$pSearchhistory,
 123     'list-invites:i'    => \$pListShareInvites,
 124     'restrictions:i'    => \$pDebarments,
 125     'all-restrictions'  => \$allDebarments,
 126     'del-exp-selfreg'   => \$pExpSelfReg,
 127     'del-unv-selfreg'   => \$pUnvSelfReg,
 128     'unique-holidays:i' => \$special_holidays_days,
 129     'temp-uploads'      => \$temp_uploads,
 130     'temp-uploads-days:i' => \$temp_uploads_days,
 131     'uploads-missing:i' => \$uploads_missing,
 132 ) || usage(1);
 133
 134 # Use default values
 135 $sessions          = 1                                    if $sess_days                  && $sess_days > 0;
 136 $pImport           = DEFAULT_IMPORT_PURGEDAYS             if defined($pImport)           && $pImport == 0;
 137 $pLogs             = DEFAULT_LOGS_PURGEDAYS               if defined($pLogs)             && $pLogs == 0;
 138 $zebraqueue_days   = DEFAULT_ZEBRAQ_PURGEDAYS             if defined($zebraqueue_days)   && $zebraqueue_days == 0;
 139 $mail              = DEFAULT_MAIL_PURGEDAYS               if defined($mail)              && $mail == 0;
 140 $pSearchhistory    = DEFAULT_SEARCHHISTORY_PURGEDAYS      if defined($pSearchhistory)    && $pSearchhistory == 0;
 141 $pListShareInvites = DEFAULT_SHARE_INVITATION_EXPIRY_DAYS if defined($pListShareInvites) && $pListShareInvites == 0;
 142 $pDebarments       = DEFAULT_DEBARMENTS_PURGEDAYS         if defined($pDebarments)       && $pDebarments == 0;
 143
 144 if ($help) {
 145     usage(0);
 146 }
 147
 148 unless ( $sessions
 149     || $zebraqueue_days
 150     || $mail
 151     || $purge_merged
 152     || $pImport
 153     || $pLogs
 154     || $fees_days
 155     || $pSearchhistory
 156     || $pZ3950
 157     || $pListShareInvites
 158     || $pDebarments
 159     || $allDebarments
 160     || $pExpSelfReg
 161     || $pUnvSelfReg
 162     || $special_holidays_days
 163     || $temp_uploads
 164     || defined $uploads_missing
 165 ) {
 166     print "You did not specify any cleanup work for the script to do.\n\n";
 167     usage(1);
 168 }
 169
 170 if ($pDebarments && $allDebarments) {
 171     print "You can not specify both --restrictions and --all-restrictions.\n\n";
 172     usage(1);
 173 }
 174
 175 cronlogaction();
 176
 177 my $dbh = C4::Context->dbh();
 178 my $sth;
 179 my $sth2;
 180 my $count;
 181
 182 if ( $sessions && !$sess_days ) {
 183     if ($verbose) {
 184         print "Session purge triggered.\n";
 185         $sth = $dbh->prepare(q{ SELECT COUNT(*) FROM sessions });
 186         $sth->execute() or die $dbh->errstr;
 187         my @count_arr = $sth->fetchrow_array;
 188         print "$count_arr[0] entries will be deleted.\n";
 189     }
 190     $sth = $dbh->prepare(q{ TRUNCATE sessions });
 191     $sth->execute() or die $dbh->errstr;
 192     if ($verbose) {
 193         print "Done with session purge.\n";
 194     }
 195 }
 196 elsif ( $sessions && $sess_days > 0 ) {
 197     print "Session purge triggered with days>$sess_days.\n" if $verbose;
 198     RemoveOldSessions();
 199     print "Done with session purge with days>$sess_days.\n" if $verbose;
 200 }
 201
 202 if ($zebraqueue_days) {
 203     $count = 0;
 204     print "Zebraqueue purge triggered for $zebraqueue_days days.\n" if $verbose;
 205     $sth = $dbh->prepare(
 206         q{
 207             SELECT id,biblio_auth_number,server,time
 208             FROM zebraqueue
 209             WHERE done=1 AND time < date_sub(curdate(), INTERVAL ? DAY)
 210         }
 211     );
 212     $sth->execute($zebraqueue_days) or die $dbh->errstr;
 213     $sth2 = $dbh->prepare(q{ DELETE FROM zebraqueue WHERE id=? });
 214     while ( my $record = $sth->fetchrow_hashref ) {
 215         $sth2->execute( $record->{id} ) or die $dbh->errstr;
 216         $count++;
 217     }
 218     print "$count records were deleted.\nDone with zebraqueue purge.\n" if $verbose;
 219 }
 220
 221 if ($mail) {
 222     print "Mail queue purge triggered for $mail days.\n" if $verbose;
 223     $sth = $dbh->prepare(
 224         q{
 225             DELETE FROM message_queue
 226             WHERE time_queued < date_sub(curdate(), INTERVAL ? DAY)
 227         }
 228     );
 229     $sth->execute($mail) or die $dbh->errstr;
 230     $count = $sth->rows;
 231     $sth->finish;
 232     print "$count messages were deleted from the mail queue.\nDone with message_queue purge.\n" if $verbose;
 233 }
 234
 235 if ($purge_merged) {
 236     print "Purging completed entries from need_merge_authorities.\n" if $verbose;
 237     $sth = $dbh->prepare(q{ DELETE FROM need_merge_authorities WHERE done=1 });
 238     $sth->execute() or die $dbh->errstr;
 239     print "Done with purging need_merge_authorities.\n" if $verbose;
 240 }
 241
 242 if ($pImport) {
 243     print "Purging records from import tables.\n" if $verbose;
 244     PurgeImportTables();
 245     print "Done with purging import tables.\n" if $verbose;
 246 }
 247
 248 if ($pZ3950) {
 249     print "Purging Z39.50 records from import tables.\n" if $verbose;
 250     PurgeZ3950();
 251     print "Done with purging Z39.50 records from import tables.\n" if $verbose;
 252 }
 253
 254 if ($pLogs) {
 255     print "Purging records from action_logs.\n" if $verbose;
 256     $sth = $dbh->prepare(
 257         q{
 258             DELETE FROM action_logs
 259             WHERE timestamp < date_sub(curdate(), INTERVAL ? DAY)
 260         }
 261     );
 262     $sth->execute($pLogs) or die $dbh->errstr;
 263     print "Done with purging action_logs.\n" if $verbose;
 264 }
 265
 266 if ($fees_days) {
 267     print "Purging records from accountlines.\n" if $verbose;
 268     purge_zero_balance_fees( $fees_days );
 269     print "Done purging records from accountlines.\n" if $verbose;
 270 }
 271
 272 if ($pSearchhistory) {
 273     print "Purging records older than $pSearchhistory from search_history.\n" if $verbose;
 274     C4::Search::History::delete({ interval => $pSearchhistory });
 275     print "Done with purging search_history.\n" if $verbose;
 276 }
 277
 278 if ($pListShareInvites) {
 279     print "Purging unaccepted list share invites older than $pListShareInvites days.\n" if $verbose;
 280     $sth = $dbh->prepare(
 281         q{
 282             DELETE FROM virtualshelfshares
 283             WHERE invitekey IS NOT NULL
 284             AND (sharedate + INTERVAL ? DAY) < NOW()
 285         }
 286     );
 287     $sth->execute($pListShareInvites);
 288     print "Done with purging unaccepted list share invites.\n" if $verbose;
 289 }
 290
 291 if ($pDebarments) {
 292     print "Expired patrons restrictions purge triggered for $pDebarments days.\n" if $verbose;
 293     $count = PurgeDebarments($pDebarments);
 294     print "$count restrictions were deleted.\nDone with restrictions purge.\n" if $verbose;
 295 }
 296
 297 if($allDebarments) {
 298     print "All expired patrons restrictions purge triggered.\n" if $verbose;
 299     $count = PurgeDebarments(0);
 300     print "$count restrictions were deleted.\nDone with all restrictions purge.\n" if $verbose;
 301 }
 302
 303 if( $pExpSelfReg ) {
 304     DeleteExpiredSelfRegs();
 305 }
 306 if( $pUnvSelfReg ) {
 307     DeleteUnverifiedSelfRegs( $pUnvSelfReg );
 308 }
 309
 310 if ($special_holidays_days) {
 311     DeleteSpecialHolidays( abs($special_holidays_days) );
 312 }
 313
 314 if( $temp_uploads ) {
 315     # Delete temporary uploads, governed by a pref (unless you override)
 316     print "Purging temporary uploads.\n" if $verbose;
 317     Koha::UploadedFiles->delete_temporary({
 318         defined($temp_uploads_days)
 319             ? ( override_pref => $temp_uploads_days )
 320             : ()
 321     });
 322     print "Done purging temporary uploads.\n" if $verbose;
 323 }
 324
 325 if( defined $uploads_missing ) {
 326     print "Looking for missing uploads\n" if $verbose;
 327     my $keep = $uploads_missing == 1 ? 0 : 1;
 328     my $count = Koha::UploadedFiles->delete_missing({ keep_record => $keep });
 329     if( $keep ) {
 330         print "Counted $count missing uploaded files\n";
 331     } else {
 332         print "Removed $count records for missing uploads\n";
 333     }
 334 }
 335
 336 exit(0);
 337
 338 sub RemoveOldSessions {
 339     my ( $id, $a_session, $limit, $lasttime );
 340     $limit = time() - 24 * 3600 * $sess_days;
 341
 342     $sth = $dbh->prepare(q{ SELECT id, a_session FROM sessions });
 343     $sth->execute or die $dbh->errstr;
 344     $sth->bind_columns( \$id, \$a_session );
 345     $sth2  = $dbh->prepare(q{ DELETE FROM sessions WHERE id=? });
 346     $count = 0;
 347
 348     while ( $sth->fetch ) {
 349         $lasttime = 0;
 350         if ( $a_session =~ /lasttime:\s+'?(\d+)/ ) {
 351             $lasttime = $1;
 352         }
 353         elsif ( $a_session =~ /(ATIME|CTIME):\s+'?(\d+)/ ) {
 354             $lasttime = $2;
 355         }
 356         if ( $lasttime && $lasttime < $limit ) {
 357             $sth2->execute($id) or die $dbh->errstr;
 358             $count++;
 359         }
 360     }
 361     if ($verbose) {
 362         print "$count sessions were deleted.\n";
 363     }
 364 }
 365
 366 sub PurgeImportTables {
 367
 368     #First purge import_records
 369     #Delete cascades to import_biblios, import_items and import_record_matches
 370     $sth = $dbh->prepare(
 371         q{
 372             DELETE FROM import_records
 373             WHERE upload_timestamp < date_sub(curdate(), INTERVAL ? DAY)
 374         }
 375     );
 376     $sth->execute($pImport) or die $dbh->errstr;
 377
 378     # Now purge import_batches
 379     # Timestamp cannot be used here without care, because records are added
 380     # continuously to batches without updating timestamp (Z39.50 search).
 381     # So we only delete older empty batches.
 382     # This delete will therefore not have a cascading effect.
 383     $sth = $dbh->prepare(
 384         q{
 385             DELETE ba
 386             FROM import_batches ba
 387             LEFT JOIN import_records re ON re.import_batch_id=ba.import_batch_id
 388             WHERE re.import_record_id IS NULL AND
 389             ba.upload_timestamp < date_sub(curdate(), INTERVAL ? DAY)
 390         }
 391     );
 392     $sth->execute($pImport) or die $dbh->errstr;
 393 }
 394
 395 sub PurgeZ3950 {
 396     $sth = $dbh->prepare(
 397         q{
 398             DELETE FROM import_batches
 399             WHERE batch_type = 'z3950'
 400         }
 401     );
 402     $sth->execute() or die $dbh->errstr;
 403 }
 404
 405 sub PurgeDebarments {
 406     require Koha::Patron::Debarments;
 407     my $days = shift;
 408     $count = 0;
 409     $sth   = $dbh->prepare(
 410         q{
 411             SELECT borrower_debarment_id
 412             FROM borrower_debarments
 413             WHERE expiration < date_sub(curdate(), INTERVAL ? DAY)
 414         }
 415     );
 416     $sth->execute($days) or die $dbh->errstr;
 417     while ( my ($borrower_debarment_id) = $sth->fetchrow_array ) {
 418         Koha::Patron::Debarments::DelDebarment($borrower_debarment_id);
 419         $count++;
 420     }
 421     return $count;
 422 }
 423
 424 sub DeleteExpiredSelfRegs {
 425     my $cnt= C4::Members::DeleteExpiredOpacRegistrations();
 426     print "Removed $cnt expired self-registered borrowers\n" if $verbose;
 427 }
 428
 429 sub DeleteUnverifiedSelfRegs {
 430     my $cnt= C4::Members::DeleteUnverifiedOpacRegistrations( $_[0] );
 431     print "Removed $cnt unverified self-registrations\n" if $verbose;
 432 }
 433
 434 sub DeleteSpecialHolidays {
 435     my ( $days ) = @_;
 436
 437     my $sth = $dbh->prepare(q{
 438         DELETE FROM special_holidays
 439         WHERE DATE( CONCAT( year, '-', month, '-', day ) ) < DATE_SUB( CAST(NOW() AS DATE), INTERVAL ? DAY );
 440     });
 441     my $count = $sth->execute( $days ) + 0;
 442     print "Removed $count unique holidays\n" if $verbose;
 443 }