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 my $U = 'OpenILS::Application::AppUtils';
27 # A list of LDR/06 values from http://loc.gov/marc
54 # --------------------------------------------------------------------------------
57 sub create_bib_queue {
64 my $match_set = shift;
65 my $import_def = shift;
66 my $match_bucket = shift;
68 my $e = new_editor(authtoken => $auth, xact => 1);
70 return $e->die_event unless $e->checkauth;
71 return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
72 $owner ||= $e->requestor->id;
74 if ($e->search_vandelay_bib_queue( {name => $name, owner => $owner, queue_type => $type})->[0]) {
76 return OpenILS::Event->new('BIB_QUEUE_EXISTS')
79 my $queue = new Fieldmapper::vandelay::bib_queue();
80 $queue->name( $name );
81 $queue->owner( $owner );
82 $queue->queue_type( $type ) if ($type);
83 $queue->item_attr_def( $import_def ) if ($import_def);
84 $queue->match_set($match_set) if $match_set;
85 $queue->match_bucket($match_bucket);
87 my $new_q = $e->create_vandelay_bib_queue( $queue );
88 return $e->die_event unless ($new_q);
93 __PACKAGE__->register_method(
94 api_name => "open-ils.vandelay.bib_queue.create",
95 method => "create_bib_queue",
101 sub create_auth_queue {
108 my $match_set = shift;
110 my $e = new_editor(authtoken => $auth, xact => 1);
112 return $e->die_event unless $e->checkauth;
113 return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
114 $owner ||= $e->requestor->id;
116 if ($e->search_vandelay_authority_queue({name => $name, owner => $owner, queue_type => $type})->[0]) {
118 return OpenILS::Event->new('AUTH_QUEUE_EXISTS')
121 my $queue = new Fieldmapper::vandelay::authority_queue();
122 $queue->name( $name );
123 $queue->owner( $owner );
124 $queue->queue_type( $type ) if ($type);
126 my $new_q = $e->create_vandelay_authority_queue( $queue );
127 $e->die_event unless ($new_q);
132 __PACKAGE__->register_method(
133 api_name => "open-ils.vandelay.authority_queue.create",
134 method => "create_auth_queue",
139 sub add_record_to_bib_queue {
146 my $bib_source = shift;
148 my $e = new_editor(authtoken => $auth, xact => 1);
150 $queue = $e->retrieve_vandelay_bib_queue($queue);
152 return $e->die_event unless $e->checkauth;
153 return $e->die_event unless
154 ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
155 $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
157 my $new_rec = _add_bib_rec($e, $marc, $queue->id, $purpose, $bib_source);
159 return $e->die_event unless ($new_rec);
163 __PACKAGE__->register_method(
164 api_name => "open-ils.vandelay.queued_bib_record.create",
165 method => "add_record_to_bib_queue",
175 my $bib_source = shift;
177 my $rec = new Fieldmapper::vandelay::queued_bib_record();
179 $rec->queue( $queue );
180 $rec->purpose( $purpose ) if ($purpose);
181 $rec->bib_source($bib_source);
183 return $e->create_vandelay_queued_bib_record( $rec );
186 sub add_record_to_authority_queue {
194 my $e = new_editor(authtoken => $auth, xact => 1);
196 $queue = $e->retrieve_vandelay_authority_queue($queue);
198 return $e->die_event unless $e->checkauth;
199 return $e->die_event unless
200 ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
201 $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
203 my $new_rec = _add_auth_rec($e, $marc, $queue->id, $purpose);
205 return $e->die_event unless ($new_rec);
209 __PACKAGE__->register_method(
210 api_name => "open-ils.vandelay.queued_authority_record.create",
211 method => "add_record_to_authority_queue",
222 my $rec = new Fieldmapper::vandelay::queued_authority_record();
224 $rec->queue( $queue );
225 $rec->purpose( $purpose ) if ($purpose);
227 return $e->create_vandelay_queued_authority_record( $rec );
234 my $fingerprint = shift || '';
235 my $queue_id = shift;
237 my $filename = shift;
238 my $bib_source = shift;
240 my $e = new_editor(authtoken => $auth, xact => 1);
241 return $e->die_event unless $e->checkauth;
244 my $type = $self->{record_type};
247 $queue = $e->retrieve_vandelay_bib_queue($queue_id) or return $e->die_event;
249 $queue = $e->retrieve_vandelay_authority_queue($queue_id) or return $e->die_event;
252 my $evt = check_queue_perms($e, $type, $queue);
253 return $evt if ($evt);
255 my $cache = new OpenSRF::Utils::Cache();
258 my $data = $cache->get_cache('vandelay_import_spool_' . $fingerprint);
259 $purpose = $data->{purpose};
260 $filename = $data->{path};
261 $bib_source = $data->{bib_source};
264 unless(-r $filename) {
265 $logger->error("unable to read MARC file $filename");
266 return -1; # make this an event XXX
269 $logger->info("vandelay spooling $fingerprint purpose=$purpose file=$filename");
271 my $marctype = 'USMARC';
274 $marctype = 'XML' if (getc(F) =~ /^\D/o);
277 my $batch = new MARC::Batch ($marctype, $filename);
280 my $response_scale = 10;
283 while (try { $r = $batch->next } otherwise { $r = -1 }) {
285 $logger->warn("Processing of record $count in set $filename failed. Skipping this record");
289 $logger->info("processing record $count");
292 my $xml = clean_marc($r);
295 # Check the leader to ensure we've got something resembling the expected
296 # Allow spaces to give records the benefit of the doubt
297 my $ldr_type = substr($r->leader(), 6, 1);
298 if ($type eq 'bib' && ($record_types{$ldr_type}) eq 'bib' || $ldr_type eq ' ') {
299 $qrec = _add_bib_rec( $e, $xml, $queue_id, $purpose, $bib_source ) or return $e->die_event;
300 } elsif ($type eq 'auth' && ($record_types{$ldr_type}) eq 'auth' || $ldr_type eq ' ') {
301 $qrec = _add_auth_rec( $e, $xml, $queue_id, $purpose ) or return $e->die_event;
303 # I don't know how to handle this type; rock on
304 $logger->error("In process_spool(), type was $type and leader type was $ldr_type ; not currently supported");
308 if($self->api_name =~ /stream_results/ and $qrec) {
309 $client->respond($qrec->id)
311 $client->respond($count) if (++$count % $response_scale) == 0;
312 $response_scale *= 10 if ($count == ($response_scale * 10));
316 $logger->warn("Encountered a bad record at Vandelay ingest: ".$error);
322 $cache->delete_cache('vandelay_import_spool_' . $fingerprint) if $fingerprint;
326 __PACKAGE__->register_method(
327 api_name => "open-ils.vandelay.bib.process_spool",
328 method => "process_spool",
334 __PACKAGE__->register_method(
335 api_name => "open-ils.vandelay.auth.process_spool",
336 method => "process_spool",
340 record_type => 'auth'
343 __PACKAGE__->register_method(
344 api_name => "open-ils.vandelay.bib.process_spool.stream_results",
345 method => "process_spool",
352 __PACKAGE__->register_method(
353 api_name => "open-ils.vandelay.auth.process_spool.stream_results",
354 method => "process_spool",
359 record_type => 'auth'
362 __PACKAGE__->register_method(
363 api_name => "open-ils.vandelay.bib_queue.records.retrieve",
364 method => 'retrieve_queued_records',
370 __PACKAGE__->register_method(
371 api_name => "open-ils.vandelay.bib_queue.records.retrieve.export.print",
372 method => 'retrieve_queued_records',
378 __PACKAGE__->register_method(
379 api_name => "open-ils.vandelay.bib_queue.records.retrieve.export.csv",
380 method => 'retrieve_queued_records',
386 __PACKAGE__->register_method(
387 api_name => "open-ils.vandelay.bib_queue.records.retrieve.export.email",
388 method => 'retrieve_queued_records',
395 __PACKAGE__->register_method(
396 api_name => "open-ils.vandelay.auth_queue.records.retrieve",
397 method => 'retrieve_queued_records',
401 record_type => 'auth'
403 __PACKAGE__->register_method(
404 api_name => "open-ils.vandelay.auth_queue.records.retrieve.export.print",
405 method => 'retrieve_queued_records',
409 record_type => 'auth'
411 __PACKAGE__->register_method(
412 api_name => "open-ils.vandelay.auth_queue.records.retrieve.export.csv",
413 method => 'retrieve_queued_records',
417 record_type => 'auth'
419 __PACKAGE__->register_method(
420 api_name => "open-ils.vandelay.auth_queue.records.retrieve.export.email",
421 method => 'retrieve_queued_records',
425 record_type => 'auth'
428 __PACKAGE__->register_method(
429 api_name => "open-ils.vandelay.bib_queue.records.matches.retrieve",
430 method => 'retrieve_queued_records',
434 record_type => 'bib',
436 desc => q/Only retrieve queued bib records that have matches against existing records/
439 __PACKAGE__->register_method(
440 api_name => "open-ils.vandelay.auth_queue.records.matches.retrieve",
441 method => 'retrieve_queued_records',
445 record_type => 'auth',
447 desc => q/Only retrieve queued authority records that have matches against existing records/
451 sub retrieve_queued_records {
452 my($self, $conn, $auth, $queue_id, $options) = @_;
455 my $limit = $$options{limit} || 20;
456 my $offset = $$options{offset} || 0;
457 my $type = $self->{record_type};
459 my $e = new_editor(authtoken => $auth, xact => 1);
460 return $e->die_event unless $e->checkauth;
464 $queue = $e->retrieve_vandelay_bib_queue($queue_id) or return $e->die_event;
466 $queue = $e->retrieve_vandelay_authority_queue($queue_id) or return $e->die_event;
468 my $evt = check_queue_perms($e, $type, $queue);
469 return $evt if ($evt);
471 my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
473 select => {$class => ['id']},
475 where => {queue => $queue_id},
477 order_by => {$class => ['id']},
481 if($self->api_name =~ /export/) {
482 delete $query->{limit};
483 delete $query->{offset};
486 $query->{where}->{import_time} = undef if $$options{non_imported};
488 if($$options{with_import_error}) {
490 $query->{from} = {$class => {vii => {type => 'left'}}};
491 $query->{where}->{'-or'} = [
492 {'+vqbr' => {import_error => {'!=' => undef}}},
493 {'+vii' => {import_error => {'!=' => undef}}}
498 if($$options{with_rec_import_error}) {
499 $query->{where}->{import_error} = {'!=' => undef};
501 } elsif( $$options{with_item_import_error} and $type eq 'bib') {
503 $query->{from} = {$class => 'vii'};
504 $query->{where}->{'+vii'} = {import_error => {'!=' => undef}};
508 if($self->api_name =~ /matches/) {
509 # find only records that have matches
510 my $mclass = $type eq 'bib' ? 'vbm' : 'vam';
511 $query->{from} = {$class => {$mclass => {type => 'right'}}};
514 my $record_ids = $e->json_query($query);
516 my $retrieve = ($type eq 'bib') ?
517 'retrieve_vandelay_queued_bib_record' : 'retrieve_vandelay_queued_authority_record';
518 my $search = ($type eq 'bib') ?
519 'search_vandelay_queued_bib_record' : 'search_vandelay_queued_authority_record';
521 if ($self->api_name =~ /export/) {
522 my $rec_list = $e->$search({id => [map { $_->{id} } @$record_ids]}, {substream => 1});
523 if ($self->api_name =~ /print/) {
526 return $U->fire_object_event(
528 'vandelay.queued_'.$type.'_record.print',
533 } elsif ($self->api_name =~ /csv/) {
536 return $U->fire_object_event(
538 'vandelay.queued_'.$type.'_record.csv',
543 } elsif ($self->api_name =~ /email/) {
545 $conn->respond_complete(1);
547 for my $rec (@$rec_list) {
548 $U->create_events_for_hook(
549 'vandelay.queued_'.$type.'_record.email',
551 $e->requestor->home_ou,
560 for my $rec_id (@$record_ids) {
561 my $flesh = ['attributes', 'matches'];
562 push(@$flesh, 'import_items') if $$options{flesh_import_items};
563 my $params = {flesh => 1, flesh_fields => {$class => $flesh}};
564 my $rec = $e->$retrieve([$rec_id->{id}, $params]);
565 $rec->clear_marc if $$options{clear_marc};
566 $conn->respond($rec);
574 __PACKAGE__->register_method(
575 api_name => 'open-ils.vandelay.import_item.queue.retrieve',
576 method => 'retrieve_queue_import_items',
582 Returns Import Item (vii) objects for the selected queue.
584 with_import_error : only return items that failed to import
587 __PACKAGE__->register_method(
588 api_name => 'open-ils.vandelay.import_item.queue.export.print',
589 method => 'retrieve_queue_import_items',
595 Returns template-generated printable output of Import Item (vii) objects for the selected queue.
597 with_import_error : only return items that failed to import
600 __PACKAGE__->register_method(
601 api_name => 'open-ils.vandelay.import_item.queue.export.csv',
602 method => 'retrieve_queue_import_items',
608 Returns template-generated CSV output of Import Item (vii) objects for the selected queue.
610 with_import_error : only return items that failed to import
613 __PACKAGE__->register_method(
614 api_name => 'open-ils.vandelay.import_item.queue.export.email',
615 method => 'retrieve_queue_import_items',
621 Emails template-generated output of Import Item (vii) objects for the selected queue.
623 with_import_error : only return items that failed to import
627 sub retrieve_queue_import_items {
628 my($self, $conn, $auth, $q_id, $options) = @_;
631 my $limit = $$options{limit} || 20;
632 my $offset = $$options{offset} || 0;
634 my $e = new_editor(authtoken => $auth);
635 return $e->event unless $e->checkauth;
637 my $queue = $e->retrieve_vandelay_bib_queue($q_id) or return $e->event;
638 my $evt = check_queue_perms($e, 'bib', $queue);
642 select => {vii => ['id']},
650 filter => {id => $q_id}
656 order_by => {'vii' => ['record','id']},
660 if($self->api_name =~ /export/) {
661 delete $query->{limit};
662 delete $query->{offset};
665 $query->{where} = {'+vii' => {import_error => {'!=' => undef}}}
666 if $$options{with_import_error};
668 my $items = $e->json_query($query);
669 my $item_list = $e->search_vandelay_import_item({id => [map { $_->{id} } @$items]});
670 if ($self->api_name =~ /export/) {
671 if ($self->api_name =~ /print/) {
673 return $U->fire_object_event(
675 'vandelay.import_items.print',
680 } elsif ($self->api_name =~ /csv/) {
682 return $U->fire_object_event(
684 'vandelay.import_items.csv',
689 } elsif ($self->api_name =~ /email/) {
691 $conn->respond_complete(1);
693 for my $item (@$item_list) {
694 $U->create_events_for_hook(
695 'vandelay.import_items.email',
697 $e->requestor->home_ou,
706 for my $item (@$item_list) {
707 $conn->respond($item);
714 sub check_queue_perms {
715 my($e, $type, $queue) = @_;
716 if ($type eq 'bib') {
717 return $e->die_event unless
718 ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
719 $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
721 return $e->die_event unless
722 ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
723 $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
729 __PACKAGE__->register_method(
730 api_name => "open-ils.vandelay.bib_record.list.import",
731 method => 'import_record_list',
738 __PACKAGE__->register_method(
739 api_name => "open-ils.vandelay.auth_record.list.import",
740 method => 'import_record_list',
744 record_type => 'auth'
747 sub import_record_list {
748 my($self, $conn, $auth, $rec_ids, $args) = @_;
749 my $e = new_editor(authtoken => $auth, xact => 1);
750 return $e->die_event unless $e->checkauth;
752 my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $args);
753 try {$e->rollback} otherwise {};
755 return {complete => 1};
759 __PACKAGE__->register_method(
760 api_name => "open-ils.vandelay.bib_queue.import",
761 method => 'import_queue',
766 record_type => 'bib',
769 Attempts to import all non-imported records for the selected queue.
770 Will also attempt import of all non-imported items.
775 __PACKAGE__->register_method(
776 api_name => "open-ils.vandelay.auth_queue.import",
777 method => 'import_queue',
782 record_type => 'auth'
786 my($self, $conn, $auth, $q_id, $options) = @_;
787 my $e = new_editor(authtoken => $auth, xact => 1);
788 return $e->die_event unless $e->checkauth;
790 my $type = $self->{record_type};
791 my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
793 # First, collect the not-yet-imported records
794 my $query = {queue => $q_id, import_time => undef};
795 my $search = ($type eq 'bib') ?
796 'search_vandelay_queued_bib_record' :
797 'search_vandelay_queued_authority_record';
798 my $rec_ids = $e->$search($query, {idlist => 1});
800 # Now add any imported records that have un-imported items
803 my $item_recs = $e->json_query({
804 select => {vqbr => ['id']},
805 from => {vqbr => 'vii'},
809 import_time => {'!=' => undef}
811 '+vii' => {import_time => undef}
815 push(@$rec_ids, map {$_->{id}} @$item_recs);
818 my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $options);
819 try {$e->rollback} otherwise {}; # only using this to make the read authoritative -- don't die from it
821 return {complete => 1};
824 # returns a list of queued record IDs for a given queue that
825 # have at least one entry in the match table
827 sub queued_records_with_matches {
828 my($e, $type, $q_id, $limit, $offset, $filter) = @_;
830 my $match_class = 'vbm';
831 my $rec_class = 'vqbr';
832 if($type eq 'auth') {
833 $match_class = 'vam';
838 $filter->{queue} = $q_id;
842 select => {$match_class => ['queued_record']},
847 fkey => 'queued_record',
854 if($limit or defined $offset) {
857 $query->{limit} = $limit;
858 $query->{offset} = $offset;
861 my $data = $e->json_query($query);
862 return [ map {$_->{queued_record}} @$data ];
866 sub import_record_list_impl {
867 my($self, $conn, $rec_ids, $requestor, $args) = @_;
869 my $overlay_map = $args->{overlay_map} || {};
870 my $type = $self->{record_type};
877 total => scalar(@$rec_ids),
878 report_all => $$args{report_all}
881 $conn->max_chunk_count(1) if $$args{report_all};
883 my $auto_overlay_exact = $$args{auto_overlay_exact};
884 my $auto_overlay_1match = $$args{auto_overlay_1match};
885 my $auto_overlay_best = $$args{auto_overlay_best_match};
886 my $match_quality_ratio = $$args{match_quality_ratio};
887 my $merge_profile = $$args{merge_profile};
888 my $ft_merge_profile = $$args{fall_through_merge_profile};
889 my $bib_source = $$args{bib_source};
890 my $import_no_match = $$args{import_no_match};
891 my $strip_grps = $$args{strip_field_groups}; # bib-only
893 my $overlay_func = 'vandelay.overlay_bib_record';
894 my $auto_overlay_func = 'vandelay.auto_overlay_bib_record';
895 my $auto_overlay_best_func = 'vandelay.auto_overlay_bib_record_with_best'; # XXX bib-only
896 my $retrieve_func = 'retrieve_vandelay_queued_bib_record';
897 my $update_func = 'update_vandelay_queued_bib_record';
898 my $search_func = 'search_vandelay_queued_bib_record';
899 my $retrieve_queue_func = 'retrieve_vandelay_bib_queue';
900 my $update_queue_func = 'update_vandelay_bib_queue';
901 my $delete_queue_func = 'delete_vandelay_bib_queue';
902 my $rec_class = 'vqbr';
904 my $editor = new_editor();
907 my $sources = $editor->search_config_bib_source({id => {'!=' => undef}});
908 $bib_sources{$_->id} = $_->source for @$sources;
910 if($type eq 'auth') {
911 $overlay_func =~ s/bib/auth/o;
912 $auto_overlay_func = s/bib/auth/o;
913 $retrieve_func =~ s/bib/authority/o;
914 $retrieve_queue_func =~ s/bib/authority/o;
915 $update_queue_func =~ s/bib/authority/o;
916 $update_func =~ s/bib/authority/o;
917 $search_func =~ s/bib/authority/o;
918 $delete_queue_func =~ s/bib/authority/o;
922 my $new_rec_perm_cache;
924 for my $rec_id (@$rec_ids) {
927 my $overlay_target = $overlay_map->{$rec_id};
929 my $e = new_editor(xact => 1);
930 $e->requestor($requestor);
932 $$report_args{e} = $e;
933 $$report_args{evt} = undef;
934 $$report_args{import_error} = undef;
935 $$report_args{no_import} = 0;
937 my $rec = $e->$retrieve_func([
940 flesh_fields => { $rec_class => ['matches']},
945 $$report_args{evt} = $e->event;
946 finish_rec_import_attempt($report_args);
950 if($rec->import_time) {
951 # if the record is already imported, that means it may have
952 # un-imported copies. Add to success list for later processing.
953 push(@success_rec_ids, $rec_id);
958 $$report_args{rec} = $rec;
959 $queues{$rec->queue} = 1;
964 if ($type eq 'bib') {
965 # strip configured / selected MARC tags from inbound records
967 my $marcdoc = XML::LibXML->new->parse_string($rec->marc);
968 $rec->marc($U->strip_marc_fields($e, $marcdoc, $strip_grps));
970 unless ($e->$update_func($rec)) {
971 $$report_args{evt} = $e->die_event;
972 finish_rec_import_attempt($report_args);
977 if(defined $overlay_target) {
978 # Caller chose an explicit overlay target
980 my $res = $e->json_query(
991 if($res and ($res = $res->[0])) {
993 if($res->{$overlay_func} eq 't') {
994 $logger->info("vl: $type direct overlay succeeded for queued rec ".
995 "$rec_id and overlay target $overlay_target");
1001 $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
1006 if($auto_overlay_1match) { # overlay if there is exactly 1 match
1008 my %match_recs = map { $_->eg_record => 1 } @{$rec->matches};
1010 if( scalar(keys %match_recs) == 1) { # all matches point to the same record
1012 ($imported, $error, $rec) = try_auto_overlay(
1015 $auto_overlay_best_func,
1019 $match_quality_ratio,
1026 if(!$imported and !$error and $auto_overlay_exact and scalar(@{$rec->matches}) == 1 ) {
1028 # caller says to overlay if there is an /exact/ match
1029 # $auto_overlay_func only proceeds and returns true on exact matches
1031 my $res = $e->json_query(
1041 if($res and ($res = $res->[0])) {
1043 if($res->{$auto_overlay_func} eq 't') {
1044 $logger->info("vl: $type auto-overlay succeeded for queued rec $rec_id");
1047 # re-fetch the record to pick up the imported_as value from the DB
1048 $$report_args{rec} = $rec = $e->$retrieve_func([
1049 $rec_id, {flesh => 1, flesh_fields => {$rec_class => ['matches']}}]);
1052 $logger->info("vl: $type auto-overlay failed for queued rec $rec_id");
1057 $logger->error("vl: Error attempting overlay with func=$auto_overlay_func, profile=$merge_profile, record=$rec_id");
1061 if(!$imported and !$error and $auto_overlay_best and scalar(@{$rec->matches}) > 0 ) {
1062 # caller says to overlay the best match
1064 ($imported, $error, $rec) = try_auto_overlay(
1067 $auto_overlay_best_func,
1071 $match_quality_ratio,
1077 if(!$imported and !$error and $import_no_match and scalar(@{$rec->matches}) == 0) {
1079 # No overlay / merge occurred. Do a traditional record import by creating a new record
1081 if (!$new_rec_perm_cache) {
1082 $new_rec_perm_cache = {};
1084 # all users creating new records are required to have the basic permission.
1085 # if the client requests, we can enforce extra permissions for creating new records.
1086 # for speed, check the permissions the first time then cache the result.
1088 my $perm = ($type eq 'bib') ? 'IMPORT_MARC' : 'IMPORT_AUTHORITY_MARC';
1089 my $xperm = $$args{new_rec_perm};
1090 my $rec_ou = $e->requestor->ws_ou;
1092 $new_rec_perm_cache->{evt} = $e->die_event
1093 if !$e->allowed($perm, $rec_ou) || ($xperm and !$e->allowed($xperm, $rec_ou));
1096 if ($new_rec_perm_cache->{evt}) {
1098 # a cached event won't roll back the transaction (a la die_event), but
1099 # the transaction will get rolled back in finish_rec_import_attempt() below
1100 $$report_args{evt} = $new_rec_perm_cache->{evt};
1101 $$report_args{import_error} = 'import.record.perm_failure';
1103 } else { # perm checks succeeded
1105 $logger->info("vl: creating new $type record for queued record $rec_id");
1107 if ($type eq 'bib') {
1109 $record = OpenILS::Application::Cat::BibCommon->biblio_record_xml_import(
1110 $e, $rec->marc, $bib_sources{$rec->bib_source}, undef, 1);
1112 } else { # authority record
1114 $record = OpenILS::Application::Cat::AuthCommon->import_authority_record($e, $rec->marc); #$source);
1117 if($U->event_code($record)) {
1118 $$report_args{import_error} = 'import.duplicate.tcn'
1119 if $record->{textcode} eq 'OPEN_TCN_NOT_FOUND';
1120 $$report_args{evt} = $record;
1124 $logger->info("vl: successfully imported new $type record");
1125 $rec->imported_as($record->id);
1134 $rec->import_time('now');
1135 $rec->clear_import_error;
1136 $rec->clear_error_detail;
1138 if($e->$update_func($rec)) {
1140 if($type eq 'bib') {
1142 # see if this record is linked from an acq record.
1143 my $li = $e->search_acq_lineitem(
1144 {queued_record => $rec->id, state => {'!=' => 'canceled'}})->[0];
1147 # if so, update the acq lineitem to point to the imported record
1148 $li->eg_bib_id($rec->imported_as);
1149 $$report_args{evt} = $e->die_event unless $e->update_acq_lineitem($li);
1153 push @success_rec_ids, $rec_id;
1154 finish_rec_import_attempt($report_args);
1162 $logger->info("vl: record $rec_id was not imported");
1163 $$report_args{evt} = $e->event unless $$report_args{evt};
1164 $$report_args{no_import} = 1;
1165 finish_rec_import_attempt($report_args);
1169 # see if we need to mark any queues as complete
1170 for my $q_id (keys %queues) {
1172 my $e = new_editor(xact => 1);
1173 my $remaining = $e->$search_func(
1174 [{queue => $q_id, import_time => undef}, {limit =>1}], {idlist => 1});
1176 unless(@$remaining) {
1177 my $queue = $e->$retrieve_queue_func($q_id);
1178 unless($U->is_true($queue->complete)) {
1179 $queue->complete('t');
1180 $e->$update_queue_func($queue) or return $e->die_event;
1189 import_record_asset_list_impl($conn, \@success_rec_ids, $requestor) if @success_rec_ids;
1191 $conn->respond({total => $$report_args{total}, progress => $$report_args{progress}});
1196 sub try_auto_overlay {
1199 my $report_args = shift;
1200 my $overlay_func = shift;
1201 my $retrieve_func = shift;
1202 my $rec_class = shift;
1204 my $match_quality_ratio = shift;
1205 my $merge_profile = shift;
1206 my $ft_merge_profile = shift;
1211 # Find the best match and overlay if the quality ratio allows it.
1212 my $res = $e->json_query(
1218 $match_quality_ratio
1223 if($res and ($res = $res->[0])) {
1225 if($res->{$overlay_func} eq 't') {
1227 # first attempt succeeded
1232 # quality-limited merge failed with insufficient quality. If there is a
1233 # fall-through merge profile, re-do the merge with the alternate profile
1234 # and no quality restriction.
1236 if($ft_merge_profile and $match_quality_ratio > 0) {
1238 $logger->info("vl: $type auto-merge failed with profile $merge_profile; ".
1239 "re-merging with fall-through profile $ft_merge_profile");
1241 my $res = $e->json_query(
1247 0 # minimum quality not required
1252 if($res and ($res = $res->[0])) {
1254 if($res->{$overlay_func} eq 't') {
1256 # second attempt succeeded
1261 # failed to merge on second attempt
1262 $logger->info("vl: $type auto-merge with fall-through failed for queued rec $rec_id");
1266 # second attempt died
1268 $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
1273 # failed to merge on first attempt, no fall-through was provided
1274 $$report_args{import_error} = 'overlay.record.quality' if $match_quality_ratio > 0;
1275 $logger->info("vl: $type auto-merge failed for queued rec $rec_id");
1281 # first attempt died
1283 $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
1288 # at least 1 of the attempts succeeded
1289 $logger->info("vl: $type auto-merge succeeded for queued rec $rec_id");
1291 # re-fetch the record to pick up the imported_as value from the DB
1292 $$report_args{rec} = $e->$retrieve_func([
1293 $rec_id, {flesh => 1, flesh_fields => {$rec_class => ['matches']}}]);
1296 return ($imported, $error, $$report_args{rec});
1300 # tracks any import errors, commits the current xact, responds to the client
1301 sub finish_rec_import_attempt {
1303 my $evt = $$args{evt};
1304 my $rec = $$args{rec};
1307 my $error = $$args{import_error};
1308 $error = 'general.unknown' if $evt and not $error;
1313 if($error or $evt) {
1315 # since an error occurred, there's no guarantee the transaction wasn't
1316 # rolled back. force a rollback and create a new editor.
1318 $e = new_editor(xact => 1);
1319 $rec->import_error($error);
1322 my $detail = sprintf("%s : %s", $evt->{textcode}, substr($evt->{desc}, 0, 140));
1323 $rec->error_detail($detail);
1326 my $method = 'update_vandelay_queued_bib_record';
1327 $method =~ s/bib/authority/ if $$args{type} eq 'auth';
1328 $e->$method($rec) and $e->commit or $e->rollback;
1331 # commit the successful import
1336 # requested queued record was not found
1341 if($$args{report_all} or ($$args{progress} % $$args{step}) == 0) {
1342 $$args{conn}->respond({
1343 total => $$args{total},
1344 progress => $$args{progress},
1345 imported => ($rec) ? $rec->id : undef,
1346 import_error => $error,
1347 no_import => $$args{no_import},
1350 $$args{step} *= 2 unless $$args{step} == 256;
1360 __PACKAGE__->register_method(
1361 api_name => "open-ils.vandelay.bib_queue.owner.retrieve",
1362 method => 'owner_queue_retrieve',
1366 record_type => 'bib'
1368 __PACKAGE__->register_method(
1369 api_name => "open-ils.vandelay.authority_queue.owner.retrieve",
1370 method => 'owner_queue_retrieve',
1374 record_type => 'auth'
1377 sub owner_queue_retrieve {
1378 my($self, $conn, $auth, $owner_id, $filters) = @_;
1379 my $e = new_editor(authtoken => $auth, xact => 1);
1380 return $e->die_event unless $e->checkauth;
1381 $owner_id = $e->requestor->id; # XXX add support for viewing other's queues?
1384 my $search = {owner => $owner_id};
1385 $search->{$_} = $filters->{$_} for keys %$filters;
1387 if($self->{record_type} eq 'bib') {
1388 $queues = $e->search_vandelay_bib_queue(
1389 [$search, {order_by => {vbq => 'evergreen.lowercase(name)'}}]);
1391 $queues = $e->search_vandelay_authority_queue(
1392 [$search, {order_by => {vaq => 'evergreen.lowercase(name)'}}]);
1394 $conn->respond($_) for @$queues;
1399 __PACKAGE__->register_method(
1400 api_name => "open-ils.vandelay.bib_queue.delete",
1401 method => "delete_queue",
1404 record_type => 'bib'
1406 __PACKAGE__->register_method(
1407 api_name => "open-ils.vandelay.auth_queue.delete",
1408 method => "delete_queue",
1411 record_type => 'auth'
1415 my($self, $conn, $auth, $q_id) = @_;
1416 my $e = new_editor(xact => 1, authtoken => $auth);
1417 return $e->die_event unless $e->checkauth;
1418 if($self->{record_type} eq 'bib') {
1419 return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
1420 my $queue = $e->retrieve_vandelay_bib_queue($q_id)
1421 or return $e->die_event;
1422 $e->delete_vandelay_bib_queue($queue)
1423 or return $e->die_event;
1425 return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
1426 my $queue = $e->retrieve_vandelay_authority_queue($q_id)
1427 or return $e->die_event;
1428 $e->delete_vandelay_authority_queue($queue)
1429 or return $e->die_event;
1436 __PACKAGE__->register_method(
1437 api_name => "open-ils.vandelay.queued_bib_record.html",
1438 method => 'queued_record_html',
1442 record_type => 'bib'
1444 __PACKAGE__->register_method(
1445 api_name => "open-ils.vandelay.queued_authority_record.html",
1446 method => 'queued_record_html',
1450 record_type => 'auth'
1453 sub queued_record_html {
1454 my($self, $conn, $auth, $rec_id) = @_;
1455 my $e = new_editor(xact=>1,authtoken => $auth);
1456 return $e->die_event unless $e->checkauth;
1458 if($self->{record_type} eq 'bib') {
1459 $rec = $e->retrieve_vandelay_queued_bib_record($rec_id)
1460 or return $e->die_event;
1462 $rec = $e->retrieve_vandelay_queued_authority_record($rec_id)
1463 or return $e->die_event;
1467 return $U->simplereq(
1469 'open-ils.search.biblio.record.html', undef, 1, $rec->marc);
1473 __PACKAGE__->register_method(
1474 api_name => "open-ils.vandelay.bib_queue.summary.retrieve",
1475 method => 'retrieve_queue_summary',
1479 record_type => 'bib'
1481 __PACKAGE__->register_method(
1482 api_name => "open-ils.vandelay.auth_queue.summary.retrieve",
1483 method => 'retrieve_queue_summary',
1487 record_type => 'auth'
1490 sub retrieve_queue_summary {
1491 my($self, $conn, $auth, $queue_id) = @_;
1492 my $e = new_editor(xact=>1, authtoken => $auth);
1493 return $e->die_event unless $e->checkauth;
1496 my $type = $self->{record_type};
1497 if($type eq 'bib') {
1498 $queue = $e->retrieve_vandelay_bib_queue($queue_id)
1499 or return $e->die_event;
1501 $queue = $e->retrieve_vandelay_authority_queue($queue_id)
1502 or return $e->die_event;
1505 my $evt = check_queue_perms($e, $type, $queue);
1506 return $evt if $evt;
1508 my $search = 'search_vandelay_queued_bib_record';
1509 $search =~ s/bib/authority/ if $type ne 'bib';
1513 total => scalar(@{$e->$search({queue => $queue_id}, {idlist=>1})}),
1514 imported => scalar(@{$e->$search({queue => $queue_id, import_time => {'!=' => undef}}, {idlist=>1})}),
1517 my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
1518 $summary->{rec_import_errors} = $e->json_query({
1519 select => {$class => [{alias => 'count', column => 'id', transform => 'count', aggregate => 1}]},
1521 where => {queue => $queue_id, import_error => {'!=' => undef}}
1524 if($type eq 'bib') {
1526 # count of all items attached to records in the queue in question
1528 select => {vii => [{alias => 'count', column => 'id', transform => 'count', aggregate => 1}]},
1533 select => {vqbr => ['id']},
1535 where => {queue => $queue_id}
1540 $summary->{total_items} = $e->json_query($query)->[0]->{count};
1542 # count of items we attempted to import, but errored, attached to records in the queue in question
1543 $query->{where}->{import_error} = {'!=' => undef};
1544 $summary->{item_import_errors} = $e->json_query($query)->[0]->{count};
1546 # count of items we successfully imported attached to records in the queue in question
1547 delete $query->{where}->{import_error};
1548 $query->{where}->{import_time} = {'!=' => undef};
1549 $summary->{total_items_imported} = $e->json_query($query)->[0]->{count};
1555 # --------------------------------------------------------------------------------
1556 # Given a list of queued record IDs, imports all items attached to those records
1557 # --------------------------------------------------------------------------------
1558 sub import_record_asset_list_impl {
1559 my($conn, $rec_ids, $requestor) = @_;
1561 my $roe = new_editor(xact=> 1, requestor => $requestor);
1563 # for speed, filter out any records have not been
1564 # imported or have no import items to load
1565 $rec_ids = $roe->json_query({
1566 select => {vqbr => ['id']},
1567 from => {vqbr => 'vii'},
1568 where => {'+vqbr' => {
1570 import_time => {'!=' => undef}
1574 $rec_ids = [map {$_->{id}} @$rec_ids];
1578 total => scalar(@$rec_ids),
1579 step => 1, # how often to respond
1584 for my $rec_id (@$rec_ids) {
1585 my $rec = $roe->retrieve_vandelay_queued_bib_record($rec_id);
1586 my $item_ids = $roe->search_vandelay_import_item(
1587 {record => $rec->id, import_error => undef},
1591 for my $item_id (@$item_ids) {
1592 my $e = new_editor(requestor => $requestor, xact => 1);
1593 my $item = $e->retrieve_vandelay_import_item($item_id);
1594 my ($copy, $vol, $evt);
1596 $$report_args{import_item} = $item;
1597 $$report_args{e} = $e;
1598 $$report_args{import_error} = undef;
1599 $$report_args{evt} = undef;
1601 if (my $copy_id = $item->internal_id) { # assignment
1602 # copy matches an existing copy. Overlay instead of create.
1604 $logger->info("vl: performing copy overlay for internal_id=$copy_id");
1606 my $qt = $e->json_query({
1607 select => {vbq => ['queue_type']},
1608 from => {vqbr => 'vbq'},
1609 where => {'+vqbr' => {id => $rec_id}}
1610 })->[0]->{queue_type};
1613 # internal_id for ACQ queues refers to acq.lineitem_detail.id
1614 # pull the real copy id from the acq LID
1616 my $lid = $e->retrieve_acq_lineitem_detail($copy_id);
1618 $$report_args{evt} = $e->die_event;
1619 respond_with_status($report_args);
1622 $copy_id = $lid->eg_copy_id;
1623 $logger->info("vl: performing ACQ copy overlay for copy $copy_id");
1626 $copy = $e->search_asset_copy([
1627 {id => $copy_id, deleted => 'f'},
1628 {flesh => 1, flesh_fields => {acp => ['call_number']}}
1632 $$report_args{evt} = $e->die_event;
1633 respond_with_status($report_args);
1637 # prevent update of unrelated copies
1638 if ($copy->call_number->record != $rec->imported_as) {
1639 $logger->info("vl: attempt to overlay unrelated copy=$copy_id; rec=".$rec->imported_as);
1641 $evt = OpenILS::Event->new('INVALID_IMPORT_COPY_ID',
1642 note => 'Cannot overlay copies for unlinked bib',
1643 bre => $rec->imported_as,
1646 $$report_args{evt} = $evt;
1647 respond_with_status($report_args);
1651 # overlaying copies requires an extra permission
1652 if (!$e->allowed("IMPORT_OVERLAY_COPY", $copy->call_number->owning_lib)) {
1653 $$report_args{evt} = $e->die_event;
1654 respond_with_status($report_args);
1658 # are we updating the call-number?
1659 if ($item->call_number and $item->call_number ne $copy->call_number->label) {
1661 my $count = $e->json_query({
1662 select => {acp => [{
1665 transform => 'count',
1671 call_number => $copy->call_number->id
1676 # if this is the only copy attached to this
1677 # callnumber, just update the callnumber
1679 $logger->info("vl: updating callnumber label in copy overlay");
1681 $copy->call_number->label($item->call_number);
1682 if (!$e->update_asset_call_number($copy->call_number)) {
1683 $$report_args{evt} = $e->die_event;
1684 respond_with_status($report_args);
1690 # otherwise, move the copy to a new/existing
1691 # call-number with the given label/owner
1692 # note that overlay does not allow the owning_lib
1693 # to be changed. Should it?
1695 $logger->info("vl: moving copy to new callnumber in copy overlay");
1698 OpenILS::Application::Cat::AssetCommon->find_or_create_volume(
1699 $e, $item->call_number,
1700 $copy->call_number->record,
1701 $copy->call_number->owning_lib
1705 $$report_args{evt} = $evt;
1706 respond_with_status($report_args);
1710 $copy->call_number($vol);
1714 # for every field that has a non-'' value, overlay the copy value
1715 foreach (qw/ barcode location circ_lib status
1716 circulate deposit deposit_amount ref holdable
1717 price circ_as_type alert_message opac_visible circ_modifier/) {
1719 my $val = $item->$_();
1720 $copy->$_($val) if $val and $val ne '';
1723 # de-flesh for update
1724 $copy->call_number($copy->call_number->id);
1725 $copy->ischanged(1);
1727 $evt = OpenILS::Application::Cat::AssetCommon->
1728 update_fleshed_copies($e, {all => 1}, undef, [$copy]);
1731 $$report_args{evt} = $evt;
1732 respond_with_status($report_args);
1738 # Creating a new copy
1739 $logger->info("vl: creating new copy in import");
1741 # --------------------------------------------------------------------------------
1742 # Find or create the volume
1743 # --------------------------------------------------------------------------------
1745 OpenILS::Application::Cat::AssetCommon->find_or_create_volume(
1746 $e, $item->call_number, $rec->imported_as, $item->owning_lib);
1749 $$report_args{evt} = $evt;
1750 respond_with_status($report_args);
1754 # --------------------------------------------------------------------------------
1755 # Create the new copy
1756 # --------------------------------------------------------------------------------
1757 $copy = Fieldmapper::asset::copy->new;
1758 $copy->loan_duration(2);
1759 $copy->fine_level(2);
1760 $copy->barcode($item->barcode);
1761 $copy->location($item->location);
1762 $copy->circ_lib($item->circ_lib || $item->owning_lib);
1763 $copy->status( defined($item->status) ? $item->status : OILS_COPY_STATUS_IN_PROCESS );
1764 $copy->circulate($item->circulate);
1765 $copy->deposit($item->deposit);
1766 $copy->deposit_amount($item->deposit_amount);
1767 $copy->ref($item->ref);
1768 $copy->holdable($item->holdable);
1769 $copy->price($item->price);
1770 $copy->circ_as_type($item->circ_as_type);
1771 $copy->alert_message($item->alert_message);
1772 $copy->opac_visible($item->opac_visible);
1773 $copy->circ_modifier($item->circ_modifier);
1775 # --------------------------------------------------------------------------------
1776 # Check for dupe barcode
1777 # --------------------------------------------------------------------------------
1778 if($evt = OpenILS::Application::Cat::AssetCommon->create_copy($e, $vol, $copy)) {
1779 $$report_args{evt} = $evt;
1780 $$report_args{import_error} = 'import.item.duplicate.barcode'
1781 if $evt->{textcode} eq 'ITEM_BARCODE_EXISTS';
1782 respond_with_status($report_args);
1786 # --------------------------------------------------------------------------------
1788 # --------------------------------------------------------------------------------
1789 $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
1790 $e, $copy, '', $item->pub_note, 1) if $item->pub_note;
1793 $$report_args{evt} = $evt;
1794 respond_with_status($report_args);
1798 $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
1799 $e, $copy, '', $item->priv_note) if $item->priv_note;
1802 $$report_args{evt} = $evt;
1803 respond_with_status($report_args);
1808 # set the import data on the import item
1809 $item->imported_as($copy->id); # $copy->id is set by create_copy() ^--
1810 $item->import_time('now');
1812 unless($e->update_vandelay_import_item($item)) {
1813 $$report_args{evt} = $e->die_event;
1814 respond_with_status($report_args);
1818 # --------------------------------------------------------------------------------
1819 # Item import succeeded
1820 # --------------------------------------------------------------------------------
1822 $$report_args{in_count}++;
1823 respond_with_status($report_args);
1824 $logger->info("vl: successfully imported item " . $item->barcode);
1833 sub respond_with_status {
1837 # If the import failed, track the failure reason
1839 my $error = $$args{import_error};
1840 my $evt = $$args{evt};
1842 if($error or $evt) {
1844 my $item = $$args{import_item};
1845 $logger->info("vl: unable to import item " . $item->barcode);
1847 $error ||= 'general.unknown';
1848 $item->import_error($error);
1851 my $detail = sprintf("%s : %s", $evt->{textcode}, substr($evt->{desc}, 0, 140));
1852 $item->error_detail($detail);
1855 # state of the editor is unknown at this point. Force a rollback and start over.
1857 $e = new_editor(xact => 1);
1858 $e->update_vandelay_import_item($item);
1862 if($$args{report_all} or ($$args{progress} % $$args{step}) == 0) {
1863 $$args{conn}->respond({
1864 total => $$args{total},
1865 progress => $$args{progress},
1866 success_count => $$args{success_count},
1869 $$args{step} *= 2 unless $$args{step} == 256;
1875 __PACKAGE__->register_method(
1876 api_name => "open-ils.vandelay.match_set.get_tree",
1877 method => "match_set_get_tree",
1881 desc => q/For a given vms object, return a tree of match set points
1882 represented by a vmsp object with recursively fleshed
1887 sub match_set_get_tree {
1888 my ($self, $conn, $authtoken, $match_set_id) = @_;
1890 $match_set_id = int($match_set_id) or return;
1892 my $e = new_editor("authtoken" => $authtoken);
1893 $e->checkauth or return $e->die_event;
1895 my $set = $e->retrieve_vandelay_match_set($match_set_id) or
1896 return $e->die_event;
1898 $e->allowed("ADMIN_IMPORT_MATCH_SET", $set->owner) or
1899 return $e->die_event;
1901 my $tree = $e->search_vandelay_match_set_point([
1902 {"match_set" => $match_set_id, "parent" => undef},
1903 {"flesh" => -1, "flesh_fields" => {"vmsp" => ["children"]}}
1904 ]) or return $e->die_event;
1910 __PACKAGE__->register_method(
1911 api_name => "open-ils.vandelay.match_set.update",
1912 method => "match_set_update_tree",
1916 desc => q/Replace any vmsp objects associated with a given (by ID) vms
1917 with the given objects (recursively fleshed vmsp tree)./
1921 sub _walk_new_vmsp {
1922 my ($e, $match_set_id, $node, $parent_id) = @_;
1924 my $point = new Fieldmapper::vandelay::match_set_point;
1925 $point->parent($parent_id);
1926 $point->match_set($match_set_id);
1927 $point->$_($node->$_) for (qw/bool_op svf tag subfield negate quality/);
1929 $e->create_vandelay_match_set_point($point) or return $e->die_event;
1931 $parent_id = $e->data->id;
1932 if ($node->children && @{$node->children}) {
1933 for (@{$node->children}) {
1934 return $e->die_event if
1935 _walk_new_vmsp($e, $match_set_id, $_, $parent_id);
1942 sub match_set_update_tree {
1943 my ($self, $conn, $authtoken, $match_set_id, $tree) = @_;
1945 my $e = new_editor("xact" => 1, "authtoken" => $authtoken);
1946 $e->checkauth or return $e->die_event;
1948 my $set = $e->retrieve_vandelay_match_set($match_set_id) or
1949 return $e->die_event;
1951 $e->allowed("ADMIN_IMPORT_MATCH_SET", $set->owner) or
1952 return $e->die_event;
1954 my $existing = $e->search_vandelay_match_set_point([
1955 {"match_set" => $match_set_id},
1956 {"order_by" => {"vmsp" => "id DESC"}}
1957 ]) or return $e->die_event;
1959 # delete points, working up from leaf points to the root
1961 for my $point (shift @$existing) {
1962 if( grep {$_->parent eq $point->id} @$existing) {
1963 push(@$existing, $point);
1965 $e->delete_vandelay_match_set_point($point) or return $e->die_event;
1970 _walk_new_vmsp($e, $match_set_id, $tree);
1972 $e->commit or return $e->die_event;
1975 __PACKAGE__->register_method(
1976 api_name => 'open-ils.vandelay.bib_queue.to_bucket',
1977 method => 'bib_queue_to_bucket',
1981 desc => q/Add to or create a new bib container (bucket) with the successfully
1982 imported contents of a vandelay queue. Any user that has Vandelay
1983 queue create permissions can append or create buckets from his-her own queues./,
1985 {desc => 'Authtoken', type => 'string'},
1986 {desc => 'Queue ID', type => 'number'},
1987 {desc => 'Bucket Name', type => 'string'}
1989 return => {desc => q/
1990 {bucket => $bucket, addcount => number-of-items-added-to-bucket, item_count => total-bucket-item-count} on success,
1991 {add_count => 0} if there is nothing to do, and Event on error/}
1995 sub bib_queue_to_bucket {
1996 my ($self, $conn, $auth, $q_id, $bucket_name) = @_;
1998 my $e = new_editor(xact => 1, authtoken => $auth);
1999 return $e->die_event unless $e->checkauth;
2001 my $queue = $e->retrieve_vandelay_bib_queue($q_id)
2002 or return $e->die_event;
2004 return OpenILS::Event->new('BAD_PARAMS',
2005 note => q/Bucket creator must be queue owner/)
2006 unless $queue->owner == $e->requestor->id;
2008 # find the bib IDs that will go into the bucket
2009 my $bib_ids = $e->json_query({
2010 select => {vqbr => ['imported_as']},
2012 where => {queue => $q_id, imported_as => {'!=' => undef}}
2015 if (!@$bib_ids) { # no records to add
2017 return {add_count => 0};
2020 # allow user to add to an existing bucket by name
2021 my $bucket = $e->search_container_biblio_record_entry_bucket({
2022 owner => $e->requestor->id,
2023 name => $bucket_name,
2024 btype => 'vandelay_queue'
2027 # if the bucket does not exist, create a new one
2029 $bucket = Fieldmapper::container::biblio_record_entry_bucket->new;
2030 $bucket->name($bucket_name);
2031 $bucket->owner($e->requestor->id);
2032 $bucket->btype('vandelay_queue');
2034 $e->create_container_biblio_record_entry_bucket($bucket)
2035 or return $e->die_event;
2038 # create the new bucket items
2039 for my $bib_id ( map {$_->{imported_as}} @$bib_ids ) {
2040 my $item = Fieldmapper::container::biblio_record_entry_bucket_item->new;
2041 $item->target_biblio_record_entry($bib_id);
2042 $item->bucket($bucket->id);
2043 $e->create_container_biblio_record_entry_bucket_item($item)
2044 or return $e->die_event;
2047 # re-fetch the bucket to pick up the correct create_time
2048 $bucket = $e->retrieve_container_biblio_record_entry_bucket($bucket->id)
2049 or return $e->die_event;
2051 # get the total count of items in this bucket
2052 my $count = $e->json_query({
2053 select => {cbrebi => [{
2055 transform => 'count',
2060 where => {bucket => $bucket->id}
2067 add_count => scalar(@$bib_ids), # items added to the bucket
2068 item_count => $count->{count} # total items in buckets