Bug 5685: (RM followup) opac.less and opac.css out of sync
[koha.git] / tools / manage-marc-import.pl
blobb0d4f8886f70eb23bb4e9224e520172776290955
1 #!/usr/bin/perl
3 # Copyright (C) 2007 LibLime
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it
8 # under the terms of the GNU General Public License as published by
9 # the Free Software Foundation; either version 3 of the License, or
10 # (at your option) any later version.
12 # Koha is distributed in the hope that it will be useful, but
13 # WITHOUT ANY WARRANTY; without even the implied warranty of
14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
15 # GNU General Public License for more details.
17 # You should have received a copy of the GNU General Public License
18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
20 use strict;
21 use warnings;
23 # standard or CPAN modules used
24 use CGI qw ( -utf8 );
25 use CGI::Cookie;
26 use MARC::File::USMARC;
28 # Koha modules used
29 use C4::Context;
30 use C4::Koha;
31 use C4::Auth;
32 use C4::AuthoritiesMarc;
33 use C4::Output;
34 use C4::Biblio;
35 use C4::ImportBatch;
36 use C4::Matcher;
37 use C4::BackgroundJob;
38 use C4::Labels::Batch;
40 my $script_name = "/cgi-bin/koha/tools/manage-marc-import.pl";
42 my $input = new CGI;
43 my $op = $input->param('op') || '';
44 my $completedJobID = $input->param('completedJobID');
45 our $runinbackground = $input->param('runinbackground');
46 my $import_batch_id = $input->param('import_batch_id') || '';
48 # record list displays
49 my $offset = $input->param('offset') || 0;
50 my $results_per_page = $input->param('results_per_page') || 25;
52 my ($template, $loggedinuser, $cookie)
53 = get_template_and_user({template_name => "tools/manage-marc-import.tt",
54 query => $input,
55 type => "intranet",
56 authnotrequired => 0,
57 flagsrequired => {tools => 'manage_staged_marc'},
58 debug => 1,
59 });
61 my %cookies = parse CGI::Cookie($cookie);
62 our $sessionID = $cookies{'CGISESSID'}->value;
63 our $dbh = C4::Context->dbh;
65 # Frameworks selection loop
67 my $frameworks = getframeworks;
68 my $arrayref = [];
69 while ( my ($key, $value) = each %$frameworks ) {
70 push @$arrayref, { value => $key, label => $value->{frameworktext} };
72 $template->param( frameworks => $arrayref );
75 if ($op eq "create_labels") {
76 #create a batch of labels, then lose $op & $import_batch_id so we get back to import batch list.
77 my $label_batch_id = create_labelbatch_from_importbatch($import_batch_id);
78 if ($label_batch_id == -1) {
79 $template->param( label_batch_msg => "Error attempting to create label batch. Please ask your system administrator to check the log for more details.",
80 message_type => 'alert',
83 else {
84 $template->param( label_batch_msg => "Label batch #$label_batch_id created.",
85 message_type => 'dialog',
88 $op='';
89 $import_batch_id='';
91 if ($op) {
92 $template->param(script_name => $script_name, $op => 1);
93 } else {
94 $template->param(script_name => $script_name);
97 if ($op eq "") {
98 # displaying a list
99 if ($import_batch_id eq '') {
100 import_batches_list($template, $offset, $results_per_page);
101 } else {
102 import_records_list($template, $import_batch_id, $offset, $results_per_page);
104 } elsif ($op eq "commit-batch") {
105 if ($completedJobID) {
106 add_saved_job_results_to_template($template, $completedJobID);
107 } else {
108 my $framework = $input->param('framework');
109 commit_batch($template, $import_batch_id, $framework);
111 import_records_list($template, $import_batch_id, $offset, $results_per_page);
112 } elsif ($op eq "revert-batch") {
113 if ($completedJobID) {
114 add_saved_job_results_to_template($template, $completedJobID);
115 } else {
116 revert_batch($template, $import_batch_id);
118 import_records_list($template, $import_batch_id, $offset, $results_per_page);
119 } elsif ($op eq "clean-batch") {
120 CleanBatch($import_batch_id);
121 import_batches_list($template, $offset, $results_per_page);
122 $template->param(
123 did_clean => 1,
124 import_batch_id => $import_batch_id,
126 } elsif ($op eq "redo-matching") {
127 my $new_matcher_id = $input->param('new_matcher_id');
128 my $current_matcher_id = $input->param('current_matcher_id');
129 my $overlay_action = $input->param('overlay_action');
130 my $nomatch_action = $input->param('nomatch_action');
131 my $item_action = $input->param('item_action');
132 redo_matching($template, $import_batch_id, $new_matcher_id, $current_matcher_id,
133 $overlay_action, $nomatch_action, $item_action);
134 import_records_list($template, $import_batch_id, $offset, $results_per_page);
137 output_html_with_http_headers $input, $cookie, $template->output;
139 exit 0;
141 sub redo_matching {
142 my ($template, $import_batch_id, $new_matcher_id, $current_matcher_id, $overlay_action, $nomatch_action, $item_action) = @_;
143 my $rematch_failed = 0;
144 return if not defined $new_matcher_id and not defined $current_matcher_id;
145 my $old_overlay_action = GetImportBatchOverlayAction($import_batch_id);
146 my $old_nomatch_action = GetImportBatchNoMatchAction($import_batch_id);
147 my $old_item_action = GetImportBatchItemAction($import_batch_id);
148 return if $new_matcher_id eq $current_matcher_id and
149 $old_overlay_action eq $overlay_action and
150 $old_nomatch_action eq $nomatch_action and
151 $old_item_action eq $item_action;
153 if ($old_overlay_action ne $overlay_action) {
154 SetImportBatchOverlayAction($import_batch_id, $overlay_action);
155 $template->param('changed_overlay_action' => 1);
157 if ($old_nomatch_action ne $nomatch_action) {
158 SetImportBatchNoMatchAction($import_batch_id, $nomatch_action);
159 $template->param('changed_nomatch_action' => 1);
161 if ($old_item_action ne $item_action) {
162 SetImportBatchItemAction($import_batch_id, $item_action);
163 $template->param('changed_item_action' => 1);
166 my $num_with_matches = 0;
167 if (defined $new_matcher_id and $new_matcher_id ne "") {
168 my $matcher = C4::Matcher->fetch($new_matcher_id);
169 if (defined $matcher) {
170 $num_with_matches = BatchFindDuplicates($import_batch_id, $matcher);
171 SetImportBatchMatcher($import_batch_id, $new_matcher_id);
172 } else {
173 $rematch_failed = 1;
175 } else {
176 $num_with_matches = BatchFindDuplicates($import_batch_id, undef);
177 SetImportBatchMatcher($import_batch_id, undef);
178 SetImportBatchOverlayAction('create_new');
180 $template->param(rematch_failed => $rematch_failed);
181 $template->param(rematch_attempted => 1);
182 $template->param(num_with_matches => $num_with_matches);
185 sub create_labelbatch_from_importbatch {
186 my ($batch_id) = @_;
187 my $err = undef;
188 my $branch_code = C4::Context->userenv->{'branch'};
189 my $batch = C4::Labels::Batch->new(branch_code => $branch_code);
190 my @items = GetItemNumbersFromImportBatch($batch_id);
191 if (grep{$_ == 0} @items) {
192 warn sprintf('create_labelbatch_from_importbatch() : Call to C4::ImportBatch::GetItemNumbersFromImportBatch returned no item number(s) from import batch #%s.', $batch_id);
193 return -1;
195 foreach my $item_number (@items) {
196 $err = $batch->add_item($item_number);
197 if ($err == -1) {
198 warn sprintf('create_labelbatch_from_importbatch() : Error attempting to add item #%s of import batch #%s to label batch.', $item_number, $batch_id);
199 return -1;
202 return $batch->get_attr('batch_id');
205 sub import_batches_list {
206 my ($template, $offset, $results_per_page) = @_;
207 my $batches = GetImportBatchRangeDesc($offset, $results_per_page);
209 my @list = ();
210 foreach my $batch (@$batches) {
211 push @list, {
212 import_batch_id => $batch->{'import_batch_id'},
213 num_records => $batch->{'num_records'},
214 num_items => $batch->{'num_items'},
215 upload_timestamp => $batch->{'upload_timestamp'},
216 import_status => $batch->{'import_status'},
217 file_name => $batch->{'file_name'} || "($batch->{'batch_type'})",
218 comments => $batch->{'comments'},
219 can_clean => ($batch->{'import_status'} ne 'cleaned') ? 1 : 0,
220 record_type => $batch->{'record_type'},
223 $template->param(batch_list => \@list);
224 my $num_batches = GetNumberOfNonZ3950ImportBatches();
225 add_page_numbers($template, $offset, $results_per_page, $num_batches);
226 $template->param(offset => $offset);
227 $template->param(range_top => $offset + $results_per_page - 1);
228 $template->param(num_results => $num_batches);
229 $template->param(results_per_page => $results_per_page);
233 sub commit_batch {
234 my ($template, $import_batch_id, $framework) = @_;
236 my $job = undef;
237 $dbh->{AutoCommit} = 0;
238 my $callback = sub {};
239 if ($runinbackground) {
240 $job = put_in_background($import_batch_id);
241 $callback = progress_callback($job, $dbh);
243 my ($num_added, $num_updated, $num_items_added, $num_items_replaced, $num_items_errored, $num_ignored) =
244 BatchCommitRecords($import_batch_id, $framework, 50, $callback);
245 $dbh->commit();
247 my $results = {
248 did_commit => 1,
249 num_added => $num_added,
250 num_updated => $num_updated,
251 num_items_added => $num_items_added,
252 num_items_replaced => $num_items_replaced,
253 num_items_errored => $num_items_errored,
254 num_ignored => $num_ignored
256 if ($runinbackground) {
257 $job->finish($results);
258 } else {
259 add_results_to_template($template, $results);
263 sub revert_batch {
264 my ($template, $import_batch_id) = @_;
266 $dbh->{AutoCommit} = 0;
267 my $job = undef;
268 my $callback = sub {};
269 if ($runinbackground) {
270 $job = put_in_background($import_batch_id);
271 $callback = progress_callback($job, $dbh);
273 my ($num_deleted, $num_errors, $num_reverted, $num_items_deleted, $num_ignored) =
274 BatchRevertRecords($import_batch_id, 50, $callback);
275 $dbh->commit();
277 my $results = {
278 did_revert => 1,
279 num_deleted => $num_deleted,
280 num_items_deleted => $num_items_deleted,
281 num_errors => $num_errors,
282 num_reverted => $num_reverted,
283 num_ignored => $num_ignored,
285 if ($runinbackground) {
286 $job->finish($results);
287 } else {
288 add_results_to_template($template, $results);
292 sub put_in_background {
293 my $import_batch_id = shift;
295 my $batch = GetImportBatch($import_batch_id);
296 my $job = C4::BackgroundJob->new($sessionID, $batch->{'file_name'}, '/cgi-bin/koha/tools/manage-marc-import.pl', $batch->{'num_records'});
297 my $jobID = $job->id();
299 # fork off
300 if (my $pid = fork) {
301 # parent
302 # return job ID as JSON
304 # prevent parent exiting from
305 # destroying the kid's database handle
306 # FIXME: according to DBI doc, this may not work for Oracle
307 $dbh->{InactiveDestroy} = 1;
309 my $reply = CGI->new("");
310 print $reply->header(-type => 'text/html');
311 print '{"jobID":"' . $jobID . '"}';
312 exit 0;
313 } elsif (defined $pid) {
314 # child
315 # close STDOUT to signal to Apache that
316 # we're now running in the background
317 close STDOUT;
318 close STDERR;
319 } else {
320 # fork failed, so exit immediately
321 warn "fork failed while attempting to run tools/manage-marc-import.pl as a background job";
322 exit 0;
324 return $job;
327 sub progress_callback {
328 my $job = shift;
329 my $dbh = shift;
330 return sub {
331 my $progress = shift;
332 $job->progress($progress);
333 $dbh->commit();
337 sub add_results_to_template {
338 my $template = shift;
339 my $results = shift;
340 $template->param(map { $_ => $results->{$_} } keys %{ $results });
343 sub add_saved_job_results_to_template {
344 my $template = shift;
345 my $completedJobID = shift;
346 my $job = C4::BackgroundJob->fetch($sessionID, $completedJobID);
347 my $results = $job->results();
348 add_results_to_template($template, $results);
351 sub import_records_list {
352 my ($template, $import_batch_id, $offset, $results_per_page) = @_;
354 my $batch = GetImportBatch($import_batch_id);
355 $template->param(import_batch_id => $import_batch_id);
357 my $overlay_action = GetImportBatchOverlayAction($import_batch_id);
358 $template->param("overlay_action_${overlay_action}" => 1);
359 $template->param(overlay_action => $overlay_action);
361 my $nomatch_action = GetImportBatchNoMatchAction($import_batch_id);
362 $template->param("nomatch_action_${nomatch_action}" => 1);
363 $template->param(nomatch_action => $nomatch_action);
365 my $item_action = GetImportBatchItemAction($import_batch_id);
366 $template->param("item_action_${item_action}" => 1);
367 $template->param(item_action => $item_action);
369 batch_info($template, $batch);
373 sub batch_info {
374 my ($template, $batch) = @_;
375 $template->param(batch_info => 1);
376 $template->param(file_name => $batch->{'file_name'});
377 $template->param(comments => $batch->{'comments'});
378 $template->param(import_status => $batch->{'import_status'});
379 $template->param(upload_timestamp => $batch->{'upload_timestamp'});
380 $template->{VARS}->{'record_type'} = $batch->{'record_type'};
381 $template->param(num_records => $batch->{'num_records'});
382 $template->param(num_items => $batch->{'num_items'});
383 if ($batch->{'import_status'} ne 'cleaned') {
384 $template->param(can_clean => 1);
386 if ($batch->{'num_records'} > 0) {
387 if ($batch->{'import_status'} eq 'staged' or $batch->{'import_status'} eq 'reverted') {
388 $template->param(can_commit => 1);
390 if ($batch->{'import_status'} eq 'imported') {
391 $template->param(can_revert => 1);
394 if (defined $batch->{'matcher_id'}) {
395 my $matcher = C4::Matcher->fetch($batch->{'matcher_id'});
396 if (defined $matcher) {
397 $template->param('current_matcher_id' => $batch->{'matcher_id'});
398 $template->param('current_matcher_code' => $matcher->code());
399 $template->param('current_matcher_description' => $matcher->description());
402 add_matcher_list($template,$batch->{'matcher_id'});
405 sub add_matcher_list {
406 my ($template,$current_matcher_id) = @_;
407 my @matchers = C4::Matcher::GetMatcherList();
408 if (defined $current_matcher_id) {
409 for (my $i = 0; $i <= $#matchers; $i++) {
410 if ($matchers[$i]->{'matcher_id'} eq $current_matcher_id) {
411 $matchers[$i]->{'selected'} = 1;
415 $template->param(available_matchers => \@matchers);
418 sub add_page_numbers {
419 my ($template, $offset, $results_per_page, $total_results) = @_;
420 my $max_pages = POSIX::ceil($total_results / $results_per_page);
421 return if $max_pages < 2;
422 my $current_page = int($offset / $results_per_page) + 1;
423 my @pages = ();
424 for (my $i = 1; $i <= $max_pages; $i++) {
425 push @pages, {
426 page_number => $i,
427 current_page => ($current_page == $i) ? 1 : 0,
428 offset => ($i - 1) * $results_per_page
431 $template->param(pages => \@pages);