1 package OpenILS::Application::Vandelay;
2 use strict; use warnings;
3 use OpenILS::Application;
4 use base qw/OpenILS::Application/;
5 use Unicode::Normalize;
6 use OpenSRF::EX qw/:try/;
7 use OpenSRF::AppSession;
8 use OpenSRF::Utils::SettingsClient;
9 use OpenSRF::Utils::Cache;
10 use OpenILS::Utils::Fieldmapper;
11 use OpenILS::Utils::CStoreEditor qw/:funcs/;
14 use MARC::File::XML ( BinaryEncoding => 'UTF-8' );
15 use Time::HiRes qw(time);
16 use OpenSRF::Utils::Logger qw/$logger/;
18 use OpenILS::Const qw/:const/;
19 use OpenILS::Application::AppUtils;
20 use OpenILS::Application::Cat::BibCommon;
21 use OpenILS::Application::Cat::AuthCommon;
22 use OpenILS::Application::Cat::AssetCommon;
23 my $U = 'OpenILS::Application::AppUtils';
25 # A list of LDR/06 values from http://loc.gov/marc
52 # --------------------------------------------------------------------------------
55 sub create_bib_queue {
62 my $match_set = shift;
63 my $import_def = shift;
65 my $e = new_editor(authtoken => $auth, xact => 1);
67 return $e->die_event unless $e->checkauth;
68 return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
69 $owner ||= $e->requestor->id;
71 if ($e->search_vandelay_bib_queue( {name => $name, owner => $owner, queue_type => $type})->[0]) {
73 return OpenILS::Event->new('BIB_QUEUE_EXISTS')
76 my $queue = new Fieldmapper::vandelay::bib_queue();
77 $queue->name( $name );
78 $queue->owner( $owner );
79 $queue->queue_type( $type ) if ($type);
80 $queue->item_attr_def( $import_def ) if ($import_def);
81 $queue->match_set($match_set) if $match_set;
83 my $new_q = $e->create_vandelay_bib_queue( $queue );
84 return $e->die_event unless ($new_q);
89 __PACKAGE__->register_method(
90 api_name => "open-ils.vandelay.bib_queue.create",
91 method => "create_bib_queue",
97 sub create_auth_queue {
104 my $match_set = shift;
106 my $e = new_editor(authtoken => $auth, xact => 1);
108 return $e->die_event unless $e->checkauth;
109 return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
110 $owner ||= $e->requestor->id;
112 if ($e->search_vandelay_bib_queue({name => $name, owner => $owner, queue_type => $type})->[0]) {
114 return OpenILS::Event->new('AUTH_QUEUE_EXISTS')
117 my $queue = new Fieldmapper::vandelay::authority_queue();
118 $queue->name( $name );
119 $queue->owner( $owner );
120 $queue->queue_type( $type ) if ($type);
122 my $new_q = $e->create_vandelay_authority_queue( $queue );
123 $e->die_event unless ($new_q);
128 __PACKAGE__->register_method(
129 api_name => "open-ils.vandelay.authority_queue.create",
130 method => "create_auth_queue",
135 sub add_record_to_bib_queue {
142 my $bib_source = shift;
144 my $e = new_editor(authtoken => $auth, xact => 1);
146 $queue = $e->retrieve_vandelay_bib_queue($queue);
148 return $e->die_event unless $e->checkauth;
149 return $e->die_event unless
150 ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
151 $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
153 my $new_rec = _add_bib_rec($e, $marc, $queue->id, $purpose, $bib_source);
155 return $e->die_event unless ($new_rec);
159 __PACKAGE__->register_method(
160 api_name => "open-ils.vandelay.queued_bib_record.create",
161 method => "add_record_to_bib_queue",
171 my $bib_source = shift;
173 my $rec = new Fieldmapper::vandelay::queued_bib_record();
175 $rec->queue( $queue );
176 $rec->purpose( $purpose ) if ($purpose);
177 $rec->bib_source($bib_source);
179 return $e->create_vandelay_queued_bib_record( $rec );
182 sub add_record_to_authority_queue {
190 my $e = new_editor(authtoken => $auth, xact => 1);
192 $queue = $e->retrieve_vandelay_authority_queue($queue);
194 return $e->die_event unless $e->checkauth;
195 return $e->die_event unless
196 ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
197 $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
199 my $new_rec = _add_auth_rec($e, $marc, $queue->id, $purpose);
201 return $e->die_event unless ($new_rec);
205 __PACKAGE__->register_method(
206 api_name => "open-ils.vandelay.queued_authority_record.create",
207 method => "add_record_to_authority_queue",
218 my $rec = new Fieldmapper::vandelay::queued_authority_record();
220 $rec->queue( $queue );
221 $rec->purpose( $purpose ) if ($purpose);
223 return $e->create_vandelay_queued_authority_record( $rec );
230 my $fingerprint = shift || '';
231 my $queue_id = shift;
233 my $filename = shift;
234 my $bib_source = shift;
236 my $e = new_editor(authtoken => $auth, xact => 1);
237 return $e->die_event unless $e->checkauth;
240 my $type = $self->{record_type};
243 $queue = $e->retrieve_vandelay_bib_queue($queue_id) or return $e->die_event;
245 $queue = $e->retrieve_vandelay_authority_queue($queue_id) or return $e->die_event;
248 my $evt = check_queue_perms($e, $type, $queue);
249 return $evt if ($evt);
251 my $cache = new OpenSRF::Utils::Cache();
254 my $data = $cache->get_cache('vandelay_import_spool_' . $fingerprint);
255 $purpose = $data->{purpose};
256 $filename = $data->{path};
257 $bib_source = $data->{bib_source};
260 unless(-r $filename) {
261 $logger->error("unable to read MARC file $filename");
262 return -1; # make this an event XXX
265 $logger->info("vandelay spooling $fingerprint purpose=$purpose file=$filename");
267 my $marctype = 'USMARC';
270 $marctype = 'XML' if (getc(F) =~ /^\D/o);
273 my $batch = new MARC::Batch ($marctype, $filename);
276 my $response_scale = 10;
279 while (try { $r = $batch->next } otherwise { $r = -1 }) {
281 $logger->warn("Processing of record $count in set $filename failed. Skipping this record");
285 $logger->info("processing record $count");
288 (my $xml = $r->as_xml_record()) =~ s/\n//sog;
289 $xml =~ s/^<\?xml.+\?\s*>//go;
290 $xml =~ s/>\s+</></go;
291 $xml =~ s/\p{Cc}//go;
292 $xml = $U->entityize($xml);
293 $xml =~ s/[\x00-\x1f]//go;
296 # Check the leader to ensure we've got something resembling the expected
297 # Allow spaces to give records the benefit of the doubt
298 my $ldr_type = substr($r->leader(), 6, 1);
299 if ($type eq 'bib' && ($record_types{$ldr_type}) eq 'bib' || $ldr_type eq ' ') {
300 $qrec = _add_bib_rec( $e, $xml, $queue_id, $purpose, $bib_source ) or return $e->die_event;
301 } elsif ($type eq 'auth' && ($record_types{$ldr_type}) eq 'auth' || $ldr_type eq ' ') {
302 $qrec = _add_auth_rec( $e, $xml, $queue_id, $purpose ) or return $e->die_event;
304 # I don't know how to handle this type; rock on
305 $logger->error("In process_spool(), type was $type and leader type was $ldr_type ; not currently supported");
309 if($self->api_name =~ /stream_results/ and $qrec) {
310 $client->respond($qrec->id)
312 $client->respond($count) if (++$count % $response_scale) == 0;
313 $response_scale *= 10 if ($count == ($response_scale * 10));
317 $logger->warn("Encountered a bad record at Vandelay ingest: ".$error);
323 $cache->delete_cache('vandelay_import_spool_' . $fingerprint) if $fingerprint;
327 __PACKAGE__->register_method(
328 api_name => "open-ils.vandelay.bib.process_spool",
329 method => "process_spool",
335 __PACKAGE__->register_method(
336 api_name => "open-ils.vandelay.auth.process_spool",
337 method => "process_spool",
341 record_type => 'auth'
344 __PACKAGE__->register_method(
345 api_name => "open-ils.vandelay.bib.process_spool.stream_results",
346 method => "process_spool",
353 __PACKAGE__->register_method(
354 api_name => "open-ils.vandelay.auth.process_spool.stream_results",
355 method => "process_spool",
360 record_type => 'auth'
363 __PACKAGE__->register_method(
364 api_name => "open-ils.vandelay.bib_queue.records.retrieve",
365 method => 'retrieve_queued_records',
371 __PACKAGE__->register_method(
372 api_name => "open-ils.vandelay.bib_queue.records.retrieve.export.print",
373 method => 'retrieve_queued_records',
379 __PACKAGE__->register_method(
380 api_name => "open-ils.vandelay.bib_queue.records.retrieve.export.csv",
381 method => 'retrieve_queued_records',
387 __PACKAGE__->register_method(
388 api_name => "open-ils.vandelay.bib_queue.records.retrieve.export.email",
389 method => 'retrieve_queued_records',
396 __PACKAGE__->register_method(
397 api_name => "open-ils.vandelay.auth_queue.records.retrieve",
398 method => 'retrieve_queued_records',
402 record_type => 'auth'
404 __PACKAGE__->register_method(
405 api_name => "open-ils.vandelay.auth_queue.records.retrieve.export.print",
406 method => 'retrieve_queued_records',
410 record_type => 'auth'
412 __PACKAGE__->register_method(
413 api_name => "open-ils.vandelay.auth_queue.records.retrieve.export.csv",
414 method => 'retrieve_queued_records',
418 record_type => 'auth'
420 __PACKAGE__->register_method(
421 api_name => "open-ils.vandelay.auth_queue.records.retrieve.export.email",
422 method => 'retrieve_queued_records',
426 record_type => 'auth'
429 __PACKAGE__->register_method(
430 api_name => "open-ils.vandelay.bib_queue.records.matches.retrieve",
431 method => 'retrieve_queued_records',
435 record_type => 'bib',
437 desc => q/Only retrieve queued bib records that have matches against existing records/
440 __PACKAGE__->register_method(
441 api_name => "open-ils.vandelay.auth_queue.records.matches.retrieve",
442 method => 'retrieve_queued_records',
446 record_type => 'auth',
448 desc => q/Only retrieve queued authority records that have matches against existing records/
452 sub retrieve_queued_records {
453 my($self, $conn, $auth, $queue_id, $options) = @_;
456 my $limit = $$options{limit} || 20;
457 my $offset = $$options{offset} || 0;
458 my $type = $self->{record_type};
460 my $e = new_editor(authtoken => $auth, xact => 1);
461 return $e->die_event unless $e->checkauth;
465 $queue = $e->retrieve_vandelay_bib_queue($queue_id) or return $e->die_event;
467 $queue = $e->retrieve_vandelay_authority_queue($queue_id) or return $e->die_event;
469 my $evt = check_queue_perms($e, $type, $queue);
470 return $evt if ($evt);
472 my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
474 select => {$class => ['id']},
476 where => {queue => $queue_id},
478 order_by => {$class => ['id']},
482 if($self->api_name =~ /export/) {
483 delete $query->{limit};
484 delete $query->{offset};
487 $query->{where}->{import_time} = undef if $$options{non_imported};
489 if($$options{with_import_error}) {
491 $query->{from} = {$class => {vii => {type => 'left'}}};
492 $query->{where}->{'-or'} = [
493 {'+vqbr' => {import_error => {'!=' => undef}}},
494 {'+vii' => {import_error => {'!=' => undef}}}
499 if($$options{with_rec_import_error}) {
500 $query->{where}->{import_error} = {'!=' => undef};
502 } elsif( $$options{with_item_import_error} and $type eq 'bib') {
504 $query->{from} = {$class => 'vii'};
505 $query->{where}->{'+vii'} = {import_error => {'!=' => undef}};
509 if($self->api_name =~ /matches/) {
510 # find only records that have matches
511 my $mclass = $type eq 'bib' ? 'vbm' : 'vam';
512 $query->{from} = {$class => {$mclass => {type => 'right'}}};
515 my $record_ids = $e->json_query($query);
517 my $retrieve = ($type eq 'bib') ?
518 'retrieve_vandelay_queued_bib_record' : 'retrieve_vandelay_queued_authority_record';
519 my $search = ($type eq 'bib') ?
520 'search_vandelay_queued_bib_record' : 'search_vandelay_queued_authority_record';
522 if ($self->api_name =~ /export/) {
523 my $rec_list = $e->$search({id => [map { $_->{id} } @$record_ids]}, {substream => 1});
524 if ($self->api_name =~ /print/) {
527 return $U->fire_object_event(
529 'vandelay.queued_'.$type.'_record.print',
534 } elsif ($self->api_name =~ /csv/) {
537 return $U->fire_object_event(
539 'vandelay.queued_'.$type.'_record.csv',
544 } elsif ($self->api_name =~ /email/) {
546 $conn->respond_complete(1);
548 for my $rec (@$rec_list) {
549 $U->create_events_for_hook(
550 'vandelay.queued_'.$type.'_record.email',
552 $e->requestor->home_ou,
561 for my $rec_id (@$record_ids) {
562 my $flesh = ['attributes', 'matches'];
563 push(@$flesh, 'import_items') if $$options{flesh_import_items};
564 my $params = {flesh => 1, flesh_fields => {$class => $flesh}};
565 my $rec = $e->$retrieve([$rec_id->{id}, $params]);
566 $rec->clear_marc if $$options{clear_marc};
567 $conn->respond($rec);
575 __PACKAGE__->register_method(
576 api_name => 'open-ils.vandelay.import_item.queue.retrieve',
577 method => 'retrieve_queue_import_items',
583 Returns Import Item (vii) objects for the selected queue.
585 with_import_error : only return items that failed to import
588 __PACKAGE__->register_method(
589 api_name => 'open-ils.vandelay.import_item.queue.export.print',
590 method => 'retrieve_queue_import_items',
596 Returns template-generated printable output of Import Item (vii) objects for the selected queue.
598 with_import_error : only return items that failed to import
601 __PACKAGE__->register_method(
602 api_name => 'open-ils.vandelay.import_item.queue.export.csv',
603 method => 'retrieve_queue_import_items',
609 Returns template-generated CSV output of Import Item (vii) objects for the selected queue.
611 with_import_error : only return items that failed to import
614 __PACKAGE__->register_method(
615 api_name => 'open-ils.vandelay.import_item.queue.export.email',
616 method => 'retrieve_queue_import_items',
622 Emails template-generated output of Import Item (vii) objects for the selected queue.
624 with_import_error : only return items that failed to import
628 sub retrieve_queue_import_items {
629 my($self, $conn, $auth, $q_id, $options) = @_;
632 my $limit = $$options{limit} || 20;
633 my $offset = $$options{offset} || 0;
635 my $e = new_editor(authtoken => $auth);
636 return $e->event unless $e->checkauth;
638 my $queue = $e->retrieve_vandelay_bib_queue($q_id) or return $e->event;
639 my $evt = check_queue_perms($e, 'bib', $queue);
643 select => {vii => ['id']},
651 filter => {id => $q_id}
657 order_by => {'vii' => ['record','id']},
661 if($self->api_name =~ /export/) {
662 delete $query->{limit};
663 delete $query->{offset};
666 $query->{where} = {'+vii' => {import_error => {'!=' => undef}}}
667 if $$options{with_import_error};
669 my $items = $e->json_query($query);
670 my $item_list = $e->search_vandelay_import_item({id => [map { $_->{id} } @$items]});
671 if ($self->api_name =~ /export/) {
672 if ($self->api_name =~ /print/) {
674 return $U->fire_object_event(
676 'vandelay.import_items.print',
681 } elsif ($self->api_name =~ /csv/) {
683 return $U->fire_object_event(
685 'vandelay.import_items.csv',
690 } elsif ($self->api_name =~ /email/) {
692 $conn->respond_complete(1);
694 for my $item (@$item_list) {
695 $U->create_events_for_hook(
696 'vandelay.import_items.email',
698 $e->requestor->home_ou,
707 for my $item (@$item_list) {
708 $conn->respond($item);
715 sub check_queue_perms {
716 my($e, $type, $queue) = @_;
717 if ($type eq 'bib') {
718 return $e->die_event unless
719 ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
720 $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
722 return $e->die_event unless
723 ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
724 $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
730 __PACKAGE__->register_method(
731 api_name => "open-ils.vandelay.bib_record.list.import",
732 method => 'import_record_list',
739 __PACKAGE__->register_method(
740 api_name => "open-ils.vandelay.auth_record.list.import",
741 method => 'import_record_list',
745 record_type => 'auth'
748 sub import_record_list {
749 my($self, $conn, $auth, $rec_ids, $args) = @_;
750 my $e = new_editor(authtoken => $auth, xact => 1);
751 return $e->die_event unless $e->checkauth;
753 my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $args);
754 try {$e->rollback} otherwise {};
756 return {complete => 1};
760 __PACKAGE__->register_method(
761 api_name => "open-ils.vandelay.bib_queue.import",
762 method => 'import_queue',
767 record_type => 'bib',
770 Attempts to import all non-imported records for the selected queue.
771 Will also attempt import of all non-imported items.
776 __PACKAGE__->register_method(
777 api_name => "open-ils.vandelay.auth_queue.import",
778 method => 'import_queue',
783 record_type => 'auth'
787 my($self, $conn, $auth, $q_id, $options) = @_;
788 my $e = new_editor(authtoken => $auth, xact => 1);
789 return $e->die_event unless $e->checkauth;
791 my $type = $self->{record_type};
792 my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
794 # First, collect the not-yet-imported records
795 my $query = {queue => $q_id, import_time => undef};
796 my $search = ($type eq 'bib') ?
797 'search_vandelay_queued_bib_record' :
798 'search_vandelay_queued_authority_record';
799 my $rec_ids = $e->$search($query, {idlist => 1});
801 # Now add any imported records that have un-imported items
804 my $item_recs = $e->json_query({
805 select => {vqbr => ['id']},
806 from => {vqbr => 'vii'},
810 import_time => {'!=' => undef}
812 '+vii' => {import_time => undef}
816 push(@$rec_ids, map {$_->{id}} @$item_recs);
819 my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $options);
820 try {$e->rollback} otherwise {}; # only using this to make the read authoritative -- don't die from it
822 return {complete => 1};
825 # returns a list of queued record IDs for a given queue that
826 # have at least one entry in the match table
828 sub queued_records_with_matches {
829 my($e, $type, $q_id, $limit, $offset, $filter) = @_;
831 my $match_class = 'vbm';
832 my $rec_class = 'vqbr';
833 if($type eq 'auth') {
834 $match_class = 'vam';
839 $filter->{queue} = $q_id;
843 select => {$match_class => ['queued_record']},
848 fkey => 'queued_record',
855 if($limit or defined $offset) {
858 $query->{limit} = $limit;
859 $query->{offset} = $offset;
862 my $data = $e->json_query($query);
863 return [ map {$_->{queued_record}} @$data ];
867 sub import_record_list_impl {
868 my($self, $conn, $rec_ids, $requestor, $args) = @_;
870 my $overlay_map = $args->{overlay_map} || {};
871 my $type = $self->{record_type};
878 total => scalar(@$rec_ids),
879 report_all => $$args{report_all}
882 my $auto_overlay_exact = $$args{auto_overlay_exact};
883 my $auto_overlay_1match = $$args{auto_overlay_1match};
884 my $auto_overlay_best = $$args{auto_overlay_best_match};
885 my $match_quality_ratio = $$args{match_quality_ratio};
886 my $merge_profile = $$args{merge_profile};
887 my $ft_merge_profile = $$args{fall_through_merge_profile};
888 my $bib_source = $$args{bib_source};
889 my $import_no_match = $$args{import_no_match};
891 my $overlay_func = 'vandelay.overlay_bib_record';
892 my $auto_overlay_func = 'vandelay.auto_overlay_bib_record';
893 my $auto_overlay_best_func = 'vandelay.auto_overlay_bib_record_with_best'; # XXX bib-only
894 my $retrieve_func = 'retrieve_vandelay_queued_bib_record';
895 my $update_func = 'update_vandelay_queued_bib_record';
896 my $search_func = 'search_vandelay_queued_bib_record';
897 my $retrieve_queue_func = 'retrieve_vandelay_bib_queue';
898 my $update_queue_func = 'update_vandelay_bib_queue';
899 my $rec_class = 'vqbr';
901 my $editor = new_editor();
904 my $sources = $editor->search_config_bib_source({id => {'!=' => undef}});
905 $bib_sources{$_->id} = $_->source for @$sources;
907 if($type eq 'auth') {
908 $overlay_func =~ s/bib/auth/o;
909 $auto_overlay_func = s/bib/auth/o;
910 $retrieve_func =~ s/bib/authority/o;
911 $retrieve_queue_func =~ s/bib/authority/o;
912 $update_queue_func =~ s/bib/authority/o;
913 $update_func =~ s/bib/authority/o;
914 $search_func =~ s/bib/authority/o;
919 for my $rec_id (@$rec_ids) {
922 my $overlay_target = $overlay_map->{$rec_id};
924 my $e = new_editor(xact => 1);
925 $e->requestor($requestor);
927 $$report_args{e} = $e;
928 $$report_args{evt} = undef;
929 $$report_args{import_error} = undef;
931 my $rec = $e->$retrieve_func([
934 flesh_fields => { $rec_class => ['matches']},
939 $$report_args{evt} = $e->event;
940 finish_rec_import_attempt($report_args);
944 if($rec->import_time) {
945 # if the record is already imported, that means it may have
946 # un-imported copies. Add to success list for later processing.
947 push(@success_rec_ids, $rec_id);
952 $$report_args{rec} = $rec;
953 $queues{$rec->queue} = 1;
958 if(defined $overlay_target) {
959 # Caller chose an explicit overlay target
961 my $res = $e->json_query(
972 if($res and ($res = $res->[0])) {
974 if($res->{$overlay_func} eq 't') {
975 $logger->info("vl: $type direct overlay succeeded for queued rec ".
976 "$rec_id and overlay target $overlay_target");
982 $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
987 if($auto_overlay_1match) { # overlay if there is exactly 1 match
989 my %match_recs = map { $_->eg_record => 1 } @{$rec->matches};
991 if( scalar(keys %match_recs) == 1) { # all matches point to the same record
993 ($imported, $error, $rec) = try_auto_overlay(
996 $auto_overlay_best_func,
1000 $match_quality_ratio,
1007 if(!$imported and !$error and $auto_overlay_exact and scalar(@{$rec->matches}) == 1 ) {
1009 # caller says to overlay if there is an /exact/ match
1010 # $auto_overlay_func only proceeds and returns true on exact matches
1012 my $res = $e->json_query(
1022 if($res and ($res = $res->[0])) {
1024 if($res->{$auto_overlay_func} eq 't') {
1025 $logger->info("vl: $type auto-overlay succeeded for queued rec $rec_id");
1028 # re-fetch the record to pick up the imported_as value from the DB
1029 $$report_args{rec} = $rec = $e->$retrieve_func([
1030 $rec_id, {flesh => 1, flesh_fields => {$rec_class => ['matches']}}]);
1033 $logger->info("vl: $type auto-overlay failed for queued rec $rec_id");
1038 $logger->error("vl: Error attempting overlay with func=$auto_overlay_func, profile=$merge_profile, record=$rec_id");
1042 if(!$imported and !$error and $auto_overlay_best and scalar(@{$rec->matches}) > 0 ) {
1043 # caller says to overlay the best match
1045 ($imported, $error, $rec) = try_auto_overlay(
1048 $auto_overlay_best_func,
1052 $match_quality_ratio,
1058 if(!$imported and !$error and $import_no_match and scalar(@{$rec->matches}) == 0) {
1060 # No overlay / merge occurred. Do a traditional record import by creating a new record
1062 $logger->info("vl: creating new $type record for queued record $rec_id");
1063 if($type eq 'bib') {
1064 $record = OpenILS::Application::Cat::BibCommon->biblio_record_xml_import(
1065 $e, $rec->marc, $bib_sources{$rec->bib_source}, undef, 1);
1068 $record = OpenILS::Application::Cat::AuthCommon->import_authority_record($e, $rec->marc); #$source);
1071 if($U->event_code($record)) {
1072 $$report_args{import_error} = 'import.duplicate.tcn'
1073 if $record->{textcode} eq 'OPEN_TCN_NOT_FOUND';
1074 $$report_args{evt} = $record;
1078 $logger->info("vl: successfully imported new $type record");
1079 $rec->imported_as($record->id);
1087 $rec->import_time('now');
1088 $rec->clear_import_error;
1089 $rec->clear_error_detail;
1091 if($e->$update_func($rec)) {
1093 push @success_rec_ids, $rec_id;
1094 finish_rec_import_attempt($report_args);
1102 $logger->info("vl: record $rec_id was not imported");
1103 $$report_args{evt} = $e->event unless $$report_args{evt};
1104 finish_rec_import_attempt($report_args);
1108 # see if we need to mark any queues as complete
1109 for my $q_id (keys %queues) {
1111 my $e = new_editor(xact => 1);
1112 my $remaining = $e->$search_func(
1113 [{queue => $q_id, import_time => undef}, {limit =>1}], {idlist => 1});
1115 unless(@$remaining) {
1116 my $queue = $e->$retrieve_queue_func($q_id);
1118 unless($U->is_true($queue->complete)) {
1119 $queue->complete('t');
1120 $e->$update_queue_func($queue) or return $e->die_event;
1129 import_record_asset_list_impl($conn, \@success_rec_ids, $requestor) if @success_rec_ids;
1131 $conn->respond({total => $$report_args{total}, progress => $$report_args{progress}});
1136 sub try_auto_overlay {
1139 my $report_args = shift;
1140 my $overlay_func = shift;
1141 my $retrieve_func = shift;
1142 my $rec_class = shift;
1144 my $match_quality_ratio = shift;
1145 my $merge_profile = shift;
1146 my $ft_merge_profile = shift;
1151 # Find the best match and overlay if the quality ratio allows it.
1152 my $res = $e->json_query(
1158 $match_quality_ratio
1163 if($res and ($res = $res->[0])) {
1165 if($res->{$overlay_func} eq 't') {
1167 # first attempt succeeded
1172 # quality-limited merge failed with insufficient quality. If there is a
1173 # fall-through merge profile, re-do the merge with the alternate profile
1174 # and no quality restriction.
1176 if($ft_merge_profile and $match_quality_ratio > 0) {
1178 $logger->info("vl: $type auto-merge failed with profile $merge_profile; ".
1179 "re-merging with fall-through profile $ft_merge_profile");
1181 my $res = $e->json_query(
1187 0 # minimum quality not required
1192 if($res and ($res = $res->[0])) {
1194 if($res->{$overlay_func} eq 't') {
1196 # second attempt succeeded
1201 # failed to merge on second attempt
1202 $logger->info("vl: $type auto-merge with fall-through failed for queued rec $rec_id");
1206 # second attempt died
1208 $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
1213 # failed to merge on first attempt, no fall-through was provided
1214 $$report_args{import_error} = 'overlay.record.quality' if $match_quality_ratio > 0;
1215 $logger->info("vl: $type auto-merge failed for queued rec $rec_id");
1221 # first attempt died
1223 $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
1228 # at least 1 of the attempts succeeded
1229 $logger->info("vl: $type auto-merge succeeded for queued rec $rec_id");
1231 # re-fetch the record to pick up the imported_as value from the DB
1232 $$report_args{rec} = $e->$retrieve_func([
1233 $rec_id, {flesh => 1, flesh_fields => {$rec_class => ['matches']}}]);
1236 return ($imported, $error, $$report_args{rec});
1240 # tracks any import errors, commits the current xact, responds to the client
1241 sub finish_rec_import_attempt {
1243 my $evt = $$args{evt};
1244 my $rec = $$args{rec};
1247 my $error = $$args{import_error};
1248 $error = 'general.unknown' if $evt and not $error;
1253 if($error or $evt) {
1255 # since an error occurred, there's no guarantee the transaction wasn't
1256 # rolled back. force a rollback and create a new editor.
1258 $e = new_editor(xact => 1);
1259 $rec->import_error($error);
1262 my $detail = sprintf("%s : %s", $evt->{textcode}, substr($evt->{desc}, 0, 140));
1263 $rec->error_detail($detail);
1266 my $method = 'update_vandelay_queued_bib_record';
1267 $method =~ s/bib/authority/ if $$args{type} eq 'auth';
1268 $e->$method($rec) and $e->commit or $e->rollback;
1271 # commit the successful import
1276 # requested queued record was not found
1281 if($$args{report_all} or ($$args{progress} % $$args{step}) == 0) {
1282 $$args{conn}->respond({
1283 total => $$args{total},
1284 progress => $$args{progress},
1285 imported => ($rec) ? $rec->id : undef,
1288 $$args{step} *= 2 unless $$args{step} == 256;
1298 __PACKAGE__->register_method(
1299 api_name => "open-ils.vandelay.bib_queue.owner.retrieve",
1300 method => 'owner_queue_retrieve',
1304 record_type => 'bib'
1306 __PACKAGE__->register_method(
1307 api_name => "open-ils.vandelay.authority_queue.owner.retrieve",
1308 method => 'owner_queue_retrieve',
1312 record_type => 'auth'
1315 sub owner_queue_retrieve {
1316 my($self, $conn, $auth, $owner_id, $filters) = @_;
1317 my $e = new_editor(authtoken => $auth, xact => 1);
1318 return $e->die_event unless $e->checkauth;
1319 $owner_id = $e->requestor->id; # XXX add support for viewing other's queues?
1322 my $search = {owner => $owner_id};
1323 $search->{$_} = $filters->{$_} for keys %$filters;
1325 if($self->{record_type} eq 'bib') {
1326 $queues = $e->search_vandelay_bib_queue(
1327 [$search, {order_by => {vbq => 'evergreen.lowercase(name)'}}]);
1329 $queues = $e->search_vandelay_authority_queue(
1330 [$search, {order_by => {vaq => 'evergreen.lowercase(name)'}}]);
1332 $conn->respond($_) for @$queues;
1337 __PACKAGE__->register_method(
1338 api_name => "open-ils.vandelay.bib_queue.delete",
1339 method => "delete_queue",
1342 record_type => 'bib'
1344 __PACKAGE__->register_method(
1345 api_name => "open-ils.vandelay.auth_queue.delete",
1346 method => "delete_queue",
1349 record_type => 'auth'
1353 my($self, $conn, $auth, $q_id) = @_;
1354 my $e = new_editor(xact => 1, authtoken => $auth);
1355 return $e->die_event unless $e->checkauth;
1356 if($self->{record_type} eq 'bib') {
1357 return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
1358 my $queue = $e->retrieve_vandelay_bib_queue($q_id)
1359 or return $e->die_event;
1360 $e->delete_vandelay_bib_queue($queue)
1361 or return $e->die_event;
1363 return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
1364 my $queue = $e->retrieve_vandelay_authority_queue($q_id)
1365 or return $e->die_event;
1366 $e->delete_vandelay_authority_queue($queue)
1367 or return $e->die_event;
1374 __PACKAGE__->register_method(
1375 api_name => "open-ils.vandelay.queued_bib_record.html",
1376 method => 'queued_record_html',
1380 record_type => 'bib'
1382 __PACKAGE__->register_method(
1383 api_name => "open-ils.vandelay.queued_authority_record.html",
1384 method => 'queued_record_html',
1388 record_type => 'auth'
1391 sub queued_record_html {
1392 my($self, $conn, $auth, $rec_id) = @_;
1393 my $e = new_editor(xact=>1,authtoken => $auth);
1394 return $e->die_event unless $e->checkauth;
1396 if($self->{record_type} eq 'bib') {
1397 $rec = $e->retrieve_vandelay_queued_bib_record($rec_id)
1398 or return $e->die_event;
1400 $rec = $e->retrieve_vandelay_queued_authority_record($rec_id)
1401 or return $e->die_event;
1405 return $U->simplereq(
1407 'open-ils.search.biblio.record.html', undef, 1, $rec->marc);
1411 __PACKAGE__->register_method(
1412 api_name => "open-ils.vandelay.bib_queue.summary.retrieve",
1413 method => 'retrieve_queue_summary',
1417 record_type => 'bib'
1419 __PACKAGE__->register_method(
1420 api_name => "open-ils.vandelay.auth_queue.summary.retrieve",
1421 method => 'retrieve_queue_summary',
1425 record_type => 'auth'
1428 sub retrieve_queue_summary {
1429 my($self, $conn, $auth, $queue_id) = @_;
1430 my $e = new_editor(xact=>1, authtoken => $auth);
1431 return $e->die_event unless $e->checkauth;
1434 my $type = $self->{record_type};
1435 if($type eq 'bib') {
1436 $queue = $e->retrieve_vandelay_bib_queue($queue_id)
1437 or return $e->die_event;
1439 $queue = $e->retrieve_vandelay_authority_queue($queue_id)
1440 or return $e->die_event;
1443 my $evt = check_queue_perms($e, $type, $queue);
1444 return $evt if $evt;
1446 my $search = 'search_vandelay_queued_bib_record';
1447 $search =~ s/bib/authority/ if $type ne 'bib';
1451 total => scalar(@{$e->$search({queue => $queue_id}, {idlist=>1})}),
1452 imported => scalar(@{$e->$search({queue => $queue_id, import_time => {'!=' => undef}}, {idlist=>1})}),
1455 my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
1456 $summary->{rec_import_errors} = $e->json_query({
1457 select => {$class => [{alias => 'count', column => 'id', transform => 'count', aggregate => 1}]},
1459 where => {queue => $queue_id, import_error => {'!=' => undef}}
1462 if($type eq 'bib') {
1464 # count of all items attached to records in the queue in question
1466 select => {vii => [{alias => 'count', column => 'id', transform => 'count', aggregate => 1}]},
1471 select => {vqbr => ['id']},
1473 where => {queue => $queue_id}
1478 $summary->{total_items} = $e->json_query($query)->[0]->{count};
1480 # count of items we attempted to import, but errored, attached to records in the queue in question
1481 $query->{where}->{import_error} = {'!=' => undef};
1482 $summary->{item_import_errors} = $e->json_query($query)->[0]->{count};
1484 # count of items we successfully imported attached to records in the queue in question
1485 delete $query->{where}->{import_error};
1486 $query->{where}->{import_time} = {'!=' => undef};
1487 $summary->{total_items_imported} = $e->json_query($query)->[0]->{count};
1493 # --------------------------------------------------------------------------------
1494 # Given a list of queued record IDs, imports all items attached to those records
1495 # --------------------------------------------------------------------------------
1496 sub import_record_asset_list_impl {
1497 my($conn, $rec_ids, $requestor) = @_;
1499 my $roe = new_editor(xact=> 1, requestor => $requestor);
1501 # for speed, filter out any records have not been
1502 # imported or have no import items to load
1503 $rec_ids = $roe->json_query({
1504 select => {vqbr => ['id']},
1505 from => {vqbr => 'vii'},
1506 where => {'+vqbr' => {
1508 import_time => {'!=' => undef}
1512 $rec_ids = [map {$_->{id}} @$rec_ids];
1516 total => scalar(@$rec_ids),
1517 step => 1, # how often to respond
1522 for my $rec_id (@$rec_ids) {
1523 my $rec = $roe->retrieve_vandelay_queued_bib_record($rec_id);
1524 my $item_ids = $roe->search_vandelay_import_item(
1525 {record => $rec->id, import_error => undef},
1529 for my $item_id (@$item_ids) {
1530 my $e = new_editor(requestor => $requestor, xact => 1);
1531 my $item = $e->retrieve_vandelay_import_item($item_id);
1532 $$report_args{import_item} = $item;
1533 $$report_args{e} = $e;
1534 $$report_args{import_error} = undef;
1535 $$report_args{evt} = undef;
1537 # --------------------------------------------------------------------------------
1538 # Find or create the volume
1539 # --------------------------------------------------------------------------------
1541 OpenILS::Application::Cat::AssetCommon->find_or_create_volume(
1542 $e, $item->call_number, $rec->imported_as, $item->owning_lib);
1546 $$report_args{evt} = $evt;
1547 respond_with_status($report_args);
1551 # --------------------------------------------------------------------------------
1552 # Create the new copy
1553 # --------------------------------------------------------------------------------
1554 my $copy = Fieldmapper::asset::copy->new;
1555 $copy->loan_duration(2);
1556 $copy->fine_level(2);
1557 $copy->barcode($item->barcode);
1558 $copy->location($item->location);
1559 $copy->circ_lib($item->circ_lib || $item->owning_lib);
1560 $copy->status( defined($item->status) ? $item->status : OILS_COPY_STATUS_IN_PROCESS );
1561 $copy->circulate($item->circulate);
1562 $copy->deposit($item->deposit);
1563 $copy->deposit_amount($item->deposit_amount);
1564 $copy->ref($item->ref);
1565 $copy->holdable($item->holdable);
1566 $copy->price($item->price);
1567 $copy->circ_as_type($item->circ_as_type);
1568 $copy->alert_message($item->alert_message);
1569 $copy->opac_visible($item->opac_visible);
1570 $copy->circ_modifier($item->circ_modifier);
1572 # --------------------------------------------------------------------------------
1573 # Check for dupe barcode
1574 # --------------------------------------------------------------------------------
1575 if($evt = OpenILS::Application::Cat::AssetCommon->create_copy($e, $vol, $copy)) {
1576 $$report_args{evt} = $evt;
1577 $$report_args{import_error} = 'import.item.duplicate.barcode'
1578 if $evt->{textcode} eq 'ITEM_BARCODE_EXISTS';
1579 respond_with_status($report_args);
1583 # --------------------------------------------------------------------------------
1585 # --------------------------------------------------------------------------------
1586 $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
1587 $e, $copy, '', $item->pub_note, 1) if $item->pub_note;
1590 $$report_args{evt} = $evt;
1591 respond_with_status($report_args);
1595 $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
1596 $e, $copy, '', $item->priv_note) if $item->priv_note;
1599 $$report_args{evt} = $evt;
1600 respond_with_status($report_args);
1604 # set the import data on the import item
1605 $item->imported_as($copy->id); # $copy->id is set by create_copy() ^--
1606 $item->import_time('now');
1608 unless($e->update_vandelay_import_item($item)) {
1609 $$report_args{evt} = $e->die_event;
1610 respond_with_status($report_args);
1614 # --------------------------------------------------------------------------------
1615 # Item import succeeded
1616 # --------------------------------------------------------------------------------
1618 $$report_args{in_count}++;
1619 respond_with_status($report_args);
1620 $logger->info("vl: successfully imported item " . $item->barcode);
1630 sub respond_with_status {
1634 # If the import failed, track the failure reason
1636 my $error = $$args{import_error};
1637 my $evt = $$args{evt};
1639 if($error or $evt) {
1641 my $item = $$args{import_item};
1642 $logger->info("vl: unable to import item " . $item->barcode);
1644 $error ||= 'general.unknown';
1645 $item->import_error($error);
1648 my $detail = sprintf("%s : %s", $evt->{textcode}, substr($evt->{desc}, 0, 140));
1649 $item->error_detail($detail);
1652 # state of the editor is unknown at this point. Force a rollback and start over.
1654 $e = new_editor(xact => 1);
1655 $e->update_vandelay_import_item($item);
1659 if($$args{report_all} or ($$args{progress} % $$args{step}) == 0) {
1660 $$args{conn}->respond({
1661 total => $$args{total},
1662 progress => $$args{progress},
1663 success_count => $$args{success_count},
1666 $$args{step} *= 2 unless $$args{step} == 256;
1672 __PACKAGE__->register_method(
1673 api_name => "open-ils.vandelay.match_set.get_tree",
1674 method => "match_set_get_tree",
1678 desc => q/For a given vms object, return a tree of match set points
1679 represented by a vmsp object with recursively fleshed
1684 sub match_set_get_tree {
1685 my ($self, $conn, $authtoken, $match_set_id) = @_;
1687 $match_set_id = int($match_set_id) or return;
1689 my $e = new_editor("authtoken" => $authtoken);
1690 $e->checkauth or return $e->die_event;
1692 my $set = $e->retrieve_vandelay_match_set($match_set_id) or
1693 return $e->die_event;
1695 $e->allowed("ADMIN_IMPORT_MATCH_SET", $set->owner) or
1696 return $e->die_event;
1698 my $tree = $e->search_vandelay_match_set_point([
1699 {"match_set" => $match_set_id, "parent" => undef},
1700 {"flesh" => -1, "flesh_fields" => {"vmsp" => ["children"]}}
1701 ]) or return $e->die_event;
1707 __PACKAGE__->register_method(
1708 api_name => "open-ils.vandelay.match_set.update",
1709 method => "match_set_update_tree",
1713 desc => q/Replace any vmsp objects associated with a given (by ID) vms
1714 with the given objects (recursively fleshed vmsp tree)./
1718 sub _walk_new_vmsp {
1719 my ($e, $match_set_id, $node, $parent_id) = @_;
1721 my $point = new Fieldmapper::vandelay::match_set_point;
1722 $point->parent($parent_id);
1723 $point->match_set($match_set_id);
1724 $point->$_($node->$_) for (qw/bool_op svf tag subfield negate quality/);
1726 $e->create_vandelay_match_set_point($point) or return $e->die_event;
1728 $parent_id = $e->data->id;
1729 if ($node->children && @{$node->children}) {
1730 for (@{$node->children}) {
1731 return $e->die_event if
1732 _walk_new_vmsp($e, $match_set_id, $_, $parent_id);
1739 sub match_set_update_tree {
1740 my ($self, $conn, $authtoken, $match_set_id, $tree) = @_;
1742 my $e = new_editor("xact" => 1, "authtoken" => $authtoken);
1743 $e->checkauth or return $e->die_event;
1745 my $set = $e->retrieve_vandelay_match_set($match_set_id) or
1746 return $e->die_event;
1748 $e->allowed("ADMIN_IMPORT_MATCH_SET", $set->owner) or
1749 return $e->die_event;
1751 my $existing = $e->search_vandelay_match_set_point([
1752 {"match_set" => $match_set_id},
1753 {"order_by" => {"vmsp" => "id DESC"}}
1754 ]) or return $e->die_event;
1756 # delete points, working up from leaf points to the root
1758 for my $point (shift @$existing) {
1759 if( grep {$_->parent eq $point->id} @$existing) {
1760 push(@$existing, $point);
1762 $e->delete_vandelay_match_set_point($point) or return $e->die_event;
1767 _walk_new_vmsp($e, $match_set_id, $tree);
1769 $e->commit or return $e->die_event;
1772 __PACKAGE__->register_method(
1773 api_name => 'open-ils.vandelay.bib_queue.to_bucket',
1774 method => 'bib_queue_to_bucket',
1778 desc => q/Add to or create a new bib container (bucket) with the successfully
1779 imported contents of a vandelay queue. Any user that has Vandelay
1780 queue create permissions can append or create buckets from his-her own queues./,
1782 {desc => 'Authtoken', type => 'string'},
1783 {desc => 'Queue ID', type => 'number'},
1784 {desc => 'Bucket Name', type => 'string'}
1786 return => {desc => q/
1787 {bucket => $bucket, addcount => number-of-items-added-to-bucket, item_count => total-bucket-item-count} on success,
1788 {add_count => 0} if there is nothing to do, and Event on error/}
1792 sub bib_queue_to_bucket {
1793 my ($self, $conn, $auth, $q_id, $bucket_name) = @_;
1795 my $e = new_editor(xact => 1, authtoken => $auth);
1796 return $e->die_event unless $e->checkauth;
1798 my $queue = $e->retrieve_vandelay_bib_queue($q_id)
1799 or return $e->die_event;
1801 return OpenILS::Event->new('BAD_PARAMS',
1802 note => q/Bucket creator must be queue owner/)
1803 unless $queue->owner == $e->requestor->id;
1805 # find the bib IDs that will go into the bucket
1806 my $bib_ids = $e->json_query({
1807 select => {vqbr => ['imported_as']},
1809 where => {queue => $q_id, imported_as => {'!=' => undef}}
1812 if (!@$bib_ids) { # no records to add
1814 return {add_count => 0};
1817 # allow user to add to an existing bucket by name
1818 my $bucket = $e->search_container_biblio_record_entry_bucket({
1819 owner => $e->requestor->id,
1820 name => $bucket_name,
1821 btype => 'vandelay_queue'
1824 # if the bucket does not exist, create a new one
1826 $bucket = Fieldmapper::container::biblio_record_entry_bucket->new;
1827 $bucket->name($bucket_name);
1828 $bucket->owner($e->requestor->id);
1829 $bucket->btype('vandelay_queue');
1831 $e->create_container_biblio_record_entry_bucket($bucket)
1832 or return $e->die_event;
1835 # create the new bucket items
1836 for my $bib_id ( map {$_->{imported_as}} @$bib_ids ) {
1837 my $item = Fieldmapper::container::biblio_record_entry_bucket_item->new;
1838 $item->target_biblio_record_entry($bib_id);
1839 $item->bucket($bucket->id);
1840 $e->create_container_biblio_record_entry_bucket_item($item)
1841 or return $e->die_event;
1844 # re-fetch the bucket to pick up the correct create_time
1845 $bucket = $e->retrieve_container_biblio_record_entry_bucket($bucket->id)
1846 or return $e->die_event;
1848 # get the total count of items in this bucket
1849 my $count = $e->json_query({
1850 select => {cbrebi => [{
1852 transform => 'count',
1857 where => {bucket => $bucket->id}
1864 add_count => scalar(@$bib_ids), # items added to the bucket
1865 item_count => $count->{count} # total items in buckets