Bug 16672 - Add ability to remove expired holidays from special_holidays
authorKyle M Hall <kyle@bywatersolutions.com>
Mon, 6 Jun 2016 13:52:45 +0000 (13:52 +0000)
committerKyle M Hall <kyle@bywatersolutions.com>
Fri, 17 Jun 2016 15:45:54 +0000 (15:45 +0000)
It would be very helpful if the cleanup_database.pl script had the
ability to delete holidays from the special_holidays table there were
older than a given number of days in the past.

Test Plan:
1) Apply this patch
2) Create some unique holidays in the past of varying ages
3) Test the new switch '--unique-holidays DAYS' for cleanup_database.pl
4) Verify only holidays older then the specified number of days are removed

NOTE: The language 'unique holdays' is used in the interface to match
      it's use in the staff web interface.

Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
misc/cronjobs/cleanup_database.pl

index bb54256..d9004ef 100755 (executable)
@@ -78,7 +78,8 @@ Usage: $0 [-h|--help] [--sessions] [--sessdays DAYS] [-v|--verbose] [--zebraqueu
                          Defaults to 30 days if no days specified.
     --all-restrictions   purge all expired patrons restrictions.
    --del-exp-selfreg  Delete expired self registration accounts
-   --del-unv-selfreg DAYS  Delete unverified self registrations older than DAYS
+   --del-unv-selfreg  DAYS  Delete unverified self registrations older than DAYS
+   --unique-holidays DAYS  Delete all unique holidays older than DAYS
 USAGE
     exit $_[0];
 }
@@ -100,25 +101,27 @@ my $allDebarments;
 my $pExpSelfReg;
 my $pUnvSelfReg;
 my $fees_days;
+my $special_holidays_days;
 
 GetOptions(
-    'h|help'          => \$help,
-    'sessions'        => \$sessions,
-    'sessdays:i'      => \$sess_days,
-    'v|verbose'       => \$verbose,
-    'm|mail:i'        => \$mail,
-    'zebraqueue:i'    => \$zebraqueue_days,
-    'merged'          => \$purge_merged,
-    'import:i'        => \$pImport,
-    'z3950'           => \$pZ3950,
-    'logs:i'          => \$pLogs,
-    'fees:i'          => \$fees_days,
-    'searchhistory:i' => \$pSearchhistory,
-    'list-invites:i'  => \$pListShareInvites,
-    'restrictions:i'  => \$pDebarments,
-    'all-restrictions' => \$allDebarments,
-    'del-exp-selfreg' => \$pExpSelfReg,
-    'del-unv-selfreg' => \$pUnvSelfReg,
+    'h|help'            => \$help,
+    'sessions'          => \$sessions,
+    'sessdays:i'        => \$sess_days,
+    'v|verbose'         => \$verbose,
+    'm|mail:i'          => \$mail,
+    'zebraqueue:i'      => \$zebraqueue_days,
+    'merged'            => \$purge_merged,
+    'import:i'          => \$pImport,
+    'z3950'             => \$pZ3950,
+    'logs:i'            => \$pLogs,
+    'fees:i'            => \$fees_days,
+    'searchhistory:i'   => \$pSearchhistory,
+    'list-invites:i'    => \$pListShareInvites,
+    'restrictions:i'    => \$pDebarments,
+    'all-restrictions'  => \$allDebarments,
+    'del-exp-selfreg'   => \$pExpSelfReg,
+    'del-unv-selfreg'   => \$pUnvSelfReg,
+    'unique-holidays:i' => \$special_holidays_days,
 ) || usage(1);
 
 # Use default values
@@ -149,6 +152,7 @@ unless ( $sessions
     || $allDebarments
     || $pExpSelfReg
     || $pUnvSelfReg
+    || $special_holidays_days
 ) {
     print "You did not specify any cleanup work for the script to do.\n\n";
     usage(1);
@@ -294,6 +298,10 @@ if( $pUnvSelfReg ) {
     DeleteUnverifiedSelfRegs( $pUnvSelfReg );
 }
 
+if ($special_holidays_days) {
+    DeleteSpecialHolidays($special_holidays_days);
+}
+
 exit(0);
 
 sub RemoveOldSessions {
@@ -391,3 +399,14 @@ sub DeleteUnverifiedSelfRegs {
     my $cnt= C4::Members::DeleteUnverifiedOpacRegistrations( $_[0] );
     print "Removed $cnt unverified self-registrations\n" if $verbose;
 }
+
+sub DeleteSpecialHolidays {
+    my ( $days ) = @_;
+
+    my $sth = $dbh->prepare(q{
+        DELETE FROM special_holidays
+        WHERE DATE( CONCAT( year, '-', month, '-', day ) ) < DATE_SUB( CAST(NOW() AS DATE), INTERVAL ? DAY );
+    });
+    my $count = $sth->execute( $days ) + 0;
+    print "Removed $count unqiue holidays\n" if $verbose;
+}