misc/cronjobs/purge_suggestions.pl

   1 #!/usr/bin/perl -w
   2
   3 # Copyright 2010 Biblibre SARL
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 use Modern::Perl;
  21
  22 use Getopt::Long qw( GetOptions );
  23
  24 use Koha::Script -cron;
  25 use C4::Suggestions;
  26 use C4::Log qw( cronlogaction );
  27 use C4::Context;
  28
  29 my ( $help, $days, $confirm );
  30
  31 my $command_line_options = join(" ",@ARGV);
  32
  33 GetOptions(
  34     'help|?' => \$help,
  35     'days:i' => \$days,
  36     'confirm'=> \$confirm,
  37 );
  38
  39 my $usage = << 'ENDUSAGE';
  40 This script deletes old suggestions
  41 Parameters:
  42 -help|? This message
  43 -days TTT to define the age of suggestions to delete
  44 -confirm flag needed to confirm purge operation
  45
  46 The days parameter falls back to the value of system preference
  47 PurgeSuggestionsOlderThan. Suggestions are deleted only for a positive
  48 number of days.
  49
  50 Example:
  51 ENDUSAGE
  52 $usage .= $0 . " -confirm -days 30\n";
  53
  54 # If this script is called without the 'days' parameter, we use the system preferences value instead.
  55 $days = C4::Context->preference('PurgeSuggestionsOlderThan') if !defined($days);
  56
  57 # If this script is called with the 'help' parameter, we show up the help message and we leave the script without doing anything.
  58 if( !$confirm || $help || !defined($days) ) {
  59     print "No confirm parameter passed!\n\n" if !$confirm && !$help;
  60     print $usage;
  61 } elsif( $days and $days > 0 ) {
  62     $command_line_options .= " ( effective days = $days )";
  63     cronlogaction({ info => $command_line_options });
  64     DelSuggestionsOlderThan($days);
  65 } else {
  66     warn "This script requires a positive number of days. Aborted.\n";
  67 }
  68
  69 cronlogaction({ action => 'End', info => "COMPLETED" });