rt/sbin/rt-clean-sessions.in

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