Koha/misc/stage_file.pl
Jonathan Druart 238fabc4ab Bug 28617: Remove kohalib.pl and rely on PERL5LIB
The purpose of this script was to load the relevant Koha lib for the
different scripts (installation, cronjob, CLI, etc.)
However it is not used consistently and we prefer to rely on PERL5LIB.

From bug 28617 comment 6 from Galen:
"""
Time marches on, and one of the motivations for having kohalib.pl - making
it possible to install Koha without setting a single environment variable -
has been obviated by the vast improvements in the ease of installing Koha.

Consequently, I think kohalib.pl can go away.
"""

Test plan:
confirm that the changes make sense and that kohalib.pl can be removed
safely.

Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
Signed-off-by: Fridolin Somers <fridolin.somers@biblibre.com>
2021-12-07 12:16:28 -10:00

258 lines
9.9 KiB
Perl
Executable file

#!/usr/bin/perl
# This file is part of Koha.
#
# Copyright (C) 2007 LibLime
# Parts Copyright BSZ 2011
# Parts Copyright C & P Bibliography Services 2012
#
# 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::ImportBatch qw( RecordsFromISO2709File RecordsFromMARCXMLFile BatchStageMarcRecords SetImportBatchMatcher SetImportBatchOverlayAction SetImportBatchNoMatchAction SetImportBatchItemAction BatchFindDuplicates );
use C4::Matcher;
use C4::MarcModificationTemplates qw( GetModificationTemplates );
use Getopt::Long qw( GetOptions );
$| = 1;
# command-line parameters
my $record_type = "biblio";
my $encoding = "UTF-8";
my $authorities = 0;
my $match = 0;
my $add_items = 0;
my $input_file = "";
my $batch_comment = "";
my $want_help = 0;
my $no_replace;
my $format = 'ISO2709';
my $no_create;
my $item_action = 'always_add';
my $marc_mod_template = '';
my $marc_mod_template_id = undef;
my $result = GetOptions(
'encoding:s' => \$encoding,
'file:s' => \$input_file,
'format:s' => \$format,
'match|match-bibs:s' => \$match,
'add-items' => \$add_items,
'item-action:s' => \$item_action,
'no-replace' => \$no_replace,
'no-create' => \$no_create,
'comment:s' => \$batch_comment,
'authorities' => \$authorities,
'marcmodtemplate:s' => \$marc_mod_template,
'h|help' => \$want_help
);
if($marc_mod_template ne '') {
my @templates = GetModificationTemplates();
foreach my $this_template (@templates) {
if($this_template->{'name'} eq $marc_mod_template) {
if(!defined $marc_mod_template_id) {
$marc_mod_template_id = $this_template->{'template_id'};
} else {
print "WARNING: MARC modification template name " .
"'$marc_mod_template' matches multiple templates. " .
"Please fix this issue before proceeding.\n";
exit 1;
}
}
}
if(!defined $marc_mod_template_id ) {
die "Can't locate MARC modification template '$marc_mod_template'\n";
}
}
$record_type = 'auth' if ($authorities);
if (not $result or $input_file eq "" or $want_help) {
print_usage();
exit 0;
}
if ( $format !~ /^(MARCXML|ISO2709)$/i ) {
print "\n --format must be MARCXML or ISO2709\n";
print_usage();
exit 0;
}
unless (-r $input_file) {
die "$0: cannot open input file $input_file: $!\n";
}
my $dbh = C4::Context->dbh;
$dbh->{AutoCommit} = 0;
process_batch(
{
format => $format,
input_file => $input_file,
record_type => $record_type,
match => $match,
add_items => $add_items,
batch_comment => $batch_comment,
encoding => $encoding,
no_replace => $no_replace,
no_create => $no_create,
item_action => $item_action,
marc_mod_template_id => $marc_mod_template_id,
}
);
$dbh->commit();
exit 0;
sub process_batch {
my ( $params ) = @_; #Possible params are: format input_file record_type match add_items batch_comment encoding no_replace no_create item_action
my $format = $params->{format} // '';
my $record_type = $params->{record_type} // 'biblio';
my ( $errors, $marc_records );
if( $format eq 'ISO2709' ) {
( $errors, $marc_records ) = C4::ImportBatch::RecordsFromISO2709File(
$params->{input_file}, $record_type, $params->{encoding} );
} elsif( $format eq 'MARCXML' ) {
( $errors, $marc_records ) = C4::ImportBatch::RecordsFromMARCXMLFile(
$params->{input_file}, $params->{encoding} );
}
warn ( join ',', @$errors ) if @$errors;
my $num_input_records = ($marc_records) ? scalar(@$marc_records) : 0;
print "... staging MARC records -- please wait\n";
#FIXME: We should really allow the use of marc modification frameworks and to_marc plugins here if possible
my ( $batch_id, $num_valid_records, $num_items, @import_errors ) =
BatchStageMarcRecords(
$record_type, $params->{encoding},
$marc_records, $params->{input_file},
$params->{'marc_mod_template_id'}, $params->{batch_comment},
'', $params->{add_items},
0, 100,
\&print_progress_and_commit
);
print "... finished staging MARC records\n";
my $num_with_matches = 0;
if ( $params->{match} ) {
my $matcher = C4::Matcher->fetch( $params->{match} );
if (defined $matcher) {
SetImportBatchMatcher( $batch_id, $params->{match} );
} elsif ($record_type eq 'biblio') {
$matcher = C4::Matcher->new($record_type);
$matcher->add_simple_matchpoint('isbn', 1000, '020', 'a', -1, 0, '');
$matcher->add_simple_required_check('245', 'a', -1, 0, '',
'245', 'a', -1, 0, '');
}
# set default record overlay behavior
SetImportBatchOverlayAction( $batch_id, $params->{no_replace} ? 'ignore' : 'replace' );
SetImportBatchNoMatchAction( $batch_id, $params->{no_create} ? 'ignore' : 'create_new' );
SetImportBatchItemAction( $batch_id, $params->{item_action} );
print "... looking for matches with records already in database\n";
$num_with_matches = BatchFindDuplicates($batch_id, $matcher, 10, 100, \&print_progress_and_commit);
print "... finished looking for matches\n";
}
my $num_invalid_records = scalar(@import_errors);
print <<_SUMMARY_;
MARC record staging report
------------------------------------
Input file: $params->{input_file}
Record type: $record_type
Number of input records: $num_input_records
Number of valid records: $num_valid_records
Number of invalid records: $num_invalid_records
_SUMMARY_
if( $params->{match} ) {
print "Number of records matched: $num_with_matches\n";
} else {
print "Incoming records not matched against existing records (--match option not supplied)\n";
}
if ($record_type eq 'biblio') {
if ( $params->{add_items} ) {
print "Number of items parsed: $num_items\n";
} else {
print "No items parsed (--add-items option not supplied)\n";
}
}
print "\n";
print "Batch number assigned: $batch_id\n";
print "\n";
}
sub print_progress_and_commit {
my $recs = shift;
$dbh->commit();
print "... processed $recs records\n";
}
sub print_usage {
print <<_USAGE_;
$0: stage MARC file into reservoir.
Use this batch job to load a file of MARC bibliographic
(with optional item information) or authority records into
the Koha reservoir.
After running this program to stage your file, you can use
either the batch job commit_file.pl or the Koha
Tools option "Manage Staged MARC Records" to load the
records into the main Koha database.
Parameters:
--file <file_name> name of input MARC bib file
--authorities stage authority records instead of bibs
--encoding <encoding> encoding of MARC records, default is UTF-8.
Other possible options are: MARC-8,
ISO_5426, ISO_6937, ISO_8859-1, EUC-KR
--format The MARC transport format to use?
Defaults to ISO2709.
Available values, MARCXML, ISO2709.
--match <match_id> use this option to match records
in the file with records already in
the database for future overlay.
If <match_id> isn't defined, a default
MARC21 ISBN & title match rule will be applied
for bib imports.
--add-items use this option to specify that
item data is embedded in the MARC
bibs and should be parsed.
--item-action action to take if --add-items is specifed;
choices are 'always_add',
'add_only_for_matches', 'add_only_for_new',
'ignore', or 'replace'
--no-replace overlay action for record: default is to
replace extant with the imported record.
--no-create nomatch action for record: default is to
create new record with imported record.
--comment <comment> optional comment to describe
the record batch; if the comment
has spaces in it, surround the
comment with quotation marks.
--marcmodtemplate <TEMPLATE>
This parameter allows you to specify the
name of an existing MARC modification
template to apply as the MARC records are
imported (these templates are created in
the "MARC modification templates" tool in
Koha). If not specified, no MARC modification
templates are used (default).
--help or -h show this message.
_USAGE_
}