tools/stage-marc-import.pl

   1 #!/usr/bin/perl
   2
   3 # Script for handling import of MARC data into Koha db
   4 #   and Z39.50 lookups
   5
   6 # Koha library project  www.koha-community.org
   7
   8 # Licensed under the GPL
   9
  10 # Copyright 2000-2002 Katipo Communications
  11 #
  12 # This file is part of Koha.
  13 #
  14 # Koha is free software; you can redistribute it and/or modify it
  15 # under the terms of the GNU General Public License as published by
  16 # the Free Software Foundation; either version 3 of the License, or
  17 # (at your option) any later version.
  18 #
  19 # Koha is distributed in the hope that it will be useful, but
  20 # WITHOUT ANY WARRANTY; without even the implied warranty of
  21 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  22 # GNU General Public License for more details.
  23 #
  24 # You should have received a copy of the GNU General Public License
  25 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  26
  27 use strict;
  28 #use warnings; FIXME - Bug 2505
  29
  30 # standard or CPAN modules used
  31 use CGI qw ( -utf8 );
  32 use CGI::Cookie;
  33 use MARC::File::USMARC;
  34
  35 # Koha modules used
  36 use C4::Context;
  37 use C4::Auth;
  38 use C4::Output;
  39 use C4::Biblio;
  40 use C4::ImportBatch;
  41 use C4::Matcher;
  42 use Koha::Upload;
  43 use C4::BackgroundJob;
  44 use C4::MarcModificationTemplates;
  45 use Koha::Plugins;
  46
  47 my $input = new CGI;
  48
  49 my $fileID                     = $input->param('uploadedfileid');
  50 my $runinbackground            = $input->param('runinbackground');
  51 my $completedJobID             = $input->param('completedJobID');
  52 my $matcher_id                 = $input->param('matcher');
  53 my $overlay_action             = $input->param('overlay_action');
  54 my $nomatch_action             = $input->param('nomatch_action');
  55 my $parse_items                = $input->param('parse_items');
  56 my $item_action                = $input->param('item_action');
  57 my $comments                   = $input->param('comments');
  58 my $record_type                = $input->param('record_type');
  59 my $encoding                   = $input->param('encoding') || 'UTF-8';
  60 my $format                     = $input->param('format') || 'ISO2709';
  61 my $to_marc_plugin             = $input->param('to_marc_plugin');
  62 my $marc_modification_template = $input->param('marc_modification_template_id');
  63
  64 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
  65     {
  66         template_name   => "tools/stage-marc-import.tt",
  67         query           => $input,
  68         type            => "intranet",
  69         authnotrequired => 0,
  70         flagsrequired   => { tools => 'stage_marc_import' },
  71         debug           => 1,
  72     }
  73 );
  74
  75 $template->param(
  76     SCRIPT_NAME => '/cgi-bin/koha/tools/stage-marc-import.pl',
  77     uploadmarc  => $fileID,
  78     record_type => $record_type,
  79 );
  80
  81 my %cookies = parse CGI::Cookie($cookie);
  82 my $sessionID = $cookies{'CGISESSID'}->value;
  83 if ($completedJobID) {
  84     my $job = C4::BackgroundJob->fetch($sessionID, $completedJobID);
  85     my $results = $job->results();
  86     $template->param(map { $_ => $results->{$_} } keys %{ $results });
  87 } elsif ($fileID) {
  88     my $upload = Koha::Upload->new->get({ id => $fileID });
  89     my ( $file, $filename ) = ( $upload->{path}, $upload->{name} );
  90     my ( $errors, $marcrecords );
  91     if( $format eq 'MARCXML' ) {
  92         ( $errors, $marcrecords ) = C4::ImportBatch::RecordsFromMARCXMLFile( $file, $encoding);
  93     } else {
  94         ( $errors, $marcrecords ) = C4::ImportBatch::RecordsFromISO2709File( $file, $record_type, $encoding );
  95     }
  96     warn "$filename: " . ( join ',', @$errors ) if @$errors;
  97         # no need to exit if we have no records (or only errors) here
  98         # BatchStageMarcRecords can handle that
  99
 100     my $job = undef;
 101     my $dbh;
 102     if ($runinbackground) {
 103         my $job_size = scalar(@$marcrecords);
 104         # if we're matching, job size is doubled
 105         $job_size *= 2 if ($matcher_id ne "");
 106         $job = C4::BackgroundJob->new($sessionID, $filename, '/cgi-bin/koha/tools/stage-marc-import.pl', $job_size);
 107         my $jobID = $job->id();
 108
 109         # fork off
 110         if (my $pid = fork) {
 111             # parent
 112             # return job ID as JSON
 113             my $reply = CGI->new("");
 114             print $reply->header(-type => 'text/html');
 115             print '{"jobID":"' . $jobID . '"}';
 116             exit 0;
 117         } elsif (defined $pid) {
 118             # child
 119             # close STDOUT to signal to Apache that
 120             # we're now running in the background
 121             close STDOUT;
 122             # close STDERR; # there is no good reason to close STDERR
 123         } else {
 124             # fork failed, so exit immediately
 125             warn "fork failed while attempting to run tools/stage-marc-import.pl as a background job: $!";
 126             exit 0;
 127         }
 128
 129         # if we get here, we're a child that has detached
 130         # itself from Apache
 131
 132     }
 133
 134     # New handle, as we're a child.
 135     $dbh = C4::Context->dbh({new => 1});
 136     $dbh->{AutoCommit} = 0;
 137     # FIXME branch code
 138     my ( $batch_id, $num_valid, $num_items, @import_errors ) =
 139       BatchStageMarcRecords(
 140         $record_type,    $encoding,
 141         $marcrecords,    $filename,
 142         $to_marc_plugin, $marc_modification_template,
 143         $comments,       '',
 144         $parse_items,    0,
 145         50, staging_progress_callback( $job, $dbh )
 146       );
 147
 148     my $num_with_matches = 0;
 149     my $checked_matches = 0;
 150     my $matcher_failed = 0;
 151     my $matcher_code = "";
 152     if ($matcher_id ne "") {
 153         my $matcher = C4::Matcher->fetch($matcher_id);
 154         if (defined $matcher) {
 155             $checked_matches = 1;
 156             $matcher_code = $matcher->code();
 157             $num_with_matches =
 158               BatchFindDuplicates( $batch_id, $matcher, 10, 50,
 159                 matching_progress_callback( $job, $dbh ) );
 160             SetImportBatchMatcher($batch_id, $matcher_id);
 161             SetImportBatchOverlayAction($batch_id, $overlay_action);
 162             SetImportBatchNoMatchAction($batch_id, $nomatch_action);
 163             SetImportBatchItemAction($batch_id, $item_action);
 164             $dbh->commit();
 165         } else {
 166             $matcher_failed = 1;
 167         }
 168     } else {
 169         $dbh->commit();
 170     }
 171
 172     my $results = {
 173         staged          => $num_valid,
 174         matched         => $num_with_matches,
 175         num_items       => $num_items,
 176         import_errors   => scalar(@import_errors),
 177         total           => $num_valid + scalar(@import_errors),
 178         checked_matches => $checked_matches,
 179         matcher_failed  => $matcher_failed,
 180         matcher_code    => $matcher_code,
 181         import_batch_id => $batch_id
 182     };
 183     if ($runinbackground) {
 184         $job->finish($results);
 185         exit 0;
 186     } else {
 187             $template->param(staged => $num_valid,
 188                              matched => $num_with_matches,
 189                          num_items => $num_items,
 190                          import_errors => scalar(@import_errors),
 191                          total => $num_valid + scalar(@import_errors),
 192                          checked_matches => $checked_matches,
 193                          matcher_failed => $matcher_failed,
 194                          matcher_code => $matcher_code,
 195                          import_batch_id => $batch_id
 196                         );
 197     }
 198
 199 } else {
 200     # initial form
 201     if ( C4::Context->preference("marcflavour") eq "UNIMARC" ) {
 202         $template->param( "UNIMARC" => 1 );
 203     }
 204     my @matchers = C4::Matcher::GetMatcherList();
 205     $template->param( available_matchers => \@matchers );
 206
 207     my @templates = GetModificationTemplates();
 208     $template->param( MarcModificationTemplatesLoop => \@templates );
 209
 210     if ( C4::Context->preference('UseKohaPlugins') &&
 211          C4::Context->config('enable_plugins') ) {
 212
 213         my @plugins = Koha::Plugins->new()->GetPlugins({
 214             method => 'to_marc',
 215         });
 216         $template->param( plugins => \@plugins );
 217     }
 218 }
 219
 220 output_html_with_http_headers $input, $cookie, $template->output;
 221
 222 exit 0;
 223
 224 sub staging_progress_callback {
 225     my $job = shift;
 226     my $dbh = shift;
 227     return sub {
 228         my $progress = shift;
 229         $job->progress($progress);
 230     }
 231 }
 232
 233 sub matching_progress_callback {
 234     my $job = shift;
 235     my $dbh = shift;
 236     my $start_progress = $job->progress();
 237     return sub {
 238         my $progress = shift;
 239         $job->progress($start_progress + $progress);
 240     }
 241 }