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>.
22 # standard or CPAN modules used
25 use MARC::File::USMARC;
31 use C4::AuthoritiesMarc;
36 use C4::BackgroundJob;
37 use C4::Labels::Batch;
38 use Koha::BiblioFrameworks;
40 my $script_name = "/cgi-bin/koha/tools/manage-marc-import.pl";
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",
56 flagsrequired => {tools => 'manage_staged_marc'},
59 my %cookies = parse CGI::Cookie($cookie);
60 our $sessionID = $cookies{'CGISESSID'}->value;
61 our $dbh = C4::Context->dbh;
63 my $frameworks = Koha::BiblioFrameworks->search({ tagfield => { 'not' => undef } }, { join => 'marc_tag_structure', distinct => 'frameworkcode', order_by => ['frameworktext'] });
64 $template->param( frameworks => $frameworks );
66 if ($op eq "create_labels") {
67 #create a batch of labels, then lose $op & $import_batch_id so we get back to import batch list.
68 my $label_batch_id = create_labelbatch_from_importbatch($import_batch_id);
69 if ($label_batch_id == -1) {
70 $template->param( label_batch_msg => "error",
71 message_type => 'alert',
75 $template->param( label_batch_msg => $label_batch_id,
76 message_type => 'dialog',
83 $template->param(script_name => $script_name, $op => 1);
85 $template->param(script_name => $script_name);
90 if ($import_batch_id eq '') {
91 import_batches_list($template, $offset, $results_per_page);
93 import_records_list($template, $import_batch_id, $offset, $results_per_page);
95 } elsif ($op eq "commit-batch") {
96 if ($completedJobID) {
97 add_saved_job_results_to_template($template, $completedJobID);
99 my $framework = $input->param('framework');
100 commit_batch($template, $import_batch_id, $framework);
102 import_records_list($template, $import_batch_id, $offset, $results_per_page);
103 } elsif ($op eq "revert-batch") {
104 if ($completedJobID) {
105 add_saved_job_results_to_template($template, $completedJobID);
107 revert_batch($template, $import_batch_id);
109 import_records_list($template, $import_batch_id, $offset, $results_per_page);
110 } elsif ($op eq "clean-batch") {
111 CleanBatch($import_batch_id);
112 import_batches_list($template, $offset, $results_per_page);
115 import_batch_id => $import_batch_id,
117 } elsif ($op eq "delete-batch") {
118 DeleteBatch($import_batch_id);
119 import_batches_list($template, $offset, $results_per_page);
123 } elsif ($op eq "redo-matching") {
124 my $new_matcher_id = $input->param('new_matcher_id');
125 my $current_matcher_id = $input->param('current_matcher_id');
126 my $overlay_action = $input->param('overlay_action');
127 my $nomatch_action = $input->param('nomatch_action');
128 my $item_action = $input->param('item_action');
129 redo_matching($template, $import_batch_id, $new_matcher_id, $current_matcher_id,
130 $overlay_action, $nomatch_action, $item_action);
131 import_records_list($template, $import_batch_id, $offset, $results_per_page);
134 output_html_with_http_headers $input, $cookie, $template->output;
139 my ($template, $import_batch_id, $new_matcher_id, $current_matcher_id, $overlay_action, $nomatch_action, $item_action) = @_;
140 my $rematch_failed = 0;
141 return if not defined $new_matcher_id and not defined $current_matcher_id;
142 my $old_overlay_action = GetImportBatchOverlayAction($import_batch_id);
143 my $old_nomatch_action = GetImportBatchNoMatchAction($import_batch_id);
144 my $old_item_action = GetImportBatchItemAction($import_batch_id);
145 return if $new_matcher_id eq $current_matcher_id and
146 $old_overlay_action eq $overlay_action and
147 $old_nomatch_action eq $nomatch_action and
148 $old_item_action eq $item_action;
150 if ($old_overlay_action ne $overlay_action) {
151 SetImportBatchOverlayAction($import_batch_id, $overlay_action);
152 $template->param('changed_overlay_action' => 1);
154 if ($old_nomatch_action ne $nomatch_action) {
155 SetImportBatchNoMatchAction($import_batch_id, $nomatch_action);
156 $template->param('changed_nomatch_action' => 1);
158 if ($old_item_action ne $item_action) {
159 SetImportBatchItemAction($import_batch_id, $item_action);
160 $template->param('changed_item_action' => 1);
163 my $num_with_matches = 0;
164 if (defined $new_matcher_id and $new_matcher_id ne "") {
165 my $matcher = C4::Matcher->fetch($new_matcher_id);
166 if (defined $matcher) {
167 $num_with_matches = BatchFindDuplicates($import_batch_id, $matcher);
168 SetImportBatchMatcher($import_batch_id, $new_matcher_id);
173 $num_with_matches = BatchFindDuplicates($import_batch_id, undef);
174 SetImportBatchMatcher($import_batch_id, undef);
175 SetImportBatchOverlayAction('create_new');
177 $template->param(rematch_failed => $rematch_failed);
178 $template->param(rematch_attempted => 1);
179 $template->param(num_with_matches => $num_with_matches);
182 sub create_labelbatch_from_importbatch {
185 my $branch_code = C4::Context->userenv->{'branch'};
186 my $batch = C4::Labels::Batch->new(branch_code => $branch_code);
187 my @items = GetItemNumbersFromImportBatch($batch_id);
188 if (grep{$_ == 0} @items) {
189 warn sprintf('create_labelbatch_from_importbatch() : Call to C4::ImportBatch::GetItemNumbersFromImportBatch returned no item number(s) from import batch #%s.', $batch_id);
192 foreach my $item_number (@items) {
193 $err = $batch->add_item($item_number);
195 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 $batch->get_attr('batch_id');
202 sub import_batches_list {
203 my ($template, $offset, $results_per_page) = @_;
204 my $batches = GetImportBatchRangeDesc($offset, $results_per_page);
207 foreach my $batch (@$batches) {
209 import_batch_id => $batch->{'import_batch_id'},
210 num_records => $batch->{'num_records'},
211 num_items => $batch->{'num_items'},
212 upload_timestamp => $batch->{'upload_timestamp'},
213 import_status => $batch->{'import_status'},
214 file_name => $batch->{'file_name'} || "($batch->{'batch_type'})",
215 comments => $batch->{'comments'},
216 can_clean => ($batch->{'import_status'} ne 'cleaned') ? 1 : 0,
217 record_type => $batch->{'record_type'},
218 profile => $batch->{'profile'},
221 $template->param(batch_list => \@list);
222 my $num_batches = GetNumberOfNonZ3950ImportBatches();
223 add_page_numbers($template, $offset, $results_per_page, $num_batches);
224 $template->param(offset => $offset);
225 $template->param(range_top => $offset + $results_per_page - 1);
226 $template->param(num_results => $num_batches);
227 $template->param(results_per_page => $results_per_page);
232 my ($template, $import_batch_id, $framework) = @_;
235 my ( $num_added, $num_updated, $num_items_added,
236 $num_items_replaced, $num_items_errored, $num_ignored );
237 my $schema = Koha::Database->new->schema;
238 $schema->storage->txn_do(
240 my $callback = sub { };
241 if ($runinbackground) {
242 $job = put_in_background($import_batch_id);
243 $callback = progress_callback( $job, $dbh );
246 $num_added, $num_updated, $num_items_added,
247 $num_items_replaced, $num_items_errored, $num_ignored
249 = BatchCommitRecords( $import_batch_id, $framework, 50,
256 num_added => $num_added,
257 num_updated => $num_updated,
258 num_items_added => $num_items_added,
259 num_items_replaced => $num_items_replaced,
260 num_items_errored => $num_items_errored,
261 num_ignored => $num_ignored
263 if ($runinbackground) {
264 $job->finish($results);
266 add_results_to_template($template, $results);
271 my ($template, $import_batch_id) = @_;
275 $num_deleted, $num_errors, $num_reverted,
276 $num_items_deleted, $num_ignored
278 my $schema = Koha::Database->new->schema;
281 my $callback = sub { };
282 if ($runinbackground) {
283 $job = put_in_background($import_batch_id);
284 $callback = progress_callback( $job, $dbh );
287 $num_deleted, $num_errors, $num_reverted,
288 $num_items_deleted, $num_ignored
289 ) = BatchRevertRecords( $import_batch_id, 50, $callback );
295 num_deleted => $num_deleted,
296 num_items_deleted => $num_items_deleted,
297 num_errors => $num_errors,
298 num_reverted => $num_reverted,
299 num_ignored => $num_ignored,
301 if ($runinbackground) {
302 $job->finish($results);
304 add_results_to_template($template, $results);
308 sub put_in_background {
309 my $import_batch_id = shift;
311 my $batch = GetImportBatch($import_batch_id);
312 my $job = C4::BackgroundJob->new($sessionID, $batch->{'file_name'}, '/cgi-bin/koha/tools/manage-marc-import.pl', $batch->{'num_records'});
313 my $jobID = $job->id();
316 if (my $pid = fork) {
318 # return job ID as JSON
320 # prevent parent exiting from
321 # destroying the kid's database handle
322 # FIXME: according to DBI doc, this may not work for Oracle
323 $dbh->{InactiveDestroy} = 1;
325 my $reply = CGI->new("");
326 print $reply->header(-type => 'text/html');
327 print '{"jobID":"' . $jobID . '"}';
329 } elsif (defined $pid) {
331 # close STDOUT to signal to Apache that
332 # we're now running in the background
336 # fork failed, so exit immediately
337 warn "fork failed while attempting to run tools/manage-marc-import.pl as a background job";
343 sub progress_callback {
347 my $progress = shift;
348 $job->progress($progress);
353 sub add_results_to_template {
354 my $template = shift;
356 $template->param(map { $_ => $results->{$_} } keys %{ $results });
359 sub add_saved_job_results_to_template {
360 my $template = shift;
361 my $completedJobID = shift;
362 my $job = C4::BackgroundJob->fetch($sessionID, $completedJobID);
363 my $results = $job->results();
364 add_results_to_template($template, $results);
367 sub import_records_list {
368 my ($template, $import_batch_id, $offset, $results_per_page) = @_;
370 my $batch = GetImportBatch($import_batch_id);
371 $template->param(import_batch_id => $import_batch_id);
373 my $overlay_action = GetImportBatchOverlayAction($import_batch_id);
374 $template->param("overlay_action_${overlay_action}" => 1);
375 $template->param(overlay_action => $overlay_action);
377 my $nomatch_action = GetImportBatchNoMatchAction($import_batch_id);
378 $template->param("nomatch_action_${nomatch_action}" => 1);
379 $template->param(nomatch_action => $nomatch_action);
381 my $item_action = GetImportBatchItemAction($import_batch_id);
382 $template->param("item_action_${item_action}" => 1);
383 $template->param(item_action => $item_action);
385 batch_info($template, $batch);
390 my ($template, $batch) = @_;
391 $template->param(batch_info => 1);
392 $template->param(file_name => $batch->{'file_name'});
393 $template->param(profile => $batch->{'profile'});
394 $template->param(comments => $batch->{'comments'});
395 $template->param(import_status => $batch->{'import_status'});
396 $template->param(upload_timestamp => $batch->{'upload_timestamp'});
397 $template->{VARS}->{'record_type'} = $batch->{'record_type'};
398 $template->param(num_records => $batch->{'num_records'});
399 $template->param(num_items => $batch->{'num_items'});
400 if ($batch->{'import_status'} ne 'cleaned') {
401 $template->param(can_clean => 1);
403 if ($batch->{'num_records'} > 0) {
404 if ($batch->{'import_status'} eq 'staged' or $batch->{'import_status'} eq 'reverted') {
405 $template->param(can_commit => 1);
407 if ($batch->{'import_status'} eq 'imported') {
408 $template->param(can_revert => 1);
411 if (defined $batch->{'matcher_id'}) {
412 my $matcher = C4::Matcher->fetch($batch->{'matcher_id'});
413 if (defined $matcher) {
414 $template->param('current_matcher_id' => $batch->{'matcher_id'});
415 $template->param('current_matcher_code' => $matcher->code());
416 $template->param('current_matcher_description' => $matcher->description());
419 add_matcher_list($template,$batch->{'matcher_id'});
422 sub add_matcher_list {
423 my ($template,$current_matcher_id) = @_;
424 my @matchers = C4::Matcher::GetMatcherList();
425 if (defined $current_matcher_id) {
426 for (my $i = 0; $i <= $#matchers; $i++) {
427 if ($matchers[$i]->{'matcher_id'} eq $current_matcher_id) {
428 $matchers[$i]->{'selected'} = 1;
432 $template->param(available_matchers => \@matchers);
435 sub add_page_numbers {
436 my ($template, $offset, $results_per_page, $total_results) = @_;
437 my $max_pages = POSIX::ceil($total_results / $results_per_page);
438 return if $max_pages < 2;
439 my $current_page = int($offset / $results_per_page) + 1;
441 for (my $i = 1; $i <= $max_pages; $i++) {
444 current_page => ($current_page == $i) ? 1 : 0,
445 offset => ($i - 1) * $results_per_page
448 $template->param(pages => \@pages);