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