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/;
12 use OpenILS::Utils::Normalize qw/clean_marc/;
15 use MARC::File::XML ( BinaryEncoding => 'UTF-8' );
16 use Time::HiRes qw(time);
17 use OpenSRF::Utils::Logger qw/$logger/;
19 use OpenILS::Const qw/:const/;
20 use OpenILS::Application::AppUtils;
21 use OpenILS::Application::Cat::BibCommon;
22 use OpenILS::Application::Cat::AuthCommon;
23 use OpenILS::Application::Cat::AssetCommon;
24 my $U = 'OpenILS::Application::AppUtils';
26 # A list of LDR/06 values from http://loc.gov/marc
53 # --------------------------------------------------------------------------------
56 sub create_bib_queue {
63 my $match_set = shift;
64 my $import_def = shift;
66 my $e = new_editor(authtoken => $auth, xact => 1);
68 return $e->die_event unless $e->checkauth;
69 return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
70 $owner ||= $e->requestor->id;
72 if ($e->search_vandelay_bib_queue( {name => $name, owner => $owner, queue_type => $type})->[0]) {
74 return OpenILS::Event->new('BIB_QUEUE_EXISTS')
77 my $queue = new Fieldmapper::vandelay::bib_queue();
78 $queue->name( $name );
79 $queue->owner( $owner );
80 $queue->queue_type( $type ) if ($type);
81 $queue->item_attr_def( $import_def ) if ($import_def);
82 $queue->match_set($match_set) if $match_set;
84 my $new_q = $e->create_vandelay_bib_queue( $queue );
85 return $e->die_event unless ($new_q);
90 __PACKAGE__->register_method(
91 api_name => "open-ils.vandelay.bib_queue.create",
92 method => "create_bib_queue",
98 sub create_auth_queue {
105 my $match_set = shift;
107 my $e = new_editor(authtoken => $auth, xact => 1);
109 return $e->die_event unless $e->checkauth;
110 return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
111 $owner ||= $e->requestor->id;
113 if ($e->search_vandelay_authority_queue({name => $name, owner => $owner, queue_type => $type})->[0]) {
115 return OpenILS::Event->new('AUTH_QUEUE_EXISTS')
118 my $queue = new Fieldmapper::vandelay::authority_queue();
119 $queue->name( $name );
120 $queue->owner( $owner );
121 $queue->queue_type( $type ) if ($type);
123 my $new_q = $e->create_vandelay_authority_queue( $queue );
124 $e->die_event unless ($new_q);
129 __PACKAGE__->register_method(
130 api_name => "open-ils.vandelay.authority_queue.create",
131 method => "create_auth_queue",
136 sub add_record_to_bib_queue {
143 my $bib_source = shift;
145 my $e = new_editor(authtoken => $auth, xact => 1);
147 $queue = $e->retrieve_vandelay_bib_queue($queue);
149 return $e->die_event unless $e->checkauth;
150 return $e->die_event unless
151 ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
152 $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
154 my $new_rec = _add_bib_rec($e, $marc, $queue->id, $purpose, $bib_source);
156 return $e->die_event unless ($new_rec);
160 __PACKAGE__->register_method(
161 api_name => "open-ils.vandelay.queued_bib_record.create",
162 method => "add_record_to_bib_queue",
172 my $bib_source = shift;
174 my $rec = new Fieldmapper::vandelay::queued_bib_record();
176 $rec->queue( $queue );
177 $rec->purpose( $purpose ) if ($purpose);
178 $rec->bib_source($bib_source);
180 return $e->create_vandelay_queued_bib_record( $rec );
183 sub add_record_to_authority_queue {
191 my $e = new_editor(authtoken => $auth, xact => 1);
193 $queue = $e->retrieve_vandelay_authority_queue($queue);
195 return $e->die_event unless $e->checkauth;
196 return $e->die_event unless
197 ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
198 $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
200 my $new_rec = _add_auth_rec($e, $marc, $queue->id, $purpose);
202 return $e->die_event unless ($new_rec);
206 __PACKAGE__->register_method(
207 api_name => "open-ils.vandelay.queued_authority_record.create",
208 method => "add_record_to_authority_queue",
219 my $rec = new Fieldmapper::vandelay::queued_authority_record();
221 $rec->queue( $queue );
222 $rec->purpose( $purpose ) if ($purpose);
224 return $e->create_vandelay_queued_authority_record( $rec );
231 my $fingerprint = shift || '';
232 my $queue_id = shift;
234 my $filename = shift;
235 my $bib_source = shift;
237 my $e = new_editor(authtoken => $auth, xact => 1);
238 return $e->die_event unless $e->checkauth;
241 my $type = $self->{record_type};
244 $queue = $e->retrieve_vandelay_bib_queue($queue_id) or return $e->die_event;
246 $queue = $e->retrieve_vandelay_authority_queue($queue_id) or return $e->die_event;
249 my $evt = check_queue_perms($e, $type, $queue);
250 return $evt if ($evt);
252 my $cache = new OpenSRF::Utils::Cache();
255 my $data = $cache->get_cache('vandelay_import_spool_' . $fingerprint);
256 $purpose = $data->{purpose};
257 $filename = $data->{path};
258 $bib_source = $data->{bib_source};
261 unless(-r $filename) {
262 $logger->error("unable to read MARC file $filename");
263 return -1; # make this an event XXX
266 $logger->info("vandelay spooling $fingerprint purpose=$purpose file=$filename");
268 my $marctype = 'USMARC';
271 $marctype = 'XML' if (getc(F) =~ /^\D/o);
274 my $batch = new MARC::Batch ($marctype, $filename);
277 my $response_scale = 10;
280 while (try { $r = $batch->next } otherwise { $r = -1 }) {
282 $logger->warn("Processing of record $count in set $filename failed. Skipping this record");
286 $logger->info("processing record $count");
289 my $xml = clean_marc($r);
292 # Check the leader to ensure we've got something resembling the expected
293 # Allow spaces to give records the benefit of the doubt
294 my $ldr_type = substr($r->leader(), 6, 1);
295 if ($type eq 'bib' && ($record_types{$ldr_type}) eq 'bib' || $ldr_type eq ' ') {
296 $qrec = _add_bib_rec( $e, $xml, $queue_id, $purpose, $bib_source ) or return $e->die_event;
297 } elsif ($type eq 'auth' && ($record_types{$ldr_type}) eq 'auth' || $ldr_type eq ' ') {
298 $qrec = _add_auth_rec( $e, $xml, $queue_id, $purpose ) or return $e->die_event;
300 # I don't know how to handle this type; rock on
301 $logger->error("In process_spool(), type was $type and leader type was $ldr_type ; not currently supported");
305 if($self->api_name =~ /stream_results/ and $qrec) {
306 $client->respond($qrec->id)
308 $client->respond($count) if (++$count % $response_scale) == 0;
309 $response_scale *= 10 if ($count == ($response_scale * 10));
313 $logger->warn("Encountered a bad record at Vandelay ingest: ".$error);
319 $cache->delete_cache('vandelay_import_spool_' . $fingerprint) if $fingerprint;
323 __PACKAGE__->register_method(
324 api_name => "open-ils.vandelay.bib.process_spool",
325 method => "process_spool",
331 __PACKAGE__->register_method(
332 api_name => "open-ils.vandelay.auth.process_spool",
333 method => "process_spool",
337 record_type => 'auth'
340 __PACKAGE__->register_method(
341 api_name => "open-ils.vandelay.bib.process_spool.stream_results",
342 method => "process_spool",
349 __PACKAGE__->register_method(
350 api_name => "open-ils.vandelay.auth.process_spool.stream_results",
351 method => "process_spool",
356 record_type => 'auth'
359 __PACKAGE__->register_method(
360 api_name => "open-ils.vandelay.bib_queue.records.retrieve",
361 method => 'retrieve_queued_records',
367 __PACKAGE__->register_method(
368 api_name => "open-ils.vandelay.bib_queue.records.retrieve.export.print",
369 method => 'retrieve_queued_records',
375 __PACKAGE__->register_method(
376 api_name => "open-ils.vandelay.bib_queue.records.retrieve.export.csv",
377 method => 'retrieve_queued_records',
383 __PACKAGE__->register_method(
384 api_name => "open-ils.vandelay.bib_queue.records.retrieve.export.email",
385 method => 'retrieve_queued_records',
392 __PACKAGE__->register_method(
393 api_name => "open-ils.vandelay.auth_queue.records.retrieve",
394 method => 'retrieve_queued_records',
398 record_type => 'auth'
400 __PACKAGE__->register_method(
401 api_name => "open-ils.vandelay.auth_queue.records.retrieve.export.print",
402 method => 'retrieve_queued_records',
406 record_type => 'auth'
408 __PACKAGE__->register_method(
409 api_name => "open-ils.vandelay.auth_queue.records.retrieve.export.csv",
410 method => 'retrieve_queued_records',
414 record_type => 'auth'
416 __PACKAGE__->register_method(
417 api_name => "open-ils.vandelay.auth_queue.records.retrieve.export.email",
418 method => 'retrieve_queued_records',
422 record_type => 'auth'
425 __PACKAGE__->register_method(
426 api_name => "open-ils.vandelay.bib_queue.records.matches.retrieve",
427 method => 'retrieve_queued_records',
431 record_type => 'bib',
433 desc => q/Only retrieve queued bib records that have matches against existing records/
436 __PACKAGE__->register_method(
437 api_name => "open-ils.vandelay.auth_queue.records.matches.retrieve",
438 method => 'retrieve_queued_records',
442 record_type => 'auth',
444 desc => q/Only retrieve queued authority records that have matches against existing records/
448 sub retrieve_queued_records {
449 my($self, $conn, $auth, $queue_id, $options) = @_;
452 my $limit = $$options{limit} || 20;
453 my $offset = $$options{offset} || 0;
454 my $type = $self->{record_type};
456 my $e = new_editor(authtoken => $auth, xact => 1);
457 return $e->die_event unless $e->checkauth;
461 $queue = $e->retrieve_vandelay_bib_queue($queue_id) or return $e->die_event;
463 $queue = $e->retrieve_vandelay_authority_queue($queue_id) or return $e->die_event;
465 my $evt = check_queue_perms($e, $type, $queue);
466 return $evt if ($evt);
468 my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
470 select => {$class => ['id']},
472 where => {queue => $queue_id},
474 order_by => {$class => ['id']},
478 if($self->api_name =~ /export/) {
479 delete $query->{limit};
480 delete $query->{offset};
483 $query->{where}->{import_time} = undef if $$options{non_imported};
485 if($$options{with_import_error}) {
487 $query->{from} = {$class => {vii => {type => 'left'}}};
488 $query->{where}->{'-or'} = [
489 {'+vqbr' => {import_error => {'!=' => undef}}},
490 {'+vii' => {import_error => {'!=' => undef}}}
495 if($$options{with_rec_import_error}) {
496 $query->{where}->{import_error} = {'!=' => undef};
498 } elsif( $$options{with_item_import_error} and $type eq 'bib') {
500 $query->{from} = {$class => 'vii'};
501 $query->{where}->{'+vii'} = {import_error => {'!=' => undef}};
505 if($self->api_name =~ /matches/) {
506 # find only records that have matches
507 my $mclass = $type eq 'bib' ? 'vbm' : 'vam';
508 $query->{from} = {$class => {$mclass => {type => 'right'}}};
511 my $record_ids = $e->json_query($query);
513 my $retrieve = ($type eq 'bib') ?
514 'retrieve_vandelay_queued_bib_record' : 'retrieve_vandelay_queued_authority_record';
515 my $search = ($type eq 'bib') ?
516 'search_vandelay_queued_bib_record' : 'search_vandelay_queued_authority_record';
518 if ($self->api_name =~ /export/) {
519 my $rec_list = $e->$search({id => [map { $_->{id} } @$record_ids]}, {substream => 1});
520 if ($self->api_name =~ /print/) {
523 return $U->fire_object_event(
525 'vandelay.queued_'.$type.'_record.print',
530 } elsif ($self->api_name =~ /csv/) {
533 return $U->fire_object_event(
535 'vandelay.queued_'.$type.'_record.csv',
540 } elsif ($self->api_name =~ /email/) {
542 $conn->respond_complete(1);
544 for my $rec (@$rec_list) {
545 $U->create_events_for_hook(
546 'vandelay.queued_'.$type.'_record.email',
548 $e->requestor->home_ou,
557 for my $rec_id (@$record_ids) {
558 my $flesh = ['attributes', 'matches'];
559 push(@$flesh, 'import_items') if $$options{flesh_import_items};
560 my $params = {flesh => 1, flesh_fields => {$class => $flesh}};
561 my $rec = $e->$retrieve([$rec_id->{id}, $params]);
562 $rec->clear_marc if $$options{clear_marc};
563 $conn->respond($rec);
571 __PACKAGE__->register_method(
572 api_name => 'open-ils.vandelay.import_item.queue.retrieve',
573 method => 'retrieve_queue_import_items',
579 Returns Import Item (vii) objects for the selected queue.
581 with_import_error : only return items that failed to import
584 __PACKAGE__->register_method(
585 api_name => 'open-ils.vandelay.import_item.queue.export.print',
586 method => 'retrieve_queue_import_items',
592 Returns template-generated printable output of Import Item (vii) objects for the selected queue.
594 with_import_error : only return items that failed to import
597 __PACKAGE__->register_method(
598 api_name => 'open-ils.vandelay.import_item.queue.export.csv',
599 method => 'retrieve_queue_import_items',
605 Returns template-generated CSV output of Import Item (vii) objects for the selected queue.
607 with_import_error : only return items that failed to import
610 __PACKAGE__->register_method(
611 api_name => 'open-ils.vandelay.import_item.queue.export.email',
612 method => 'retrieve_queue_import_items',
618 Emails template-generated output of Import Item (vii) objects for the selected queue.
620 with_import_error : only return items that failed to import
624 sub retrieve_queue_import_items {
625 my($self, $conn, $auth, $q_id, $options) = @_;
628 my $limit = $$options{limit} || 20;
629 my $offset = $$options{offset} || 0;
631 my $e = new_editor(authtoken => $auth);
632 return $e->event unless $e->checkauth;
634 my $queue = $e->retrieve_vandelay_bib_queue($q_id) or return $e->event;
635 my $evt = check_queue_perms($e, 'bib', $queue);
639 select => {vii => ['id']},
647 filter => {id => $q_id}
653 order_by => {'vii' => ['record','id']},
657 if($self->api_name =~ /export/) {
658 delete $query->{limit};
659 delete $query->{offset};
662 $query->{where} = {'+vii' => {import_error => {'!=' => undef}}}
663 if $$options{with_import_error};
665 my $items = $e->json_query($query);
666 my $item_list = $e->search_vandelay_import_item({id => [map { $_->{id} } @$items]});
667 if ($self->api_name =~ /export/) {
668 if ($self->api_name =~ /print/) {
670 return $U->fire_object_event(
672 'vandelay.import_items.print',
677 } elsif ($self->api_name =~ /csv/) {
679 return $U->fire_object_event(
681 'vandelay.import_items.csv',
686 } elsif ($self->api_name =~ /email/) {
688 $conn->respond_complete(1);
690 for my $item (@$item_list) {
691 $U->create_events_for_hook(
692 'vandelay.import_items.email',
694 $e->requestor->home_ou,
703 for my $item (@$item_list) {
704 $conn->respond($item);
711 sub check_queue_perms {
712 my($e, $type, $queue) = @_;
713 if ($type eq 'bib') {
714 return $e->die_event unless
715 ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
716 $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
718 return $e->die_event unless
719 ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
720 $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
726 __PACKAGE__->register_method(
727 api_name => "open-ils.vandelay.bib_record.list.import",
728 method => 'import_record_list',
735 __PACKAGE__->register_method(
736 api_name => "open-ils.vandelay.auth_record.list.import",
737 method => 'import_record_list',
741 record_type => 'auth'
744 sub import_record_list {
745 my($self, $conn, $auth, $rec_ids, $args) = @_;
746 my $e = new_editor(authtoken => $auth, xact => 1);
747 return $e->die_event unless $e->checkauth;
749 my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $args);
750 try {$e->rollback} otherwise {};
752 return {complete => 1};
756 __PACKAGE__->register_method(
757 api_name => "open-ils.vandelay.bib_queue.import",
758 method => 'import_queue',
763 record_type => 'bib',
766 Attempts to import all non-imported records for the selected queue.
767 Will also attempt import of all non-imported items.
772 __PACKAGE__->register_method(
773 api_name => "open-ils.vandelay.auth_queue.import",
774 method => 'import_queue',
779 record_type => 'auth'
783 my($self, $conn, $auth, $q_id, $options) = @_;
784 my $e = new_editor(authtoken => $auth, xact => 1);
785 return $e->die_event unless $e->checkauth;
787 my $type = $self->{record_type};
788 my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
790 # First, collect the not-yet-imported records
791 my $query = {queue => $q_id, import_time => undef};
792 my $search = ($type eq 'bib') ?
793 'search_vandelay_queued_bib_record' :
794 'search_vandelay_queued_authority_record';
795 my $rec_ids = $e->$search($query, {idlist => 1});
797 # Now add any imported records that have un-imported items
800 my $item_recs = $e->json_query({
801 select => {vqbr => ['id']},
802 from => {vqbr => 'vii'},
806 import_time => {'!=' => undef}
808 '+vii' => {import_time => undef}
812 push(@$rec_ids, map {$_->{id}} @$item_recs);
815 my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $options);
816 try {$e->rollback} otherwise {}; # only using this to make the read authoritative -- don't die from it
818 return {complete => 1};
821 # returns a list of queued record IDs for a given queue that
822 # have at least one entry in the match table
824 sub queued_records_with_matches {
825 my($e, $type, $q_id, $limit, $offset, $filter) = @_;
827 my $match_class = 'vbm';
828 my $rec_class = 'vqbr';
829 if($type eq 'auth') {
830 $match_class = 'vam';
835 $filter->{queue} = $q_id;
839 select => {$match_class => ['queued_record']},
844 fkey => 'queued_record',
851 if($limit or defined $offset) {
854 $query->{limit} = $limit;
855 $query->{offset} = $offset;
858 my $data = $e->json_query($query);
859 return [ map {$_->{queued_record}} @$data ];
863 sub import_record_list_impl {
864 my($self, $conn, $rec_ids, $requestor, $args) = @_;
866 my $overlay_map = $args->{overlay_map} || {};
867 my $type = $self->{record_type};
874 total => scalar(@$rec_ids),
875 report_all => $$args{report_all}
878 $conn->max_chunk_count(1) if $$args{report_all};
880 my $auto_overlay_exact = $$args{auto_overlay_exact};
881 my $auto_overlay_1match = $$args{auto_overlay_1match};
882 my $auto_overlay_best = $$args{auto_overlay_best_match};
883 my $match_quality_ratio = $$args{match_quality_ratio};
884 my $merge_profile = $$args{merge_profile};
885 my $ft_merge_profile = $$args{fall_through_merge_profile};
886 my $bib_source = $$args{bib_source};
887 my $import_no_match = $$args{import_no_match};
889 my $overlay_func = 'vandelay.overlay_bib_record';
890 my $auto_overlay_func = 'vandelay.auto_overlay_bib_record';
891 my $auto_overlay_best_func = 'vandelay.auto_overlay_bib_record_with_best'; # XXX bib-only
892 my $retrieve_func = 'retrieve_vandelay_queued_bib_record';
893 my $update_func = 'update_vandelay_queued_bib_record';
894 my $search_func = 'search_vandelay_queued_bib_record';
895 my $retrieve_queue_func = 'retrieve_vandelay_bib_queue';
896 my $update_queue_func = 'update_vandelay_bib_queue';
897 my $delete_queue_func = 'delete_vandelay_bib_queue';
898 my $rec_class = 'vqbr';
900 my $editor = new_editor();
903 my $sources = $editor->search_config_bib_source({id => {'!=' => undef}});
904 $bib_sources{$_->id} = $_->source for @$sources;
906 if($type eq 'auth') {
907 $overlay_func =~ s/bib/auth/o;
908 $auto_overlay_func = s/bib/auth/o;
909 $retrieve_func =~ s/bib/authority/o;
910 $retrieve_queue_func =~ s/bib/authority/o;
911 $update_queue_func =~ s/bib/authority/o;
912 $update_func =~ s/bib/authority/o;
913 $search_func =~ s/bib/authority/o;
914 $delete_queue_func =~ s/bib/authority/o;
918 my $new_rec_perm_cache;
920 for my $rec_id (@$rec_ids) {
923 my $overlay_target = $overlay_map->{$rec_id};
925 my $e = new_editor(xact => 1);
926 $e->requestor($requestor);
928 $$report_args{e} = $e;
929 $$report_args{evt} = undef;
930 $$report_args{import_error} = undef;
931 $$report_args{no_import} = 0;
933 my $rec = $e->$retrieve_func([
936 flesh_fields => { $rec_class => ['matches']},
941 $$report_args{evt} = $e->event;
942 finish_rec_import_attempt($report_args);
946 if($rec->import_time) {
947 # if the record is already imported, that means it may have
948 # un-imported copies. Add to success list for later processing.
949 push(@success_rec_ids, $rec_id);
954 $$report_args{rec} = $rec;
955 $queues{$rec->queue} = 1;
960 if(defined $overlay_target) {
961 # Caller chose an explicit overlay target
963 my $res = $e->json_query(
974 if($res and ($res = $res->[0])) {
976 if($res->{$overlay_func} eq 't') {
977 $logger->info("vl: $type direct overlay succeeded for queued rec ".
978 "$rec_id and overlay target $overlay_target");
984 $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
989 if($auto_overlay_1match) { # overlay if there is exactly 1 match
991 my %match_recs = map { $_->eg_record => 1 } @{$rec->matches};
993 if( scalar(keys %match_recs) == 1) { # all matches point to the same record
995 ($imported, $error, $rec) = try_auto_overlay(
998 $auto_overlay_best_func,
1002 $match_quality_ratio,
1009 if(!$imported and !$error and $auto_overlay_exact and scalar(@{$rec->matches}) == 1 ) {
1011 # caller says to overlay if there is an /exact/ match
1012 # $auto_overlay_func only proceeds and returns true on exact matches
1014 my $res = $e->json_query(
1024 if($res and ($res = $res->[0])) {
1026 if($res->{$auto_overlay_func} eq 't') {
1027 $logger->info("vl: $type auto-overlay succeeded for queued rec $rec_id");
1030 # re-fetch the record to pick up the imported_as value from the DB
1031 $$report_args{rec} = $rec = $e->$retrieve_func([
1032 $rec_id, {flesh => 1, flesh_fields => {$rec_class => ['matches']}}]);
1035 $logger->info("vl: $type auto-overlay failed for queued rec $rec_id");
1040 $logger->error("vl: Error attempting overlay with func=$auto_overlay_func, profile=$merge_profile, record=$rec_id");
1044 if(!$imported and !$error and $auto_overlay_best and scalar(@{$rec->matches}) > 0 ) {
1045 # caller says to overlay the best match
1047 ($imported, $error, $rec) = try_auto_overlay(
1050 $auto_overlay_best_func,
1054 $match_quality_ratio,
1060 if(!$imported and !$error and $import_no_match and scalar(@{$rec->matches}) == 0) {
1062 # No overlay / merge occurred. Do a traditional record import by creating a new record
1064 if (!$new_rec_perm_cache) {
1065 $new_rec_perm_cache = {};
1067 # all users creating new records are required to have the basic permission.
1068 # if the client requests, we can enforce extra permissions for creating new records.
1069 # for speed, check the permissions the first time then cache the result.
1071 my $perm = ($type eq 'bib') ? 'IMPORT_MARC' : 'IMPORT_AUTHORITY_MARC';
1072 my $xperm = $$args{new_rec_perm};
1073 my $rec_ou = $e->requestor->ws_ou;
1075 $new_rec_perm_cache->{evt} = $e->die_event
1076 if !$e->allowed($perm, $rec_ou) || ($xperm and !$e->allowed($xperm, $rec_ou));
1079 if ($new_rec_perm_cache->{evt}) {
1081 # a cached event won't roll back the transaction (a la die_event), but
1082 # the transaction will get rolled back in finish_rec_import_attempt() below
1083 $$report_args{evt} = $new_rec_perm_cache->{evt};
1084 $$report_args{import_error} = 'import.record.perm_failure';
1086 } else { # perm checks succeeded
1088 $logger->info("vl: creating new $type record for queued record $rec_id");
1090 if ($type eq 'bib') {
1092 $record = OpenILS::Application::Cat::BibCommon->biblio_record_xml_import(
1093 $e, $rec->marc, $bib_sources{$rec->bib_source}, undef, 1);
1095 } else { # authority record
1097 $record = OpenILS::Application::Cat::AuthCommon->import_authority_record($e, $rec->marc); #$source);
1100 if($U->event_code($record)) {
1101 $$report_args{import_error} = 'import.duplicate.tcn'
1102 if $record->{textcode} eq 'OPEN_TCN_NOT_FOUND';
1103 $$report_args{evt} = $record;
1107 $logger->info("vl: successfully imported new $type record");
1108 $rec->imported_as($record->id);
1117 $rec->import_time('now');
1118 $rec->clear_import_error;
1119 $rec->clear_error_detail;
1121 if($e->$update_func($rec)) {
1123 if($type eq 'bib') {
1125 # see if this record is linked from an acq record.
1126 my $li = $e->search_acq_lineitem(
1127 {queued_record => $rec->id, state => {'!=' => 'canceled'}})->[0];
1130 # if so, update the acq lineitem to point to the imported record
1131 $li->eg_bib_id($rec->imported_as);
1132 $$report_args{evt} = $e->die_event unless $e->update_acq_lineitem($li);
1136 push @success_rec_ids, $rec_id;
1137 finish_rec_import_attempt($report_args);
1145 $logger->info("vl: record $rec_id was not imported");
1146 $$report_args{evt} = $e->event unless $$report_args{evt};
1147 $$report_args{no_import} = 1;
1148 finish_rec_import_attempt($report_args);
1152 # see if we need to mark any queues as complete
1153 for my $q_id (keys %queues) {
1155 my $e = new_editor(xact => 1);
1156 my $remaining = $e->$search_func(
1157 [{queue => $q_id, import_time => undef}, {limit =>1}], {idlist => 1});
1159 unless(@$remaining) {
1160 my $queue = $e->$retrieve_queue_func($q_id);
1161 unless($U->is_true($queue->complete)) {
1162 $queue->complete('t');
1163 $e->$update_queue_func($queue) or return $e->die_event;
1172 import_record_asset_list_impl($conn, \@success_rec_ids, $requestor) if @success_rec_ids;
1174 $conn->respond({total => $$report_args{total}, progress => $$report_args{progress}});
1179 sub try_auto_overlay {
1182 my $report_args = shift;
1183 my $overlay_func = shift;
1184 my $retrieve_func = shift;
1185 my $rec_class = shift;
1187 my $match_quality_ratio = shift;
1188 my $merge_profile = shift;
1189 my $ft_merge_profile = shift;
1194 # Find the best match and overlay if the quality ratio allows it.
1195 my $res = $e->json_query(
1201 $match_quality_ratio
1206 if($res and ($res = $res->[0])) {
1208 if($res->{$overlay_func} eq 't') {
1210 # first attempt succeeded
1215 # quality-limited merge failed with insufficient quality. If there is a
1216 # fall-through merge profile, re-do the merge with the alternate profile
1217 # and no quality restriction.
1219 if($ft_merge_profile and $match_quality_ratio > 0) {
1221 $logger->info("vl: $type auto-merge failed with profile $merge_profile; ".
1222 "re-merging with fall-through profile $ft_merge_profile");
1224 my $res = $e->json_query(
1230 0 # minimum quality not required
1235 if($res and ($res = $res->[0])) {
1237 if($res->{$overlay_func} eq 't') {
1239 # second attempt succeeded
1244 # failed to merge on second attempt
1245 $logger->info("vl: $type auto-merge with fall-through failed for queued rec $rec_id");
1249 # second attempt died
1251 $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
1256 # failed to merge on first attempt, no fall-through was provided
1257 $$report_args{import_error} = 'overlay.record.quality' if $match_quality_ratio > 0;
1258 $logger->info("vl: $type auto-merge failed for queued rec $rec_id");
1264 # first attempt died
1266 $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
1271 # at least 1 of the attempts succeeded
1272 $logger->info("vl: $type auto-merge succeeded for queued rec $rec_id");
1274 # re-fetch the record to pick up the imported_as value from the DB
1275 $$report_args{rec} = $e->$retrieve_func([
1276 $rec_id, {flesh => 1, flesh_fields => {$rec_class => ['matches']}}]);
1279 return ($imported, $error, $$report_args{rec});
1283 # tracks any import errors, commits the current xact, responds to the client
1284 sub finish_rec_import_attempt {
1286 my $evt = $$args{evt};
1287 my $rec = $$args{rec};
1290 my $error = $$args{import_error};
1291 $error = 'general.unknown' if $evt and not $error;
1296 if($error or $evt) {
1298 # since an error occurred, there's no guarantee the transaction wasn't
1299 # rolled back. force a rollback and create a new editor.
1301 $e = new_editor(xact => 1);
1302 $rec->import_error($error);
1305 my $detail = sprintf("%s : %s", $evt->{textcode}, substr($evt->{desc}, 0, 140));
1306 $rec->error_detail($detail);
1309 my $method = 'update_vandelay_queued_bib_record';
1310 $method =~ s/bib/authority/ if $$args{type} eq 'auth';
1311 $e->$method($rec) and $e->commit or $e->rollback;
1314 # commit the successful import
1319 # requested queued record was not found
1324 if($$args{report_all} or ($$args{progress} % $$args{step}) == 0) {
1325 $$args{conn}->respond({
1326 total => $$args{total},
1327 progress => $$args{progress},
1328 imported => ($rec) ? $rec->id : undef,
1329 import_error => $error,
1330 no_import => $$args{no_import},
1333 $$args{step} *= 2 unless $$args{step} == 256;
1343 __PACKAGE__->register_method(
1344 api_name => "open-ils.vandelay.bib_queue.owner.retrieve",
1345 method => 'owner_queue_retrieve',
1349 record_type => 'bib'
1351 __PACKAGE__->register_method(
1352 api_name => "open-ils.vandelay.authority_queue.owner.retrieve",
1353 method => 'owner_queue_retrieve',
1357 record_type => 'auth'
1360 sub owner_queue_retrieve {
1361 my($self, $conn, $auth, $owner_id, $filters) = @_;
1362 my $e = new_editor(authtoken => $auth, xact => 1);
1363 return $e->die_event unless $e->checkauth;
1364 $owner_id = $e->requestor->id; # XXX add support for viewing other's queues?
1367 my $search = {owner => $owner_id};
1368 $search->{$_} = $filters->{$_} for keys %$filters;
1370 if($self->{record_type} eq 'bib') {
1371 $queues = $e->search_vandelay_bib_queue(
1372 [$search, {order_by => {vbq => 'evergreen.lowercase(name)'}}]);
1374 $queues = $e->search_vandelay_authority_queue(
1375 [$search, {order_by => {vaq => 'evergreen.lowercase(name)'}}]);
1377 $conn->respond($_) for @$queues;
1382 __PACKAGE__->register_method(
1383 api_name => "open-ils.vandelay.bib_queue.delete",
1384 method => "delete_queue",
1387 record_type => 'bib'
1389 __PACKAGE__->register_method(
1390 api_name => "open-ils.vandelay.auth_queue.delete",
1391 method => "delete_queue",
1394 record_type => 'auth'
1398 my($self, $conn, $auth, $q_id) = @_;
1399 my $e = new_editor(xact => 1, authtoken => $auth);
1400 return $e->die_event unless $e->checkauth;
1401 if($self->{record_type} eq 'bib') {
1402 return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
1403 my $queue = $e->retrieve_vandelay_bib_queue($q_id)
1404 or return $e->die_event;
1405 $e->delete_vandelay_bib_queue($queue)
1406 or return $e->die_event;
1408 return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
1409 my $queue = $e->retrieve_vandelay_authority_queue($q_id)
1410 or return $e->die_event;
1411 $e->delete_vandelay_authority_queue($queue)
1412 or return $e->die_event;
1419 __PACKAGE__->register_method(
1420 api_name => "open-ils.vandelay.queued_bib_record.html",
1421 method => 'queued_record_html',
1425 record_type => 'bib'
1427 __PACKAGE__->register_method(
1428 api_name => "open-ils.vandelay.queued_authority_record.html",
1429 method => 'queued_record_html',
1433 record_type => 'auth'
1436 sub queued_record_html {
1437 my($self, $conn, $auth, $rec_id) = @_;
1438 my $e = new_editor(xact=>1,authtoken => $auth);
1439 return $e->die_event unless $e->checkauth;
1441 if($self->{record_type} eq 'bib') {
1442 $rec = $e->retrieve_vandelay_queued_bib_record($rec_id)
1443 or return $e->die_event;
1445 $rec = $e->retrieve_vandelay_queued_authority_record($rec_id)
1446 or return $e->die_event;
1450 return $U->simplereq(
1452 'open-ils.search.biblio.record.html', undef, 1, $rec->marc);
1456 __PACKAGE__->register_method(
1457 api_name => "open-ils.vandelay.bib_queue.summary.retrieve",
1458 method => 'retrieve_queue_summary',
1462 record_type => 'bib'
1464 __PACKAGE__->register_method(
1465 api_name => "open-ils.vandelay.auth_queue.summary.retrieve",
1466 method => 'retrieve_queue_summary',
1470 record_type => 'auth'
1473 sub retrieve_queue_summary {
1474 my($self, $conn, $auth, $queue_id) = @_;
1475 my $e = new_editor(xact=>1, authtoken => $auth);
1476 return $e->die_event unless $e->checkauth;
1479 my $type = $self->{record_type};
1480 if($type eq 'bib') {
1481 $queue = $e->retrieve_vandelay_bib_queue($queue_id)
1482 or return $e->die_event;
1484 $queue = $e->retrieve_vandelay_authority_queue($queue_id)
1485 or return $e->die_event;
1488 my $evt = check_queue_perms($e, $type, $queue);
1489 return $evt if $evt;
1491 my $search = 'search_vandelay_queued_bib_record';
1492 $search =~ s/bib/authority/ if $type ne 'bib';
1496 total => scalar(@{$e->$search({queue => $queue_id}, {idlist=>1})}),
1497 imported => scalar(@{$e->$search({queue => $queue_id, import_time => {'!=' => undef}}, {idlist=>1})}),
1500 my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
1501 $summary->{rec_import_errors} = $e->json_query({
1502 select => {$class => [{alias => 'count', column => 'id', transform => 'count', aggregate => 1}]},
1504 where => {queue => $queue_id, import_error => {'!=' => undef}}
1507 if($type eq 'bib') {
1509 # count of all items attached to records in the queue in question
1511 select => {vii => [{alias => 'count', column => 'id', transform => 'count', aggregate => 1}]},
1516 select => {vqbr => ['id']},
1518 where => {queue => $queue_id}
1523 $summary->{total_items} = $e->json_query($query)->[0]->{count};
1525 # count of items we attempted to import, but errored, attached to records in the queue in question
1526 $query->{where}->{import_error} = {'!=' => undef};
1527 $summary->{item_import_errors} = $e->json_query($query)->[0]->{count};
1529 # count of items we successfully imported attached to records in the queue in question
1530 delete $query->{where}->{import_error};
1531 $query->{where}->{import_time} = {'!=' => undef};
1532 $summary->{total_items_imported} = $e->json_query($query)->[0]->{count};
1538 # --------------------------------------------------------------------------------
1539 # Given a list of queued record IDs, imports all items attached to those records
1540 # --------------------------------------------------------------------------------
1541 sub import_record_asset_list_impl {
1542 my($conn, $rec_ids, $requestor) = @_;
1544 my $roe = new_editor(xact=> 1, requestor => $requestor);
1546 # for speed, filter out any records have not been
1547 # imported or have no import items to load
1548 $rec_ids = $roe->json_query({
1549 select => {vqbr => ['id']},
1550 from => {vqbr => 'vii'},
1551 where => {'+vqbr' => {
1553 import_time => {'!=' => undef}
1557 $rec_ids = [map {$_->{id}} @$rec_ids];
1561 total => scalar(@$rec_ids),
1562 step => 1, # how often to respond
1567 for my $rec_id (@$rec_ids) {
1568 my $rec = $roe->retrieve_vandelay_queued_bib_record($rec_id);
1569 my $item_ids = $roe->search_vandelay_import_item(
1570 {record => $rec->id, import_error => undef},
1574 for my $item_id (@$item_ids) {
1575 my $e = new_editor(requestor => $requestor, xact => 1);
1576 my $item = $e->retrieve_vandelay_import_item($item_id);
1577 $$report_args{import_item} = $item;
1578 $$report_args{e} = $e;
1579 $$report_args{import_error} = undef;
1580 $$report_args{evt} = undef;
1582 # --------------------------------------------------------------------------------
1583 # Find or create the volume
1584 # --------------------------------------------------------------------------------
1586 OpenILS::Application::Cat::AssetCommon->find_or_create_volume(
1587 $e, $item->call_number, $rec->imported_as, $item->owning_lib);
1591 $$report_args{evt} = $evt;
1592 respond_with_status($report_args);
1596 # --------------------------------------------------------------------------------
1597 # Create the new copy
1598 # --------------------------------------------------------------------------------
1599 my $copy = Fieldmapper::asset::copy->new;
1600 $copy->loan_duration(2);
1601 $copy->fine_level(2);
1602 $copy->barcode($item->barcode);
1603 $copy->location($item->location);
1604 $copy->circ_lib($item->circ_lib || $item->owning_lib);
1605 $copy->status( defined($item->status) ? $item->status : OILS_COPY_STATUS_IN_PROCESS );
1606 $copy->circulate($item->circulate);
1607 $copy->deposit($item->deposit);
1608 $copy->deposit_amount($item->deposit_amount);
1609 $copy->ref($item->ref);
1610 $copy->holdable($item->holdable);
1611 $copy->price($item->price);
1612 $copy->circ_as_type($item->circ_as_type);
1613 $copy->alert_message($item->alert_message);
1614 $copy->opac_visible($item->opac_visible);
1615 $copy->circ_modifier($item->circ_modifier);
1617 # --------------------------------------------------------------------------------
1618 # Check for dupe barcode
1619 # --------------------------------------------------------------------------------
1620 if($evt = OpenILS::Application::Cat::AssetCommon->create_copy($e, $vol, $copy)) {
1621 $$report_args{evt} = $evt;
1622 $$report_args{import_error} = 'import.item.duplicate.barcode'
1623 if $evt->{textcode} eq 'ITEM_BARCODE_EXISTS';
1624 respond_with_status($report_args);
1628 # --------------------------------------------------------------------------------
1630 # --------------------------------------------------------------------------------
1631 $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
1632 $e, $copy, '', $item->pub_note, 1) if $item->pub_note;
1635 $$report_args{evt} = $evt;
1636 respond_with_status($report_args);
1640 $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
1641 $e, $copy, '', $item->priv_note) if $item->priv_note;
1644 $$report_args{evt} = $evt;
1645 respond_with_status($report_args);
1649 # set the import data on the import item
1650 $item->imported_as($copy->id); # $copy->id is set by create_copy() ^--
1651 $item->import_time('now');
1653 unless($e->update_vandelay_import_item($item)) {
1654 $$report_args{evt} = $e->die_event;
1655 respond_with_status($report_args);
1659 # --------------------------------------------------------------------------------
1660 # Item import succeeded
1661 # --------------------------------------------------------------------------------
1663 $$report_args{in_count}++;
1664 respond_with_status($report_args);
1665 $logger->info("vl: successfully imported item " . $item->barcode);
1675 sub respond_with_status {
1679 # If the import failed, track the failure reason
1681 my $error = $$args{import_error};
1682 my $evt = $$args{evt};
1684 if($error or $evt) {
1686 my $item = $$args{import_item};
1687 $logger->info("vl: unable to import item " . $item->barcode);
1689 $error ||= 'general.unknown';
1690 $item->import_error($error);
1693 my $detail = sprintf("%s : %s", $evt->{textcode}, substr($evt->{desc}, 0, 140));
1694 $item->error_detail($detail);
1697 # state of the editor is unknown at this point. Force a rollback and start over.
1699 $e = new_editor(xact => 1);
1700 $e->update_vandelay_import_item($item);
1704 if($$args{report_all} or ($$args{progress} % $$args{step}) == 0) {
1705 $$args{conn}->respond({
1706 total => $$args{total},
1707 progress => $$args{progress},
1708 success_count => $$args{success_count},
1711 $$args{step} *= 2 unless $$args{step} == 256;
1717 __PACKAGE__->register_method(
1718 api_name => "open-ils.vandelay.match_set.get_tree",
1719 method => "match_set_get_tree",
1723 desc => q/For a given vms object, return a tree of match set points
1724 represented by a vmsp object with recursively fleshed
1729 sub match_set_get_tree {
1730 my ($self, $conn, $authtoken, $match_set_id) = @_;
1732 $match_set_id = int($match_set_id) or return;
1734 my $e = new_editor("authtoken" => $authtoken);
1735 $e->checkauth or return $e->die_event;
1737 my $set = $e->retrieve_vandelay_match_set($match_set_id) or
1738 return $e->die_event;
1740 $e->allowed("ADMIN_IMPORT_MATCH_SET", $set->owner) or
1741 return $e->die_event;
1743 my $tree = $e->search_vandelay_match_set_point([
1744 {"match_set" => $match_set_id, "parent" => undef},
1745 {"flesh" => -1, "flesh_fields" => {"vmsp" => ["children"]}}
1746 ]) or return $e->die_event;
1752 __PACKAGE__->register_method(
1753 api_name => "open-ils.vandelay.match_set.update",
1754 method => "match_set_update_tree",
1758 desc => q/Replace any vmsp objects associated with a given (by ID) vms
1759 with the given objects (recursively fleshed vmsp tree)./
1763 sub _walk_new_vmsp {
1764 my ($e, $match_set_id, $node, $parent_id) = @_;
1766 my $point = new Fieldmapper::vandelay::match_set_point;
1767 $point->parent($parent_id);
1768 $point->match_set($match_set_id);
1769 $point->$_($node->$_) for (qw/bool_op svf tag subfield negate quality/);
1771 $e->create_vandelay_match_set_point($point) or return $e->die_event;
1773 $parent_id = $e->data->id;
1774 if ($node->children && @{$node->children}) {
1775 for (@{$node->children}) {
1776 return $e->die_event if
1777 _walk_new_vmsp($e, $match_set_id, $_, $parent_id);
1784 sub match_set_update_tree {
1785 my ($self, $conn, $authtoken, $match_set_id, $tree) = @_;
1787 my $e = new_editor("xact" => 1, "authtoken" => $authtoken);
1788 $e->checkauth or return $e->die_event;
1790 my $set = $e->retrieve_vandelay_match_set($match_set_id) or
1791 return $e->die_event;
1793 $e->allowed("ADMIN_IMPORT_MATCH_SET", $set->owner) or
1794 return $e->die_event;
1796 my $existing = $e->search_vandelay_match_set_point([
1797 {"match_set" => $match_set_id},
1798 {"order_by" => {"vmsp" => "id DESC"}}
1799 ]) or return $e->die_event;
1801 # delete points, working up from leaf points to the root
1803 for my $point (shift @$existing) {
1804 if( grep {$_->parent eq $point->id} @$existing) {
1805 push(@$existing, $point);
1807 $e->delete_vandelay_match_set_point($point) or return $e->die_event;
1812 _walk_new_vmsp($e, $match_set_id, $tree);
1814 $e->commit or return $e->die_event;
1817 __PACKAGE__->register_method(
1818 api_name => 'open-ils.vandelay.bib_queue.to_bucket',
1819 method => 'bib_queue_to_bucket',
1823 desc => q/Add to or create a new bib container (bucket) with the successfully
1824 imported contents of a vandelay queue. Any user that has Vandelay
1825 queue create permissions can append or create buckets from his-her own queues./,
1827 {desc => 'Authtoken', type => 'string'},
1828 {desc => 'Queue ID', type => 'number'},
1829 {desc => 'Bucket Name', type => 'string'}
1831 return => {desc => q/
1832 {bucket => $bucket, addcount => number-of-items-added-to-bucket, item_count => total-bucket-item-count} on success,
1833 {add_count => 0} if there is nothing to do, and Event on error/}
1837 sub bib_queue_to_bucket {
1838 my ($self, $conn, $auth, $q_id, $bucket_name) = @_;
1840 my $e = new_editor(xact => 1, authtoken => $auth);
1841 return $e->die_event unless $e->checkauth;
1843 my $queue = $e->retrieve_vandelay_bib_queue($q_id)
1844 or return $e->die_event;
1846 return OpenILS::Event->new('BAD_PARAMS',
1847 note => q/Bucket creator must be queue owner/)
1848 unless $queue->owner == $e->requestor->id;
1850 # find the bib IDs that will go into the bucket
1851 my $bib_ids = $e->json_query({
1852 select => {vqbr => ['imported_as']},
1854 where => {queue => $q_id, imported_as => {'!=' => undef}}
1857 if (!@$bib_ids) { # no records to add
1859 return {add_count => 0};
1862 # allow user to add to an existing bucket by name
1863 my $bucket = $e->search_container_biblio_record_entry_bucket({
1864 owner => $e->requestor->id,
1865 name => $bucket_name,
1866 btype => 'vandelay_queue'
1869 # if the bucket does not exist, create a new one
1871 $bucket = Fieldmapper::container::biblio_record_entry_bucket->new;
1872 $bucket->name($bucket_name);
1873 $bucket->owner($e->requestor->id);
1874 $bucket->btype('vandelay_queue');
1876 $e->create_container_biblio_record_entry_bucket($bucket)
1877 or return $e->die_event;
1880 # create the new bucket items
1881 for my $bib_id ( map {$_->{imported_as}} @$bib_ids ) {
1882 my $item = Fieldmapper::container::biblio_record_entry_bucket_item->new;
1883 $item->target_biblio_record_entry($bib_id);
1884 $item->bucket($bucket->id);
1885 $e->create_container_biblio_record_entry_bucket_item($item)
1886 or return $e->die_event;
1889 # re-fetch the bucket to pick up the correct create_time
1890 $bucket = $e->retrieve_container_biblio_record_entry_bucket($bucket->id)
1891 or return $e->die_event;
1893 # get the total count of items in this bucket
1894 my $count = $e->json_query({
1895 select => {cbrebi => [{
1897 transform => 'count',
1902 where => {bucket => $bucket->id}
1909 add_count => scalar(@$bib_ids), # items added to the bucket
1910 item_count => $count->{count} # total items in buckets