Initial commit 4.0.5-3
[usit-rt.git] / sbin / rt-clean-sessions
CommitLineData
84fb5b46
MKG
1#!/usr/bin/perl
2# BEGIN BPS TAGGED BLOCK {{{
3#
4# COPYRIGHT:
5#
6# This software is Copyright (c) 1996-2012 Best Practical Solutions, LLC
7# <sales@bestpractical.com>
8#
9# (Except where explicitly superseded by other copyright notices)
10#
11#
12# LICENSE:
13#
14# This work is made available to you under the terms of Version 2 of
15# the GNU General Public License. A copy of that license should have
16# been provided with this software, but in any event can be snarfed
17# from www.gnu.org.
18#
19# This work is distributed in the hope that it will be useful, but
20# WITHOUT ANY WARRANTY; without even the implied warranty of
21# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
22# General Public License for more details.
23#
24# You should have received a copy of the GNU General Public License
25# along with this program; if not, write to the Free Software
26# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
27# 02110-1301 or visit their web page on the internet at
28# http://www.gnu.org/licenses/old-licenses/gpl-2.0.html.
29#
30#
31# CONTRIBUTION SUBMISSION POLICY:
32#
33# (The following paragraph is not intended to limit the rights granted
34# to you to modify and distribute this software under the terms of
35# the GNU General Public License and is only of importance to you if
36# you choose to contribute your changes and enhancements to the
37# community by submitting them to Best Practical Solutions, LLC.)
38#
39# By intentionally submitting any modifications, corrections or
40# derivatives to this work, or any other work intended for use with
41# Request Tracker, to Best Practical Solutions, LLC, you confirm that
42# you are the copyright holder for those contributions and you grant
43# Best Practical Solutions, LLC a nonexclusive, worldwide, irrevocable,
44# royalty-free, perpetual, license to use, copy, create derivative
45# works based on those contributions, and sublicense and distribute
46# those contributions and any derivatives thereof.
47#
48# END BPS TAGGED BLOCK }}}
49use strict;
50use warnings;
51
52# fix lib paths, some may be relative
53BEGIN {
54 require File::Spec;
55 my @libs = ("lib", "local/lib");
56 my $bin_path;
57
58 for my $lib (@libs) {
59 unless ( File::Spec->file_name_is_absolute($lib) ) {
60 unless ($bin_path) {
61 if ( File::Spec->file_name_is_absolute(__FILE__) ) {
62 $bin_path = ( File::Spec->splitpath(__FILE__) )[1];
63 }
64 else {
65 require FindBin;
66 no warnings "once";
67 $bin_path = $FindBin::Bin;
68 }
69 }
70 $lib = File::Spec->catfile( $bin_path, File::Spec->updir, $lib );
71 }
72 unshift @INC, $lib;
73 }
74}
75
76use Getopt::Long;
77my %opt;
78GetOptions( \%opt, "older=s", "debug", "help|h", "skip-user" );
79
80
81if ( $opt{help} ) {
82 require Pod::Usage;
83 Pod::Usage::pod2usage({ verbose => 2 });
84 exit;
85}
86
87
88if( $opt{'older'} ) {
89 unless( $opt{'older'} =~ /^\s*([0-9]+)\s*(H|D|M|Y)?$/i ) {
90 print STDERR "wrong format of the 'older' argumnet\n";
91 exit(1);
92 }
93 my ($num,$unit) = ($1, uc($2 ||'D'));
94 my %factor = ( H => 60*60 );
95 $factor{'D'} = $factor{'H'}*24;
96 $factor{'M'} = $factor{'D'}*31;
97 $factor{'Y'} = $factor{'D'}*365;
98 $opt{'older'} = $num * $factor{ $unit };
99}
100
101require RT;
102RT::LoadConfig();
103
104if( $opt{'debug'} ) {
105 RT->Config->Set( LogToScreen => 'debug' );
106} else {
107 RT->Config->Set( LogToScreen => undef );
108}
109
110RT::ConnectToDatabase();
111RT::InitLogging();
112
113require RT::Interface::Web::Session;
114
115my $alogoff = int RT->Config->Get('AutoLogoff');
116if ( $opt{'older'} or $alogoff ) {
117 my $min;
118 foreach ($alogoff*60, $opt{'older'}) {
119 next unless $_;
120 $min = $_ unless $min;
121 $min = $_ if $_ < $min;
122 }
123
124 RT::Interface::Web::Session->ClearOld( $min );
125}
126
127RT::Interface::Web::Session->ClearByUser
128 unless $opt{'skip-user'};
129
130exit(0);
131
132__END__
133
134=head1 NAME
135
136rt-clean-sessions - clean old and duplicate RT sessions
137
138=head1 SYNOPSIS
139
140 rt-clean-sessions [--debug] [--older <NUM>[H|D|M|Y]]
141
142 rt-clean-sessions
143 rt-clean-sessions --debug
144 rt-clean-sessions --older 10D
145 rt-clean-sessions --debug --older 1M
146 rt-clean-sessions --older 10D --skip-user
147
148=head1 DESCRIPTION
149
150Script cleans RT sessions from DB or dir with sessions data.
151Leaves in DB only one session per RT user and sessions that aren't older
152than specified(see options).
153
154Script is safe because data in the sessions is temporary and can be deleted.
155
156=head1 OPTIONS
157
158=over 4
159
160=item older
161
162Date interval in the C<< <NUM>[<unit>] >> format. Default unit is D(ays),
163H(our), M(onth) and Y(ear) are also supported.
164
165For example: C<rt-clean-sessions --older 1M> would delete all sessions that are
166older than 1 month.
167
168=item skip-user
169
170By default only one session per user left in the DB, so users that have
171sessions on multiple computers or in different browsers will be logged out.
172Use this option to avoid this.
173
174=item debug
175
176Turn on debug output.
177
178=back
179
180=head1 NOTES
181
182Functionality similar to this is implemented in
183html/Elements/SetupSessionCookie ; however, that does not guarantee
184that a session will be removed from disk and database soon after the
185timeout expires. This script, if run from a cron job, will ensure
186that the timed out sessions are actually removed from disk; the Mason
187component just ensures that the old sessions are not reusable before
188the cron job gets to them.
189
190=cut