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