88c4495a11f9e3ab1516aa72e3c6988c54ee1fcf
[usit-rt.git] / sbin / rt-clean-sessions
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 }}}
49 use strict;
50 use warnings;
51
52 use lib '/www/data/rt/rt-perl/current-perl10/share/perl5';
53 use lib '/www/data/rt/rt-perl/current-perl10/lib/perl5';
54 use lib '/www/data/rt/rt-perl/current-perl10/lib64/perl5';
55
56 # fix lib paths, some may be relative
57 BEGIN {
58     require File::Spec;
59     my @libs = ("lib", "local/lib");
60     my $bin_path;
61
62     for my $lib (@libs) {
63         unless ( File::Spec->file_name_is_absolute($lib) ) {
64             unless ($bin_path) {
65                 if ( File::Spec->file_name_is_absolute(__FILE__) ) {
66                     $bin_path = ( File::Spec->splitpath(__FILE__) )[1];
67                 }
68                 else {
69                     require FindBin;
70                     no warnings "once";
71                     $bin_path = $FindBin::Bin;
72                 }
73             }
74             $lib = File::Spec->catfile( $bin_path, File::Spec->updir, $lib );
75         }
76         unshift @INC, $lib;
77     }
78 }
79
80 use Getopt::Long;
81 my %opt;
82 GetOptions( \%opt, "older=s", "debug", "help|h", "skip-user" );
83
84
85 if ( $opt{help} ) {
86     require Pod::Usage;
87     Pod::Usage::pod2usage({ verbose => 2 });
88     exit;    
89 }
90
91
92 if( $opt{'older'} ) {
93     unless( $opt{'older'} =~ /^\s*([0-9]+)\s*(H|D|M|Y)?$/i ) {
94         print STDERR "wrong format of the 'older' argumnet\n";
95         exit(1);
96     }
97     my ($num,$unit) = ($1, uc($2 ||'D'));
98     my %factor = ( H => 60*60 );
99     $factor{'D'} = $factor{'H'}*24;
100     $factor{'M'} = $factor{'D'}*31;
101     $factor{'Y'} = $factor{'D'}*365;
102     $opt{'older'} = $num * $factor{ $unit };
103 }
104
105 require RT;
106 RT::LoadConfig();
107
108 if( $opt{'debug'} ) {
109     RT->Config->Set( LogToScreen => 'debug' );
110 } else {
111     RT->Config->Set( LogToScreen => undef );
112 }
113
114 RT::ConnectToDatabase();
115 RT::InitLogging();
116
117 require RT::Interface::Web::Session;
118
119 my $alogoff = int RT->Config->Get('AutoLogoff');
120 if ( $opt{'older'} or $alogoff ) {
121     my $min;
122     foreach ($alogoff*60, $opt{'older'}) {
123         next unless $_;
124         $min = $_ unless $min;
125         $min = $_ if $_ < $min;
126     }
127
128     RT::Interface::Web::Session->ClearOld( $min );
129 }
130
131 RT::Interface::Web::Session->ClearByUser
132     unless $opt{'skip-user'};
133
134 exit(0);
135
136 __END__
137
138 =head1 NAME
139
140 rt-clean-sessions - clean old and duplicate RT sessions
141
142 =head1 SYNOPSIS
143
144      rt-clean-sessions [--debug] [--older <NUM>[H|D|M|Y]]
145
146      rt-clean-sessions
147      rt-clean-sessions --debug
148      rt-clean-sessions --older 10D
149      rt-clean-sessions --debug --older 1M
150      rt-clean-sessions --older 10D --skip-user
151
152 =head1 DESCRIPTION
153
154 Script cleans RT sessions from DB or dir with sessions data.
155 Leaves in DB only one session per RT user and sessions that aren't older
156 than specified(see options).
157
158 Script is safe because data in the sessions is temporary and can be deleted.
159
160 =head1 OPTIONS
161
162 =over 4
163
164 =item older
165
166 Date interval in the C<< <NUM>[<unit>] >> format. Default unit is D(ays),
167 H(our), M(onth) and Y(ear) are also supported.
168
169 For example: C<rt-clean-sessions --older 1M> would delete all sessions that are
170 older than 1 month.
171
172 =item skip-user
173
174 By default only one session per user left in the DB, so users that have
175 sessions on multiple computers or in different browsers will be logged out.
176 Use this option to avoid this.
177
178 =item debug
179
180 Turn on debug output.
181
182 =back
183
184 =head1 NOTES
185
186 Functionality similar to this is implemented in
187 html/Elements/SetupSessionCookie ; however, that does not guarantee
188 that a session will be removed from disk and database soon after the
189 timeout expires.  This script, if run from a cron job, will ensure
190 that the timed out sessions are actually removed from disk; the Mason
191 component just ensures that the old sessions are not reusable before
192 the cron job gets to them.
193
194 =cut