Koha/C4/AuthoritiesMarc/MARC21.pm
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

113 lines
3.1 KiB
Perl

package C4::AuthoritiesMarc::MARC21;
# Copyright (C) 2007 LibLime
#
# 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;
=head1 NAME
C4::AuthoritiesMarc::MARC21
=head1 SYNOPSIS
use C4::AuthoritiesMarc::MARC21;
=head1 DESCRIPTION
This is a helper module providing functions used by
C<C4::AuthoritiesMarc> to deal with behavior specific
to MARC21 authority records (as opposed to other
MARC formats).
Functions from this module generally should not be used
directly; instead, use the appropriate function from
C<C4::Authorities> that will dispatch the appropriate
function based on the marcflavour system preference.
=head1 FUNCTIONS
=cut
=head2 get_heading_type_from_marc
my $auth_type = get_auth_type_from_marc($marc);
Given a MARC::Record object containing an authority record,
determine its heading type (e.g., personal name, topical term,
etc.).
=cut
=head2 default_auth_type_location
my ($tag, $subfield) = default_auth_type_location();
Get the tag and subfield used to store the heading type
if not specified in the MARC framework. For MARC21,
this defaults to 942$a.
=cut
sub default_auth_type_location {
return ('942', 'a');
}
=head2 fix_marc21_auth_type_location
fix_marc21_auth_type_location($auth_marc, $auth_type_tag, $auth_type_subfield);
If the incoming C<MARC::Record> object has a 152$b, remove it. If no
field already exists that contains the specified C<$auth_type_tag>
and C<$auth_type_subfield>, create a new field whose contents
are the original contents of the 152$b.
This routine exists to deal with a historical problem: MARC21
authority records in previous versions of Koha kept the
authority type in the 152$b. While the 152 may be OK for UNIMARC,
a 9XX should have been used for MARC21.
This function is meant to be called from GetAuthority, GetAuthorityXML,
and AddAuthority.
FIXME: This function should be removed once it's determined
that no MARC21 users of Koha are using the 152$b
to store the authority type.
=cut
sub fix_marc21_auth_type_location {
my ($auth_marc, $auth_type_tag, $auth_type_subfield) = @_;
my $auth_type_code;
return unless $auth_type_code = $auth_marc->subfield('152', 'b');
$auth_marc->delete_field($auth_marc->field('152'));
unless ($auth_marc->field($auth_type_tag) && $auth_marc->subfield($auth_type_tag, $auth_type_subfield)) {
$auth_marc->add_fields($auth_type_tag,'','', $auth_type_subfield=>$auth_type_code);
}
}
=head1 AUTHOR
Koha Development Team <http://koha-community.org/>
Galen Charlton <galen.charlton@liblime.com>
=cut
1;