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/;
20 use OpenILS::Const qw/:const/;
21 use OpenILS::Application::AppUtils;
22 use OpenILS::Application::Cat::BibCommon;
23 use OpenILS::Application::Cat::AuthCommon;
24 use OpenILS::Application::Cat::AssetCommon;
25 use OpenILS::Application::Cat::Merge;
26 my $U = 'OpenILS::Application::AppUtils';
28 # A list of LDR/06 values from http://loc.gov/marc
55 # --------------------------------------------------------------------------------
58 sub create_bib_queue {
65 my $match_set = shift;
66 my $import_def = shift;
67 my $match_bucket = shift;
69 my $e = new_editor(authtoken => $auth, xact => 1);
71 return $e->die_event unless $e->checkauth;
72 return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
73 $owner ||= $e->requestor->id;
75 if ($e->search_vandelay_bib_queue( {name => $name, owner => $owner, queue_type => $type})->[0]) {
77 return OpenILS::Event->new('BIB_QUEUE_EXISTS')
80 my $queue = new Fieldmapper::vandelay::bib_queue();
81 $queue->name( $name );
82 $queue->owner( $owner );
83 $queue->queue_type( $type ) if ($type);
84 $queue->item_attr_def( $import_def ) if ($import_def);
85 $queue->match_set($match_set) if $match_set;
86 $queue->match_bucket($match_bucket) if $match_bucket;
88 my $new_q = $e->create_vandelay_bib_queue( $queue );
89 return $e->die_event unless ($new_q);
94 __PACKAGE__->register_method(
95 api_name => "open-ils.vandelay.bib_queue.create",
96 method => "create_bib_queue",
102 sub create_auth_queue {
109 my $match_set = shift;
111 my $e = new_editor(authtoken => $auth, xact => 1);
113 return $e->die_event unless $e->checkauth;
114 return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
115 $owner ||= $e->requestor->id;
117 if ($e->search_vandelay_authority_queue({name => $name, owner => $owner, queue_type => $type})->[0]) {
119 return OpenILS::Event->new('AUTH_QUEUE_EXISTS')
122 my $queue = new Fieldmapper::vandelay::authority_queue();
123 $queue->name( $name );
124 $queue->owner( $owner );
125 $queue->queue_type( $type ) if ($type);
126 $queue->match_set($match_set) if $match_set;
128 my $new_q = $e->create_vandelay_authority_queue( $queue );
129 $e->die_event unless ($new_q);
134 __PACKAGE__->register_method(
135 api_name => "open-ils.vandelay.authority_queue.create",
136 method => "create_auth_queue",
141 sub add_record_to_bib_queue {
148 my $bib_source = shift;
150 my $e = new_editor(authtoken => $auth, xact => 1);
152 $queue = $e->retrieve_vandelay_bib_queue($queue);
154 return $e->die_event unless $e->checkauth;
155 return $e->die_event unless
156 ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
157 $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
159 my $new_rec = _add_bib_rec($e, $marc, $queue->id, $purpose, $bib_source);
161 return $e->die_event unless ($new_rec);
165 __PACKAGE__->register_method(
166 api_name => "open-ils.vandelay.queued_bib_record.create",
167 method => "add_record_to_bib_queue",
177 my $bib_source = shift;
179 my $rec = new Fieldmapper::vandelay::queued_bib_record();
181 $rec->queue( $queue );
182 $rec->purpose( $purpose ) if ($purpose);
183 $rec->bib_source($bib_source);
185 return $e->create_vandelay_queued_bib_record( $rec, {timeout => 600} );
188 sub add_record_to_authority_queue {
196 my $e = new_editor(authtoken => $auth, xact => 1);
198 $queue = $e->retrieve_vandelay_authority_queue($queue);
200 return $e->die_event unless $e->checkauth;
201 return $e->die_event unless
202 ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
203 $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
205 my $new_rec = _add_auth_rec($e, $marc, $queue->id, $purpose);
207 return $e->die_event unless ($new_rec);
211 __PACKAGE__->register_method(
212 api_name => "open-ils.vandelay.queued_authority_record.create",
213 method => "add_record_to_authority_queue",
224 my $rec = new Fieldmapper::vandelay::queued_authority_record();
226 $rec->queue( $queue );
227 $rec->purpose( $purpose ) if ($purpose);
229 return $e->create_vandelay_queued_authority_record( $rec, {timeout => 600} );
236 my $fingerprint = shift || '';
237 my $queue_id = shift;
239 my $filename = shift;
240 my $bib_source = shift;
242 $client->max_chunk_count($self->{max_bundle_count}) if (!$client->can('max_bundle_count') && $self->{max_bundle_count});
244 my $e = new_editor(authtoken => $auth, xact => 1);
245 return $e->die_event unless $e->checkauth;
248 my $type = $self->{record_type};
251 $queue = $e->retrieve_vandelay_bib_queue($queue_id) or return $e->die_event;
253 $queue = $e->retrieve_vandelay_authority_queue($queue_id) or return $e->die_event;
256 my $evt = check_queue_perms($e, $type, $queue);
257 return $evt if ($evt);
259 my $cache = new OpenSRF::Utils::Cache();
262 my $data = $cache->get_cache('vandelay_import_spool_' . $fingerprint);
263 $purpose = $data->{purpose};
264 $filename = $data->{path};
265 $bib_source = $data->{bib_source};
268 unless(-r $filename) {
269 $logger->error("unable to read MARC file $filename");
270 return -1; # make this an event XXX
273 $logger->info("vandelay spooling $fingerprint purpose=$purpose file=$filename");
275 my $marctype = 'USMARC';
278 $marctype = 'XML' if (getc(F) =~ /^\D/o);
281 my $batch = new MARC::Batch ($marctype, $filename);
284 my $response_scale = 10;
287 while (try { $r = $batch->next } otherwise { $r = -1 }) {
289 $logger->warn("Processing of record $count in set $filename failed. Skipping this record");
293 $logger->info("processing record $count");
296 my $xml = clean_marc($r);
299 # Check the leader to ensure we've got something resembling the expected
300 # Allow spaces to give records the benefit of the doubt
301 my $ldr_type = substr($r->leader(), 6, 1);
302 if ($type eq 'bib' && ($record_types{$ldr_type}) eq 'bib' || $ldr_type eq ' ') {
303 $qrec = _add_bib_rec( $e, $xml, $queue_id, $purpose, $bib_source ) or return $e->die_event;
304 } elsif ($type eq 'auth' && ($record_types{$ldr_type}) eq 'auth' || $ldr_type eq ' ') {
305 $qrec = _add_auth_rec( $e, $xml, $queue_id, $purpose ) or return $e->die_event;
307 # I don't know how to handle this type; rock on
308 $logger->error("In process_spool(), type was $type and leader type was $ldr_type ; not currently supported");
312 if($self->api_name =~ /stream_results/ and $qrec) {
313 $client->respond($qrec->id)
315 $client->respond($count) if (++$count % $response_scale) == 0;
316 $response_scale *= 10 if ($count == ($response_scale * 10));
320 $logger->warn("Encountered a bad record at Vandelay ingest: ".$error);
326 $cache->delete_cache('vandelay_import_spool_' . $fingerprint) if $fingerprint;
330 __PACKAGE__->register_method(
331 api_name => "open-ils.vandelay.bib.process_spool",
332 method => "process_spool",
335 max_bundle_count => 1,
338 __PACKAGE__->register_method(
339 api_name => "open-ils.vandelay.auth.process_spool",
340 method => "process_spool",
343 max_bundle_count => 1,
344 record_type => 'auth'
347 __PACKAGE__->register_method(
348 api_name => "open-ils.vandelay.bib.process_spool.stream_results",
349 method => "process_spool",
353 max_bundle_count => 1,
356 __PACKAGE__->register_method(
357 api_name => "open-ils.vandelay.auth.process_spool.stream_results",
358 method => "process_spool",
362 max_bundle_count => 1,
363 record_type => 'auth'
366 __PACKAGE__->register_method(
367 api_name => "open-ils.vandelay.bib_queue.records.retrieve",
368 method => 'retrieve_queued_records',
374 __PACKAGE__->register_method(
375 api_name => "open-ils.vandelay.bib_queue.records.retrieve.export.print",
376 method => 'retrieve_queued_records',
382 __PACKAGE__->register_method(
383 api_name => "open-ils.vandelay.bib_queue.records.retrieve.export.csv",
384 method => 'retrieve_queued_records',
390 __PACKAGE__->register_method(
391 api_name => "open-ils.vandelay.bib_queue.records.retrieve.export.email",
392 method => 'retrieve_queued_records',
399 __PACKAGE__->register_method(
400 api_name => "open-ils.vandelay.auth_queue.records.retrieve",
401 method => 'retrieve_queued_records',
405 record_type => 'auth'
407 __PACKAGE__->register_method(
408 api_name => "open-ils.vandelay.auth_queue.records.retrieve.export.print",
409 method => 'retrieve_queued_records',
413 record_type => 'auth'
415 __PACKAGE__->register_method(
416 api_name => "open-ils.vandelay.auth_queue.records.retrieve.export.csv",
417 method => 'retrieve_queued_records',
421 record_type => 'auth'
423 __PACKAGE__->register_method(
424 api_name => "open-ils.vandelay.auth_queue.records.retrieve.export.email",
425 method => 'retrieve_queued_records',
429 record_type => 'auth'
432 __PACKAGE__->register_method(
433 api_name => "open-ils.vandelay.bib_queue.records.matches.retrieve",
434 method => 'retrieve_queued_records',
438 record_type => 'bib',
440 desc => q/Only retrieve queued bib records that have matches against existing records/
443 __PACKAGE__->register_method(
444 api_name => "open-ils.vandelay.auth_queue.records.matches.retrieve",
445 method => 'retrieve_queued_records',
449 record_type => 'auth',
451 desc => q/Only retrieve queued authority records that have matches against existing records/
455 sub retrieve_queued_records {
456 my($self, $conn, $auth, $queue_id, $options) = @_;
459 my $limit = $$options{limit} || 20;
460 my $offset = $$options{offset} || 0;
461 my $type = $self->{record_type};
463 my $e = new_editor(authtoken => $auth, xact => 1);
464 return $e->die_event unless $e->checkauth;
468 $queue = $e->retrieve_vandelay_bib_queue($queue_id) or return $e->die_event;
470 $queue = $e->retrieve_vandelay_authority_queue($queue_id) or return $e->die_event;
472 my $evt = check_queue_perms($e, $type, $queue);
473 return $evt if ($evt);
475 my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
476 my $mclass = $type eq 'bib' ? 'vbm' : 'vam';
481 column => 'eg_record',
487 where => {queue => $queue_id},
492 if($self->api_name =~ /export/) {
493 delete $query->{limit};
494 delete $query->{offset};
497 $query->{where}->{import_time} = undef if $$options{non_imported};
499 if($$options{with_import_error}) {
501 $query->{from} = {$class => {vii => {type => 'left'}}};
502 $query->{where}->{'-or'} = [
503 {'+vqbr' => {import_error => {'!=' => undef}}},
504 {'+vii' => {import_error => {'!=' => undef}}}
509 if($$options{with_rec_import_error}) {
510 $query->{where}->{import_error} = {'!=' => undef};
512 } elsif( $$options{with_item_import_error} and $type eq 'bib') {
514 $query->{from} = {$class => 'vii'};
515 $query->{where}->{'+vii'} = {import_error => {'!=' => undef}};
519 if($self->api_name =~ /matches/) {
520 # find only records that have matches
521 $query->{from} = {$class => {$mclass => {type => 'right'}}};
523 # join to mclass for sorting (see below)
524 $query->{from} = {$class => {$mclass => {type => 'left'}}};
527 # order by the matched bib records to group like queued records
528 $query->{order_by} = [
529 {class => $mclass, field => 'eg_record', transform => 'min'},
530 {class => $class, field => 'id'}
533 my $record_ids = $e->json_query($query);
535 my $retrieve = ($type eq 'bib') ?
536 'retrieve_vandelay_queued_bib_record' : 'retrieve_vandelay_queued_authority_record';
537 my $search = ($type eq 'bib') ?
538 'search_vandelay_queued_bib_record' : 'search_vandelay_queued_authority_record';
540 if ($self->api_name =~ /export/) {
541 my $rec_list = $e->$search({id => [map { $_->{id} } @$record_ids]}, {substream => 1});
542 if ($self->api_name =~ /print/) {
545 return $U->fire_object_event(
547 'vandelay.queued_'.$type.'_record.print',
552 } elsif ($self->api_name =~ /csv/) {
555 return $U->fire_object_event(
557 'vandelay.queued_'.$type.'_record.csv',
562 } elsif ($self->api_name =~ /email/) {
564 $conn->respond_complete(1);
566 for my $rec (@$rec_list) {
567 $U->create_events_for_hook(
568 'vandelay.queued_'.$type.'_record.email',
570 $e->requestor->home_ou,
579 for my $rec_id (@$record_ids) {
580 my $flesh = ['attributes', 'matches'];
581 push(@$flesh, 'import_items') if $$options{flesh_import_items};
582 my $params = {flesh => 1, flesh_fields => {$class => $flesh}};
583 my $rec = $e->$retrieve([$rec_id->{id}, $params]);
584 $rec->clear_marc if $$options{clear_marc};
585 $conn->respond($rec);
593 __PACKAGE__->register_method(
594 api_name => 'open-ils.vandelay.import_item.queue.retrieve',
595 method => 'retrieve_queue_import_items',
601 Returns Import Item (vii) objects for the selected queue.
603 with_import_error : only return items that failed to import
606 __PACKAGE__->register_method(
607 api_name => 'open-ils.vandelay.import_item.queue.export.print',
608 method => 'retrieve_queue_import_items',
614 Returns template-generated printable output of Import Item (vii) objects for the selected queue.
616 with_import_error : only return items that failed to import
619 __PACKAGE__->register_method(
620 api_name => 'open-ils.vandelay.import_item.queue.export.csv',
621 method => 'retrieve_queue_import_items',
627 Returns template-generated CSV output of Import Item (vii) objects for the selected queue.
629 with_import_error : only return items that failed to import
632 __PACKAGE__->register_method(
633 api_name => 'open-ils.vandelay.import_item.queue.export.email',
634 method => 'retrieve_queue_import_items',
640 Emails template-generated output of Import Item (vii) objects for the selected queue.
642 with_import_error : only return items that failed to import
646 sub retrieve_queue_import_items {
647 my($self, $conn, $auth, $q_id, $options) = @_;
650 my $limit = $$options{limit} || 20;
651 my $offset = $$options{offset} || 0;
653 my $e = new_editor(authtoken => $auth);
654 return $e->event unless $e->checkauth;
656 my $queue = $e->retrieve_vandelay_bib_queue($q_id) or return $e->event;
657 my $evt = check_queue_perms($e, 'bib', $queue);
661 select => {vii => ['id']},
669 filter => {id => $q_id}
675 order_by => {'vii' => ['record','id']},
679 if($self->api_name =~ /export/) {
680 delete $query->{limit};
681 delete $query->{offset};
684 $query->{where} = {'+vii' => {import_error => {'!=' => undef}}}
685 if $$options{with_import_error};
687 my $items = $e->json_query($query);
688 my $item_list = $e->search_vandelay_import_item({id => [map { $_->{id} } @$items]});
689 if ($self->api_name =~ /export/) {
690 if ($self->api_name =~ /print/) {
692 return $U->fire_object_event(
694 'vandelay.import_items.print',
699 } elsif ($self->api_name =~ /csv/) {
701 return $U->fire_object_event(
703 'vandelay.import_items.csv',
708 } elsif ($self->api_name =~ /email/) {
710 $conn->respond_complete(1);
712 for my $item (@$item_list) {
713 $U->create_events_for_hook(
714 'vandelay.import_items.email',
716 $e->requestor->home_ou,
725 for my $item (@$item_list) {
726 $conn->respond($item);
733 sub check_queue_perms {
734 my($e, $type, $queue) = @_;
735 if ($type eq 'bib') {
736 return $e->die_event unless
737 ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
738 $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
740 return $e->die_event unless
741 ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
742 $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
748 __PACKAGE__->register_method(
749 api_name => "open-ils.vandelay.bib_record.list.import",
750 method => 'import_record_list',
757 __PACKAGE__->register_method(
758 api_name => "open-ils.vandelay.auth_record.list.import",
759 method => 'import_record_list',
763 record_type => 'auth'
766 sub import_record_list {
767 my($self, $conn, $auth, $rec_ids, $args) = @_;
768 my $e = new_editor(authtoken => $auth, xact => 1);
769 return $e->die_event unless $e->checkauth;
771 my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $args);
772 try {$e->rollback} otherwise {};
774 return {complete => 1};
778 __PACKAGE__->register_method(
779 api_name => "open-ils.vandelay.bib_queue.import",
780 method => 'import_queue',
784 max_bundle_count => 1,
785 record_type => 'bib',
788 Attempts to import all non-imported records for the selected queue.
789 Will also attempt import of all non-imported items.
794 __PACKAGE__->register_method(
795 api_name => "open-ils.vandelay.auth_queue.import",
796 method => 'import_queue',
800 max_bundle_count => 1,
801 record_type => 'auth'
805 my($self, $conn, $auth, $q_id, $options) = @_;
806 $conn->max_chunk_count($self->{max_bundle_count}) if (!$conn->can('max_bundle_count') && $self->{max_bundle_count});
808 my $e = new_editor(authtoken => $auth, xact => 1);
809 return $e->die_event unless $e->checkauth;
811 my $type = $self->{record_type};
812 my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
814 # First, collect the not-yet-imported records
815 my $query = {queue => $q_id, import_time => undef};
816 my $search = ($type eq 'bib') ?
817 'search_vandelay_queued_bib_record' :
818 'search_vandelay_queued_authority_record';
819 my $rec_ids = $e->$search($query, {idlist => 1});
821 # Now add any imported records that have un-imported items
824 my $item_recs = $e->json_query({
825 select => {vqbr => ['id']},
826 from => {vqbr => 'vii'},
830 import_time => {'!=' => undef}
832 '+vii' => {import_time => undef}
836 push(@$rec_ids, map {$_->{id}} @$item_recs);
839 my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $options);
840 try {$e->rollback} otherwise {}; # only using this to make the read authoritative -- don't die from it
842 return {complete => 1};
845 # returns a list of queued record IDs for a given queue that
846 # have at least one entry in the match table
848 sub queued_records_with_matches {
849 my($e, $type, $q_id, $limit, $offset, $filter) = @_;
851 my $match_class = 'vbm';
852 my $rec_class = 'vqbr';
853 if($type eq 'auth') {
854 $match_class = 'vam';
859 $filter->{queue} = $q_id;
863 select => {$match_class => ['queued_record']},
868 fkey => 'queued_record',
875 if($limit or defined $offset) {
878 $query->{limit} = $limit;
879 $query->{offset} = $offset;
882 my $data = $e->json_query($query);
883 return [ map {$_->{queued_record}} @$data ];
887 # cache of import item org unit settings.
888 # used in apply_import_item_defaults() below,
889 # but reset on each call to import_record_list_impl()
890 my %item_defaults_cache;
892 sub import_record_list_impl {
893 my($self, $conn, $rec_ids, $requestor, $args) = @_;
895 my $overlay_map = $args->{overlay_map} || {};
896 my $type = $self->{record_type};
898 %item_defaults_cache = ();
904 total => scalar(@$rec_ids),
905 report_all => $$args{report_all}
908 $conn->max_chunk_count(1) if (!$conn->can('max_bundle_size') && $conn->can('max_chunk_size') && $$args{report_all});
910 my $auto_overlay_exact = $$args{auto_overlay_exact};
911 my $auto_overlay_1match = $$args{auto_overlay_1match};
912 my $auto_overlay_best = $$args{auto_overlay_best_match};
913 my $match_quality_ratio = $$args{match_quality_ratio};
914 my $merge_profile = $$args{merge_profile};
915 my $ft_merge_profile = $$args{fall_through_merge_profile};
916 my $bib_source = $$args{bib_source};
917 my $import_no_match = $$args{import_no_match};
918 my $strip_grps = $$args{strip_field_groups}; # bib-only
920 my $overlay_func = 'vandelay.overlay_bib_record';
921 my $auto_overlay_func = 'vandelay.auto_overlay_bib_record';
922 my $auto_overlay_best_func = 'vandelay.auto_overlay_bib_record_with_best';
923 my $retrieve_func = 'retrieve_vandelay_queued_bib_record';
924 my $update_func = 'update_vandelay_queued_bib_record';
925 my $search_func = 'search_vandelay_queued_bib_record';
926 my $retrieve_queue_func = 'retrieve_vandelay_bib_queue';
927 my $update_queue_func = 'update_vandelay_bib_queue';
928 my $delete_queue_func = 'delete_vandelay_bib_queue';
929 my $rec_class = 'vqbr';
931 my $editor = new_editor();
934 my $sources = $editor->search_config_bib_source({id => {'!=' => undef}});
935 $bib_sources{$_->id} = $_->source for @$sources;
937 if($type eq 'auth') {
938 $overlay_func =~ s/bib/authority/o;
939 $auto_overlay_func =~ s/bib/authority/o;
940 $auto_overlay_best_func =~ s/bib/authority/o;
941 $retrieve_func =~ s/bib/authority/o;
942 $retrieve_queue_func =~ s/bib/authority/o;
943 $update_queue_func =~ s/bib/authority/o;
944 $update_func =~ s/bib/authority/o;
945 $search_func =~ s/bib/authority/o;
946 $delete_queue_func =~ s/bib/authority/o;
950 my $new_rec_perm_cache;
952 for my $rec_id (@$rec_ids) {
955 my $overlay_target = $overlay_map->{$rec_id};
957 my $e = new_editor(xact => 1);
958 $e->requestor($requestor);
960 $$report_args{e} = $e;
961 $$report_args{evt} = undef;
962 $$report_args{import_error} = undef;
963 $$report_args{no_import} = 0;
965 my $rec = $e->$retrieve_func([
968 flesh_fields => { $rec_class => ['matches']},
973 $$report_args{evt} = $e->event;
974 finish_rec_import_attempt($report_args);
978 if($rec->import_time) {
979 # if the record is already imported, that means it may have
980 # un-imported copies. Add to success list for later processing.
981 push(@success_rec_ids, $rec_id);
986 $$report_args{rec} = $rec;
987 $queues{$rec->queue} = 1;
992 if ($type eq 'bib') {
993 # strip configured / selected MARC tags from inbound records
995 my $marcdoc = XML::LibXML->new->parse_string($rec->marc);
996 $rec->marc($U->strip_marc_fields($e, $marcdoc, $strip_grps));
999 # Set the imported record's 905$u, so
1000 # editor/edit_date are set correctly.
1001 my $marcdoc = XML::LibXML->new->parse_string($rec->marc);
1002 $rec->marc($U->set_marc_905u($marcdoc, $requestor->usrname));
1004 unless ($e->$update_func($rec)) {
1005 $$report_args{evt} = $e->die_event;
1006 finish_rec_import_attempt($report_args);
1010 if(defined $overlay_target) {
1011 # Caller chose an explicit overlay target
1013 my $res = $e->json_query(
1024 if($res and ($res = $res->[0])) {
1026 if($res->{$overlay_func} eq 't') {
1027 $logger->info("vl: $type direct overlay succeeded for queued rec ".
1028 "$rec_id and overlay target $overlay_target");
1030 $rec->imported_as($overlay_target);
1035 $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
1040 if($auto_overlay_1match) { # overlay if there is exactly 1 match
1042 my %match_recs = map { $_->eg_record => 1 } @{$rec->matches};
1044 if( scalar(keys %match_recs) == 1) { # all matches point to the same record
1046 ($imported, $error, $rec) = try_auto_overlay(
1049 $auto_overlay_best_func,
1053 $match_quality_ratio,
1060 if(!$imported and !$error and $auto_overlay_exact and scalar(@{$rec->matches}) == 1 ) {
1062 # caller says to overlay if there is an /exact/ match
1063 # $auto_overlay_func only proceeds and returns true on exact matches
1065 my $res = $e->json_query(
1075 if($res and ($res = $res->[0])) {
1077 if($res->{$auto_overlay_func} eq 't') {
1078 $logger->info("vl: $type auto-overlay succeeded for queued rec $rec_id");
1081 # re-fetch the record to pick up the imported_as value from the DB
1082 $$report_args{rec} = $rec = $e->$retrieve_func([
1083 $rec_id, {flesh => 1, flesh_fields => {$rec_class => ['matches']}}]);
1086 $logger->info("vl: $type auto-overlay failed for queued rec $rec_id");
1091 $logger->error("vl: Error attempting overlay with func=$auto_overlay_func, profile=$merge_profile, record=$rec_id");
1095 if(!$imported and !$error and $auto_overlay_best and scalar(@{$rec->matches}) > 0 ) {
1096 # caller says to overlay the best match
1098 ($imported, $error, $rec) = try_auto_overlay(
1101 $auto_overlay_best_func,
1105 $match_quality_ratio,
1111 if(!$imported and !$error and $import_no_match and scalar(@{$rec->matches}) == 0) {
1113 # No overlay / merge occurred. Do a traditional record import by creating a new record
1115 if (!$new_rec_perm_cache) {
1116 $new_rec_perm_cache = {};
1118 # all users creating new records are required to have the basic permission.
1119 # if the client requests, we can enforce extra permissions for creating new records.
1120 # for speed, check the permissions the first time then cache the result.
1122 my $perm = ($type eq 'bib') ? 'IMPORT_MARC' : 'IMPORT_AUTHORITY_MARC';
1123 my $xperm = $$args{new_rec_perm};
1124 my $rec_ou = $e->requestor->ws_ou;
1126 $new_rec_perm_cache->{evt} = $e->die_event
1127 if !$e->allowed($perm, $rec_ou) || ($xperm and !$e->allowed($xperm, $rec_ou));
1130 if ($new_rec_perm_cache->{evt}) {
1132 # a cached event won't roll back the transaction (a la die_event), but
1133 # the transaction will get rolled back in finish_rec_import_attempt() below
1134 $$report_args{evt} = $new_rec_perm_cache->{evt};
1135 $$report_args{import_error} = 'import.record.perm_failure';
1137 } else { # perm checks succeeded
1139 $logger->info("vl: creating new $type record for queued record $rec_id");
1141 if ($type eq 'bib') {
1143 $record = OpenILS::Application::Cat::BibCommon->biblio_record_xml_import(
1144 $e, $rec->marc, $bib_sources{$rec->bib_source}, undef, 1);
1146 } else { # authority record
1148 $record = OpenILS::Application::Cat::AuthCommon->import_authority_record($e, $rec->marc); #$source);
1151 if($U->event_code($record)) {
1152 $$report_args{import_error} = 'import.duplicate.tcn'
1153 if $record->{textcode} eq 'OPEN_TCN_NOT_FOUND';
1154 $$report_args{evt} = $record;
1158 $logger->info("vl: successfully imported new $type record");
1159 $rec->imported_as($record->id);
1168 $rec->import_time('now');
1169 $rec->clear_import_error;
1170 $rec->clear_error_detail;
1172 if($e->$update_func($rec)) {
1174 if($type eq 'bib') {
1176 # see if this record is linked from an acq record.
1177 my $li = $e->search_acq_lineitem(
1178 {queued_record => $rec->id, state => {'!=' => 'canceled'}})->[0];
1181 # if so, update the acq lineitem to point to the imported record
1182 $li->eg_bib_id($rec->imported_as);
1183 $$report_args{evt} = $e->die_event unless $e->update_acq_lineitem($li);
1187 push @success_rec_ids, $rec_id;
1188 finish_rec_import_attempt($report_args);
1196 $logger->info("vl: record $rec_id was not imported");
1197 $$report_args{evt} = $e->event unless $$report_args{evt};
1198 $$report_args{no_import} = 1;
1199 finish_rec_import_attempt($report_args);
1203 # see if we need to mark any queues as complete
1204 for my $q_id (keys %queues) {
1206 my $e = new_editor(xact => 1);
1207 my $remaining = $e->$search_func(
1208 [{queue => $q_id, import_time => undef}, {limit =>1}], {idlist => 1});
1210 unless(@$remaining) {
1211 my $queue = $e->$retrieve_queue_func($q_id);
1212 unless($U->is_true($queue->complete)) {
1213 $queue->complete('t');
1214 $e->$update_queue_func($queue) or return $e->die_event;
1223 import_record_asset_list_impl($conn, \@success_rec_ids, $requestor, $args) if @success_rec_ids;
1225 $conn->respond({total => $$report_args{total}, progress => $$report_args{progress}});
1230 sub try_auto_overlay {
1233 my $report_args = shift;
1234 my $overlay_func = shift;
1235 my $retrieve_func = shift;
1236 my $rec_class = shift;
1238 my $match_quality_ratio = shift;
1239 my $merge_profile = shift;
1240 my $ft_merge_profile = shift;
1245 # Find the best match and overlay if the quality ratio allows it.
1246 my $res = $e->json_query(
1252 $match_quality_ratio
1257 if($res and ($res = $res->[0])) {
1259 if($res->{$overlay_func} eq 't') {
1261 # first attempt succeeded
1266 # quality-limited merge failed with insufficient quality. If there is a
1267 # fall-through merge profile, re-do the merge with the alternate profile
1268 # and no quality restriction.
1270 if($ft_merge_profile and $match_quality_ratio > 0) {
1272 $logger->info("vl: $type auto-merge failed with profile $merge_profile; ".
1273 "re-merging with fall-through profile $ft_merge_profile");
1275 my $res = $e->json_query(
1281 0 # minimum quality not required
1286 if($res and ($res = $res->[0])) {
1288 if($res->{$overlay_func} eq 't') {
1290 # second attempt succeeded
1295 # failed to merge on second attempt
1296 $logger->info("vl: $type auto-merge with fall-through failed for queued rec $rec_id");
1300 # second attempt died
1302 $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
1307 # failed to merge on first attempt, no fall-through was provided
1308 $$report_args{import_error} = 'overlay.record.quality' if $match_quality_ratio > 0;
1309 $logger->info("vl: $type auto-merge failed for queued rec $rec_id");
1315 # first attempt died
1317 $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
1322 # at least 1 of the attempts succeeded
1323 $logger->info("vl: $type auto-merge succeeded for queued rec $rec_id");
1325 # re-fetch the record to pick up the imported_as value from the DB
1326 $$report_args{rec} = $e->$retrieve_func([
1327 $rec_id, {flesh => 1, flesh_fields => {$rec_class => ['matches']}}]);
1330 return ($imported, $error, $$report_args{rec});
1334 # tracks any import errors, commits the current xact, responds to the client
1335 sub finish_rec_import_attempt {
1337 my $evt = $$args{evt};
1338 my $rec = $$args{rec};
1341 my $error = $$args{import_error};
1342 $error = 'general.unknown' if $evt and not $error;
1347 if($error or $evt) {
1349 # since an error occurred, there's no guarantee the transaction wasn't
1350 # rolled back. force a rollback and create a new editor.
1352 $e = new_editor(xact => 1);
1353 $rec->import_error($error);
1356 my $detail = sprintf("%s : %s", $evt->{textcode}, substr($evt->{desc}, 0, 140));
1357 $rec->error_detail($detail);
1360 my $method = 'update_vandelay_queued_bib_record';
1361 $method =~ s/bib/authority/ if $$args{type} eq 'auth';
1362 $e->$method($rec) and $e->commit or $e->rollback;
1365 # commit the successful import
1370 # requested queued record was not found
1375 if($$args{report_all} or ($$args{progress} % $$args{step}) == 0) {
1376 $$args{conn}->respond({
1377 total => $$args{total},
1378 progress => $$args{progress},
1379 imported => ($rec) ? $rec->id : undef,
1380 import_error => $error,
1381 no_import => $$args{no_import},
1384 $$args{step} *= 2 unless $$args{step} == 256;
1394 __PACKAGE__->register_method(
1395 api_name => "open-ils.vandelay.bib_queue.owner.retrieve",
1396 method => 'owner_queue_retrieve',
1400 record_type => 'bib'
1402 __PACKAGE__->register_method(
1403 api_name => "open-ils.vandelay.authority_queue.owner.retrieve",
1404 method => 'owner_queue_retrieve',
1408 record_type => 'auth'
1411 sub owner_queue_retrieve {
1412 my($self, $conn, $auth, $owner_id, $filters) = @_;
1413 my $e = new_editor(authtoken => $auth, xact => 1);
1414 return $e->die_event unless $e->checkauth;
1415 $owner_id = $e->requestor->id; # XXX add support for viewing other's queues?
1418 my $search = {owner => $owner_id};
1419 $search->{$_} = $filters->{$_} for keys %$filters;
1421 if($self->{record_type} eq 'bib') {
1422 $queues = $e->search_vandelay_bib_queue(
1423 [$search, {order_by => {vbq => 'evergreen.lowercase(name)'}}]);
1425 $queues = $e->search_vandelay_authority_queue(
1426 [$search, {order_by => {vaq => 'evergreen.lowercase(name)'}}]);
1428 $conn->respond($_) for @$queues;
1433 __PACKAGE__->register_method(
1434 api_name => "open-ils.vandelay.bib_queue.delete",
1435 method => "delete_queue",
1438 record_type => 'bib'
1440 __PACKAGE__->register_method(
1441 api_name => "open-ils.vandelay.auth_queue.delete",
1442 method => "delete_queue",
1445 record_type => 'auth'
1449 my($self, $conn, $auth, $q_id) = @_;
1450 my $e = new_editor(xact => 1, authtoken => $auth);
1451 return $e->die_event unless $e->checkauth;
1452 if($self->{record_type} eq 'bib') {
1453 return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
1454 my $queue = $e->retrieve_vandelay_bib_queue($q_id)
1455 or return $e->die_event;
1456 $e->delete_vandelay_bib_queue($queue)
1457 or return $e->die_event;
1459 return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
1460 my $queue = $e->retrieve_vandelay_authority_queue($q_id)
1461 or return $e->die_event;
1462 $e->delete_vandelay_authority_queue($queue)
1463 or return $e->die_event;
1470 __PACKAGE__->register_method(
1471 api_name => "open-ils.vandelay.queued_bib_record.html",
1472 method => 'queued_record_html',
1476 record_type => 'bib'
1478 __PACKAGE__->register_method(
1479 api_name => "open-ils.vandelay.queued_authority_record.html",
1480 method => 'queued_record_html',
1484 record_type => 'auth'
1487 sub queued_record_html {
1488 my($self, $conn, $auth, $rec_id) = @_;
1489 my $e = new_editor(xact=>1,authtoken => $auth);
1490 return $e->die_event unless $e->checkauth;
1492 if($self->{record_type} eq 'bib') {
1493 $rec = $e->retrieve_vandelay_queued_bib_record($rec_id)
1494 or return $e->die_event;
1496 $rec = $e->retrieve_vandelay_queued_authority_record($rec_id)
1497 or return $e->die_event;
1501 return $U->simplereq(
1503 'open-ils.search.biblio.record.html', undef, 1, $rec->marc);
1507 __PACKAGE__->register_method(
1508 api_name => "open-ils.vandelay.bib_queue.summary.retrieve",
1509 method => 'retrieve_queue_summary',
1513 record_type => 'bib'
1515 __PACKAGE__->register_method(
1516 api_name => "open-ils.vandelay.auth_queue.summary.retrieve",
1517 method => 'retrieve_queue_summary',
1521 record_type => 'auth'
1524 sub retrieve_queue_summary {
1525 my($self, $conn, $auth, $queue_id) = @_;
1526 my $e = new_editor(xact=>1, authtoken => $auth);
1527 return $e->die_event unless $e->checkauth;
1530 my $type = $self->{record_type};
1531 if($type eq 'bib') {
1532 $queue = $e->retrieve_vandelay_bib_queue($queue_id)
1533 or return $e->die_event;
1535 $queue = $e->retrieve_vandelay_authority_queue($queue_id)
1536 or return $e->die_event;
1539 my $evt = check_queue_perms($e, $type, $queue);
1540 return $evt if $evt;
1542 my $search = 'search_vandelay_queued_bib_record';
1543 $search =~ s/bib/authority/ if $type ne 'bib';
1547 total => scalar(@{$e->$search({queue => $queue_id}, {idlist=>1})}),
1548 imported => scalar(@{$e->$search({queue => $queue_id, import_time => {'!=' => undef}}, {idlist=>1})}),
1551 my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
1552 $summary->{rec_import_errors} = $e->json_query({
1553 select => {$class => [{alias => 'count', column => 'id', transform => 'count', aggregate => 1}]},
1555 where => {queue => $queue_id, import_error => {'!=' => undef}}
1558 if($type eq 'bib') {
1560 # count of all items attached to records in the queue in question
1562 select => {vii => [{alias => 'count', column => 'id', transform => 'count', aggregate => 1}]},
1567 select => {vqbr => ['id']},
1569 where => {queue => $queue_id}
1574 $summary->{total_items} = $e->json_query($query)->[0]->{count};
1576 # count of items we attempted to import, but errored, attached to records in the queue in question
1577 $query->{where}->{import_error} = {'!=' => undef};
1578 $summary->{item_import_errors} = $e->json_query($query)->[0]->{count};
1580 # count of items we successfully imported attached to records in the queue in question
1581 delete $query->{where}->{import_error};
1582 $query->{where}->{import_time} = {'!=' => undef};
1583 $summary->{total_items_imported} = $e->json_query($query)->[0]->{count};
1589 # --------------------------------------------------------------------------------
1590 # Given a list of queued record IDs, imports all items attached to those records
1591 # --------------------------------------------------------------------------------
1592 sub import_record_asset_list_impl {
1593 my($conn, $rec_ids, $requestor, $args) = @_;
1595 my $roe = new_editor(xact=> 1, requestor => $requestor);
1597 # for speed, filter out any records have not been
1598 # imported or have no import items to load
1599 $rec_ids = $roe->json_query({
1600 select => {vqbr => ['id']},
1601 from => {vqbr => 'vii'},
1602 where => {'+vqbr' => {
1604 import_time => {'!=' => undef}
1608 $rec_ids = [map {$_->{id}} @$rec_ids];
1612 total => scalar(@$rec_ids),
1613 step => 1, # how often to respond
1618 for my $rec_id (@$rec_ids) {
1619 my $rec = $roe->retrieve_vandelay_queued_bib_record($rec_id);
1620 my $item_ids = $roe->search_vandelay_import_item(
1621 {record => $rec->id, import_error => undef},
1625 # if any items have no call_number label and a value should be
1626 # applied automatically (via org settings), we want to use the same
1627 # call number label for every copy per org per record.
1628 my $auto_callnumber = {};
1630 my $opp_acq_copy_overlay = $args->{opp_acq_copy_overlay};
1631 my @overlaid_copy_ids;
1632 for my $item_id (@$item_ids) {
1633 my $e = new_editor(requestor => $requestor, xact => 1);
1634 my $item = $e->retrieve_vandelay_import_item($item_id);
1635 my ($copy, $vol, $evt);
1637 $$report_args{e} = $e;
1638 $$report_args{evt} = undef;
1639 $$report_args{import_item} = $item;
1640 $$report_args{import_error} = undef;
1642 if (my $copy_id = $item->internal_id) { # assignment
1643 # copy matches an existing copy. Overlay instead of create.
1645 $logger->info("vl: performing copy overlay for internal_id=$copy_id");
1647 my $qt = $e->json_query({
1648 select => {vbq => ['queue_type']},
1649 from => {vqbr => 'vbq'},
1650 where => {'+vqbr' => {id => $rec_id}}
1651 })->[0]->{queue_type};
1654 # internal_id for ACQ queues refers to acq.lineitem_detail.id
1655 # pull the real copy id from the acq LID
1657 my $lid = $e->retrieve_acq_lineitem_detail($copy_id);
1659 $$report_args{evt} = $e->die_event;
1660 respond_with_status($report_args);
1663 $copy_id = $lid->eg_copy_id;
1664 $logger->info("vl: performing ACQ copy overlay for copy $copy_id");
1667 $copy = $e->search_asset_copy([
1668 {id => $copy_id, deleted => 'f'},
1669 {flesh => 1, flesh_fields => {acp => ['call_number']}}
1673 $$report_args{evt} = $e->die_event;
1674 respond_with_status($report_args);
1678 # prevent update of unrelated copies
1679 if ($copy->call_number->record != $rec->imported_as) {
1680 $logger->info("vl: attempt to overlay unrelated copy=$copy_id; rec=".$rec->imported_as);
1682 $evt = OpenILS::Event->new('INVALID_IMPORT_COPY_ID',
1683 note => 'Cannot overlay copies for unlinked bib',
1684 bre => $rec->imported_as,
1687 $$report_args{evt} = $evt;
1688 respond_with_status($report_args);
1691 } elsif ($opp_acq_copy_overlay) { # we are going to "opportunistically" overlay received, in-process acq copies
1692 # recv_time should never be null if the copy status is
1693 # "In Process", so that is just a double-check
1696 "recv_time" => {"!=" => undef},
1697 "owning_lib" => $item->owning_lib,
1698 "+acn" => {"record" => $rec->imported_as},
1699 "+acp" => {"status" => OILS_COPY_STATUS_IN_PROCESS}
1709 "acqlid" => ["eg_copy_id"],
1710 "acp" => ["call_number"]
1714 # don't overlay the same copy twice
1715 $query->[0]{"+acp"}{"id"} = {"not in" => \@overlaid_copy_ids} if @overlaid_copy_ids;
1716 if (my $acqlid = $e->search_acq_lineitem_detail($query)->[0]) {
1717 $copy = $acqlid->eg_copy_id;
1718 push(@overlaid_copy_ids, $copy->id);
1722 if ($copy) { # we found a copy to overlay
1724 # overlaying copies requires an extra permission
1725 if (!$e->allowed("IMPORT_OVERLAY_COPY", $copy->call_number->owning_lib)) {
1726 $$report_args{evt} = $e->die_event;
1727 respond_with_status($report_args);
1731 # are we updating the call-number?
1732 if ($item->call_number and $item->call_number ne $copy->call_number->label) {
1734 my $count = $e->json_query({
1735 select => {acp => [{
1738 transform => 'count',
1744 call_number => $copy->call_number->id
1750 my $evol = $e->search_asset_call_number({
1751 id => {'<>' => $copy->call_number->id},
1752 label => $item->call_number,
1753 owning_lib => $copy->call_number->owning_lib,
1754 record => $copy->call_number->record,
1755 prefix => $copy->call_number->prefix,
1756 suffix => $copy->call_number->suffix,
1761 # call number for overlayed copy changed to a
1762 # label already in use by another call number.
1763 # merge the old CN into the new CN
1766 "vl: moving copy to new call number ".
1767 $item->call_number);
1770 OpenILS::Application::Cat::Merge::merge_volumes(
1771 $e, [$copy->call_number], $evol);
1774 $$report_args{evt} = $err;
1775 respond_with_status($report_args);
1779 # update our copy *cough* of the copy to pick up
1780 # any changes made my merge_volumes
1781 $copy = $e->retrieve_asset_copy([
1783 {flesh => 1, flesh_fields => {acp => ['call_number']}}
1788 "vl: updating copy call number label".
1789 $item->call_number);
1791 $copy->call_number->label($item->call_number);
1792 if (!$e->update_asset_call_number($copy->call_number)) {
1793 $$report_args{evt} = $e->die_event;
1794 respond_with_status($report_args);
1801 # otherwise, move the copy to a new/existing
1802 # call-number with the given label/owner
1803 # note that overlay does not allow the owning_lib
1804 # to be changed. Should it?
1806 $logger->info("vl: moving copy to new callnumber in copy overlay");
1809 OpenILS::Application::Cat::AssetCommon->find_or_create_volume(
1810 $e, $item->call_number,
1811 $copy->call_number->record,
1812 $copy->call_number->owning_lib
1816 $$report_args{evt} = $evt;
1817 respond_with_status($report_args);
1821 $copy->call_number($vol);
1825 # for every field that has a non-'' value, overlay the copy value
1826 foreach (qw/ barcode location circ_lib status
1827 circulate deposit deposit_amount ref holdable
1828 price circ_as_type alert_message opac_visible circ_modifier/) {
1830 my $val = $item->$_();
1831 $copy->$_($val) if defined $val and $val ne '';
1834 # de-flesh for update
1835 $copy->call_number($copy->call_number->id);
1836 $copy->ischanged(1);
1838 $evt = OpenILS::Application::Cat::AssetCommon->
1839 update_fleshed_copies($e, {all => 1}, undef, [$copy]);
1842 $$report_args{evt} = $evt;
1843 respond_with_status($report_args);
1849 # Creating a new copy
1850 $logger->info("vl: creating new copy in import");
1852 # appply defaults values from org settings as needed
1853 # if $auto_callnumber is unset, it will be set within
1854 apply_import_item_defaults($e, $item, $auto_callnumber);
1856 # --------------------------------------------------------------------------------
1857 # Find or create the volume
1858 # --------------------------------------------------------------------------------
1860 OpenILS::Application::Cat::AssetCommon->find_or_create_volume(
1861 $e, $item->call_number, $rec->imported_as, $item->owning_lib);
1864 $$report_args{evt} = $evt;
1865 respond_with_status($report_args);
1869 # --------------------------------------------------------------------------------
1870 # Create the new copy
1871 # --------------------------------------------------------------------------------
1872 $copy = Fieldmapper::asset::copy->new;
1873 $copy->loan_duration(2);
1874 $copy->fine_level(2);
1875 $copy->barcode($item->barcode);
1876 $copy->location($item->location);
1877 $copy->circ_lib($item->circ_lib || $item->owning_lib);
1878 $copy->status( defined($item->status) ? $item->status : OILS_COPY_STATUS_IN_PROCESS );
1879 $copy->circulate($item->circulate);
1880 $copy->deposit($item->deposit);
1881 $copy->deposit_amount($item->deposit_amount);
1882 $copy->ref($item->ref);
1883 $copy->holdable($item->holdable);
1884 $copy->price($item->price);
1885 $copy->circ_as_type($item->circ_as_type);
1886 $copy->alert_message($item->alert_message);
1887 $copy->opac_visible($item->opac_visible);
1888 $copy->circ_modifier($item->circ_modifier);
1890 # --------------------------------------------------------------------------------
1891 # Check for dupe barcode
1892 # --------------------------------------------------------------------------------
1893 if($evt = OpenILS::Application::Cat::AssetCommon->create_copy($e, $vol, $copy)) {
1894 $$report_args{evt} = $evt;
1895 $$report_args{import_error} = 'import.item.duplicate.barcode'
1896 if $evt->{textcode} eq 'ITEM_BARCODE_EXISTS';
1897 respond_with_status($report_args);
1901 # --------------------------------------------------------------------------------
1903 # --------------------------------------------------------------------------------
1904 $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
1905 $e, $copy, '', $item->pub_note, 1) if $item->pub_note;
1908 $$report_args{evt} = $evt;
1909 respond_with_status($report_args);
1913 $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
1914 $e, $copy, '', $item->priv_note) if $item->priv_note;
1917 $$report_args{evt} = $evt;
1918 respond_with_status($report_args);
1923 if ($item->stat_cat_data) {
1924 $logger->info("vl: parsing stat cat data: " . $item->stat_cat_data);
1925 my @stat_cat_pairs = split('\|\|', $item->stat_cat_data);
1926 my $stat_cat_entries = [];
1928 foreach my $stat_cat_pair (@stat_cat_pairs) {
1929 my ($stat_cat, $stat_cat_entry);
1930 my @pair_pieces = split('\|', $stat_cat_pair);
1931 if (@pair_pieces == 2) {
1932 $stat_cat = $e->search_asset_stat_cat({name=>$pair_pieces[0]})->[0];
1934 $stat_cat_entry = $e->search_asset_stat_cat_entry({'value' => $pair_pieces[1], 'stat_cat' => $stat_cat->id})->[0];
1935 push (@$stat_cat_entries, $stat_cat_entry) if $stat_cat_entry;
1938 $$report_args{import_error} = "import.item.invalid.stat_cat_format";
1942 if (!$stat_cat or !$stat_cat_entry) {
1943 $$report_args{import_error} = "import.item.invalid.stat_cat_data";
1947 if ($$report_args{import_error}) {
1948 $logger->error("vl: invalid stat cat data: " . $item->stat_cat_data);
1949 respond_with_status($report_args);
1952 $copy->stat_cat_entries( $stat_cat_entries );
1953 $copy->ischanged(1);
1954 $evt = OpenILS::Application::Cat::AssetCommon->update_copy_stat_entries($e, $copy, 0, 1); #delete_stats=0, add_or_update_only=1
1956 $$report_args{evt} = $evt;
1957 respond_with_status($report_args);
1962 if ($item->parts_data) {
1963 $logger->info("vl: parsing parts data: " . $item->parts_data);
1964 my @parts = split('\|', $item->parts_data);
1966 foreach my $part_label (@parts) {
1967 my $part_obj = $e->search_biblio_monograph_part(
1970 record=>$rec->imported_as
1975 $part_obj = Fieldmapper::biblio::monograph_part->new();
1976 $part_obj->label( $part_label );
1977 $part_obj->record( $rec->imported_as );
1978 unless($e->create_biblio_monograph_part($part_obj)) {
1979 $$report_args{evt} = $e->die_event;
1983 push @$part_objs, $part_obj;
1986 if ($$report_args{evt}) {
1987 respond_with_status($report_args);
1990 $copy->parts( $part_objs );
1991 $copy->ischanged(1);
1992 $evt = OpenILS::Application::Cat::AssetCommon->update_copy_parts($e, $copy, 0); #delete_parts=0
1994 $$report_args{evt} = $evt;
1995 respond_with_status($report_args);
2001 # set the import data on the import item
2002 $item->imported_as($copy->id); # $copy->id is set by create_copy() ^--
2003 $item->import_time('now');
2005 unless($e->update_vandelay_import_item($item)) {
2006 $$report_args{evt} = $e->die_event;
2007 respond_with_status($report_args);
2011 # --------------------------------------------------------------------------------
2012 # Item import succeeded
2013 # --------------------------------------------------------------------------------
2015 $$report_args{in_count}++;
2016 respond_with_status($report_args);
2017 $logger->info("vl: successfully imported item " . $item->barcode);
2025 sub apply_import_item_defaults {
2026 my ($e, $item, $auto_cn) = @_;
2027 my $org = $item->owning_lib || $item->circ_lib;
2028 my %c = %item_defaults_cache;
2030 # fetch and cache the org unit setting value (unless
2031 # it's already cached) and return the value to the caller
2034 return $c{$org}{$name} if defined $c{$org}{$name};
2035 my $sname = "vandelay.item.$name";
2036 $c{$org}{$name} = $U->ou_ancestor_setting_value($org, $sname, $e);
2037 $c{$org}{$name} = '' unless defined $c{$org}{$name};
2038 return $c{$org}{$name};
2041 if (!$item->barcode) {
2043 if ($set->('barcode.auto')) {
2045 my $pfx = $set->('barcode.prefix') || 'VAN';
2046 my $barcode = $pfx . $item->record . $item->id;
2048 $logger->info("vl: using auto barcode $barcode for ".$item->id);
2049 $item->barcode($barcode);
2052 $logger->error("vl: no barcode (or defualt) for item ".$item->id);
2056 if (!$item->call_number) {
2058 if ($set->('call_number.auto')) {
2060 if (!$auto_cn->{$org}) {
2061 my $pfx = $set->('call_number.prefix') || 'VAN';
2063 # use the ID of the first item to differentiate this
2064 # call number from others linked to the same record
2065 $auto_cn->{$org} = $pfx . $item->record . $item->id;
2068 $logger->info("vl: using auto call number ".$auto_cn->{$org});
2069 $item->call_number($auto_cn->{$org});
2072 $logger->error("vl: no call number or default for item ".$item->id);
2078 sub respond_with_status {
2082 # If the import failed, track the failure reason
2084 my $error = $$args{import_error};
2085 my $evt = $$args{evt};
2087 if($error or $evt) {
2089 my $item = $$args{import_item};
2090 $logger->info("vl: unable to import item " . $item->barcode);
2092 $error ||= 'general.unknown';
2093 $item->import_error($error);
2096 my $detail = sprintf("%s : %s", $evt->{textcode}, substr($evt->{desc}, 0, 140));
2097 $item->error_detail($detail);
2100 # state of the editor is unknown at this point. Force a rollback and start over.
2102 $e = new_editor(xact => 1);
2103 $e->update_vandelay_import_item($item);
2107 if($$args{report_all} or ($$args{progress} % $$args{step}) == 0) {
2108 $$args{conn}->respond({
2109 total => $$args{total},
2110 progress => $$args{progress},
2111 success_count => $$args{success_count},
2114 $$args{step} *= 2 unless $$args{step} == 256;
2120 __PACKAGE__->register_method(
2121 api_name => "open-ils.vandelay.match_set.get_tree",
2122 method => "match_set_get_tree",
2126 desc => q/For a given vms object, return a tree of match set points
2127 represented by a vmsp object with recursively fleshed
2132 sub match_set_get_tree {
2133 my ($self, $conn, $authtoken, $match_set_id) = @_;
2135 $match_set_id = int($match_set_id) or return;
2137 my $e = new_editor("authtoken" => $authtoken);
2138 $e->checkauth or return $e->die_event;
2140 my $set = $e->retrieve_vandelay_match_set($match_set_id) or
2141 return $e->die_event;
2143 $e->allowed("ADMIN_IMPORT_MATCH_SET", $set->owner) or
2144 return $e->die_event;
2146 my $tree = $e->search_vandelay_match_set_point([
2147 {"match_set" => $match_set_id, "parent" => undef},
2148 {"flesh" => -1, "flesh_fields" => {"vmsp" => ["children"]}}
2149 ]) or return $e->die_event;
2155 __PACKAGE__->register_method(
2156 api_name => "open-ils.vandelay.match_set.update",
2157 method => "match_set_update_tree",
2161 desc => q/Replace any vmsp objects associated with a given (by ID) vms
2162 with the given objects (recursively fleshed vmsp tree)./
2166 sub _walk_new_vmsp {
2167 my ($e, $match_set_id, $node, $parent_id) = @_;
2169 my $point = new Fieldmapper::vandelay::match_set_point;
2170 $point->parent($parent_id);
2171 $point->match_set($match_set_id);
2172 $point->$_($node->$_)
2173 for (qw/bool_op svf tag subfield negate quality heading/);
2175 $e->create_vandelay_match_set_point($point) or return $e->die_event;
2177 $parent_id = $e->data->id;
2178 if ($node->children && @{$node->children}) {
2179 for (@{$node->children}) {
2180 return $e->die_event if
2181 _walk_new_vmsp($e, $match_set_id, $_, $parent_id);
2188 sub match_set_update_tree {
2189 my ($self, $conn, $authtoken, $match_set_id, $tree) = @_;
2191 my $e = new_editor("xact" => 1, "authtoken" => $authtoken);
2192 $e->checkauth or return $e->die_event;
2194 my $set = $e->retrieve_vandelay_match_set($match_set_id) or
2195 return $e->die_event;
2197 $e->allowed("ADMIN_IMPORT_MATCH_SET", $set->owner) or
2198 return $e->die_event;
2200 my $existing = $e->search_vandelay_match_set_point([
2201 {"match_set" => $match_set_id},
2202 {"order_by" => {"vmsp" => "id DESC"}}
2203 ]) or return $e->die_event;
2205 # delete points, working up from leaf points to the root
2207 for my $point (shift @$existing) {
2208 if( grep {$_->parent eq $point->id} @$existing) {
2209 push(@$existing, $point);
2211 $e->delete_vandelay_match_set_point($point) or return $e->die_event;
2216 _walk_new_vmsp($e, $match_set_id, $tree);
2218 $e->commit or return $e->die_event;
2221 __PACKAGE__->register_method(
2222 api_name => 'open-ils.vandelay.bib_queue.to_bucket',
2223 method => 'bib_queue_to_bucket',
2227 desc => q/Add to or create a new bib container (bucket) with the successfully
2228 imported contents of a vandelay queue. Any user that has Vandelay
2229 queue create permissions can append or create buckets from his-her own queues./,
2231 {desc => 'Authtoken', type => 'string'},
2232 {desc => 'Queue ID', type => 'number'},
2233 {desc => 'Bucket Name', type => 'string'}
2235 return => {desc => q/
2236 {bucket => $bucket, addcount => number-of-items-added-to-bucket, item_count => total-bucket-item-count} on success,
2237 {add_count => 0} if there is nothing to do, and Event on error/}
2241 sub bib_queue_to_bucket {
2242 my ($self, $conn, $auth, $q_id, $bucket_name) = @_;
2244 my $e = new_editor(xact => 1, authtoken => $auth);
2245 return $e->die_event unless $e->checkauth;
2247 my $queue = $e->retrieve_vandelay_bib_queue($q_id)
2248 or return $e->die_event;
2250 return OpenILS::Event->new('BAD_PARAMS',
2251 note => q/Bucket creator must be queue owner/)
2252 unless $queue->owner == $e->requestor->id;
2254 # find the bib IDs that will go into the bucket
2255 my $bib_ids = $e->json_query({
2256 select => {vqbr => ['imported_as']},
2258 where => {queue => $q_id, imported_as => {'!=' => undef}}
2261 if (!@$bib_ids) { # no records to add
2263 return {add_count => 0};
2266 # allow user to add to an existing bucket by name
2267 my $bucket = $e->search_container_biblio_record_entry_bucket({
2268 owner => $e->requestor->id,
2269 name => $bucket_name,
2270 btype => 'vandelay_queue'
2273 # if the bucket does not exist, create a new one
2275 $bucket = Fieldmapper::container::biblio_record_entry_bucket->new;
2276 $bucket->name($bucket_name);
2277 $bucket->owner($e->requestor->id);
2278 $bucket->btype('vandelay_queue');
2280 $e->create_container_biblio_record_entry_bucket($bucket)
2281 or return $e->die_event;
2284 # create the new bucket items
2285 for my $bib_id ( map {$_->{imported_as}} @$bib_ids ) {
2286 my $item = Fieldmapper::container::biblio_record_entry_bucket_item->new;
2287 $item->target_biblio_record_entry($bib_id);
2288 $item->bucket($bucket->id);
2289 $e->create_container_biblio_record_entry_bucket_item($item)
2290 or return $e->die_event;
2293 # re-fetch the bucket to pick up the correct create_time
2294 $bucket = $e->retrieve_container_biblio_record_entry_bucket($bucket->id)
2295 or return $e->die_event;
2297 # get the total count of items in this bucket
2298 my $count = $e->json_query({
2299 select => {cbrebi => [{
2301 transform => 'count',
2306 where => {bucket => $bucket->id}
2313 add_count => scalar(@$bib_ids), # items added to the bucket
2314 item_count => $count->{count} # total items in buckets