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::UploadedFiles;
  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');
  61 my $marc_modification_template = $input->param('marc_modification_template_id');
  62
  63 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
  64     {
  65         template_name   => "tools/stage-marc-import.tt",
  66         query           => $input,
  67         type            => "intranet",
  68         authnotrequired => 0,
  69         flagsrequired   => { tools => 'stage_marc_import' },
  70         debug           => 1,
  71     }
  72 );
  73
  74 $template->param(
  75     SCRIPT_NAME => '/cgi-bin/koha/tools/stage-marc-import.pl',
  76     uploadmarc  => $fileID,
  77     record_type => $record_type,
  78 );
  79
  80 my %cookies = parse CGI::Cookie($cookie);
  81 my $sessionID = $cookies{'CGISESSID'}->value;
  82 if ($completedJobID) {
  83     my $job = C4::BackgroundJob->fetch($sessionID, $completedJobID);
  84     my $results = $job->results();
  85     $template->param(map { $_ => $results->{$_} } keys %{ $results });
  86 } elsif ($fileID) {
  87     my $upload = Koha::UploadedFiles->find( $fileID );
  88     my $file = $upload->full_path;
  89     my $filename = $upload->filename;
  90
  91     my ( $errors, $marcrecords );
  92     if( $format eq 'MARCXML' ) {
  93         ( $errors, $marcrecords ) = C4::ImportBatch::RecordsFromMARCXMLFile( $file, $encoding);
  94     } elsif( $format eq 'MARC' ) {
  95         ( $errors, $marcrecords ) = C4::ImportBatch::RecordsFromISO2709File( $file, $record_type, $encoding );
  96     } elsif( $format ) { # plugin
  97         $errors = [];
  98         $marcrecords = C4::ImportBatch::RecordsFromMarcPlugin( $file, $format, $encoding );
  99     } else {
 100         die "No format specified";
 101     }
 102     warn "$filename: " . ( join ',', @$errors ) if @$errors;
 103         # no need to exit if we have no records (or only errors) here
 104         # BatchStageMarcRecords can handle that
 105
 106     my $job = undef;
 107     my $dbh;
 108     if ($runinbackground) {
 109         my $job_size = scalar(@$marcrecords);
 110         # if we're matching, job size is doubled
 111         $job_size *= 2 if ($matcher_id ne "");
 112         $job = C4::BackgroundJob->new($sessionID, $filename, '/cgi-bin/koha/tools/stage-marc-import.pl', $job_size);
 113         my $jobID = $job->id();
 114
 115         # fork off
 116         if (my $pid = fork) {
 117             # parent
 118             # return job ID as JSON
 119             my $reply = CGI->new("");
 120             print $reply->header(-type => 'text/html');
 121             print '{"jobID":"' . $jobID . '"}';
 122             exit 0;
 123         } elsif (defined $pid) {
 124             # child
 125             # close STDOUT to signal to Apache that
 126             # we're now running in the background
 127             close STDOUT;
 128             # close STDERR; # there is no good reason to close STDERR
 129         } else {
 130             # fork failed, so exit immediately
 131             warn "fork failed while attempting to run tools/stage-marc-import.pl as a background job: $!";
 132             exit 0;
 133         }
 134
 135         # if we get here, we're a child that has detached
 136         # itself from Apache
 137
 138     }
 139
 140     # New handle, as we're a child.
 141     $dbh = C4::Context->dbh({new => 1});
 142     $dbh->{AutoCommit} = 0;
 143     # FIXME branch code
 144     my ( $batch_id, $num_valid, $num_items, @import_errors ) =
 145       BatchStageMarcRecords(
 146         $record_type,    $encoding,
 147         $marcrecords,    $filename,
 148         $marc_modification_template,
 149         $comments,       '',
 150         $parse_items,    0,
 151         50, staging_progress_callback( $job, $dbh )
 152       );
 153
 154     my $num_with_matches = 0;
 155     my $checked_matches = 0;
 156     my $matcher_failed = 0;
 157     my $matcher_code = "";
 158     if ($matcher_id ne "") {
 159         my $matcher = C4::Matcher->fetch($matcher_id);
 160         if (defined $matcher) {
 161             $checked_matches = 1;
 162             $matcher_code = $matcher->code();
 163             $num_with_matches =
 164               BatchFindDuplicates( $batch_id, $matcher, 10, 50,
 165                 matching_progress_callback( $job, $dbh ) );
 166             SetImportBatchMatcher($batch_id, $matcher_id);
 167             SetImportBatchOverlayAction($batch_id, $overlay_action);
 168             SetImportBatchNoMatchAction($batch_id, $nomatch_action);
 169             SetImportBatchItemAction($batch_id, $item_action);
 170             $dbh->commit();
 171         } else {
 172             $matcher_failed = 1;
 173         }
 174     } else {
 175         $dbh->commit();
 176     }
 177
 178     my $results = {
 179         staged          => $num_valid,
 180         matched         => $num_with_matches,
 181         num_items       => $num_items,
 182         import_errors   => scalar(@import_errors),
 183         total           => $num_valid + scalar(@import_errors),
 184         checked_matches => $checked_matches,
 185         matcher_failed  => $matcher_failed,
 186         matcher_code    => $matcher_code,
 187         import_batch_id => $batch_id
 188     };
 189     if ($runinbackground) {
 190         $job->finish($results);
 191         exit 0;
 192     } else {
 193             $template->param(staged => $num_valid,
 194                              matched => $num_with_matches,
 195                          num_items => $num_items,
 196                          import_errors => scalar(@import_errors),
 197                          total => $num_valid + scalar(@import_errors),
 198                          checked_matches => $checked_matches,
 199                          matcher_failed => $matcher_failed,
 200                          matcher_code => $matcher_code,
 201                          import_batch_id => $batch_id
 202                         );
 203     }
 204
 205 } else {
 206     # initial form
 207     if ( C4::Context->preference("marcflavour") eq "UNIMARC" ) {
 208         $template->param( "UNIMARC" => 1 );
 209     }
 210     my @matchers = C4::Matcher::GetMatcherList();
 211     $template->param( available_matchers => \@matchers );
 212
 213     my @templates = GetModificationTemplates();
 214     $template->param( MarcModificationTemplatesLoop => \@templates );
 215
 216     if ( C4::Context->preference('UseKohaPlugins') &&
 217          C4::Context->config('enable_plugins') ) {
 218
 219         my @plugins = Koha::Plugins->new()->GetPlugins({
 220             method => 'to_marc',
 221         });
 222         $template->param( plugins => \@plugins );
 223     }
 224 }
 225
 226 output_html_with_http_headers $input, $cookie, $template->output;
 227
 228 exit 0;
 229
 230 sub staging_progress_callback {
 231     my $job = shift;
 232     my $dbh = shift;
 233     return sub {
 234         my $progress = shift;
 235         $job->progress($progress);
 236     }
 237 }
 238
 239 sub matching_progress_callback {
 240     my $job = shift;
 241     my $dbh = shift;
 242     my $start_progress = $job->progress();
 243     return sub {
 244         my $progress = shift;
 245         $job->progress($start_progress + $progress);
 246     }
 247 }