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