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_IMPORT_PURGEDAYS => 60;
25 use constant DEFAULT_LOGS_PURGEDAYS => 180;
28 # find Koha's Perl modules
29 # test carefully before changing this
31 eval { require "$FindBin::Bin/../kohalib.pl" };
41 Usage: $0 [-h|--help] [--sessions] [--sessdays DAYS] [-v|--verbose] [--zebraqueue DAYS] [-m|--mail] [--merged] [--import DAYS] [--logs DAYS]
43 -h --help prints this help message, and exits, ignoring all
45 --sessions purge the sessions table. If you use this while users
46 are logged into Koha, they will have to reconnect.
47 --sessdays DAYS purge only sessions older than DAYS days.
48 -v --verbose will cause the script to give you a bit more information
50 --zebraqueue DAYS purge completed zebraqueue entries older than DAYS days.
51 Defaults to 30 days if no days specified.
52 -m --mail purge the mail queue.
53 --merged purged completed entries from need_merge_authorities.
54 --import DAYS purge records from import tables older than DAYS days.
55 Defaults to 60 days if no days specified.
56 --logs DAYS purge entries from action_logs older than DAYS days.
57 Defaults to 180 days if no days specified.
62 my ( $help, $sessions, $sess_days, $verbose, $zebraqueue_days, $mail, $purge_merged, $pImport, $pLogs);
66 'sessions' => \$sessions,
67 'sessdays:i' => \$sess_days,
68 'v|verbose' => \$verbose,
70 'zebraqueue:i' => \$zebraqueue_days,
71 'merged' => \$purge_merged,
72 'import:i' => \$pImport,
76 $sessions=1 if $sess_days && $sess_days>0;
77 # if --import, --logs or --zebraqueue were passed without number of days,
79 $pImport= DEFAULT_IMPORT_PURGEDAYS if defined($pImport) && $pImport==0;
80 $pLogs= DEFAULT_LOGS_PURGEDAYS if defined($pLogs) && $pLogs==0;
81 $zebraqueue_days= DEFAULT_ZEBRAQ_PURGEDAYS if defined($zebraqueue_days) && $zebraqueue_days==0;
87 if ( !( $sessions || $zebraqueue_days || $mail || $purge_merged || $pImport || $pLogs) ) {
88 print "You did not specify any cleanup work for the script to do.\n\n";
92 my $dbh = C4::Context->dbh();
98 if ( $sessions && !$sess_days ) {
100 print "Session purge triggered.\n";
101 $sth = $dbh->prepare("SELECT COUNT(*) FROM sessions");
102 $sth->execute() or die $dbh->errstr;
103 my @count_arr = $sth->fetchrow_array;
104 print "$count_arr[0] entries will be deleted.\n";
106 $sth = $dbh->prepare("TRUNCATE sessions");
107 $sth->execute() or die $dbh->errstr;
109 print "Done with session purge.\n";
111 } elsif ( $sessions && $sess_days > 0 ) {
113 print "Session purge triggered with days>$sess_days.\n";
117 print "Done with session purge with days>$sess_days.\n";
121 if ($zebraqueue_days) {
124 print "Zebraqueue purge triggered for $zebraqueue_days days.\n";
126 $sth = $dbh->prepare(
127 "SELECT id,biblio_auth_number,server,time FROM zebraqueue
128 WHERE done=1 and time < date_sub(curdate(), interval ? day)"
130 $sth->execute($zebraqueue_days) or die $dbh->errstr;
131 $sth2 = $dbh->prepare("DELETE FROM zebraqueue WHERE id=?");
132 while ( my $record = $sth->fetchrow_hashref ) {
133 $sth2->execute( $record->{id} ) or die $dbh->errstr;
137 print "$count records were deleted.\nDone with zebraqueue purge.\n";
143 $sth = $dbh->prepare("SELECT COUNT(*) FROM message_queue");
144 $sth->execute() or die $dbh->errstr;
145 my @count_arr = $sth->fetchrow_array;
146 print "Deleting $count_arr[0] entries from the mail queue.\n";
148 $sth = $dbh->prepare("TRUNCATE message_queue");
149 $sth->execute() or $dbh->errstr;
150 print "Done with purging the mail queue.\n" if ($verbose);
154 print "Purging completed entries from need_merge_authorities.\n" if $verbose;
155 $sth = $dbh->prepare("DELETE FROM need_merge_authorities WHERE done=1");
156 $sth->execute() or die $dbh->errstr;
157 print "Done with purging need_merge_authorities.\n" if $verbose;
161 print "Purging records from import tables.\n" if $verbose;
163 print "Done with purging import tables.\n" if $verbose;
167 print "Purging records from action_logs.\n" if $verbose;
168 $sth = $dbh->prepare("DELETE FROM action_logs WHERE timestamp < date_sub(curdate(), interval ? DAY)");
169 $sth->execute($pLogs) or die $dbh->errstr;
170 print "Done with purging action_logs.\n" if $verbose;
175 sub RemoveOldSessions {
176 my ( $id, $a_session, $limit, $lasttime );
177 $limit = time() - 24 * 3600 * $sess_days;
179 $sth = $dbh->prepare("SELECT id, a_session FROM sessions");
180 $sth->execute or die $dbh->errstr;
181 $sth->bind_columns( \$id, \$a_session );
182 $sth2 = $dbh->prepare("DELETE FROM sessions WHERE id=?");
185 while ( $sth->fetch ) {
187 if ( $a_session =~ /lasttime:\s+'?(\d+)/ ) {
189 } elsif ( $a_session =~ /(ATIME|CTIME):\s+'?(\d+)/ ) {
192 if ( $lasttime && $lasttime < $limit ) {
193 $sth2->execute($id) or die $dbh->errstr;
198 print "$count sessions were deleted.\n";
202 sub PurgeImportTables {
203 #First purge import_records
204 #Delete cascades to import_biblios, import_items and import_record_matches
205 $sth = $dbh->prepare("DELETE FROM import_records WHERE upload_timestamp < date_sub(curdate(), interval ? DAY)");
206 $sth->execute($pImport) or die $dbh->errstr;
208 # Now purge import_batches
209 # Timestamp cannot be used here without care, because records are added
210 # continuously to batches without updating timestamp (z3950 search).
211 # So we only delete older empty batches.
212 # This delete will therefore not have a cascading effect.
213 $sth = $dbh->prepare("DELETE ba
214 FROM import_batches ba
215 LEFT JOIN import_records re ON re.import_batch_id=ba.import_batch_id
216 WHERE re.import_record_id IS NULL AND
217 ba.upload_timestamp < date_sub(curdate(), interval ? DAY)");
218 $sth->execute($pImport) or die $dbh->errstr;