3 # Script for handling import of MARC data into Koha db
6 # Koha library project www.koha-community.org
8 # Licensed under the GPL
10 # Copyright 2000-2002 Katipo Communications
12 # This file is part of Koha.
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.
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.
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>.
29 # standard or CPAN modules used
32 use MARC::File::USMARC;
41 use Koha::UploadedFiles;
42 use C4::BackgroundJob;
43 use C4::MarcModificationTemplates;
45 use Koha::ImportBatches;
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');
66 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
68 template_name => "tools/stage-marc-import.tt",
71 flagsrequired => { tools => 'stage_marc_import' },
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,
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 });
91 my $upload = Koha::UploadedFiles->find( $fileID );
92 my $file = $upload->full_path;
93 my $filename = $upload->filename;
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
102 $marcrecords = C4::ImportBatch::RecordsFromMarcPlugin( $file, $format, $encoding );
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
109 if ($runinbackground) {
110 my $job_size = scalar(@$marcrecords);
111 # if we're matching, job size is doubled
112 $job_size *= 2 if ($matcher_id ne "");
113 $job = C4::BackgroundJob->new($sessionID, $filename, '/cgi-bin/koha/tools/stage-marc-import.pl', $job_size);
114 my $jobID = $job->id();
117 if (my $pid = fork) {
119 # return job ID as JSON
120 my $reply = CGI->new("");
121 print $reply->header(-type => 'text/html');
122 print '{"jobID":"' . $jobID . '"}';
124 } elsif (defined $pid) {
126 # close STDOUT/STDERR to signal to end CGI session with Apache
127 # Otherwise, the AJAX request to this script won't return properly
131 # fork failed, so exit immediately
132 warn "fork failed while attempting to run tools/stage-marc-import.pl as a background job: $!";
136 # if we get here, we're a child that has detached
141 my $schema = Koha::Database->new->schema;
142 $schema->storage->txn_begin;
145 my ( $batch_id, $num_valid, $num_items, @import_errors ) =
146 BatchStageMarcRecords(
147 $record_type, $encoding,
148 $marcrecords, $filename,
149 $marc_modification_template,
152 50, staging_progress_callback( $job )
156 my $ibatch = Koha::ImportBatches->find($batch_id);
157 $ibatch->set({profile_id => $profile_id})->store;
160 my $num_with_matches = 0;
161 my $checked_matches = 0;
162 my $matcher_failed = 0;
163 my $matcher_code = "";
164 if ($matcher_id ne "") {
165 my $matcher = C4::Matcher->fetch($matcher_id);
166 if (defined $matcher) {
167 $checked_matches = 1;
168 $matcher_code = $matcher->code();
170 BatchFindDuplicates( $batch_id, $matcher, 10, 50,
171 matching_progress_callback($job) );
172 SetImportBatchMatcher($batch_id, $matcher_id);
173 SetImportBatchOverlayAction($batch_id, $overlay_action);
174 SetImportBatchNoMatchAction($batch_id, $nomatch_action);
175 SetImportBatchItemAction($batch_id, $item_action);
176 $schema->storage->txn_commit;
179 $schema->storage->txn_rollback;
182 $schema->storage->txn_commit;
186 staged => $num_valid,
187 matched => $num_with_matches,
188 num_items => $num_items,
189 import_errors => scalar(@import_errors),
190 total => $num_valid + scalar(@import_errors),
191 checked_matches => $checked_matches,
192 matcher_failed => $matcher_failed,
193 matcher_code => $matcher_code,
194 import_batch_id => $batch_id,
195 booksellerid => $booksellerid,
196 basketno => $basketno
198 if ($runinbackground) {
199 $job->finish($results);
202 $template->param(staged => $num_valid,
203 matched => $num_with_matches,
204 num_items => $num_items,
205 import_errors => scalar(@import_errors),
206 total => $num_valid + scalar(@import_errors),
207 checked_matches => $checked_matches,
208 matcher_failed => $matcher_failed,
209 matcher_code => $matcher_code,
210 import_batch_id => $batch_id,
211 booksellerid => $booksellerid,
212 basketno => $basketno
218 if ( C4::Context->preference("marcflavour") eq "UNIMARC" ) {
219 $template->param( "UNIMARC" => 1 );
221 my @matchers = C4::Matcher::GetMatcherList();
222 $template->param( available_matchers => \@matchers );
224 my @templates = GetModificationTemplates();
225 $template->param( MarcModificationTemplatesLoop => \@templates );
227 if ( C4::Context->config('enable_plugins') ) {
229 my @plugins = Koha::Plugins->new()->GetPlugins({
232 $template->param( plugins => \@plugins );
236 output_html_with_http_headers $input, $cookie, $template->output;
240 sub staging_progress_callback {
243 my $progress = shift;
244 $job->progress($progress);
248 sub matching_progress_callback {
250 my $start_progress = $job->progress();
252 my $progress = shift;
253 $job->progress($start_progress + $progress);