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>
196 lines
4.8 KiB
Perl
196 lines
4.8 KiB
Perl
package Koha::BiblioUtils;
|
|
|
|
# This contains functions to do with managing biblio records.
|
|
|
|
# Copyright 2014 Catalyst IT
|
|
#
|
|
# 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>.
|
|
|
|
=head1 NAME
|
|
|
|
Koha::BiblioUtils - contains fundamental biblio-related functions
|
|
|
|
=head1 DESCRIPTION
|
|
|
|
This contains functions for normal operations on biblio records.
|
|
|
|
Note: really, C4::Biblio does the main functions, but the Koha namespace is
|
|
the new thing that should be used.
|
|
|
|
=cut
|
|
|
|
use C4::Biblio;
|
|
use Koha::MetadataIterator;
|
|
use Koha::Database;
|
|
use Modern::Perl;
|
|
|
|
|
|
use base qw(Koha::MetadataRecord);
|
|
|
|
__PACKAGE__->mk_accessors(qw( record schema id datatype ));
|
|
|
|
=head1 FUNCTIONS
|
|
|
|
=head2 new
|
|
|
|
my $biblio = Koha::BiblioUtils->new($marc_record, [$biblionumber]);
|
|
|
|
Creates an instance of C<Koha::BiblioUtils> based on the marc record. If known,
|
|
the biblionumber can be provided too.
|
|
|
|
=cut
|
|
|
|
sub new {
|
|
my $class = shift;
|
|
my $record = shift;
|
|
my $biblionumber = shift;
|
|
|
|
my $self = $class->SUPER::new(
|
|
{
|
|
'record' => $record,
|
|
'schema' => lc C4::Context->preference("marcflavour"),
|
|
'id' => $biblionumber,
|
|
'datatype' => 'biblio',
|
|
}
|
|
);
|
|
bless $self, $class;
|
|
return $self;
|
|
}
|
|
|
|
=head2 get_from_biblionumber
|
|
|
|
my $biblio = Koha::BiblioUtils->get_from_biblionumber($biblionumber, %options);
|
|
|
|
This will give you an instance of L<Koha::BiblioUtils> that is the biblio that
|
|
you requested.
|
|
|
|
Options are:
|
|
|
|
=over 4
|
|
|
|
=item C<$item_data>
|
|
|
|
If true, then the item data will be merged into the record when it's loaded.
|
|
|
|
=back
|
|
|
|
It will return C<undef> if the biblio doesn't exist.
|
|
|
|
=cut
|
|
|
|
sub get_from_biblionumber {
|
|
my ($class, $bibnum, %options) = @_;
|
|
|
|
my $marc = $class->get_marc_biblio($bibnum, %options);
|
|
return $class->new($marc, $bibnum);
|
|
}
|
|
|
|
=head2 get_all_biblios_iterator
|
|
|
|
my $it = Koha::BiblioUtils->get_all_biblios_iterator(%options);
|
|
|
|
This will provide an iterator object that will, one by one, provide the
|
|
Koha::BiblioUtils of each biblio. This will include the item data.
|
|
|
|
The iterator is a Koha::MetadataIterator object.
|
|
|
|
Possible options are:
|
|
|
|
=over 4
|
|
|
|
=item C<slice>
|
|
|
|
slice may be defined as a hash of two values: index and count. index
|
|
is the slice number to process and count is total number of slices.
|
|
With this information the iterator returns just the given slice of
|
|
records instead of all.
|
|
|
|
=back
|
|
|
|
=cut
|
|
|
|
sub get_all_biblios_iterator {
|
|
my ($self, %options) = @_;
|
|
|
|
my $search_terms = {};
|
|
my ($slice_modulo, $slice_count);
|
|
if ($options{slice}) {
|
|
$slice_count = $options{slice}->{count};
|
|
$slice_modulo = $options{slice}->{index};
|
|
$search_terms = \[ 'mod(biblionumber, ?) = ?', $slice_count, $slice_modulo ];
|
|
}
|
|
|
|
my $search_options = { columns => [qw/ biblionumber /] };
|
|
if ( $options{desc} ){
|
|
$search_options->{order_by} = { -desc => 'biblionumber' };
|
|
}
|
|
|
|
my $database = Koha::Database->new();
|
|
my $schema = $database->schema();
|
|
my $rs =
|
|
$schema->resultset('Biblio')->search(
|
|
$search_terms,
|
|
$search_options );
|
|
my $next_func = sub {
|
|
# Warn and skip bad records, otherwise we break the loop
|
|
while (1) {
|
|
my $row = $rs->next();
|
|
return if !$row;
|
|
my $marc = C4::Biblio::GetMarcBiblio({
|
|
biblionumber => $row->biblionumber,
|
|
embed_items => 1 });
|
|
my $next = eval {
|
|
__PACKAGE__->new($marc, $row->biblionumber);
|
|
};
|
|
if ($@) {
|
|
warn "Something went wrong reading record for biblio $row->biblionumber: $@\n";
|
|
next;
|
|
}
|
|
return $next;
|
|
}
|
|
};
|
|
return Koha::MetadataIterator->new($next_func);
|
|
}
|
|
|
|
=head2 get_marc_biblio
|
|
|
|
my $marc = Koha::BiblioUtils->get_marc_biblio($bibnum, %options);
|
|
|
|
This non-class function fetches the MARC::Record for the given biblio number.
|
|
Nothing is returned if the biblionumber couldn't be found (or it somehow has no
|
|
MARC data.)
|
|
|
|
Options are:
|
|
|
|
=over 4
|
|
|
|
=item item_data
|
|
|
|
If set to true, item data is embedded in the record. Default is to not do this.
|
|
|
|
=back
|
|
|
|
=cut
|
|
|
|
sub get_marc_biblio {
|
|
my ($class, $bibnum, %options) = @_;
|
|
|
|
return C4::Biblio::GetMarcBiblio({
|
|
biblionumber => $bibnum,
|
|
embed_items => ($options{item_data} ? 1 : 0 ) });
|
|
}
|
|
|
|
1;
|