Jonathan Druart
9d6d641d1f
On bug 17591 we discovered that there was something weird going on with the way we export and use subroutines/modules. This patch tries to standardize our EXPORT to use EXPORT_OK only. That way we will need to explicitely define the subroutine we want to use from a module. This patch is a squashed version of: Bug 17600: After export.pl Bug 17600: After perlimport Bug 17600: Manual changes Bug 17600: Other manual changes after second perlimports run Bug 17600: Fix tests And a lot of other manual changes. export.pl is a dirty script that can be found on bug 17600. "perlimport" is: git clone https://github.com/oalders/App-perlimports.git cd App-perlimports/ cpanm --installdeps . export PERL5LIB="$PERL5LIB:/kohadevbox/koha/App-perlimports/lib" find . \( -name "*.pl" -o -name "*.pm" \) -exec perl App-perlimports/script/perlimports --inplace-edit --no-preserve-unused --filename {} \; The ideas of this patch are to: * use EXPORT_OK instead of EXPORT * perltidy the EXPORT_OK list * remove '&' before the subroutine names * remove some uneeded use statements * explicitely import the subroutines we need within the controllers or modules Note that the private subroutines (starting with _) should not be exported (and not used from outside of the module except from tests). EXPORT vs EXPORT_OK (from https://www.thegeekstuff.com/2010/06/perl-exporter-examples/) """ Export allows to export the functions and variables of modules to user’s namespace using the standard import method. This way, we don’t need to create the objects for the modules to access it’s members. @EXPORT and @EXPORT_OK are the two main variables used during export operation. @EXPORT contains list of symbols (subroutines and variables) of the module to be exported into the caller namespace. @EXPORT_OK does export of symbols on demand basis. """ If this patch caused a conflict with a patch you wrote prior to its push: * Make sure you are not reintroducing a "use" statement that has been removed * "$subroutine" is not exported by the C4::$MODULE module means that you need to add the subroutine to the @EXPORT_OK list * Bareword "$subroutine" not allowed while "strict subs" means that you didn't imported the subroutine from the module: - use $MODULE qw( $subroutine list ); You can also use the fully qualified namespace: C4::$MODULE::$subroutine Signed-off-by: Jonathan Druart <jonathan.druart@bugs.koha-community.org>
130 lines
3.4 KiB
Perl
Executable file
130 lines
3.4 KiB
Perl
Executable file
#!/usr/bin/perl
|
|
|
|
use Modern::Perl;
|
|
|
|
use Pod::Usage qw( pod2usage );
|
|
use Getopt::Long qw( GetOptions );
|
|
|
|
use Koha::Script -cron;
|
|
use C4::Context;
|
|
use C4::UsageStats;
|
|
use C4::Log qw( cronlogaction );
|
|
use POSIX qw( strftime );
|
|
|
|
my ( $help, $verbose, $force, $quiet );
|
|
GetOptions(
|
|
'h|help' => \$help,
|
|
'v|verbose' => \$verbose,
|
|
'f|force' => \$force,
|
|
'q|quiet' => \$quiet,
|
|
) || pod2usage(1);
|
|
|
|
if ($help) {
|
|
pod2usage(0);
|
|
}
|
|
|
|
unless ( C4::Context->preference('UsageStats') ) {
|
|
$quiet && exit;
|
|
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
|
|
|
|
Setting the quiet flag will silence this message.
|
|
|
|
|
);
|
|
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] [-f|--force] [-q|--quiet]
|
|
|
|
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, UsageStatsLibrariesInfo.
|
|
|
|
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
|
|
|
|
=item B<-q|--quiet>
|
|
|
|
Do not emit "The UsageStats system preference is not set" message
|
|
|
|
=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.
|
|
#
|
|
# 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, see <http://www.gnu.org/licenses>.
|
|
|
|
=cut
|