use C4::Context;
use C4::Koha;
use C4::Biblio;
-use C4::Matcher;
-require Exporter;
-
+use C4::Items;
use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
-# set the version for version checking
-$VERSION = 3.00;
-
-=head1 NAME
-
-C4::ImportBatch - manage batches of imported MARC records
-
-=head1 SYNOPSIS
-
-=over 4
-
-use C4::ImportBatch;
-
-=back
-
-=head1 FUNCTIONS
-
-=cut
-
-@ISA = qw(Exporter);
-@EXPORT = qw(
+BEGIN {
+ # set the version for version checking
+ $VERSION = 3.01;
+ require Exporter;
+ @ISA = qw(Exporter);
+ @EXPORT = qw(
GetZ3950BatchId
GetImportRecordMarc
AddImportBatch
BatchCommitBibRecords
BatchRevertBibRecords
+ GetAllImportBatches
GetImportBatchRangeDesc
GetNumberOfNonZ3950ImportBatches
GetImportBibliosRange
SetImportBatchStatus
GetImportBatchOverlayAction
SetImportBatchOverlayAction
+ GetImportBatchMatcher
+ SetImportBatchMatcher
GetImportRecordOverlayStatus
SetImportRecordOverlayStatus
GetImportRecordStatus
SetImportRecordStatus
GetImportRecordMatches
SetImportRecordMatches
-);
+ );
+}
+
+=head1 NAME
+
+C4::ImportBatch - manage batches of imported MARC records
+
+=head1 SYNOPSIS
+
+=over 4
+
+use C4::ImportBatch;
+
+=back
+
+=head1 FUNCTIONS
=head2 GetZ3950BatchId
=head2 GetImportRecordMarc
-=over4
+=over 4
my ($marcblob, $encoding) = GetImportRecordMarc($import_record_id);
=over 4
-($batch_id, $num_records, @invalid_records) = BatchStageMarcRecords($marc_flavor, $marc_records, $file_name,
- $comments, $branch_code, $leave_as_staging);
+($batch_id, $num_records, $num_items, @invalid_records) =
+ BatchStageMarcRecords($marc_flavor, $marc_records, $file_name,
+ $comments, $branch_code, $parse_items,
+ $leave_as_staging,
+ $progress_interval, $progress_callback);
=back
=cut
sub BatchStageMarcRecords {
- my ($marc_flavor, $marc_records, $file_name, $comments, $branch_code, $leave_as_staging) = @_;
-
+ my $marc_flavor = shift;
+ my $marc_records = shift;
+ my $file_name = shift;
+ my $comments = shift;
+ my $branch_code = shift;
+ my $parse_items = shift;
+ my $leave_as_staging = shift;
+
+ # optional callback to monitor status
+ # of job
+ my $progress_interval = 0;
+ my $progress_callback = undef;
+ if ($#_ == 1) {
+ $progress_interval = shift;
+ $progress_callback = shift;
+ $progress_interval = 0 unless $progress_interval =~ /^\d+$/ and $progress_interval > 0;
+ $progress_interval = 0 unless 'CODE' eq ref $progress_callback;
+ }
+
my $batch_id = AddImportBatch('create_new', 'staging', 'batch', $file_name, $comments);
my @invalid_records = ();
my $num_valid = 0;
+ my $num_items = 0;
# FIXME - for now, we're dealing only with bibs
my $rec_num = 0;
foreach my $marc_blob (split(/\x1D/, $marc_records)) {
$rec_num++;
+ if ($progress_interval and (0 == ($rec_num % $progress_interval))) {
+ &$progress_callback($rec_num);
+ }
my $marc_record = FixEncoding($marc_blob, "\x1D");
my $import_record_id;
if (scalar($marc_record->fields()) == 0) {
} else {
$num_valid++;
$import_record_id = AddBiblioToBatch($batch_id, $rec_num, $marc_record, $marc_flavor, int(rand(99999)), 0);
+ if ($parse_items) {
+ my @import_items_ids = AddItemsToImportBiblio($batch_id, $import_record_id, $marc_record, 0);
+ $num_items += scalar(@import_items_ids);
+ }
}
}
unless ($leave_as_staging) {
}
# FIXME branch_code, number of bibs, number of items
_update_batch_record_counts($batch_id);
- return ($batch_id, $num_valid, @invalid_records);
+ return ($batch_id, $num_valid, $num_items, @invalid_records);
+}
+
+=head2 AddItemsToImportBiblio
+
+=over 4
+
+my @import_items_ids = AddItemsToImportBiblio($batch_id, $import_record_id, $marc_record, $update_counts);
+
+=back
+
+=cut
+
+sub AddItemsToImportBiblio {
+ my $batch_id = shift;
+ my $import_record_id = shift;
+ my $marc_record = shift;
+ my $update_counts = @_ ? shift : 0;
+
+ my @import_items_ids = ();
+
+ my $dbh = C4::Context->dbh;
+ my ($item_tag,$item_subfield) = &GetMarcFromKohaField("items.itemnumber",'');
+ foreach my $item_field ($marc_record->field($item_tag)) {
+ my $item_marc = MARC::Record->new();
+ $item_marc->append_fields($item_field);
+ $marc_record->delete_field($item_field);
+ my $sth = $dbh->prepare_cached("INSERT INTO import_items (import_record_id, status, marcxml)
+ VALUES (?, ?, ?)");
+ $sth->bind_param(1, $import_record_id);
+ $sth->bind_param(2, 'staged');
+ $sth->bind_param(3, $item_marc->as_xml());
+ $sth->execute();
+ push @import_items_ids, $dbh->{'mysql_insertid'};
+ $sth->finish();
+ }
+
+ if ($#import_items_ids > -1) {
+ _update_batch_record_counts($batch_id) if $update_counts;
+ _update_import_record_marc($import_record_id, $marc_record);
+ }
+ return @import_items_ids;
}
=head2 BatchFindBibDuplicates
-=over4
+=over 4
-my $num_with_matches = BatchFindBibDuplicates($batch_id, $matcher, $max_matches);
+my $num_with_matches = BatchFindBibDuplicates($batch_id, $matcher, $max_matches, $progress_interval, $progress_callback);
=back
Goes through the records loaded in the batch and attempts to
find duplicates for each one. Sets the overlay action to
-'replace' if it was 'create_new', and sets the overlay status
-of each record to 'no_match' or 'auto_match' as appropriate.
+"replace" if it was "create_new", and sets the overlay status
+of each record to "no_match" or "auto_match" as appropriate.
The $max_matches parameter is optional; if it is not supplied,
it defaults to 10.
+The $progress_interval and $progress_callback parameters are
+optional; if both are supplied, the sub referred to by
+$progress_callback will be invoked every $progress_interval
+records using the number of records processed as the
+singular argument.
+
=cut
sub BatchFindBibDuplicates {
my $matcher = shift;
my $max_matches = @_ ? shift : 10;
+ # optional callback to monitor status
+ # of job
+ my $progress_interval = 0;
+ my $progress_callback = undef;
+ if ($#_ == 1) {
+ $progress_interval = shift;
+ $progress_callback = shift;
+ $progress_interval = 0 unless $progress_interval =~ /^\d+$/ and $progress_interval > 0;
+ $progress_interval = 0 unless 'CODE' eq ref $progress_callback;
+ }
+
my $dbh = C4::Context->dbh;
my $old_overlay_action = GetImportBatchOverlayAction($batch_id);
if ($old_overlay_action eq "create_new") {
WHERE import_batch_id = ?");
$sth->execute($batch_id);
my $num_with_matches = 0;
+ my $rec_num = 0;
while (my $rowref = $sth->fetchrow_hashref) {
+ $rec_num++;
+ if ($progress_interval and (0 == ($rec_num % $progress_interval))) {
+ &$progress_callback($rec_num);
+ }
my $marc_record = MARC::Record->new_from_usmarc($rowref->{'marc'});
- my @matches = $matcher->get_matches($marc_record, $max_matches);
+ my @matches = ();
+ if (defined $matcher) {
+ @matches = $matcher->get_matches($marc_record, $max_matches);
+ }
if (scalar(@matches) > 0) {
$num_with_matches++;
SetImportRecordMatches($rowref->{'import_record_id'}, @matches);
SetImportRecordOverlayStatus($rowref->{'import_record_id'}, 'auto_match');
} else {
+ SetImportRecordMatches($rowref->{'import_record_id'}, ());
SetImportRecordOverlayStatus($rowref->{'import_record_id'}, 'no_match');
}
}
=over 4
-my ($num_added, $num_updated, $num_ignored) = BatchCommitBibRecords($batch_id);
+my ($num_added, $num_updated, $num_items_added, $num_items_errored, $num_ignored) =
+ BatchCommitBibRecords($batch_id, $progress_interval, $progress_callback);
=back
sub BatchCommitBibRecords {
my $batch_id = shift;
+ # optional callback to monitor status
+ # of job
+ my $progress_interval = 0;
+ my $progress_callback = undef;
+ if ($#_ == 1) {
+ $progress_interval = shift;
+ $progress_callback = shift;
+ $progress_interval = 0 unless $progress_interval =~ /^\d+$/ and $progress_interval > 0;
+ $progress_interval = 0 unless 'CODE' eq ref $progress_callback;
+ }
+
my $num_added = 0;
my $num_updated = 0;
+ my $num_items_added = 0;
+ my $num_items_errored = 0;
my $num_ignored = 0;
# commit (i.e., save, all records in the batch)
# FIXME biblio only at the moment
SetImportBatchStatus('importing');
my $overlay_action = GetImportBatchOverlayAction($batch_id);
my $dbh = C4::Context->dbh;
- my $sth = $dbh->prepare("SELECT import_record_id, status, overlay_status, marc
+ my $sth = $dbh->prepare("SELECT import_record_id, status, overlay_status, marc, encoding
FROM import_records
JOIN import_biblios USING (import_record_id)
WHERE import_batch_id = ?");
$sth->execute($batch_id);
+ my $rec_num = 0;
while (my $rowref = $sth->fetchrow_hashref) {
+ $rec_num++;
+ if ($progress_interval and (0 == ($rec_num % $progress_interval))) {
+ &$progress_callback($rec_num);
+ }
if ($rowref->{'status'} eq 'error' or $rowref->{'status'} eq 'imported') {
$num_ignored++;
}
+
my $marc_record = MARC::Record->new_from_usmarc($rowref->{'marc'});
+
+ # remove any item tags - rely on BatchCommitItems
+ my ($item_tag,$item_subfield) = &GetMarcFromKohaField("items.itemnumber",'');
+ foreach my $item_field ($marc_record->field($item_tag)) {
+ $marc_record->delete_field($item_field);
+ }
+
if ($overlay_action eq 'create_new' or
($overlay_action eq 'replace' and $rowref->{'overlay_status'} eq 'no_match')) {
$num_added++;
my $sth = $dbh->prepare_cached("UPDATE import_biblios SET matched_biblionumber = ? WHERE import_record_id = ?");
$sth->execute($biblionumber, $rowref->{'import_record_id'});
$sth->finish();
+ my ($bib_items_added, $bib_items_errored) = BatchCommitItems($rowref->{'import_record_id'}, $biblionumber);
+ $num_items_added += $bib_items_added;
+ $num_items_errored += $bib_items_errored;
SetImportRecordStatus($rowref->{'import_record_id'}, 'imported');
} else {
$num_updated++;
my $biblionumber = GetBestRecordMatch($rowref->{'import_record_id'});
my ($count, $oldbiblio) = GetBiblio($biblionumber);
my $oldxml = GetXmlBiblio($biblionumber);
+
+ # remove item fields so that they don't get
+ # added again if record is reverted
+ my $old_marc = MARC::Record->new_from_xml($oldxml, 'UTF-8', $rowref->{'encoding'});
+ foreach my $item_field ($old_marc->field($item_tag)) {
+ $old_marc->delete_field($item_field);
+ }
+
ModBiblio($marc_record, $biblionumber, $oldbiblio->{'frameworkcode'});
my $sth = $dbh->prepare_cached("UPDATE import_records SET marcxml_old = ? WHERE import_record_id = ?");
- $sth->execute($oldxml, $rowref->{'import_record_id'});
+ $sth->execute($old_marc->as_xml(), $rowref->{'import_record_id'});
$sth->finish();
my $sth2 = $dbh->prepare_cached("UPDATE import_biblios SET matched_biblionumber = ? WHERE import_record_id = ?");
$sth2->execute($biblionumber, $rowref->{'import_record_id'});
$sth2->finish();
+ my ($bib_items_added, $bib_items_errored) = BatchCommitItems($rowref->{'import_record_id'}, $biblionumber);
+ $num_items_added += $bib_items_added;
+ $num_items_errored += $bib_items_errored;
SetImportRecordOverlayStatus($rowref->{'import_record_id'}, 'match_applied');
SetImportRecordStatus($rowref->{'import_record_id'}, 'imported');
}
}
$sth->finish();
SetImportBatchStatus($batch_id, 'imported');
- return ($num_added, $num_updated, $num_ignored);
+ return ($num_added, $num_updated, $num_items_added, $num_items_errored, $num_ignored);
+}
+
+=head2 BatchCommitItems
+
+=over 4
+
+($num_items_added, $num_items_errored) = BatchCommitItems($import_record_id, $biblionumber);
+
+=back
+
+=cut
+
+sub BatchCommitItems {
+ my ($import_record_id, $biblionumber) = @_;
+
+ my $dbh = C4::Context->dbh;
+
+ my $num_items_added = 0;
+ my $num_items_errored = 0;
+ my $sth = $dbh->prepare("SELECT import_items_id, import_items.marcxml, encoding
+ FROM import_items
+ JOIN import_records USING (import_record_id)
+ WHERE import_record_id = ?
+ ORDER BY import_items_id");
+ $sth->bind_param(1, $import_record_id);
+ $sth->execute();
+ while (my $row = $sth->fetchrow_hashref()) {
+ my $item_marc = MARC::Record->new_from_xml($row->{'marcxml'}, 'UTF-8', $row->{'encoding'});
+ # FIXME - duplicate barcode check needs to become part of AddItemFromMarc()
+ my $item = TransformMarcToKoha($dbh, $item_marc);
+ my $duplicate_barcode = exists($item->{'barcode'}) && GetItemnumberFromBarcode($item->{'barcode'});
+ if ($duplicate_barcode) {
+ my $updsth = $dbh->prepare("UPDATE import_items SET status = ?, import_error = ? WHERE import_items_id = ?");
+ $updsth->bind_param(1, 'error');
+ $updsth->bind_param(2, 'duplicate item barcode');
+ $updsth->bind_param(3, $row->{'import_items_id'});
+ $updsth->execute();
+ $num_items_errored++;
+ } else {
+ my ($item_biblionumber, $biblioitemnumber, $itemnumber) = AddItemFromMarc($item_marc, $biblionumber);
+ my $updsth = $dbh->prepare("UPDATE import_items SET status = ?, itemnumber = ? WHERE import_items_id = ?");
+ $updsth->bind_param(1, 'imported');
+ $updsth->bind_param(2, $itemnumber);
+ $updsth->bind_param(3, $row->{'import_items_id'});
+ $updsth->execute();
+ $updsth->finish();
+ $num_items_added++;
+ }
+ }
+ $sth->finish();
+ return ($num_items_added, $num_items_errored);
}
=head2 BatchRevertBibRecords
=over 4
-my ($num_deleted, $num_errors, $num_reverted, $num_ignored) = BatchRevertBibRecords($batch_id);
+my ($num_deleted, $num_errors, $num_reverted, $num_items_deleted, $num_ignored) = BatchRevertBibRecords($batch_id);
=back
my $num_deleted = 0;
my $num_errors = 0;
my $num_reverted = 0;
+ my $num_items_deleted = 0;
my $num_ignored = 0;
# commit (i.e., save, all records in the batch)
# FIXME biblio only at the moment
}
if ($overlay_action eq 'create_new' or
($overlay_action eq 'replace' and $rowref->{'overlay_status'} eq 'no_match')) {
+ $num_items_deleted += BatchRevertItems($rowref->{'import_record_id'}, $rowref->{'matched_biblionumber'});
my $error = DelBiblio($rowref->{'matched_biblionumber'});
if (defined $error) {
$num_errors++;
my $old_record = MARC::Record->new_from_xml($rowref->{'marcxml_old'}, 'UTF-8', $rowref->{'encoding'});
my $biblionumber = $rowref->{'matched_biblionumber'};
my ($count, $oldbiblio) = GetBiblio($biblionumber);
+ $num_items_deleted += BatchRevertItems($rowref->{'import_record_id'}, $rowref->{'matched_biblionumber'});
ModBiblio($old_record, $biblionumber, $oldbiblio->{'frameworkcode'});
SetImportRecordStatus($rowref->{'import_record_id'}, 'reverted');
}
}
$sth->finish();
SetImportBatchStatus($batch_id, 'reverted');
- return ($num_deleted, $num_errors, $num_reverted, $num_ignored);
+ return ($num_deleted, $num_errors, $num_reverted, $num_items_deleted, $num_ignored);
+}
+
+=head2 BatchRevertItems
+
+=over 4
+
+my $num_items_deleted = BatchRevertItems($import_record_id, $biblionumber);
+
+=back
+
+=cut
+
+sub BatchRevertItems {
+ my ($import_record_id, $biblionumber) = @_;
+
+ my $dbh = C4::Context->dbh;
+ my $num_items_deleted = 0;
+
+ my $sth = $dbh->prepare_cached("SELECT import_items_id, itemnumber
+ FROM import_items
+ JOIN items USING (itemnumber)
+ WHERE import_record_id = ?");
+ $sth->bind_param(1, $import_record_id);
+ $sth->execute();
+ while (my $row = $sth->fetchrow_hashref()) {
+ DelItem($dbh, $biblionumber, $row->{'itemnumber'});
+ my $updsth = $dbh->prepare("UPDATE import_items SET status = ? WHERE import_items_id = ?");
+ $updsth->bind_param(1, 'reverted');
+ $updsth->bind_param(2, $row->{'import_items_id'});
+ $updsth->execute();
+ $updsth->finish();
+ $num_items_deleted++;
+ }
+ $sth->finish();
+ return $num_items_deleted;
+}
+
+=head2 GetAllImportBatches
+
+=over 4
+
+my $results = GetAllImportBatches();
+
+=back
+
+Returns a references to an array of hash references corresponding
+to all import_batches rows (of batch_type 'batch'), sorted in
+ascending order by import_batch_id.
+
+=cut
+
+sub GetAllImportBatches {
+ my $dbh = C4::Context->dbh;
+ my $sth = $dbh->prepare_cached("SELECT * FROM import_batches
+ WHERE batch_type = 'batch'
+ ORDER BY import_batch_id ASC");
+
+ my $results = [];
+ $sth->execute();
+ while (my $row = $sth->fetchrow_hashref) {
+ push @$results, $row;
+ }
+ $sth->finish();
+ return $results;
}
=head2 GetImportBatchRangeDesc
}
+=head2 GetImportBatchMatcher
+
+=over 4
+
+my $matcher_id = GetImportBatchMatcher($batch_id);
+
+=back
+
+=cut
+
+sub GetImportBatchMatcher {
+ my ($batch_id) = @_;
+
+ my $dbh = C4::Context->dbh;
+ my $sth = $dbh->prepare("SELECT matcher_id FROM import_batches WHERE import_batch_id = ?");
+ $sth->execute($batch_id);
+ my ($matcher_id) = $sth->fetchrow_array();
+ $sth->finish();
+ return $matcher_id;
+
+}
+
+
+=head2 SetImportBatchMatcher
+
+=over 4
+
+SetImportBatchMatcher($batch_id, $new_matcher_id);
+
+=back
+
+=cut
+
+sub SetImportBatchMatcher {
+ my ($batch_id, $new_matcher_id) = @_;
+
+ my $dbh = C4::Context->dbh;
+ my $sth = $dbh->prepare("UPDATE import_batches SET matcher_id = ? WHERE import_batch_id = ?");
+ $sth->execute($new_matcher_id, $batch_id);
+ $sth->finish();
+
+}
+
=head2 GetImportRecordOverlayStatus
=over 4
sub _create_import_record {
my ($batch_id, $record_sequence, $marc_record, $record_type, $encoding, $z3950random) = @_;
-
+
my $dbh = C4::Context->dbh;
my $sth = $dbh->prepare("INSERT INTO import_records (import_batch_id, record_sequence, marc, marcxml,
record_type, encoding, z3950random)
$sth->bind_param(1, $batch_id);
$sth->execute();
$sth->finish();
+ $sth = $dbh->prepare_cached("UPDATE import_batches SET num_items = (
+ SELECT COUNT(*)
+ FROM import_records
+ JOIN import_items USING (import_record_id)
+ WHERE import_batch_id = import_batches.import_batch_id
+ AND record_type = 'biblio')
+ WHERE import_batch_id = ?");
+ $sth->bind_param(1, $batch_id);
+ $sth->execute();
+ $sth->finish();
}
1;
+__END__
=head1 AUTHOR