Bug 19049: [QA Follow-up] Mock config, default format
[koha.git] / tools / stage-marc-import.pl
index b113332..c845060 100755 (executable)
 #
 # 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 2 of the License, or (at your option) any later
-# version.
+# 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.
+# 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, write to the Free Software Foundation, Inc.,
-# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
 
 use strict;
 #use warnings; FIXME - Bug 2505
 
 # standard or CPAN modules used
-use CGI;
+use CGI qw ( -utf8 );
 use CGI::Cookie;
 use MARC::File::USMARC;
 
@@ -39,34 +39,43 @@ use C4::Output;
 use C4::Biblio;
 use C4::ImportBatch;
 use C4::Matcher;
-use C4::UploadedFile;
+use Koha::UploadedFiles;
 use C4::BackgroundJob;
+use C4::MarcModificationTemplates;
+use Koha::Plugins;
 
 my $input = new CGI;
-my $dbh = C4::Context->dbh;
-$dbh->{AutoCommit} = 0;
-
-my $fileID=$input->param('uploadedfileid');
-my $runinbackground = $input->param('runinbackground');
-my $completedJobID = $input->param('completedJobID');
-my $matcher_id = $input->param('matcher');
-my $overlay_action = $input->param('overlay_action');
-my $nomatch_action = $input->param('nomatch_action');
-my $parse_items = $input->param('parse_items');
-my $item_action = $input->param('item_action');
-my $comments = $input->param('comments');
-my $syntax = $input->param('syntax');
-my ($template, $loggedinuser, $cookie)
-       = get_template_and_user({template_name => "tools/stage-marc-import.tmpl",
-                                       query => $input,
-                                       type => "intranet",
-                                       authnotrequired => 0,
-                                       flagsrequired => {tools => 'stage_marc_import'},
-                                       debug => 1,
-                                       });
-
-$template->param(SCRIPT_NAME => $ENV{'SCRIPT_NAME'},
-                                               uploadmarc => $fileID);
+
+my $fileID                     = $input->param('uploadedfileid');
+my $runinbackground            = $input->param('runinbackground');
+my $completedJobID             = $input->param('completedJobID');
+my $matcher_id                 = $input->param('matcher');
+my $overlay_action             = $input->param('overlay_action');
+my $nomatch_action             = $input->param('nomatch_action');
+my $parse_items                = $input->param('parse_items');
+my $item_action                = $input->param('item_action');
+my $comments                   = $input->param('comments');
+my $record_type                = $input->param('record_type');
+my $encoding                   = $input->param('encoding') || 'UTF-8';
+my $format                     = $input->param('format') || 'MARC';
+my $marc_modification_template = $input->param('marc_modification_template_id');
+
+my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
+    {
+        template_name   => "tools/stage-marc-import.tt",
+        query           => $input,
+        type            => "intranet",
+        authnotrequired => 0,
+        flagsrequired   => { tools => 'stage_marc_import' },
+        debug           => 1,
+    }
+);
+
+$template->param(
+    SCRIPT_NAME => '/cgi-bin/koha/tools/stage-marc-import.pl',
+    uploadmarc  => $fileID,
+    record_type => $record_type,
+);
 
 my %cookies = parse CGI::Cookie($cookie);
 my $sessionID = $cookies{'CGISESSID'}->value;
@@ -75,65 +84,71 @@ if ($completedJobID) {
     my $results = $job->results();
     $template->param(map { $_ => $results->{$_} } keys %{ $results });
 } elsif ($fileID) {
-    my $uploaded_file = C4::UploadedFile->fetch($sessionID, $fileID);
-    my $fh = $uploaded_file->fh();
-       my $marcrecord='';
-    $/ = "\035";
-       while (<$fh>) {
-        s/^\s+//;
-        s/\s+$//;
-               $marcrecord.=$_;
-       }
-
-    my $filename = $uploaded_file->name();
+    my $upload = Koha::UploadedFiles->find( $fileID );
+    my $file = $upload->full_path;
+    my $filename = $upload->filename;
+
+    my ( $errors, $marcrecords );
+    if( $format eq 'MARCXML' ) {
+        ( $errors, $marcrecords ) = C4::ImportBatch::RecordsFromMARCXMLFile( $file, $encoding);
+    } elsif( $format eq 'MARC' ) {
+        ( $errors, $marcrecords ) = C4::ImportBatch::RecordsFromISO2709File( $file, $record_type, $encoding );
+    } else { # plugin based
+        $errors = [];
+        $marcrecords = C4::ImportBatch::RecordsFromMarcPlugin( $file, $format, $encoding );
+    }
+    warn "$filename: " . ( join ',', @$errors ) if @$errors;
+        # no need to exit if we have no records (or only errors) here
+        # BatchStageMarcRecords can handle that
+
     my $job = undef;
-    my $staging_callback = sub { };
-    my $matching_callback = sub { };
+    my $dbh;
     if ($runinbackground) {
-        my $job_size = () = $marcrecord =~ /\035/g;
+        my $job_size = scalar(@$marcrecords);
         # if we're matching, job size is doubled
         $job_size *= 2 if ($matcher_id ne "");
-        $job = C4::BackgroundJob->new($sessionID, $filename, $ENV{'SCRIPT_NAME'}, $job_size);
+        $job = C4::BackgroundJob->new($sessionID, $filename, '/cgi-bin/koha/tools/stage-marc-import.pl', $job_size);
         my $jobID = $job->id();
 
         # fork off
         if (my $pid = fork) {
             # parent
             # return job ID as JSON
-            
-            # prevent parent exiting from
-            # destroying the kid's database handle
-            # FIXME: according to DBI doc, this may not work for Oracle
-            $dbh->{InactiveDestroy}  = 1;
-
             my $reply = CGI->new("");
             print $reply->header(-type => 'text/html');
-            print "{ jobID: '$jobID' }";
+            print '{"jobID":"' . $jobID . '"}';
             exit 0;
         } elsif (defined $pid) {
             # child
             # close STDOUT to signal to Apache that
             # we're now running in the background
             close STDOUT;
-            close STDERR;
+            # close STDERR; # there is no good reason to close STDERR
         } else {
             # fork failed, so exit immediately
-            warn "fork failed while attempting to run $ENV{'SCRIPT_NAME'} as a background job";
+            warn "fork failed while attempting to run tools/stage-marc-import.pl as a background job: $!";
             exit 0;
         }
 
         # if we get here, we're a child that has detached
         # itself from Apache
-        $staging_callback = staging_progress_callback($job, $dbh);
-        $matching_callback = matching_progress_callback($job, $dbh);
 
     }
 
+    # New handle, as we're a child.
+    $dbh = C4::Context->dbh({new => 1});
+    $dbh->{AutoCommit} = 0;
     # FIXME branch code
-    my ($batch_id, $num_valid, $num_items, @import_errors) = BatchStageMarcRecords($syntax, $marcrecord, $filename, 
-                                                                                   $comments, '', $parse_items, 0,
-                                                                                   50, staging_progress_callback($job, $dbh));
-    $dbh->commit();
+    my ( $batch_id, $num_valid, $num_items, @import_errors ) =
+      BatchStageMarcRecords(
+        $record_type,    $encoding,
+        $marcrecords,    $filename,
+        $marc_modification_template,
+        $comments,       '',
+        $parse_items,    0,
+        50, staging_progress_callback( $job, $dbh )
+      );
+
     my $num_with_matches = 0;
     my $checked_matches = 0;
     my $matcher_failed = 0;
@@ -143,8 +158,9 @@ if ($completedJobID) {
         if (defined $matcher) {
             $checked_matches = 1;
             $matcher_code = $matcher->code();
-            $num_with_matches = BatchFindBibDuplicates($batch_id, $matcher, 
-                                                       10, 50, matching_progress_callback($job, $dbh));
+            $num_with_matches =
+              BatchFindDuplicates( $batch_id, $matcher, 10, 50,
+                matching_progress_callback( $job, $dbh ) );
             SetImportBatchMatcher($batch_id, $matcher_id);
             SetImportBatchOverlayAction($batch_id, $overlay_action);
             SetImportBatchNoMatchAction($batch_id, $nomatch_action);
@@ -153,21 +169,24 @@ if ($completedJobID) {
         } else {
             $matcher_failed = 1;
         }
+    } else {
+        $dbh->commit();
     }
 
     my $results = {
-           staged => $num_valid,
-           matched => $num_with_matches,
-        num_items => $num_items,
-        import_errors => scalar(@import_errors),
-        total => $num_valid + scalar(@import_errors),
+        staged          => $num_valid,
+        matched         => $num_with_matches,
+        num_items       => $num_items,
+        import_errors   => scalar(@import_errors),
+        total           => $num_valid + scalar(@import_errors),
         checked_matches => $checked_matches,
-        matcher_failed => $matcher_failed,
-        matcher_code => $matcher_code,
+        matcher_failed  => $matcher_failed,
+        matcher_code    => $matcher_code,
         import_batch_id => $batch_id
     };
     if ($runinbackground) {
         $job->finish($results);
+        exit 0;
     } else {
            $template->param(staged => $num_valid,
                             matched => $num_with_matches,
@@ -183,11 +202,23 @@ if ($completedJobID) {
 
 } else {
     # initial form
-    if (C4::Context->preference("marcflavour") eq "UNIMARC") {
-        $template->param("UNIMARC" => 1);
+    if ( C4::Context->preference("marcflavour") eq "UNIMARC" ) {
+        $template->param( "UNIMARC" => 1 );
     }
     my @matchers = C4::Matcher::GetMatcherList();
-    $template->param(available_matchers => \@matchers);
+    $template->param( available_matchers => \@matchers );
+
+    my @templates = GetModificationTemplates();
+    $template->param( MarcModificationTemplatesLoop => \@templates );
+
+    if ( C4::Context->preference('UseKohaPlugins') &&
+         C4::Context->config('enable_plugins') ) {
+
+        my @plugins = Koha::Plugins->new()->GetPlugins({
+            method => 'to_marc',
+        });
+        $template->param( plugins => \@plugins );
+    }
 }
 
 output_html_with_http_headers $input, $cookie, $template->output;
@@ -200,7 +231,6 @@ sub staging_progress_callback {
     return sub {
         my $progress = shift;
         $job->progress($progress);
-        $dbh->commit();
     }
 }
 
@@ -211,6 +241,5 @@ sub matching_progress_callback {
     return sub {
         my $progress = shift;
         $job->progress($start_progress + $progress);
-        $dbh->commit();
     }
 }