1 package C4::ImportBatch;
3 # Copyright (C) 2007 LibLime, 2012 C & P Bibliography Services
5 # This file is part of Koha.
7 # Koha is free software; you can redistribute it and/or modify it under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along
17 # with Koha; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
28 use C4::AuthoritiesMarc;
30 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
33 # set the version for version checking
34 $VERSION = 3.07.00.049;
41 GetImportRecordMarcXML
46 AddItemsToImportBiblio
57 GetStagedWebserviceBatches
58 GetImportBatchRangeDesc
59 GetNumberOfNonZ3950ImportBatches
61 GetItemNumbersFromImportBatch
65 GetImportBatchOverlayAction
66 SetImportBatchOverlayAction
67 GetImportBatchNoMatchAction
68 SetImportBatchNoMatchAction
69 GetImportBatchItemAction
70 SetImportBatchItemAction
73 GetImportRecordOverlayStatus
74 SetImportRecordOverlayStatus
77 GetImportRecordMatches
78 SetImportRecordMatches
84 C4::ImportBatch - manage batches of imported MARC records
92 =head2 GetZ3950BatchId
94 my $batchid = GetZ3950BatchId($z3950server);
96 Retrieves the ID of the import batch for the Z39.50
97 reservoir for the given target. If necessary,
98 creates the import batch.
102 sub GetZ3950BatchId {
103 my ($z3950server) = @_;
105 my $dbh = C4::Context->dbh;
106 my $sth = $dbh->prepare("SELECT import_batch_id FROM import_batches
107 WHERE batch_type = 'z3950'
109 $sth->execute($z3950server);
110 my $rowref = $sth->fetchrow_arrayref();
112 if (defined $rowref) {
115 my $batch_id = AddImportBatch( {
116 overlay_action => 'create_new',
117 import_status => 'staged',
118 batch_type => 'z3950',
119 file_name => $z3950server,
126 =head2 GetWebserviceBatchId
128 my $batchid = GetWebserviceBatchId();
130 Retrieves the ID of the import batch for webservice.
131 If necessary, creates the import batch.
135 my $WEBSERVICE_BASE_QRY = <<EOQ;
136 SELECT import_batch_id FROM import_batches
137 WHERE batch_type = 'webservice'
138 AND import_status = 'staged'
140 sub GetWebserviceBatchId {
143 my $dbh = C4::Context->dbh;
144 my $sql = $WEBSERVICE_BASE_QRY;
146 foreach my $field (qw(matcher_id overlay_action nomatch_action item_action)) {
147 if (my $val = $params->{$field}) {
148 $sql .= " AND $field = ?";
152 my $id = $dbh->selectrow_array($sql, undef, @args);
155 $params->{batch_type} = 'webservice';
156 $params->{import_status} = 'staged';
157 return AddImportBatch($params);
160 =head2 GetImportRecordMarc
162 my ($marcblob, $encoding) = GetImportRecordMarc($import_record_id);
166 sub GetImportRecordMarc {
167 my ($import_record_id) = @_;
169 my $dbh = C4::Context->dbh;
170 my $sth = $dbh->prepare("SELECT marc, encoding FROM import_records WHERE import_record_id = ?");
171 $sth->execute($import_record_id);
172 my ($marc, $encoding) = $sth->fetchrow();
174 return $marc, $encoding;
178 =head2 GetImportRecordMarcXML
180 my $marcxml = GetImportRecordMarcXML($import_record_id);
184 sub GetImportRecordMarcXML {
185 my ($import_record_id) = @_;
187 my $dbh = C4::Context->dbh;
188 my $sth = $dbh->prepare("SELECT marcxml FROM import_records WHERE import_record_id = ?");
189 $sth->execute($import_record_id);
190 my ($marcxml) = $sth->fetchrow();
196 =head2 AddImportBatch
198 my $batch_id = AddImportBatch($params_hash);
206 foreach (qw( matcher_id template_id branchcode
207 overlay_action nomatch_action item_action
208 import_status batch_type file_name comments record_type )) {
209 if (exists $params->{$_}) {
211 push @vals, $params->{$_};
214 my $dbh = C4::Context->dbh;
215 $dbh->do("INSERT INTO import_batches (".join( ',', @fields).")
216 VALUES (".join( ',', map '?', @fields).")",
219 return $dbh->{'mysql_insertid'};
222 =head2 GetImportBatch
224 my $row = GetImportBatch($batch_id);
226 Retrieve a hashref of an import_batches row.
233 my $dbh = C4::Context->dbh;
234 my $sth = $dbh->prepare_cached("SELECT * FROM import_batches WHERE import_batch_id = ?");
235 $sth->bind_param(1, $batch_id);
237 my $result = $sth->fetchrow_hashref;
243 =head2 AddBiblioToBatch
245 my $import_record_id = AddBiblioToBatch($batch_id, $record_sequence,
246 $marc_record, $encoding, $z3950random, $update_counts);
250 sub AddBiblioToBatch {
251 my $batch_id = shift;
252 my $record_sequence = shift;
253 my $marc_record = shift;
254 my $encoding = shift;
255 my $z3950random = shift;
256 my $update_counts = @_ ? shift : 1;
258 my $import_record_id = _create_import_record($batch_id, $record_sequence, $marc_record, 'biblio', $encoding, $z3950random, C4::Context->preference('marcflavour'));
259 _add_biblio_fields($import_record_id, $marc_record);
260 _update_batch_record_counts($batch_id) if $update_counts;
261 return $import_record_id;
264 =head2 ModBiblioInBatch
266 ModBiblioInBatch($import_record_id, $marc_record);
270 sub ModBiblioInBatch {
271 my ($import_record_id, $marc_record) = @_;
273 _update_import_record_marc($import_record_id, $marc_record, C4::Context->preference('marcflavour'));
274 _update_biblio_fields($import_record_id, $marc_record);
278 =head2 AddAuthToBatch
280 my $import_record_id = AddAuthToBatch($batch_id, $record_sequence,
281 $marc_record, $encoding, $z3950random, $update_counts, [$marc_type]);
286 my $batch_id = shift;
287 my $record_sequence = shift;
288 my $marc_record = shift;
289 my $encoding = shift;
290 my $z3950random = shift;
291 my $update_counts = @_ ? shift : 1;
292 my $marc_type = shift || C4::Context->preference('marcflavour');
294 $marc_type = 'UNIMARCAUTH' if $marc_type eq 'UNIMARC';
296 my $import_record_id = _create_import_record($batch_id, $record_sequence, $marc_record, 'auth', $encoding, $z3950random, $marc_type);
297 _add_auth_fields($import_record_id, $marc_record);
298 _update_batch_record_counts($batch_id) if $update_counts;
299 return $import_record_id;
302 =head2 ModAuthInBatch
304 ModAuthInBatch($import_record_id, $marc_record);
309 my ($import_record_id, $marc_record) = @_;
311 my $marcflavour = C4::Context->preference('marcflavour');
312 _update_import_record_marc($import_record_id, $marc_record, $marcflavour eq 'UNIMARC' ? 'UNIMARCAUTH' : 'USMARC');
316 =head2 BatchStageMarcRecords
318 ($batch_id, $num_records, $num_items, @invalid_records) =
319 BatchStageMarcRecords($record_type, $encoding, $marc_records, $file_name,
320 $comments, $branch_code, $parse_items,
322 $progress_interval, $progress_callback);
326 sub BatchStageMarcRecords {
327 my $record_type = shift;
328 my $encoding = shift;
329 my $marc_records = shift;
330 my $file_name = shift;
331 my $comments = shift;
332 my $branch_code = shift;
333 my $parse_items = shift;
334 my $leave_as_staging = shift;
336 # optional callback to monitor status
338 my $progress_interval = 0;
339 my $progress_callback = undef;
341 $progress_interval = shift;
342 $progress_callback = shift;
343 $progress_interval = 0 unless $progress_interval =~ /^\d+$/ and $progress_interval > 0;
344 $progress_interval = 0 unless 'CODE' eq ref $progress_callback;
347 my $batch_id = AddImportBatch( {
348 overlay_action => 'create_new',
349 import_status => 'staging',
350 batch_type => 'batch',
351 file_name => $file_name,
352 comments => $comments,
353 record_type => $record_type,
356 SetImportBatchItemAction($batch_id, 'always_add');
358 SetImportBatchItemAction($batch_id, 'ignore');
361 my $marc_type = C4::Context->preference('marcflavour');
362 $marc_type .= 'AUTH' if ($marc_type eq 'UNIMARC' && $record_type eq 'auth');
363 my @invalid_records = ();
366 # FIXME - for now, we're dealing only with bibs
368 foreach my $marc_blob (split(/\x1D/, $marc_records)) {
369 $marc_blob =~ s/^\s+//g;
370 $marc_blob =~ s/\s+$//g;
371 next unless $marc_blob;
373 if ($progress_interval and (0 == ($rec_num % $progress_interval))) {
374 &$progress_callback($rec_num);
376 my ($marc_record, $charset_guessed, $char_errors) =
377 MarcToUTF8Record($marc_blob, $marc_type, $encoding);
379 $encoding = $charset_guessed unless $encoding;
381 my $import_record_id;
382 if (scalar($marc_record->fields()) == 0) {
383 push @invalid_records, $marc_blob;
386 # Normalize the record so it doesn't have separated diacritics
387 SetUTF8Flag($marc_record);
390 if ($record_type eq 'biblio') {
391 $import_record_id = AddBiblioToBatch($batch_id, $rec_num, $marc_record, $encoding, int(rand(99999)), 0);
393 my @import_items_ids = AddItemsToImportBiblio($batch_id, $import_record_id, $marc_record, 0);
394 $num_items += scalar(@import_items_ids);
396 } elsif ($record_type eq 'auth') {
397 $import_record_id = AddAuthToBatch($batch_id, $rec_num, $marc_record, $encoding, int(rand(99999)), 0, $marc_type);
401 unless ($leave_as_staging) {
402 SetImportBatchStatus($batch_id, 'staged');
404 # FIXME branch_code, number of bibs, number of items
405 _update_batch_record_counts($batch_id);
406 return ($batch_id, $num_valid, $num_items, @invalid_records);
409 =head2 AddItemsToImportBiblio
411 my @import_items_ids = AddItemsToImportBiblio($batch_id,
412 $import_record_id, $marc_record, $update_counts);
416 sub AddItemsToImportBiblio {
417 my $batch_id = shift;
418 my $import_record_id = shift;
419 my $marc_record = shift;
420 my $update_counts = @_ ? shift : 0;
422 my @import_items_ids = ();
424 my $dbh = C4::Context->dbh;
425 my ($item_tag,$item_subfield) = &GetMarcFromKohaField("items.itemnumber",'');
426 foreach my $item_field ($marc_record->field($item_tag)) {
427 my $item_marc = MARC::Record->new();
428 $item_marc->leader("00000 a "); # must set Leader/09 to 'a'
429 $item_marc->append_fields($item_field);
430 $marc_record->delete_field($item_field);
431 my $sth = $dbh->prepare_cached("INSERT INTO import_items (import_record_id, status, marcxml)
433 $sth->bind_param(1, $import_record_id);
434 $sth->bind_param(2, 'staged');
435 $sth->bind_param(3, $item_marc->as_xml());
437 push @import_items_ids, $dbh->{'mysql_insertid'};
441 if ($#import_items_ids > -1) {
442 _update_batch_record_counts($batch_id) if $update_counts;
443 _update_import_record_marc($import_record_id, $marc_record, C4::Context->preference('marcflavour'));
445 return @import_items_ids;
448 =head2 BatchFindDuplicates
450 my $num_with_matches = BatchFindDuplicates($batch_id, $matcher,
451 $max_matches, $progress_interval, $progress_callback);
453 Goes through the records loaded in the batch and attempts to
454 find duplicates for each one. Sets the matching status
455 of each record to "no_match" or "auto_match" as appropriate.
457 The $max_matches parameter is optional; if it is not supplied,
460 The $progress_interval and $progress_callback parameters are
461 optional; if both are supplied, the sub referred to by
462 $progress_callback will be invoked every $progress_interval
463 records using the number of records processed as the
468 sub BatchFindDuplicates {
469 my $batch_id = shift;
471 my $max_matches = @_ ? shift : 10;
473 # optional callback to monitor status
475 my $progress_interval = 0;
476 my $progress_callback = undef;
478 $progress_interval = shift;
479 $progress_callback = shift;
480 $progress_interval = 0 unless $progress_interval =~ /^\d+$/ and $progress_interval > 0;
481 $progress_interval = 0 unless 'CODE' eq ref $progress_callback;
484 my $dbh = C4::Context->dbh;
486 my $sth = $dbh->prepare("SELECT import_record_id, record_type, marc
488 WHERE import_batch_id = ?");
489 $sth->execute($batch_id);
490 my $num_with_matches = 0;
492 while (my $rowref = $sth->fetchrow_hashref) {
494 if ($progress_interval and (0 == ($rec_num % $progress_interval))) {
495 &$progress_callback($rec_num);
497 my $marc_record = MARC::Record->new_from_usmarc($rowref->{'marc'});
499 if (defined $matcher) {
500 @matches = $matcher->get_matches($marc_record, $max_matches);
502 if (scalar(@matches) > 0) {
504 SetImportRecordMatches($rowref->{'import_record_id'}, @matches);
505 SetImportRecordOverlayStatus($rowref->{'import_record_id'}, 'auto_match');
507 SetImportRecordMatches($rowref->{'import_record_id'}, ());
508 SetImportRecordOverlayStatus($rowref->{'import_record_id'}, 'no_match');
512 return $num_with_matches;
515 =head2 BatchCommitRecords
517 my ($num_added, $num_updated, $num_items_added, $num_items_errored, $num_ignored) =
518 BatchCommitRecords($batch_id, $framework,
519 $progress_interval, $progress_callback);
523 sub BatchCommitRecords {
524 my $batch_id = shift;
525 my $framework = shift;
527 # optional callback to monitor status
529 my $progress_interval = 0;
530 my $progress_callback = undef;
532 $progress_interval = shift;
533 $progress_callback = shift;
534 $progress_interval = 0 unless $progress_interval =~ /^\d+$/ and $progress_interval > 0;
535 $progress_interval = 0 unless 'CODE' eq ref $progress_callback;
541 my $num_items_added = 0;
542 my $num_items_errored = 0;
544 # commit (i.e., save, all records in the batch)
545 SetImportBatchStatus('importing');
546 my $overlay_action = GetImportBatchOverlayAction($batch_id);
547 my $nomatch_action = GetImportBatchNoMatchAction($batch_id);
548 my $item_action = GetImportBatchItemAction($batch_id);
551 my $dbh = C4::Context->dbh;
552 my $sth = $dbh->prepare("SELECT import_records.import_record_id, record_type, status, overlay_status, marc, encoding
554 LEFT JOIN import_auths ON (import_records.import_record_id=import_auths.import_record_id)
555 LEFT JOIN import_biblios ON (import_records.import_record_id=import_biblios.import_record_id)
556 WHERE import_batch_id = ?");
557 $sth->execute($batch_id);
558 my $marcflavour = C4::Context->preference('marcflavour');
560 while (my $rowref = $sth->fetchrow_hashref) {
561 $record_type = $rowref->{'record_type'};
563 if ($progress_interval and (0 == ($rec_num % $progress_interval))) {
564 &$progress_callback($rec_num);
566 if ($rowref->{'status'} eq 'error' or $rowref->{'status'} eq 'imported') {
572 if ($marcflavour eq 'UNIMARC' && $record_type eq 'auth') {
573 $marc_type = 'UNIMARCAUTH';
574 } elsif ($marcflavour eq 'UNIMARC') {
575 $marc_type = 'UNIMARC';
577 $marc_type = 'USMARC';
579 my $marc_record = MARC::Record->new_from_usmarc($rowref->{'marc'});
581 if ($record_type eq 'biblio') {
582 # remove any item tags - rely on BatchCommitItems
583 ($item_tag,$item_subfield) = &GetMarcFromKohaField("items.itemnumber",'');
584 foreach my $item_field ($marc_record->field($item_tag)) {
585 $marc_record->delete_field($item_field);
589 my ($record_result, $item_result, $record_match) =
590 _get_commit_action($overlay_action, $nomatch_action, $item_action,
591 $rowref->{'overlay_status'}, $rowref->{'import_record_id'}, $record_type);
595 if ($record_result eq 'create_new') {
597 if ($record_type eq 'biblio') {
598 my $biblioitemnumber;
599 ($recordid, $biblioitemnumber) = AddBiblio($marc_record, $framework);
600 $query = "UPDATE import_biblios SET matched_biblionumber = ? WHERE import_record_id = ?";
601 if ($item_result eq 'create_new') {
602 my ($bib_items_added, $bib_items_errored) = BatchCommitItems($rowref->{'import_record_id'}, $recordid);
603 $num_items_added += $bib_items_added;
604 $num_items_errored += $bib_items_errored;
607 $recordid = AddAuthority($marc_record, undef, GuessAuthTypeCode($marc_record));
608 $query = "UPDATE import_auths SET matched_authid = ? WHERE import_record_id = ?";
610 my $sth = $dbh->prepare_cached($query);
611 $sth->execute($recordid, $rowref->{'import_record_id'});
613 SetImportRecordStatus($rowref->{'import_record_id'}, 'imported');
614 } elsif ($record_result eq 'replace') {
616 $recordid = $record_match;
618 if ($record_type eq 'biblio') {
619 my ($count, $oldbiblio) = GetBiblio($recordid);
620 $oldxml = GetXmlBiblio($recordid);
622 # remove item fields so that they don't get
623 # added again if record is reverted
624 my $old_marc = MARC::Record->new_from_xml(StripNonXmlChars($oldxml), 'UTF-8', $rowref->{'encoding'}, $marc_type);
625 foreach my $item_field ($old_marc->field($item_tag)) {
626 $old_marc->delete_field($item_field);
628 $oldxml = $old_marc->as_xml($marc_type);
630 ModBiblio($marc_record, $recordid, $oldbiblio->{'frameworkcode'});
631 $query = "UPDATE import_biblios SET matched_biblionumber = ? WHERE import_record_id = ?";
633 if ($item_result eq 'create_new') {
634 my ($bib_items_added, $bib_items_errored) = BatchCommitItems($rowref->{'import_record_id'}, $recordid);
635 $num_items_added += $bib_items_added;
636 $num_items_errored += $bib_items_errored;
639 $oldxml = GetAuthorityXML($recordid);
641 ModAuthority($recordid, $marc_record, GuessAuthTypeCode($marc_record));
642 $query = "UPDATE import_auths SET matched_authid = ? WHERE import_record_id = ?";
644 my $sth = $dbh->prepare_cached("UPDATE import_records SET marcxml_old = ? WHERE import_record_id = ?");
645 $sth->execute($oldxml, $rowref->{'import_record_id'});
647 my $sth2 = $dbh->prepare_cached($query);
648 $sth2->execute($recordid, $rowref->{'import_record_id'});
650 SetImportRecordOverlayStatus($rowref->{'import_record_id'}, 'match_applied');
651 SetImportRecordStatus($rowref->{'import_record_id'}, 'imported');
652 } elsif ($record_result eq 'ignore') {
654 if ($record_type eq 'biblio' and defined $recordid and $item_result eq 'create_new') {
655 my ($bib_items_added, $bib_items_errored) = BatchCommitItems($rowref->{'import_record_id'}, $recordid);
656 $num_items_added += $bib_items_added;
657 $num_items_errored += $bib_items_errored;
658 # still need to record the matched biblionumber so that the
659 # items can be reverted
660 my $sth2 = $dbh->prepare_cached("UPDATE import_biblios SET matched_biblionumber = ? WHERE import_record_id = ?");
661 $sth2->execute($recordid, $rowref->{'import_record_id'});
662 SetImportRecordOverlayStatus($rowref->{'import_record_id'}, 'match_applied');
664 SetImportRecordStatus($rowref->{'import_record_id'}, 'ignored');
668 SetImportBatchStatus($batch_id, 'imported');
669 return ($num_added, $num_updated, $num_items_added, $num_items_errored, $num_ignored);
672 =head2 BatchCommitItems
674 ($num_items_added, $num_items_errored) =
675 BatchCommitItems($import_record_id, $biblionumber);
679 sub BatchCommitItems {
680 my ($import_record_id, $biblionumber) = @_;
682 my $dbh = C4::Context->dbh;
684 my $num_items_added = 0;
685 my $num_items_errored = 0;
686 my $sth = $dbh->prepare("SELECT import_items_id, import_items.marcxml, encoding
688 JOIN import_records USING (import_record_id)
689 WHERE import_record_id = ?
690 ORDER BY import_items_id");
691 $sth->bind_param(1, $import_record_id);
693 while (my $row = $sth->fetchrow_hashref()) {
694 my $item_marc = MARC::Record->new_from_xml(StripNonXmlChars($row->{'marcxml'}), 'UTF-8', $row->{'encoding'});
695 # FIXME - duplicate barcode check needs to become part of AddItemFromMarc()
696 my $item = TransformMarcToKoha($dbh, $item_marc);
697 my $duplicate_barcode = exists($item->{'barcode'}) && GetItemnumberFromBarcode($item->{'barcode'});
698 if ($duplicate_barcode) {
699 my $updsth = $dbh->prepare("UPDATE import_items SET status = ?, import_error = ? WHERE import_items_id = ?");
700 $updsth->bind_param(1, 'error');
701 $updsth->bind_param(2, 'duplicate item barcode');
702 $updsth->bind_param(3, $row->{'import_items_id'});
704 $num_items_errored++;
706 my ($item_biblionumber, $biblioitemnumber, $itemnumber) = AddItemFromMarc($item_marc, $biblionumber);
707 my $updsth = $dbh->prepare("UPDATE import_items SET status = ?, itemnumber = ? WHERE import_items_id = ?");
708 $updsth->bind_param(1, 'imported');
709 $updsth->bind_param(2, $itemnumber);
710 $updsth->bind_param(3, $row->{'import_items_id'});
717 return ($num_items_added, $num_items_errored);
720 =head2 BatchRevertRecords
722 my ($num_deleted, $num_errors, $num_reverted, $num_items_deleted,
723 $num_ignored) = BatchRevertRecords($batch_id);
727 sub BatchRevertRecords {
728 my $batch_id = shift;
733 my $num_reverted = 0;
735 my $num_items_deleted = 0;
736 # commit (i.e., save, all records in the batch)
737 SetImportBatchStatus('reverting');
738 my $overlay_action = GetImportBatchOverlayAction($batch_id);
739 my $nomatch_action = GetImportBatchNoMatchAction($batch_id);
740 my $dbh = C4::Context->dbh;
741 my $sth = $dbh->prepare("SELECT import_records.import_record_id, record_type, status, overlay_status, marcxml_old, encoding, matched_biblionumber, matched_authid
743 LEFT JOIN import_auths ON (import_records.import_record_id=import_auths.import_record_id)
744 LEFT JOIN import_biblios ON (import_records.import_record_id=import_biblios.import_record_id)
745 WHERE import_batch_id = ?");
746 $sth->execute($batch_id);
748 my $marcflavour = C4::Context->preference('marcflavour');
749 while (my $rowref = $sth->fetchrow_hashref) {
750 $record_type = $rowref->{'record_type'};
751 if ($rowref->{'status'} eq 'error' or $rowref->{'status'} eq 'reverted') {
755 if ($marcflavour eq 'UNIMARC' && $record_type eq 'auth') {
756 $marc_type = 'UNIMARCAUTH';
757 } elsif ($marcflavour eq 'UNIMARC') {
758 $marc_type = 'UNIMARC';
760 $marc_type = 'USMARC';
763 my $record_result = _get_revert_action($overlay_action, $rowref->{'overlay_status'}, $rowref->{'status'});
765 if ($record_result eq 'delete') {
767 if ($record_type eq 'biblio') {
768 $num_items_deleted += BatchRevertItems($rowref->{'import_record_id'}, $rowref->{'matched_biblionumber'});
769 $error = DelBiblio($rowref->{'matched_biblionumber'});
771 my $deletedauthid = DelAuthority($rowref->{'matched_authid'});
773 if (defined $error) {
777 SetImportRecordStatus($rowref->{'import_record_id'}, 'reverted');
779 } elsif ($record_result eq 'restore') {
781 my $old_record = MARC::Record->new_from_xml(StripNonXmlChars($rowref->{'marcxml_old'}), 'UTF-8', $rowref->{'encoding'}, $marc_type);
782 if ($record_type eq 'biblio') {
783 my $biblionumber = $rowref->{'matched_biblionumber'};
784 my ($count, $oldbiblio) = GetBiblio($biblionumber);
785 $num_items_deleted += BatchRevertItems($rowref->{'import_record_id'}, $rowref->{'matched_biblionumber'});
786 ModBiblio($old_record, $biblionumber, $oldbiblio->{'frameworkcode'});
788 my $authid = $rowref->{'matched_authid'};
789 ModAuthority($authid, $old_record, GuessAuthTypeCode($old_record));
791 SetImportRecordStatus($rowref->{'import_record_id'}, 'reverted');
792 } elsif ($record_result eq 'ignore') {
793 if ($record_type eq 'biblio') {
794 $num_items_deleted += BatchRevertItems($rowref->{'import_record_id'}, $rowref->{'matched_biblionumber'});
796 SetImportRecordStatus($rowref->{'import_record_id'}, 'reverted');
799 if ($record_type eq 'biblio') {
800 # remove matched_biblionumber only if there is no 'imported' item left
801 $query = "UPDATE import_biblios SET matched_biblionumber = NULL WHERE import_record_id = ?";
802 $query = "UPDATE import_biblios SET matched_biblionumber = NULL WHERE import_record_id = ? AND NOT EXISTS (SELECT * FROM import_items WHERE import_items.import_record_id=import_biblios.import_record_id and status='imported')";
804 $query = "UPDATE import_auths SET matched_authid = NULL WHERE import_record_id = ?";
806 my $sth2 = $dbh->prepare_cached($query);
807 $sth2->execute($rowref->{'import_record_id'});
811 SetImportBatchStatus($batch_id, 'reverted');
812 return ($num_deleted, $num_errors, $num_reverted, $num_items_deleted, $num_ignored);
815 =head2 BatchRevertItems
817 my $num_items_deleted = BatchRevertItems($import_record_id, $biblionumber);
821 sub BatchRevertItems {
822 my ($import_record_id, $biblionumber) = @_;
824 my $dbh = C4::Context->dbh;
825 my $num_items_deleted = 0;
827 my $sth = $dbh->prepare_cached("SELECT import_items_id, itemnumber
829 JOIN items USING (itemnumber)
830 WHERE import_record_id = ?");
831 $sth->bind_param(1, $import_record_id);
833 while (my $row = $sth->fetchrow_hashref()) {
834 my $error = DelItemCheck($dbh, $biblionumber, $row->{'itemnumber'});
836 my $updsth = $dbh->prepare("UPDATE import_items SET status = ? WHERE import_items_id = ?");
837 $updsth->bind_param(1, 'reverted');
838 $updsth->bind_param(2, $row->{'import_items_id'});
841 $num_items_deleted++;
848 return $num_items_deleted;
853 CleanBatch($batch_id)
855 Deletes all staged records from the import batch
856 and sets the status of the batch to 'cleaned'. Note
857 that deleting a stage record does *not* affect
858 any record that has been committed to the database.
863 my $batch_id = shift;
864 return unless defined $batch_id;
866 C4::Context->dbh->do('DELETE FROM import_records WHERE import_batch_id = ?', {}, $batch_id);
867 SetImportBatchStatus($batch_id, 'cleaned');
870 =head2 GetAllImportBatches
872 my $results = GetAllImportBatches();
874 Returns a references to an array of hash references corresponding
875 to all import_batches rows (of batch_type 'batch'), sorted in
876 ascending order by import_batch_id.
880 sub GetAllImportBatches {
881 my $dbh = C4::Context->dbh;
882 my $sth = $dbh->prepare_cached("SELECT * FROM import_batches
883 WHERE batch_type IN ('batch', 'webservice')
884 ORDER BY import_batch_id ASC");
888 while (my $row = $sth->fetchrow_hashref) {
889 push @$results, $row;
895 =head2 GetStagedWebserviceBatches
897 my $batch_ids = GetStagedWebserviceBatches();
899 Returns a references to an array of batch id's
900 of batch_type 'webservice' that are not imported
904 my $PENDING_WEBSERVICE_BATCHES_QRY = <<EOQ;
905 SELECT import_batch_id FROM import_batches
906 WHERE batch_type = 'webservice'
907 AND import_status = 'staged'
909 sub GetStagedWebserviceBatches {
910 my $dbh = C4::Context->dbh;
911 return $dbh->selectcol_arrayref($PENDING_WEBSERVICE_BATCHES_QRY);
914 =head2 GetImportBatchRangeDesc
916 my $results = GetImportBatchRangeDesc($offset, $results_per_group);
918 Returns a reference to an array of hash references corresponding to
919 import_batches rows (sorted in descending order by import_batch_id)
920 start at the given offset.
924 sub GetImportBatchRangeDesc {
925 my ($offset, $results_per_group) = @_;
927 my $dbh = C4::Context->dbh;
928 my $query = "SELECT * FROM import_batches
929 WHERE batch_type IN ('batch', 'webservice')
930 ORDER BY import_batch_id DESC";
932 if ($results_per_group){
933 $query .= " LIMIT ?";
934 push(@params, $results_per_group);
937 $query .= " OFFSET ?";
938 push(@params, $offset);
940 my $sth = $dbh->prepare_cached($query);
941 $sth->execute(@params);
942 my $results = $sth->fetchall_arrayref({});
947 =head2 GetItemNumbersFromImportBatch
949 my @itemsnos = GetItemNumbersFromImportBatch($batch_id);
953 sub GetItemNumbersFromImportBatch {
955 my $dbh = C4::Context->dbh;
956 my $sth = $dbh->prepare("SELECT itemnumber FROM import_batches,import_records,import_items WHERE import_batches.import_batch_id=import_records.import_batch_id AND import_records.import_record_id=import_items.import_record_id AND import_batches.import_batch_id=?");
957 $sth->execute($batch_id);
959 while ( my ($itm) = $sth->fetchrow_array ) {
965 =head2 GetNumberOfImportBatches
967 my $count = GetNumberOfImportBatches();
971 sub GetNumberOfNonZ3950ImportBatches {
972 my $dbh = C4::Context->dbh;
973 my $sth = $dbh->prepare("SELECT COUNT(*) FROM import_batches WHERE batch_type != 'z3950'");
975 my ($count) = $sth->fetchrow_array();
980 =head2 GetImportRecordsRange
982 my $results = GetImportRecordsRange($batch_id, $offset, $results_per_group);
984 Returns a reference to an array of hash references corresponding to
985 import_biblios/import_auths/import_records rows for a given batch
986 starting at the given offset.
990 sub GetImportRecordsRange {
991 my ($batch_id, $offset, $results_per_group, $status) = @_;
993 my $dbh = C4::Context->dbh;
994 my $query = "SELECT title, author, isbn, issn, authorized_heading, import_records.import_record_id,
995 record_sequence, status, overlay_status,
996 matched_biblionumber, matched_authid, record_type
998 LEFT JOIN import_auths ON (import_records.import_record_id=import_auths.import_record_id)
999 LEFT JOIN import_biblios ON (import_records.import_record_id=import_biblios.import_record_id)
1000 WHERE import_batch_id = ?";
1002 push(@params, $batch_id);
1004 $query .= " AND status=?";
1005 push(@params,$status);
1007 $query.=" ORDER BY import_record_id";
1009 if($results_per_group){
1010 $query .= " LIMIT ?";
1011 push(@params, $results_per_group);
1014 $query .= " OFFSET ?";
1015 push(@params, $offset);
1017 my $sth = $dbh->prepare_cached($query);
1018 $sth->execute(@params);
1019 my $results = $sth->fetchall_arrayref({});
1025 =head2 GetBestRecordMatch
1027 my $record_id = GetBestRecordMatch($import_record_id);
1031 sub GetBestRecordMatch {
1032 my ($import_record_id) = @_;
1034 my $dbh = C4::Context->dbh;
1035 my $sth = $dbh->prepare("SELECT candidate_match_id
1036 FROM import_record_matches
1037 WHERE import_record_id = ?
1038 ORDER BY score DESC, candidate_match_id DESC");
1039 $sth->execute($import_record_id);
1040 my ($record_id) = $sth->fetchrow_array();
1045 =head2 GetImportBatchStatus
1047 my $status = GetImportBatchStatus($batch_id);
1051 sub GetImportBatchStatus {
1052 my ($batch_id) = @_;
1054 my $dbh = C4::Context->dbh;
1055 my $sth = $dbh->prepare("SELECT import_status FROM import_batches WHERE import_batch_id = ?");
1056 $sth->execute($batch_id);
1057 my ($status) = $sth->fetchrow_array();
1063 =head2 SetImportBatchStatus
1065 SetImportBatchStatus($batch_id, $new_status);
1069 sub SetImportBatchStatus {
1070 my ($batch_id, $new_status) = @_;
1072 my $dbh = C4::Context->dbh;
1073 my $sth = $dbh->prepare("UPDATE import_batches SET import_status = ? WHERE import_batch_id = ?");
1074 $sth->execute($new_status, $batch_id);
1079 =head2 GetImportBatchOverlayAction
1081 my $overlay_action = GetImportBatchOverlayAction($batch_id);
1085 sub GetImportBatchOverlayAction {
1086 my ($batch_id) = @_;
1088 my $dbh = C4::Context->dbh;
1089 my $sth = $dbh->prepare("SELECT overlay_action FROM import_batches WHERE import_batch_id = ?");
1090 $sth->execute($batch_id);
1091 my ($overlay_action) = $sth->fetchrow_array();
1093 return $overlay_action;
1098 =head2 SetImportBatchOverlayAction
1100 SetImportBatchOverlayAction($batch_id, $new_overlay_action);
1104 sub SetImportBatchOverlayAction {
1105 my ($batch_id, $new_overlay_action) = @_;
1107 my $dbh = C4::Context->dbh;
1108 my $sth = $dbh->prepare("UPDATE import_batches SET overlay_action = ? WHERE import_batch_id = ?");
1109 $sth->execute($new_overlay_action, $batch_id);
1114 =head2 GetImportBatchNoMatchAction
1116 my $nomatch_action = GetImportBatchNoMatchAction($batch_id);
1120 sub GetImportBatchNoMatchAction {
1121 my ($batch_id) = @_;
1123 my $dbh = C4::Context->dbh;
1124 my $sth = $dbh->prepare("SELECT nomatch_action FROM import_batches WHERE import_batch_id = ?");
1125 $sth->execute($batch_id);
1126 my ($nomatch_action) = $sth->fetchrow_array();
1128 return $nomatch_action;
1133 =head2 SetImportBatchNoMatchAction
1135 SetImportBatchNoMatchAction($batch_id, $new_nomatch_action);
1139 sub SetImportBatchNoMatchAction {
1140 my ($batch_id, $new_nomatch_action) = @_;
1142 my $dbh = C4::Context->dbh;
1143 my $sth = $dbh->prepare("UPDATE import_batches SET nomatch_action = ? WHERE import_batch_id = ?");
1144 $sth->execute($new_nomatch_action, $batch_id);
1149 =head2 GetImportBatchItemAction
1151 my $item_action = GetImportBatchItemAction($batch_id);
1155 sub GetImportBatchItemAction {
1156 my ($batch_id) = @_;
1158 my $dbh = C4::Context->dbh;
1159 my $sth = $dbh->prepare("SELECT item_action FROM import_batches WHERE import_batch_id = ?");
1160 $sth->execute($batch_id);
1161 my ($item_action) = $sth->fetchrow_array();
1163 return $item_action;
1168 =head2 SetImportBatchItemAction
1170 SetImportBatchItemAction($batch_id, $new_item_action);
1174 sub SetImportBatchItemAction {
1175 my ($batch_id, $new_item_action) = @_;
1177 my $dbh = C4::Context->dbh;
1178 my $sth = $dbh->prepare("UPDATE import_batches SET item_action = ? WHERE import_batch_id = ?");
1179 $sth->execute($new_item_action, $batch_id);
1184 =head2 GetImportBatchMatcher
1186 my $matcher_id = GetImportBatchMatcher($batch_id);
1190 sub GetImportBatchMatcher {
1191 my ($batch_id) = @_;
1193 my $dbh = C4::Context->dbh;
1194 my $sth = $dbh->prepare("SELECT matcher_id FROM import_batches WHERE import_batch_id = ?");
1195 $sth->execute($batch_id);
1196 my ($matcher_id) = $sth->fetchrow_array();
1203 =head2 SetImportBatchMatcher
1205 SetImportBatchMatcher($batch_id, $new_matcher_id);
1209 sub SetImportBatchMatcher {
1210 my ($batch_id, $new_matcher_id) = @_;
1212 my $dbh = C4::Context->dbh;
1213 my $sth = $dbh->prepare("UPDATE import_batches SET matcher_id = ? WHERE import_batch_id = ?");
1214 $sth->execute($new_matcher_id, $batch_id);
1219 =head2 GetImportRecordOverlayStatus
1221 my $overlay_status = GetImportRecordOverlayStatus($import_record_id);
1225 sub GetImportRecordOverlayStatus {
1226 my ($import_record_id) = @_;
1228 my $dbh = C4::Context->dbh;
1229 my $sth = $dbh->prepare("SELECT overlay_status FROM import_records WHERE import_record_id = ?");
1230 $sth->execute($import_record_id);
1231 my ($overlay_status) = $sth->fetchrow_array();
1233 return $overlay_status;
1238 =head2 SetImportRecordOverlayStatus
1240 SetImportRecordOverlayStatus($import_record_id, $new_overlay_status);
1244 sub SetImportRecordOverlayStatus {
1245 my ($import_record_id, $new_overlay_status) = @_;
1247 my $dbh = C4::Context->dbh;
1248 my $sth = $dbh->prepare("UPDATE import_records SET overlay_status = ? WHERE import_record_id = ?");
1249 $sth->execute($new_overlay_status, $import_record_id);
1254 =head2 GetImportRecordStatus
1256 my $overlay_status = GetImportRecordStatus($import_record_id);
1260 sub GetImportRecordStatus {
1261 my ($import_record_id) = @_;
1263 my $dbh = C4::Context->dbh;
1264 my $sth = $dbh->prepare("SELECT status FROM import_records WHERE import_record_id = ?");
1265 $sth->execute($import_record_id);
1266 my ($overlay_status) = $sth->fetchrow_array();
1268 return $overlay_status;
1273 =head2 SetImportRecordStatus
1275 SetImportRecordStatus($import_record_id, $new_overlay_status);
1279 sub SetImportRecordStatus {
1280 my ($import_record_id, $new_overlay_status) = @_;
1282 my $dbh = C4::Context->dbh;
1283 my $sth = $dbh->prepare("UPDATE import_records SET status = ? WHERE import_record_id = ?");
1284 $sth->execute($new_overlay_status, $import_record_id);
1289 =head2 GetImportRecordMatches
1291 my $results = GetImportRecordMatches($import_record_id, $best_only);
1295 sub GetImportRecordMatches {
1296 my $import_record_id = shift;
1297 my $best_only = @_ ? shift : 0;
1299 my $dbh = C4::Context->dbh;
1300 # FIXME currently biblio only
1301 my $sth = $dbh->prepare_cached("SELECT title, author, biblionumber,
1302 candidate_match_id, score, record_type
1304 JOIN import_record_matches USING (import_record_id)
1305 LEFT JOIN biblio ON (biblionumber = candidate_match_id)
1306 WHERE import_record_id = ?
1307 ORDER BY score DESC, biblionumber DESC");
1308 $sth->bind_param(1, $import_record_id);
1311 while (my $row = $sth->fetchrow_hashref) {
1312 if ($row->{'record_type'} eq 'auth') {
1313 $row->{'authorized_heading'} = C4::AuthoritiesMarc::GetAuthorizedHeading( { authid => $row->{'candidate_match_id'} } );
1315 next if ($row->{'record_type'} eq 'biblio' && not $row->{'biblionumber'});
1316 push @$results, $row;
1326 =head2 SetImportRecordMatches
1328 SetImportRecordMatches($import_record_id, @matches);
1332 sub SetImportRecordMatches {
1333 my $import_record_id = shift;
1336 my $dbh = C4::Context->dbh;
1337 my $delsth = $dbh->prepare("DELETE FROM import_record_matches WHERE import_record_id = ?");
1338 $delsth->execute($import_record_id);
1341 my $sth = $dbh->prepare("INSERT INTO import_record_matches (import_record_id, candidate_match_id, score)
1343 foreach my $match (@matches) {
1344 $sth->execute($import_record_id, $match->{'record_id'}, $match->{'score'});
1349 # internal functions
1351 sub _create_import_record {
1352 my ($batch_id, $record_sequence, $marc_record, $record_type, $encoding, $z3950random, $marc_type) = @_;
1354 my $dbh = C4::Context->dbh;
1355 my $sth = $dbh->prepare("INSERT INTO import_records (import_batch_id, record_sequence, marc, marcxml,
1356 record_type, encoding, z3950random)
1357 VALUES (?, ?, ?, ?, ?, ?, ?)");
1358 $sth->execute($batch_id, $record_sequence, $marc_record->as_usmarc(), $marc_record->as_xml($marc_type),
1359 $record_type, $encoding, $z3950random);
1360 my $import_record_id = $dbh->{'mysql_insertid'};
1362 return $import_record_id;
1365 sub _update_import_record_marc {
1366 my ($import_record_id, $marc_record, $marc_type) = @_;
1368 my $dbh = C4::Context->dbh;
1369 my $sth = $dbh->prepare("UPDATE import_records SET marc = ?, marcxml = ?
1370 WHERE import_record_id = ?");
1371 $sth->execute($marc_record->as_usmarc(), $marc_record->as_xml($marc_type), $import_record_id);
1375 sub _add_auth_fields {
1376 my ($import_record_id, $marc_record) = @_;
1379 if ($marc_record->field('001')) {
1380 $controlnumber = $marc_record->field('001')->data();
1382 my $authorized_heading = C4::AuthoritiesMarc::GetAuthorizedHeading({ record => $marc_record });
1383 my $dbh = C4::Context->dbh;
1384 my $sth = $dbh->prepare("INSERT INTO import_auths (import_record_id, control_number, authorized_heading) VALUES (?, ?, ?)");
1385 $sth->execute($import_record_id, $controlnumber, $authorized_heading);
1389 sub _add_biblio_fields {
1390 my ($import_record_id, $marc_record) = @_;
1392 my ($title, $author, $isbn, $issn) = _parse_biblio_fields($marc_record);
1393 my $dbh = C4::Context->dbh;
1394 # FIXME no controlnumber, originalsource
1395 $isbn = C4::Koha::_isbn_cleanup($isbn); # FIXME C4::Koha::_isbn_cleanup should be made public
1396 my $sth = $dbh->prepare("INSERT INTO import_biblios (import_record_id, title, author, isbn, issn) VALUES (?, ?, ?, ?, ?)");
1397 $sth->execute($import_record_id, $title, $author, $isbn, $issn);
1402 sub _update_biblio_fields {
1403 my ($import_record_id, $marc_record) = @_;
1405 my ($title, $author, $isbn, $issn) = _parse_biblio_fields($marc_record);
1406 my $dbh = C4::Context->dbh;
1407 # FIXME no controlnumber, originalsource
1408 # FIXME 2 - should regularize normalization of ISBN wherever it is done
1412 my $sth = $dbh->prepare("UPDATE import_biblios SET title = ?, author = ?, isbn = ?, issn = ?
1413 WHERE import_record_id = ?");
1414 $sth->execute($title, $author, $isbn, $issn, $import_record_id);
1418 sub _parse_biblio_fields {
1419 my ($marc_record) = @_;
1421 my $dbh = C4::Context->dbh;
1422 my $bibliofields = TransformMarcToKoha($dbh, $marc_record, '');
1423 return ($bibliofields->{'title'}, $bibliofields->{'author'}, $bibliofields->{'isbn'}, $bibliofields->{'issn'});
1427 sub _update_batch_record_counts {
1428 my ($batch_id) = @_;
1430 my $dbh = C4::Context->dbh;
1431 my $sth = $dbh->prepare_cached("UPDATE import_batches SET
1435 WHERE import_batch_id = import_batches.import_batch_id),
1439 JOIN import_items USING (import_record_id)
1440 WHERE import_batch_id = import_batches.import_batch_id
1441 AND record_type = 'biblio')
1442 WHERE import_batch_id = ?");
1443 $sth->bind_param(1, $batch_id);
1448 sub _get_commit_action {
1449 my ($overlay_action, $nomatch_action, $item_action, $overlay_status, $import_record_id, $record_type) = @_;
1451 if ($record_type eq 'biblio') {
1452 my ($bib_result, $bib_match, $item_result);
1454 if ($overlay_status ne 'no_match') {
1455 $bib_match = GetBestRecordMatch($import_record_id);
1456 if ($overlay_action eq 'replace') {
1457 $bib_result = defined($bib_match) ? 'replace' : 'create_new';
1458 } elsif ($overlay_action eq 'create_new') {
1459 $bib_result = 'create_new';
1460 } elsif ($overlay_action eq 'ignore') {
1461 $bib_result = 'ignore';
1463 $item_result = ($item_action eq 'always_add' or $item_action eq 'add_only_for_matches') ? 'create_new' : 'ignore';
1465 $bib_result = $nomatch_action;
1466 $item_result = ($item_action eq 'always_add' or $item_action eq 'add_only_for_new') ? 'create_new' : 'ignore';
1468 return ($bib_result, $item_result, $bib_match);
1469 } else { # must be auths
1470 my ($auth_result, $auth_match);
1472 if ($overlay_status ne 'no_match') {
1473 $auth_match = GetBestRecordMatch($import_record_id);
1474 if ($overlay_action eq 'replace') {
1475 $auth_result = defined($auth_match) ? 'replace' : 'create_new';
1476 } elsif ($overlay_action eq 'create_new') {
1477 $auth_result = 'create_new';
1478 } elsif ($overlay_action eq 'ignore') {
1479 $auth_result = 'ignore';
1482 $auth_result = $nomatch_action;
1485 return ($auth_result, undef, $auth_match);
1490 sub _get_revert_action {
1491 my ($overlay_action, $overlay_status, $status) = @_;
1495 if ($status eq 'ignored') {
1496 $bib_result = 'ignore';
1498 if ($overlay_action eq 'create_new') {
1499 $bib_result = 'delete';
1501 $bib_result = ($overlay_status eq 'match_applied') ? 'restore' : 'delete';
1512 Koha Development Team <http://koha-community.org/>
1514 Galen Charlton <galen.charlton@liblime.com>