Koha/misc/cronjobs/share_usage_with_koha_community.pl
Marc Véron df87f507d9 Bug 13889: Add information about cron jobs to system log
This patch adds information about cron jobs performed and make it viewable
under Home > Tools > Logs ("Browse system logs")

To test:

Apply patch
- Got to system preferences and set 'CronjobLog' to:  [Log] information from
  cron jobs.
- Run some cron jobs
- Go to Home > Tools > Logs
- Verify that you have a selection 'Cron jobs' in drop-down 'Module'. Select it
  with Action "All" and Submit.
- Output should show Date/time and info about Cron jobs

Rebased to work on top of Bug 6911 (conflict in viewlog.tt)  /MV

Rebased after applying patch for Bug 6911 /MV
Conflicts resolved:
misc/cronjobs/overdue_notices.pl
misc/cronjobs/cleanup_database.pl

Signed-off-by: Frederic Demians <f.demians@tamil.fr>
  - Merge both patches, and fix updatedatabase.pl
  - Works as described. Provide intersting feedback from cronjob scripts.

--
Modified version taking in account syspref CronJobLog. Handling simplified by introducing a convenience sub cronlogaction in C4/Log.pm /MV
Amended to take in account comments #11, #12, #13 /MV

http://bugs.koha-community.org/show_bug.cgi?id=13899

Signed-off-by: Mark Tompsett <mtompset@hotmail.com>

Signed-off-by: Kyle M Hall <kyle@bywatersolutions.com>
Signed-off-by: Tomas Cohen Arazi <tomascohen@gmail.com>
2015-05-04 11:11:14 -03:00

115 lines
2.9 KiB
Perl
Executable file

#!/usr/bin/perl
use Modern::Perl;
use Pod::Usage;
use Getopt::Long;
use C4::Context;
use C4::UsageStats;
use C4::Log;
use POSIX qw(strftime);
my ( $help, $verbose, $force );
GetOptions(
'h|help' => \$help,
'v|verbose' => \$verbose,
'f|force' => \$force,
) || pod2usage(1);
if ($help) {
pod2usage(1);
}
unless ( C4::Context->preference('UsageStats') ) {
pod2usage(
q|
The UsageStats system preference is not set.
If your library wants to share their usage statistics with the Koha community, you have to switch on this system preference
|
);
exit 1;
}
cronlogaction();
my $need_update = ($force ? 1 : C4::UsageStats::NeedUpdate() );
if ($need_update) {
say "Data need to be updated" if $verbose;
my $report = C4::UsageStats::BuildReport();
C4::UsageStats::ReportToCommunity($report);
C4::Context->set_preference( 'UsageStatsLastUpdateTime',
strftime( "%s", localtime ) );
}
elsif ($verbose) {
say "Data don't need to be updated";
}
=head1 NAME
share_usage_with_koha_community.pl - Share your library's usage with the Koha community
=head1 SYNOPSIS
share_usage_with_koha_community.pl [-h|--help] [-v|--verbose]
If the UsageStats system preference is set, you can launch this script to share your usage data
anonymously with the Koha community.
Collecting Koha usage statistics will help developers to know how Koha is used across the world.
This script will send the usage data for the bibliographic and authority records, checkouts, holds, orders,
and subscriptions.
Only the total number is retrieved. In no case will private data be shared!
In order to know which parts of Koha modules are used, this script will collect some system preference values.
If you want to tell us who you are, you can fill the UsageStatsLibraryName system preference with your library name, UsageStatsLibraryUrl, UsageStatsLibraryType and/or UsageStatsCountry.
All these data will be analyzed on the http://hea.koha-community.org Koha community website.
IMPORTANT : please do NOT run the cron on the 1st, but on another day. The idea is to avoid all
Koha libraries sending their data at the same time ! So choose any day between 1 and 28 !
=head1 OPTIONS
=over
=item B<-h|--help>
Print a brief help message
=item B<-v|--verbose>
Verbose mode.
=item B<-f|--force>
Force the update.
=back
=head1 AUTHOR
Alex Arnaud <alex.arnaud@biblibre.com>
Jonathan Druart <jonathan.druart@biblibre.com>
=head1 COPYRIGHT
Copyright 2014 BibLibre
=head1 LICENSE
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 3 of the License, or (at your option) any later version.
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.
=cut