From 1d5a4a0a8187672f79f886f59842ca11e2a14e55 Mon Sep 17 00:00:00 2001
From: Mirko Tietgen <mirko@abunchofthings.net>
Date: Tue, 11 Jun 2013 15:35:44 +0200
Subject: [PATCH] Bug 10361: Add option to cleanup_database.pl to purge OPAC
 search history

Add an option to cleanup_database.pl to purge the search_history
entries older than X days.

Test plan:

- Apply patch
- Check that your test DB has some entries a little older than 30 days
  and a few ones even older than that in search_history:

  SELECT * FROM search_history WHERE time < DATE_SUB( NOW(), INTERVAL 30 DAY );

  If not, modify some existing entries.

- Run cleanup_database with a fixed number of days (replace XX with
  something higher than 30)

  /misc/cronjobs/cleanup_database.pl --searchhistory XX

- Check that entries older than XX days got deleted from search_history
- Run without the day parameter
  /misc/cronjobs/cleanup_database.pl --searchhistory
- Check that entries older than 30 days got deleted from search_history

Signed-off-by: Galen Charlton <gmc@esilibrary.com>
Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
Signed-off-by: Galen Charlton <gmc@esilibrary.com>
---
 C4/Search.pm                      |  9 ++++++++-
 misc/cronjobs/cleanup_database.pl | 21 +++++++++++++++++----
 2 files changed, 25 insertions(+), 5 deletions(-)

diff --git a/C4/Search.pm b/C4/Search.pm
index 753d5ae2c4..c550385b11 100644
--- a/C4/Search.pm
+++ b/C4/Search.pm
@@ -71,7 +71,7 @@ This module provides searching functions for Koha's bibliographic databases
   &AddSearchHistory
   &GetDistinctValues
   &enabled_staff_search_views
-  &SimpleSearch
+  &PurgeSearchHistory
 );
 
 # make all your functions, whether exported or not;
@@ -2211,6 +2211,13 @@ sub GetSearchHistory{
     return  $sth->fetchall_hashref({});
 }
 
+sub PurgeSearchHistory{
+    my ($pSearchhistory)=@_;
+    my $dbh = C4::Context->dbh;
+    my $sth = $dbh->prepare("DELETE FROM search_history WHERE time < DATE_SUB( NOW(), INTERVAL ? DAY )");
+    $sth->execute($pSearchhistory) or die $dbh->errstr;
+}
+
 =head2 z3950_search_args
 
 $arrayref = z3950_search_args($matchpoints)
diff --git a/misc/cronjobs/cleanup_database.pl b/misc/cronjobs/cleanup_database.pl
index 4b6444f82d..c190a80941 100755
--- a/misc/cronjobs/cleanup_database.pl
+++ b/misc/cronjobs/cleanup_database.pl
@@ -24,6 +24,7 @@ use constant DEFAULT_ZEBRAQ_PURGEDAYS => 30;
 use constant DEFAULT_MAIL_PURGEDAYS => 30;
 use constant DEFAULT_IMPORT_PURGEDAYS => 60;
 use constant DEFAULT_LOGS_PURGEDAYS => 180;
+use constant DEFAULT_SEARCHHISTORY_PURGEDAYS => 30;
 
 BEGIN {
     # find Koha's Perl modules
@@ -35,11 +36,13 @@ BEGIN {
 use C4::Context;
 use C4::Dates;
 
+use C4::Search;
+
 use Getopt::Long;
 
 sub usage {
     print STDERR <<USAGE;
-Usage: $0 [-h|--help] [--sessions] [--sessdays DAYS] [-v|--verbose] [--zebraqueue DAYS] [-m|--mail] [--merged] [--import DAYS] [--logs DAYS]
+Usage: $0 [-h|--help] [--sessions] [--sessdays DAYS] [-v|--verbose] [--zebraqueue DAYS] [-m|--mail] [--merged] [--import DAYS] [--logs DAYS] [--searchhistory DAYS]
 
    -h --help          prints this help message, and exits, ignoring all
                       other options
@@ -57,11 +60,13 @@ Usage: $0 [-h|--help] [--sessions] [--sessdays DAYS] [-v|--verbose] [--zebraqueu
                       Defaults to 60 days if no days specified.
    --logs DAYS        purge entries from action_logs older than DAYS days.
                       Defaults to 180 days if no days specified.
+   --searchhistory DAYS  purge entries from search_history older than DAYS days.
+                         Defaults to 30 days if no days specified
 USAGE
     exit $_[0];
 }
 
-my ( $help, $sessions, $sess_days, $verbose, $zebraqueue_days, $mail, $purge_merged, $pImport, $pLogs);
+my ( $help, $sessions, $sess_days, $verbose, $zebraqueue_days, $mail, $purge_merged, $pImport, $pLogs, $pSearchhistory);
 
 GetOptions(
     'h|help'       => \$help,
@@ -73,21 +78,23 @@ GetOptions(
     'merged'       => \$purge_merged,
     'import:i'     => \$pImport,
     'logs:i'       => \$pLogs,
+    'searchhistory:i' => \$pSearchhistory,
 ) || usage(1);
 
 $sessions=1 if $sess_days && $sess_days>0;
-# if --import, --logs or --zebraqueue were passed without number of days,
+# if --import, --logs, --zebraqueue or --searchhistory were passed without number of days,
 # use defaults
 $pImport= DEFAULT_IMPORT_PURGEDAYS if defined($pImport) && $pImport==0;
 $pLogs= DEFAULT_LOGS_PURGEDAYS if defined($pLogs) && $pLogs==0;
 $zebraqueue_days= DEFAULT_ZEBRAQ_PURGEDAYS if defined($zebraqueue_days) && $zebraqueue_days==0;
 $mail= DEFAULT_MAIL_PURGEDAYS if defined($mail) && $mail==0;
+$pSearchhistory= DEFAULT_SEARCHHISTORY_PURGEDAYS if defined($pSearchhistory) && $pSearchhistory==0;
 
 if ($help) {
     usage(0);
 }
 
-if ( !( $sessions || $zebraqueue_days || $mail || $purge_merged || $pImport || $pLogs) ) {
+if ( !( $sessions || $zebraqueue_days || $mail || $purge_merged || $pImport || $pLogs || $pSearchhistory ) ) {
     print "You did not specify any cleanup work for the script to do.\n\n";
     usage(1);
 }
@@ -172,6 +179,12 @@ if($pLogs) {
     print "Done with purging action_logs.\n" if $verbose;
 }
 
+if($pSearchhistory) {
+    print "Purging records older than $pSearchhistory from search_history.\n" if $verbose;
+    PurgeSearchHistory($pSearchhistory);
+    print "Done with purging search_history.\n" if $verbose;
+}
+
 exit(0);
 
 sub RemoveOldSessions {
-- 
2.39.5