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 BEGIN {
  23     # find Koha's Perl modules
  24     # test carefully before changing this
  25     use FindBin;
  26     eval { require "$FindBin::Bin/../kohalib.pl" };
  27 }
  28
  29 use Getopt::Long;
  30 use Pod::Usage;
  31
  32 use Koha::Script -cron;
  33 use C4::Suggestions;
  34 use C4::Log;
  35 use C4::Context;
  36
  37 my ( $help, $days, $confirm );
  38
  39 GetOptions(
  40     'help|?' => \$help,
  41     'days:i' => \$days,
  42     'confirm'=> \$confirm,
  43 );
  44
  45 my $usage = << 'ENDUSAGE';
  46 This script deletes old suggestions
  47 Parameters:
  48 -help|? This message
  49 -days TTT to define the age of suggestions to delete
  50 -confirm flag needed to confirm purge operation
  51
  52 The days parameter falls back to the value of system preference
  53 PurgeSuggestionsOlderThan. Suggestions are deleted only for a positive
  54 number of days.
  55
  56 Example:
  57 ENDUSAGE
  58 $usage .= $0 . " -confirm -days 30\n";
  59
  60 # If this script is called without the 'days' parameter, we use the system preferences value instead.
  61 $days = C4::Context->preference('PurgeSuggestionsOlderThan') if !defined($days);
  62
  63 # If this script is called with the 'help' parameter, we show up the help message and we leave the script without doing anything.
  64 if( !$confirm || $help || !defined($days) ) {
  65     print "No confirm parameter passed!\n\n" if !$confirm && !$help;
  66     print $usage;
  67 } elsif( $days and $days > 0 ) {
  68     cronlogaction( " ( days: $days )");
  69     DelSuggestionsOlderThan($days);
  70 } else {
  71     warn "This script requires a positive number of days. Aborted.\n";
  72 }