Koha/tools/manage-marc-import.pl
Koha Development Team d659526b5a
Bug 38664: Tidy the whole codebase
This commit is generated using:
  % perl misc/devel/tidy.pl
*within* ktd, to get the same version of perltidy than what will be used
by our CI (currently v20230309).

Signed-off-by: Katrin Fischer <katrin.fischer@bsz-bw.de>
2025-02-11 14:58:24 +01:00

361 lines
13 KiB
Perl
Executable file

#!/usr/bin/perl
# 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;
# standard or CPAN modules used
use CGI qw ( -utf8 );
use CGI::Cookie;
use MARC::File::USMARC;
use Try::Tiny;
# Koha modules used
use C4::Context;
use C4::Koha;
use C4::Auth qw( get_template_and_user );
use C4::Output qw( output_html_with_http_headers );
use C4::ImportBatch
qw( CleanBatch DeleteBatch GetImportBatch GetImportBatchOverlayAction GetImportBatchNoMatchAction GetImportBatchItemAction SetImportBatchOverlayAction SetImportBatchNoMatchAction SetImportBatchItemAction BatchFindDuplicates SetImportBatchMatcher GetItemNumbersFromImportBatch GetImportBatchRangeDesc GetNumberOfNonZ3950ImportBatches BatchCommitRecords BatchRevertRecords );
use C4::Matcher;
use C4::Labels::Batch;
use Koha::BiblioFrameworks;
use Koha::BackgroundJob::MARCImportCommitBatch;
use Koha::BackgroundJob::MARCImportRevertBatch;
use Koha::Logger;
my $input = CGI->new;
my $op = $input->param('op') || '';
my $import_batch_id = $input->param('import_batch_id') || '';
my @messages;
# record list displays
my $offset = $input->param('offset') || 0;
my $results_per_page = $input->param('results_per_page') || 25;
my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
{
template_name => "tools/manage-marc-import.tt",
query => $input,
type => "intranet",
flagsrequired => { tools => 'manage_staged_marc' },
}
);
my $frameworks = Koha::BiblioFrameworks->search(
{ tagfield => { 'not' => undef } },
{ join => 'marc_tag_structure', distinct => 'frameworkcode', order_by => ['frameworktext'] }
);
$template->param( frameworks => $frameworks );
if ( $op eq "create_labels" ) {
#create a batch of labels, then lose $op & $import_batch_id so we get back to import batch list.
my $label_batch_id = create_labelbatch_from_importbatch($import_batch_id);
if ( $label_batch_id == -1 ) {
$template->param(
label_batch_msg => "error",
message_type => 'alert',
);
} else {
$template->param(
label_batch_msg => $label_batch_id,
message_type => 'dialog',
);
}
$op = '';
$import_batch_id = '';
}
if ($op) {
$template->param( $op => 1 );
}
if ( $op eq "" ) {
# displaying a list
if ( $import_batch_id eq '' ) {
import_batches_list( $template, $offset, $results_per_page );
} else {
import_records_list( $template, $import_batch_id, $offset, $results_per_page );
}
} elsif ( $op eq "cud-commit-batch" ) {
my $frameworkcode = $input->param('framework');
my $overlay_framework = $input->param('overlay_framework');
$overlay_framework = undef if $overlay_framework eq '_USE_ORIG_';
try {
my $job_id = Koha::BackgroundJob::MARCImportCommitBatch->new->enqueue(
{
import_batch_id => $import_batch_id,
frameworkcode => $frameworkcode,
overlay_framework => $overlay_framework
}
);
if ($job_id) {
$template->param(
job_enqueued => 1,
job_id => $job_id,
);
}
} catch {
warn $_;
push @messages,
{
type => 'error',
code => 'cannot_enqueue_job',
error => $_,
};
};
} elsif ( $op eq "cud-revert-batch" ) {
try {
my $job_id =
Koha::BackgroundJob::MARCImportRevertBatch->new->enqueue( { import_batch_id => $import_batch_id } );
if ($job_id) {
$template->param(
job_enqueued => 1,
job_id => $job_id,
);
}
} catch {
warn $_;
push @messages,
{
type => 'error',
code => 'cannot_enqueue_job',
error => $_,
};
};
} elsif ( $op eq "cud-clean-batch" ) {
CleanBatch($import_batch_id);
import_batches_list( $template, $offset, $results_per_page );
$template->param(
did_clean => 1,
import_batch_id => $import_batch_id,
);
} elsif ( $op eq "cud-delete-batch" ) {
DeleteBatch($import_batch_id);
import_batches_list( $template, $offset, $results_per_page );
$template->param(
did_delete => 1,
);
} elsif ( $op eq "cud-redo-matching" ) {
my $new_matcher_id = $input->param('new_matcher_id');
my $current_matcher_id = $input->param('current_matcher_id');
my $overlay_action = $input->param('overlay_action');
my $nomatch_action = $input->param('nomatch_action');
my $item_action = $input->param('item_action');
redo_matching(
$template, $import_batch_id, $new_matcher_id, $current_matcher_id,
$overlay_action, $nomatch_action, $item_action
);
import_records_list( $template, $import_batch_id, $offset, $results_per_page );
}
output_html_with_http_headers $input, $cookie, $template->output;
exit 0;
sub redo_matching {
my (
$template, $import_batch_id, $new_matcher_id, $current_matcher_id, $overlay_action, $nomatch_action,
$item_action
) = @_;
my $rematch_failed = 0;
return if not defined $new_matcher_id and not defined $current_matcher_id;
my $old_overlay_action = GetImportBatchOverlayAction($import_batch_id);
my $old_nomatch_action = GetImportBatchNoMatchAction($import_batch_id);
my $old_item_action = GetImportBatchItemAction($import_batch_id);
return
if $new_matcher_id eq $current_matcher_id
and $old_overlay_action eq $overlay_action
and $old_nomatch_action eq $nomatch_action
and $old_item_action eq $item_action;
if ( $old_overlay_action ne $overlay_action ) {
SetImportBatchOverlayAction( $import_batch_id, $overlay_action );
$template->param( 'changed_overlay_action' => 1 );
}
if ( $old_nomatch_action ne $nomatch_action ) {
SetImportBatchNoMatchAction( $import_batch_id, $nomatch_action );
$template->param( 'changed_nomatch_action' => 1 );
}
if ( $old_item_action ne $item_action ) {
SetImportBatchItemAction( $import_batch_id, $item_action );
$template->param( 'changed_item_action' => 1 );
}
my $num_with_matches = 0;
if ( defined $new_matcher_id and $new_matcher_id ne "" ) {
my $matcher = C4::Matcher->fetch($new_matcher_id);
if ( defined $matcher ) {
$num_with_matches = BatchFindDuplicates( $import_batch_id, $matcher );
SetImportBatchMatcher( $import_batch_id, $new_matcher_id );
} else {
$rematch_failed = 1;
}
} else {
$num_with_matches = BatchFindDuplicates( $import_batch_id, undef );
SetImportBatchMatcher( $import_batch_id, undef );
SetImportBatchOverlayAction('create_new');
}
$template->param( rematch_failed => $rematch_failed );
$template->param( rematch_attempted => 1 );
$template->param( num_with_matches => $num_with_matches );
}
sub create_labelbatch_from_importbatch {
my ($batch_id) = @_;
my $err = undef;
my $branch_code = C4::Context->userenv->{'branch'};
my $batch = C4::Labels::Batch->new( branch_code => $branch_code );
my @items = GetItemNumbersFromImportBatch($batch_id);
if ( grep { $_ == 0 } @items ) {
warn sprintf(
'create_labelbatch_from_importbatch() : Call to C4::ImportBatch::GetItemNumbersFromImportBatch returned no item number(s) from import batch #%s.',
$batch_id
);
return -1;
}
foreach my $item_number (@items) {
$err = $batch->add_item($item_number);
if ( $err == -1 ) {
warn sprintf(
'create_labelbatch_from_importbatch() : Error attempting to add item #%s of import batch #%s to label batch.',
$item_number, $batch_id
);
return -1;
}
}
return $batch->get_attr('batch_id');
}
sub import_batches_list {
my ( $template, $offset, $results_per_page ) = @_;
my $batches = GetImportBatchRangeDesc( $offset, $results_per_page );
my @list = ();
foreach my $batch (@$batches) {
push @list, {
import_batch_id => $batch->{'import_batch_id'},
num_records => $batch->{'num_records'},
num_items => $batch->{'num_items'},
upload_timestamp => $batch->{'upload_timestamp'},
import_status => $batch->{'import_status'},
file_name => $batch->{'file_name'} || "($batch->{'batch_type'})",
comments => $batch->{'comments'},
can_clean => ( $batch->{'import_status'} ne 'cleaned' ) ? 1 : 0,
record_type => $batch->{'record_type'},
profile => $batch->{'profile'},
};
}
$template->param( batch_list => \@list );
my $num_batches = GetNumberOfNonZ3950ImportBatches();
add_page_numbers( $template, $offset, $results_per_page, $num_batches );
$template->param( offset => $offset );
$template->param( range_top => $offset + $results_per_page - 1 );
$template->param( num_results => $num_batches );
$template->param( results_per_page => $results_per_page );
}
sub import_records_list {
my ( $template, $import_batch_id, $offset, $results_per_page ) = @_;
my $batch = GetImportBatch($import_batch_id);
$template->param( import_batch_id => $import_batch_id );
my $overlay_action = GetImportBatchOverlayAction($import_batch_id);
$template->param( "overlay_action_${overlay_action}" => 1 );
$template->param( overlay_action => $overlay_action );
my $nomatch_action = GetImportBatchNoMatchAction($import_batch_id);
$template->param( "nomatch_action_${nomatch_action}" => 1 );
$template->param( nomatch_action => $nomatch_action );
my $item_action = GetImportBatchItemAction($import_batch_id);
$template->param( "item_action_${item_action}" => 1 );
$template->param( item_action => $item_action );
batch_info( $template, $batch );
}
sub batch_info {
my ( $template, $batch ) = @_;
$template->param( batch_info => 1 );
$template->param( file_name => $batch->{'file_name'} );
$template->param( profile => $batch->{'profile'} );
$template->param( comments => $batch->{'comments'} );
$template->param( import_status => $batch->{'import_status'} );
$template->param( upload_timestamp => $batch->{'upload_timestamp'} );
$template->{VARS}->{'record_type'} = $batch->{'record_type'};
$template->param( num_records => $batch->{'num_records'} );
$template->param( num_items => $batch->{'num_items'} );
if ( $batch->{'import_status'} ne 'cleaned' ) {
$template->param( can_clean => 1 );
}
if ( $batch->{'num_records'} > 0 ) {
if ( $batch->{'import_status'} eq 'staged' or $batch->{'import_status'} eq 'reverted' ) {
$template->param( can_commit => 1 );
}
if ( $batch->{'import_status'} eq 'imported' ) {
$template->param( can_revert => 1 );
}
}
if ( defined $batch->{'matcher_id'} ) {
my $matcher = C4::Matcher->fetch( $batch->{'matcher_id'} );
if ( defined $matcher ) {
$template->param( 'current_matcher_id' => $batch->{'matcher_id'} );
$template->param( 'current_matcher_code' => $matcher->code() );
$template->param( 'current_matcher_description' => $matcher->description() );
}
}
add_matcher_list( $template, $batch->{'matcher_id'} );
}
sub add_matcher_list {
my ( $template, $current_matcher_id ) = @_;
my @matchers = C4::Matcher::GetMatcherList();
if ( defined $current_matcher_id ) {
for ( my $i = 0 ; $i <= $#matchers ; $i++ ) {
if ( $matchers[$i]->{'matcher_id'} eq $current_matcher_id ) {
$matchers[$i]->{'selected'} = 1;
}
}
}
$template->param( available_matchers => \@matchers );
}
sub add_page_numbers {
my ( $template, $offset, $results_per_page, $total_results ) = @_;
my $max_pages = POSIX::ceil( $total_results / $results_per_page );
return if $max_pages < 2;
my $current_page = int( $offset / $results_per_page ) + 1;
my @pages = ();
for ( my $i = 1 ; $i <= $max_pages ; $i++ ) {
push @pages, {
page_number => $i,
current_page => ( $current_page == $i ) ? 1 : 0,
offset => ( $i - 1 ) * $results_per_page
};
}
$template->param( pages => \@pages );
}