Koha/misc/maintenance/update_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

169 lines
5 KiB
Perl
Executable file

#!/usr/bin/perl
# Copyright Rijksmuseum 2017
#
# 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 Getopt::Long qw( GetOptions );
use List::MoreUtils qw( uniq );
use Pod::Usage qw( pod2usage );
use Koha::Script;
use C4::AuthoritiesMarc qw/AddAuthority DelAuthority GetAuthority merge/;
my ( @authid, $confirm, $delete, $help, $merge, $reference, $renumber, $verbose );
GetOptions(
'authid:s' => \@authid,
'confirm' => \$confirm,
'delete' => \$delete,
'help' => \$help,
'merge' => \$merge,
'reference:i' => \$reference,
'renumber' => \$renumber,
'verbose' => \$verbose,
);
@authid = map { split /[,]/, $_; } @authid;
print "No changes will be made\n" unless $confirm;
pod2usage(1) if $help;
if ( $delete and $merge and $renumber ) {
pod2usage(q|Only one action parameter can be passed (delete, merge or renumber)|);
}
if( $delete ) {
delete_auth( \@authid );
} elsif( $merge ) {
pod2usage(q|Reference parameter is missing|) unless $reference;
merge_auth( \@authid, $reference );
} elsif( $renumber ) {
renumber( \@authid );
} else {
pod2usage(1);
}
sub delete_auth {
my ( $auths ) = @_;
foreach my $authid ( uniq(@$auths) ) {
if( $confirm ) {
DelAuthority({ authid => $authid }); # triggers a merge (read: cleanup)
print "Removing $authid\n" if $verbose;
} else {
print "Would have removed $authid\n" if $verbose;
}
}
}
sub merge_auth {
my ( $auths, $reference ) = @_;
return unless $reference;
my $marc_ref = GetAuthority( $reference ) || die "Reference record $reference not found\n";
# First update all linked biblios of reference
merge({ mergefrom => $reference, MARCfrom => $marc_ref, mergeto => $reference, MARCto => $marc_ref, override_limit => 1 }) if $confirm;
# Merge all authid's into reference
my $marc;
foreach my $authid ( uniq(@$auths) ) {
next if $authid == $reference;
$marc = GetAuthority($authid);
if( !$marc ) {
print "Authority id $authid ignored, does not exist.\n";
next;
}
if( $confirm ) {
merge({
mergefrom => $authid,
MARCfrom => $marc,
mergeto => $reference,
MARCto => $marc_ref,
override_limit => 1
});
DelAuthority({ authid => $authid, skip_merge => 1 });
print "Record $authid merged into reference $reference.\n" if $verbose;
} else {
print "Would have merged record $authid into reference $reference.\n" if $verbose;
}
}
}
sub renumber {
my ( $auths ) = @_;
foreach my $authid ( uniq(@$auths) ) {
if( my $authority = Koha::Authorities->find($authid) ) {
my $marc = GetAuthority( $authid );
if( $confirm ) {
AddAuthority( $marc, $authid, $authority->authtypecode );
# AddAuthority contains an update of 001, 005 etc.
print "Renumbered $authid\n" if $verbose;
} else {
print "Would have renumbered $authid\n" if $verbose;
}
} else {
print "Record $authid not found!\n" if $verbose;
}
}
}
=head1 NAME
update_authorities.pl
=head1 DESCRIPTION
Script to perform various authority related maintenance tasks.
This version supports deleting an authority record and updating all linked
biblio records.
Furthermore it supports merging authority records with one reference record,
and updating all linked biblio records.
It also allows you to force a renumber, i.e. save the authid into field 001.
=head1 SYNOPSIS
update_authorities.pl -c -authid 1,2,3 -delete
update_authorities.pl -c -authid 1 -authid 2 -authid 3 -delete
update_authorities.pl -c -authid 1,2 -merge -reference 3
update_authorities.pl -c -merge -reference 4
update_authorities.pl -c -authid 1,2,3 -renumber
=head1 OPTIONS
authid: List authority numbers separated by commas or repeat the
parameter.
confirm: Needed to commit changes.
delete: Delete the listed authority numbers and remove its references from
linked biblio records.
merge: Merge the passed authid's into reference and update all linked biblio
records. If you do not pass authid's, the linked biblio records of reference
will be updated only.
renumber: Save authid into field 001.
=head1 AUTHOR
Marcel de Rooy, Rijksmuseum Amsterdam, The Netherlands
=cut