misc/cronjobs/share_usage_with_koha_community.pl

   1 #!/usr/bin/perl
   2
   3 use Modern::Perl;
   4
   5 use Pod::Usage;
   6 use Getopt::Long;
   7
   8 use C4::Context;
   9 use C4::UsageStats;
  10 use POSIX qw(strftime);
  11
  12 my ( $help, $verbose, $force );
  13 GetOptions(
  14     'h|help'    => \$help,
  15     'v|verbose' => \$verbose,
  16     'f|force'   => \$force,
  17 ) || pod2usage(1);
  18
  19 if ($help) {
  20     pod2usage(1);
  21 }
  22
  23 unless ( C4::Context->preference('UsageStats') ) {
  24     pod2usage(
  25 q|
  26 The UsageStats system preference is not set.
  27 If your library wants to share their usage statistics with the Koha community, you have to switch on this system preference
  28 |
  29     );
  30     exit 1;
  31 }
  32
  33 my $need_update = ($force ? 1 : C4::UsageStats::NeedUpdate() );
  34
  35 if ($need_update) {
  36     say "Data need to be updated" if $verbose;
  37     my $report = C4::UsageStats::BuildReport();
  38     C4::UsageStats::ReportToCommunity($report);
  39     C4::Context->set_preference( 'UsageStatsLastUpdateTime',
  40         strftime( "%s", localtime ) );
  41 }
  42 elsif ($verbose) {
  43     say "Data don't need to be updated";
  44 }
  45
  46 =head1 NAME
  47
  48 share_usage_with_koha_community.pl - Share your library's usage with the Koha community
  49
  50 =head1 SYNOPSIS
  51
  52 share_usage_with_koha_community.pl [-h|--help] [-v|--verbose]
  53
  54 If the UsageStats system preference is set, you can launch this script to share your usage data
  55 anonymously with the Koha community.
  56
  57 Collecting Koha usage statistics will help developers to know how Koha is used across the world.
  58
  59 This script will send the usage data for the bibliographic and authority records, checkouts, holds, orders,
  60 and subscriptions.
  61
  62 Only the total number is retrieved. In no case will private data be shared!
  63
  64 In order to know which parts of Koha modules are used, this script will collect some system preference values.
  65
  66 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.
  67
  68 All these data will be analyzed on the http://hea.koha-community.org Koha community website.
  69
  70 IMPORTANT : please do NOT run the cron on the 1st, but on another day. The idea is to avoid all
  71 Koha libraries sending their data at the same time ! So choose any day between 1 and 28 !
  72
  73 =head1 OPTIONS
  74
  75 =over
  76
  77 =item B<-h|--help>
  78
  79 Print a brief help message
  80
  81 =item B<-v|--verbose>
  82
  83 Verbose mode.
  84
  85 =item B<-f|--force>
  86
  87 Force the update.
  88
  89 =back
  90
  91 =head1 AUTHOR
  92
  93 Alex Arnaud <alex.arnaud@biblibre.com>
  94
  95 Jonathan Druart <jonathan.druart@biblibre.com>
  96
  97 =head1 COPYRIGHT
  98
  99 Copyright 2014 BibLibre
 100
 101 =head1 LICENSE
 102
 103 This file is part of Koha.
 104
 105 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
 106 Foundation; either version 3 of the License, or (at your option) any later version.
 107
 108 You should have received a copy of the GNU General Public License along
 109 with Koha; if not, write to the Free Software Foundation, Inc.,
 110 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 111
 112 =cut