Bug 26666: (QA follow-up) Add 'USE raw' in template
[koha.git] / tools / stage-marc-import.pl
blob0ea436351f098efe364bbb3e5f2e7167d4814bbc
1 #!/usr/bin/perl
3 # Script for handling import of MARC data into Koha db
4 # and Z39.50 lookups
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>.
27 use Modern::Perl;
29 # standard or CPAN modules used
30 use CGI qw ( -utf8 );
31 use CGI::Cookie;
32 use MARC::File::USMARC;
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;
46 my $input = CGI->new;
48 my $fileID = $input->param('uploadedfileid');
49 my $runinbackground = $input->param('runinbackground');
50 my $completedJobID = $input->param('completedJobID');
51 my $matcher_id = $input->param('matcher');
52 my $overlay_action = $input->param('overlay_action');
53 my $nomatch_action = $input->param('nomatch_action');
54 my $parse_items = $input->param('parse_items');
55 my $item_action = $input->param('item_action');
56 my $comments = $input->param('comments');
57 my $record_type = $input->param('record_type');
58 my $encoding = $input->param('encoding') || 'UTF-8';
59 my $format = $input->param('format') || 'ISO2709';
60 my $marc_modification_template = $input->param('marc_modification_template_id');
61 my $basketno = $input->param('basketno');
62 my $booksellerid = $input->param('booksellerid');
64 my ( $template, $loggedinuser, $cookie ) = get_template_and_user(
66 template_name => "tools/stage-marc-import.tt",
67 query => $input,
68 type => "intranet",
69 flagsrequired => { tools => 'stage_marc_import' },
70 debug => 1,
74 $template->param(
75 SCRIPT_NAME => '/cgi-bin/koha/tools/stage-marc-import.pl',
76 uploadmarc => $fileID,
77 record_type => $record_type,
78 basketno => $basketno,
79 booksellerid => $booksellerid,
82 my %cookies = parse CGI::Cookie($cookie);
83 my $sessionID = $cookies{'CGISESSID'}->value;
84 if ($completedJobID) {
85 my $job = C4::BackgroundJob->fetch($sessionID, $completedJobID);
86 my $results = $job->results();
87 $template->param(map { $_ => $results->{$_} } keys %{ $results });
88 } elsif ($fileID) {
89 my $upload = Koha::UploadedFiles->find( $fileID );
90 my $file = $upload->full_path;
91 my $filename = $upload->filename;
93 my ( $errors, $marcrecords );
94 if( $format eq 'MARCXML' ) {
95 ( $errors, $marcrecords ) = C4::ImportBatch::RecordsFromMARCXMLFile( $file, $encoding);
96 } elsif( $format eq 'ISO2709' ) {
97 ( $errors, $marcrecords ) = C4::ImportBatch::RecordsFromISO2709File( $file, $record_type, $encoding );
98 } else { # plugin based
99 $errors = [];
100 $marcrecords = C4::ImportBatch::RecordsFromMarcPlugin( $file, $format, $encoding );
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
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();
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;
135 # if we get here, we're a child that has detached
136 # itself from Apache
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 )
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;
174 } else {
175 $dbh->commit();
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 booksellerid => $booksellerid,
189 basketno => $basketno
191 if ($runinbackground) {
192 $job->finish($results);
193 exit 0;
194 } else {
195 $template->param(staged => $num_valid,
196 matched => $num_with_matches,
197 num_items => $num_items,
198 import_errors => scalar(@import_errors),
199 total => $num_valid + scalar(@import_errors),
200 checked_matches => $checked_matches,
201 matcher_failed => $matcher_failed,
202 matcher_code => $matcher_code,
203 import_batch_id => $batch_id,
204 booksellerid => $booksellerid,
205 basketno => $basketno
209 } else {
210 # initial form
211 if ( C4::Context->preference("marcflavour") eq "UNIMARC" ) {
212 $template->param( "UNIMARC" => 1 );
214 my @matchers = C4::Matcher::GetMatcherList();
215 $template->param( available_matchers => \@matchers );
217 my @templates = GetModificationTemplates();
218 $template->param( MarcModificationTemplatesLoop => \@templates );
220 if ( C4::Context->config('enable_plugins') ) {
222 my @plugins = Koha::Plugins->new()->GetPlugins({
223 method => 'to_marc',
225 $template->param( plugins => \@plugins );
229 output_html_with_http_headers $input, $cookie, $template->output;
231 exit 0;
233 sub staging_progress_callback {
234 my $job = shift;
235 my $dbh = shift;
236 return sub {
237 my $progress = shift;
238 $job->progress($progress);
242 sub matching_progress_callback {
243 my $job = shift;
244 my $dbh = shift;
245 my $start_progress = $job->progress();
246 return sub {
247 my $progress = shift;
248 $job->progress($start_progress + $progress);