Bug 13287: Add a system preference to define the number of days used in purge_suggest...

[koha.git] / misc / cronjobs / purge_suggestions.pl

diff --git a/misc/cronjobs/purge_suggestions.pl b/misc/cronjobs/purge_suggestions.pl
index d38a7bf..2b69170 100755 (executable)
--- a/misc/cronjobs/purge_suggestions.pl
+++ b/misc/cronjobs/purge_suggestions.pl
@@ -4,18 +4,18 @@
 #
 # This file is part of Koha.
 #
-# Koha is free software; you can redistribute it and/or modify it under the
-# terms of the GNU General Public License as published by the Free Software
-# Foundation; either version 2 of the License, or (at your option) any later
-# version.
+# Koha is free software; you can redistribute it and/or modify it
+# under the terms of the GNU General Public License as published by
+# the Free Software Foundation; either version 3 of the License, or
+# (at your option) any later version.
 #
-# Koha is distributed in the hope that it will be useful, but WITHOUT ANY
-# WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
-# A PARTICULAR PURPOSE.  See the GNU General Public License for more details.
+# Koha is distributed in the hope that it will be useful, but
+# WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+# GNU General Public License for more details.
 #
-# You should have received a copy of the GNU General Public License along
-# with Koha; if not, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
 
 use strict;
 use warnings;
@@ -32,6 +32,8 @@ BEGIN {
 use Getopt::Long;
 use Pod::Usage;
 use C4::Suggestions;
+use C4::Log;
+use C4::Context;
 
 my ($help, $days);
 
@@ -40,21 +42,41 @@ GetOptions(
     'days=s'         => \$days,
 );
 
-if($help or not $days){
-    print <<EOF
-    This script delete olds suggestions
-    Parameters :
-    -help|? This message
-    -days TTT to define the age of suggestions to delete
-
-     example :
-     export PERL5LIB=/path/to/koha;export KOHA_CONF=/etc/koha/koha-conf.xml;./purge_suggestions.pl -days 30
-EOF
-;
+my $usage = << 'ENDUSAGE';
+This script delete old suggestions
+Parameters:
+-help|? This message
+-days TTT to define the age of suggestions to delete
+
+Example:
+$PERL5LIB/misc/cronjobs/purge_suggestions.pl -days 30
+ENDUSAGE
+
+# If this script is called without the 'days' parameter, we use the system preferences value instead.
+if ( ! defined($days) and not $help) {
+    my $purge_sugg_days = C4::Context->preference('PurgeSuggestionsOlderThan') || '';
+    if($purge_sugg_days ne '' and $purge_sugg_days >= 0) {
+        $days = $purge_sugg_days;
+    }
+}
+# If this script is called with the 'help' parameter, we show up the help message and we leave the script without doing anything.
+if ($help) {
+    print $usage;
     exit;
 }
 
-if($days){
+if(defined($days) && $days > 0 && $days ne ''){
+    cronlogaction();
     DelSuggestionsOlderThan($days);
 }
 
+elsif(defined($days) && $days == 0) {
+    print << 'ERROR';
+    This script is not executed with 0 days. Aborted.
+ERROR
+}
+else {
+    print << 'ERROR';
+    This script requires a positive number of days. Aborted.
+ERROR
+}
\ No newline at end of file