3 # Copyright 2009 PTFS, Inc.
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along
17 # with Koha; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
23 use constant DEFAULT_ZEBRAQ_PURGEDAYS => 30;
24 use constant DEFAULT_MAIL_PURGEDAYS => 30;
25 use constant DEFAULT_IMPORT_PURGEDAYS => 60;
26 use constant DEFAULT_LOGS_PURGEDAYS => 180;
27 use constant DEFAULT_SEARCHHISTORY_PURGEDAYS => 30;
30 # find Koha's Perl modules
31 # test carefully before changing this
33 eval { require "$FindBin::Bin/../kohalib.pl" };
45 Usage: $0 [-h|--help] [--sessions] [--sessdays DAYS] [-v|--verbose] [--zebraqueue DAYS] [-m|--mail] [--merged] [--import DAYS] [--logs DAYS] [--searchhistory DAYS]
47 -h --help prints this help message, and exits, ignoring all
49 --sessions purge the sessions table. If you use this while users
50 are logged into Koha, they will have to reconnect.
51 --sessdays DAYS purge only sessions older than DAYS days.
52 -v --verbose will cause the script to give you a bit more information
54 --zebraqueue DAYS purge completed zebraqueue entries older than DAYS days.
55 Defaults to 30 days if no days specified.
56 -m --mail DAYS purge items from the mail queue that are older than DAYS days.
57 Defaults to 30 days if no days specified.
58 --merged purged completed entries from need_merge_authorities.
59 --import DAYS purge records from import tables older than DAYS days.
60 Defaults to 60 days if no days specified.
61 --z3950 purge records from import tables that are the result
63 --logs DAYS purge entries from action_logs older than DAYS days.
64 Defaults to 180 days if no days specified.
65 --searchhistory DAYS purge entries from search_history older than DAYS days.
66 Defaults to 30 days if no days specified
72 $help, $sessions, $sess_days, $verbose,
73 $zebraqueue_days, $mail, $purge_merged, $pImport,
74 $pLogs, $pSearchhistory, $pZ3950
79 'sessions' => \$sessions,
80 'sessdays:i' => \$sess_days,
81 'v|verbose' => \$verbose,
83 'zebraqueue:i' => \$zebraqueue_days,
84 'merged' => \$purge_merged,
85 'import:i' => \$pImport,
88 'searchhistory:i' => \$pSearchhistory,
91 $sessions=1 if $sess_days && $sess_days>0;
92 # if --import, --logs, --zebraqueue or --searchhistory were passed without number of days,
94 $pImport= DEFAULT_IMPORT_PURGEDAYS if defined($pImport) && $pImport==0;
95 $pLogs= DEFAULT_LOGS_PURGEDAYS if defined($pLogs) && $pLogs==0;
96 $zebraqueue_days= DEFAULT_ZEBRAQ_PURGEDAYS if defined($zebraqueue_days) && $zebraqueue_days==0;
97 $mail= DEFAULT_MAIL_PURGEDAYS if defined($mail) && $mail==0;
98 $pSearchhistory= DEFAULT_SEARCHHISTORY_PURGEDAYS if defined($pSearchhistory) && $pSearchhistory==0;
113 print "You did not specify any cleanup work for the script to do.\n\n";
117 my $dbh = C4::Context->dbh();
123 if ( $sessions && !$sess_days ) {
125 print "Session purge triggered.\n";
126 $sth = $dbh->prepare("SELECT COUNT(*) FROM sessions");
127 $sth->execute() or die $dbh->errstr;
128 my @count_arr = $sth->fetchrow_array;
129 print "$count_arr[0] entries will be deleted.\n";
131 $sth = $dbh->prepare("TRUNCATE sessions");
132 $sth->execute() or die $dbh->errstr;
134 print "Done with session purge.\n";
136 } elsif ( $sessions && $sess_days > 0 ) {
138 print "Session purge triggered with days>$sess_days.\n";
142 print "Done with session purge with days>$sess_days.\n";
146 if ($zebraqueue_days) {
149 print "Zebraqueue purge triggered for $zebraqueue_days days.\n";
151 $sth = $dbh->prepare(
152 "SELECT id,biblio_auth_number,server,time FROM zebraqueue
153 WHERE done=1 and time < date_sub(curdate(), interval ? day)"
155 $sth->execute($zebraqueue_days) or die $dbh->errstr;
156 $sth2 = $dbh->prepare("DELETE FROM zebraqueue WHERE id=?");
157 while ( my $record = $sth->fetchrow_hashref ) {
158 $sth2->execute( $record->{id} ) or die $dbh->errstr;
162 print "$count records were deleted.\nDone with zebraqueue purge.\n";
167 print "Mail queue purge triggered for $mail days.\n" if ($verbose);
169 $sth = $dbh->prepare("DELETE FROM message_queue WHERE time_queued < date_sub(curdate(), interval ? day)");
170 $sth->execute($mail) or die $dbh->errstr;
171 my $count = $sth->rows;
174 print "$count messages were deleted from the mail queue.\nDone with message_queue purge.\n" if ($verbose);
178 print "Purging completed entries from need_merge_authorities.\n" if $verbose;
179 $sth = $dbh->prepare("DELETE FROM need_merge_authorities WHERE done=1");
180 $sth->execute() or die $dbh->errstr;
181 print "Done with purging need_merge_authorities.\n" if $verbose;
185 print "Purging records from import tables.\n" if $verbose;
187 print "Done with purging import tables.\n" if $verbose;
191 print "Purging z39.50 records from import tables.\n" if $verbose;
193 print "Done with purging z39.50 records from import tables.\n" if $verbose;
197 print "Purging records from action_logs.\n" if $verbose;
198 $sth = $dbh->prepare("DELETE FROM action_logs WHERE timestamp < date_sub(curdate(), interval ? DAY)");
199 $sth->execute($pLogs) or die $dbh->errstr;
200 print "Done with purging action_logs.\n" if $verbose;
203 if($pSearchhistory) {
204 print "Purging records older than $pSearchhistory from search_history.\n" if $verbose;
205 PurgeSearchHistory($pSearchhistory);
206 print "Done with purging search_history.\n" if $verbose;
211 sub RemoveOldSessions {
212 my ( $id, $a_session, $limit, $lasttime );
213 $limit = time() - 24 * 3600 * $sess_days;
215 $sth = $dbh->prepare("SELECT id, a_session FROM sessions");
216 $sth->execute or die $dbh->errstr;
217 $sth->bind_columns( \$id, \$a_session );
218 $sth2 = $dbh->prepare("DELETE FROM sessions WHERE id=?");
221 while ( $sth->fetch ) {
223 if ( $a_session =~ /lasttime:\s+'?(\d+)/ ) {
225 } elsif ( $a_session =~ /(ATIME|CTIME):\s+'?(\d+)/ ) {
228 if ( $lasttime && $lasttime < $limit ) {
229 $sth2->execute($id) or die $dbh->errstr;
234 print "$count sessions were deleted.\n";
238 sub PurgeImportTables {
239 #First purge import_records
240 #Delete cascades to import_biblios, import_items and import_record_matches
241 $sth = $dbh->prepare("DELETE FROM import_records WHERE upload_timestamp < date_sub(curdate(), interval ? DAY)");
242 $sth->execute($pImport) or die $dbh->errstr;
244 # Now purge import_batches
245 # Timestamp cannot be used here without care, because records are added
246 # continuously to batches without updating timestamp (z3950 search).
247 # So we only delete older empty batches.
248 # This delete will therefore not have a cascading effect.
249 $sth = $dbh->prepare("DELETE ba
250 FROM import_batches ba
251 LEFT JOIN import_records re ON re.import_batch_id=ba.import_batch_id
252 WHERE re.import_record_id IS NULL AND
253 ba.upload_timestamp < date_sub(curdate(), interval ? DAY)");
254 $sth->execute($pImport) or die $dbh->errstr;
259 $sth = $dbh->prepare(q{
260 DELETE FROM import_batches WHERE batch_type = 'z3950'
262 $sth->execute() or die $dbh->errstr;