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