Koha/misc/migration_tools/remove_unused_authorities.pl
Jonathan Druart 9d6d641d1f Bug 17600: Standardize our EXPORT_OK
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>
2021-07-16 08:58:47 +02:00

143 lines
4.4 KiB
Perl
Executable file

#!/usr/bin/perl
#script to administer Authorities without biblio
# Copyright 2009 BibLibre
# written 2009-05-04 by paul dot poulain at biblibre.com
#
# 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>.
use Modern::Perl;
use Koha::Script;
use C4::Context;
use C4::AuthoritiesMarc;
use Getopt::Long qw( GetOptions );
use Koha::SearchEngine::Search;
my @authtypes;
my ($confirm, $test, $want_help);
GetOptions(
'aut|authtypecode:s' => \@authtypes,
'c|confirm' => \$confirm,
't|test' => \$test,
'h|help' => \$want_help,
);
if ( $want_help || !($test || $confirm) ) {
print_usage();
exit 0;
}
if ($test) {
print "*** Testing only, authorities will not be deleted. ***\n";
}
if (@authtypes) {
print "Restricted to authority type(s) : ".join(',', @authtypes).".\n";
}
my $searcher = Koha::SearchEngine::Search->new( { index => 'biblios' } );
my $checksearch;
if ( C4::Context->preference("SearchEngine") eq 'Zebra' ) {
# Check server state
my $errZebraConnection = C4::Context->Zconn("biblioserver",0)->errcode();
if ( $errZebraConnection == 10000 ) {
die "Zebra server seems not to be available. This script needs Zebra runs.";
} elsif ( $errZebraConnection ) {
die "Error from Zebra: $errZebraConnection";
}
$checksearch = q{an,alwaysmatches=''};
}
else {
$checksearch = q{an:*};
}
# Check search on authority number as at least one result
my ($err,$res,$nb) = $searcher->simple_search_compat($checksearch,0,10);
unless ($nb > 0) {
die "Searching authority number in biblio records seems not to be available : $checksearch";
}
my $dbh=C4::Context->dbh;
# prepare the request to retrieve all authorities of the requested types
my $rqsql = q{ SELECT authid,authtypecode FROM auth_header };
$rqsql .= q{ WHERE authtypecode IN (}.join(',',map{ '?' }@authtypes).')' if @authtypes;
my $rqselect = $dbh->prepare($rqsql);
$|=1;
$rqselect->execute(@authtypes);
my $counter=0;
my $totdeleted=0;
my $totundeleted=0;
while (my $data=$rqselect->fetchrow_hashref){
$counter++;
print 'authid='.$data->{'authid'};
print ' type='.$data->{'authtypecode'};
my $bibliosearch = 'an:'.$data->{'authid'};
# search for biblios mapped
my ($err,$res,$used) = $searcher->simple_search_compat($bibliosearch,0,10);
if (defined $err) {
print "\n";
warn "Error: $err on search for biblios $bibliosearch\n";
next;
}
unless ($used > 0){
unless ($test) {
DelAuthority({ authid => $data->{'authid'}, skip_merge => 1 });
print " : deleted";
} else {
print " : can be deleted";
}
$totdeleted++;
} else {
$totundeleted++;
print " : used $used time(s)";
}
print "\n";
}
print "$counter authorities parsed\n";
unless ($test) {
print "$totdeleted deleted because unused\n";
} else {
print "$totdeleted can be deleted because unused\n";
}
print "$totundeleted unchanged because used\n";
sub print_usage {
print <<_USAGE_;
$0: Remove unused authority records
This script removes authority records that do not have any biblio
records attached to them.
If the --aut option is supplied, only authority records of that
particular type will be checked for usage. --aut can be repeated.
If --aut is not supplied, all authority records will be checked.
Use --confirm Confirms you want to really run this script, otherwise prints this help.
Use --test to perform a test run. This script does not ask the
operator to confirm the deletion of each authority record.
parameters
--aut|authtypecode TYPE the list of authtypes to check
--confirm or -c confirm running of script
--test or -t test mode, don't delete really, just count
--help or -h show this message.
_USAGE_
}