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 Digest::MD5 qw/md5_hex/;
21 use OpenILS::Const qw/:const/;
22 use OpenILS::Application::AppUtils;
23 use OpenILS::Application::Cat::BibCommon;
24 use OpenILS::Application::Cat::AuthCommon;
25 use OpenILS::Application::Cat::AssetCommon;
26 use OpenILS::Application::Cat::Merge;
27 my $U = 'OpenILS::Application::AppUtils';
29 # A list of LDR/06 values from http://loc.gov/marc
56 # --------------------------------------------------------------------------------
59 sub create_bib_queue {
66 my $match_set = shift;
67 my $import_def = shift;
68 my $match_bucket = shift;
70 my $e = new_editor(authtoken => $auth, xact => 1);
72 return $e->die_event unless $e->checkauth;
73 return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
74 $owner ||= $e->requestor->id;
76 if ($e->search_vandelay_bib_queue( {name => $name, owner => $owner, queue_type => $type})->[0]) {
78 return OpenILS::Event->new('BIB_QUEUE_EXISTS')
81 my $queue = new Fieldmapper::vandelay::bib_queue();
82 $queue->name( $name );
83 $queue->owner( $owner );
84 $queue->queue_type( $type ) if ($type);
85 $queue->item_attr_def( $import_def ) if ($import_def);
86 $queue->match_set($match_set) if $match_set;
87 $queue->match_bucket($match_bucket) if $match_bucket;
89 my $new_q = $e->create_vandelay_bib_queue( $queue );
90 return $e->die_event unless ($new_q);
95 __PACKAGE__->register_method(
96 api_name => "open-ils.vandelay.bib_queue.create",
97 method => "create_bib_queue",
103 sub create_auth_queue {
110 my $match_set = shift;
112 my $e = new_editor(authtoken => $auth, xact => 1);
114 return $e->die_event unless $e->checkauth;
115 return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
116 $owner ||= $e->requestor->id;
118 if ($e->search_vandelay_authority_queue({name => $name, owner => $owner, queue_type => $type})->[0]) {
120 return OpenILS::Event->new('AUTH_QUEUE_EXISTS')
123 my $queue = new Fieldmapper::vandelay::authority_queue();
124 $queue->name( $name );
125 $queue->owner( $owner );
126 $queue->queue_type( $type ) if ($type);
127 $queue->match_set($match_set) if $match_set;
129 my $new_q = $e->create_vandelay_authority_queue( $queue );
130 $e->die_event unless ($new_q);
135 __PACKAGE__->register_method(
136 api_name => "open-ils.vandelay.authority_queue.create",
137 method => "create_auth_queue",
142 sub add_record_to_bib_queue {
149 my $bib_source = shift;
151 my $e = new_editor(authtoken => $auth, xact => 1);
153 $queue = $e->retrieve_vandelay_bib_queue($queue);
155 return $e->die_event unless $e->checkauth;
156 return $e->die_event unless
157 ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
158 $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
160 my $new_rec = _add_bib_rec($e, $marc, $queue->id, $purpose, $bib_source);
162 return $e->die_event unless ($new_rec);
166 __PACKAGE__->register_method(
167 api_name => "open-ils.vandelay.queued_bib_record.create",
168 method => "add_record_to_bib_queue",
178 my $bib_source = shift;
180 my $rec = new Fieldmapper::vandelay::queued_bib_record();
182 $rec->queue( $queue );
183 $rec->purpose( $purpose ) if ($purpose);
184 $rec->bib_source($bib_source);
186 return $e->create_vandelay_queued_bib_record( $rec, {timeout => 600} );
189 sub add_record_to_authority_queue {
197 my $e = new_editor(authtoken => $auth, xact => 1);
199 $queue = $e->retrieve_vandelay_authority_queue($queue);
201 return $e->die_event unless $e->checkauth;
202 return $e->die_event unless
203 ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
204 $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
206 my $new_rec = _add_auth_rec($e, $marc, $queue->id, $purpose);
208 return $e->die_event unless ($new_rec);
212 __PACKAGE__->register_method(
213 api_name => "open-ils.vandelay.queued_authority_record.create",
214 method => "add_record_to_authority_queue",
225 my $rec = new Fieldmapper::vandelay::queued_authority_record();
227 $rec->queue( $queue );
228 $rec->purpose( $purpose ) if ($purpose);
230 return $e->create_vandelay_queued_authority_record( $rec, {timeout => 600} );
237 my $fingerprint = shift || '';
238 my $queue_id = shift;
240 my $filename = shift;
241 my $bib_source = shift;
242 my $session_name = shift;
243 my $exit_early = shift;
245 $client->max_chunk_count($self->{max_bundle_count}) if (!$client->can('max_bundle_count') && $self->{max_bundle_count});
247 my $e = new_editor(authtoken => $auth, xact => 1);
248 return $e->die_event unless $e->checkauth;
251 my $type = $self->{record_type};
254 $queue = $e->retrieve_vandelay_bib_queue($queue_id) or return $e->die_event;
256 $queue = $e->retrieve_vandelay_authority_queue($queue_id) or return $e->die_event;
259 my $evt = check_queue_perms($e, $type, $queue);
260 return $evt if ($evt);
262 my $cache = new OpenSRF::Utils::Cache();
265 my $data = $cache->get_cache('vandelay_import_spool_' . $fingerprint);
266 $purpose = $data->{purpose};
267 $filename = $data->{path};
268 $bib_source = $data->{bib_source};
271 unless(-r $filename) {
272 $logger->error("unable to read MARC file $filename");
273 return -1; # make this an event XXX
276 $logger->info("vandelay spooling $fingerprint purpose=$purpose file=$filename");
278 my ($tracker, $tevt) = create_session_tracker(
279 $e->requestor->id, $e->requestor->wsid, $fingerprint,
280 $session_name, $type, $queue_id, 'enqueue');
287 $client->respond_complete($tracker) if $exit_early;
289 my $marctype = 'USMARC';
292 $marctype = 'XML' if (getc(F) =~ /^\D/o);
295 my $batch = new MARC::Batch ($marctype, $filename);
298 my $response_scale = 10;
301 while (try { $r = $batch->next } otherwise { $r = -1 }) {
303 $logger->warn("Processing of record $count in set $filename failed. Skipping this record");
307 $logger->info("processing record $count");
310 my $xml = clean_marc($r);
313 # Check the leader to ensure we've got something resembling the expected
314 # Allow spaces to give records the benefit of the doubt
315 my $ldr_type = substr($r->leader(), 6, 1);
316 if ($type eq 'bib' && ($record_types{$ldr_type}) eq 'bib' || $ldr_type eq ' ') {
317 $qrec = _add_bib_rec( $e, $xml, $queue_id, $purpose, $bib_source ) or return $e->die_event;
318 } elsif ($type eq 'auth' && ($record_types{$ldr_type}) eq 'auth' || $ldr_type eq ' ') {
319 $qrec = _add_auth_rec( $e, $xml, $queue_id, $purpose ) or return $e->die_event;
321 # I don't know how to handle this type; rock on
322 $logger->error("In process_spool(), type was $type and leader type was $ldr_type ; not currently supported");
326 return $tevt if $tevt = increment_session_tracker($tracker);
328 if (!$exit_early) { # avoid unnecessary responses
329 if($self->api_name =~ /stream_results/ and $qrec) {
330 $client->respond($qrec->id)
332 $client->respond($count) if (++$count % $response_scale) == 0;
333 $response_scale *= 10 if ($count == ($response_scale * 10));
338 $logger->warn("Encountered a bad record at Vandelay ingest: ".$error);
342 $tracker->state('complete');
343 $e->update_vandelay_session_tracker($tracker) or return $e->die_event;
347 $cache->delete_cache('vandelay_import_spool_' . $fingerprint) if $fingerprint;
351 __PACKAGE__->register_method(
352 api_name => "open-ils.vandelay.bib.process_spool",
353 method => "process_spool",
356 max_bundle_count => 1,
359 __PACKAGE__->register_method(
360 api_name => "open-ils.vandelay.auth.process_spool",
361 method => "process_spool",
364 max_bundle_count => 1,
365 record_type => 'auth'
368 __PACKAGE__->register_method(
369 api_name => "open-ils.vandelay.bib.process_spool.stream_results",
370 method => "process_spool",
374 max_bundle_count => 1,
377 __PACKAGE__->register_method(
378 api_name => "open-ils.vandelay.auth.process_spool.stream_results",
379 method => "process_spool",
383 max_bundle_count => 1,
384 record_type => 'auth'
387 __PACKAGE__->register_method(
388 api_name => "open-ils.vandelay.bib_queue.records.retrieve",
389 method => 'retrieve_queued_records',
395 __PACKAGE__->register_method(
396 api_name => "open-ils.vandelay.bib_queue.records.retrieve.export.print",
397 method => 'retrieve_queued_records',
403 __PACKAGE__->register_method(
404 api_name => "open-ils.vandelay.bib_queue.records.retrieve.export.csv",
405 method => 'retrieve_queued_records',
411 __PACKAGE__->register_method(
412 api_name => "open-ils.vandelay.bib_queue.records.retrieve.export.email",
413 method => 'retrieve_queued_records',
420 __PACKAGE__->register_method(
421 api_name => "open-ils.vandelay.auth_queue.records.retrieve",
422 method => 'retrieve_queued_records',
426 record_type => 'auth'
428 __PACKAGE__->register_method(
429 api_name => "open-ils.vandelay.auth_queue.records.retrieve.export.print",
430 method => 'retrieve_queued_records',
434 record_type => 'auth'
436 __PACKAGE__->register_method(
437 api_name => "open-ils.vandelay.auth_queue.records.retrieve.export.csv",
438 method => 'retrieve_queued_records',
442 record_type => 'auth'
444 __PACKAGE__->register_method(
445 api_name => "open-ils.vandelay.auth_queue.records.retrieve.export.email",
446 method => 'retrieve_queued_records',
450 record_type => 'auth'
453 __PACKAGE__->register_method(
454 api_name => "open-ils.vandelay.bib_queue.records.matches.retrieve",
455 method => 'retrieve_queued_records',
459 record_type => 'bib',
461 desc => q/Only retrieve queued bib records that have matches against existing records/
464 __PACKAGE__->register_method(
465 api_name => "open-ils.vandelay.auth_queue.records.matches.retrieve",
466 method => 'retrieve_queued_records',
470 record_type => 'auth',
472 desc => q/Only retrieve queued authority records that have matches against existing records/
476 sub retrieve_queued_records {
477 my($self, $conn, $auth, $queue_id, $options) = @_;
480 my $limit = $$options{limit} || 20;
481 my $offset = $$options{offset} || 0;
482 my $type = $self->{record_type};
484 my $e = new_editor(authtoken => $auth, xact => 1);
485 return $e->die_event unless $e->checkauth;
489 $queue = $e->retrieve_vandelay_bib_queue($queue_id) or return $e->die_event;
491 $queue = $e->retrieve_vandelay_authority_queue($queue_id) or return $e->die_event;
493 my $evt = check_queue_perms($e, $type, $queue);
494 return $evt if ($evt);
496 my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
497 my $mclass = $type eq 'bib' ? 'vbm' : 'vam';
502 column => 'eg_record',
508 where => {queue => $queue_id},
513 if($self->api_name =~ /export/) {
514 delete $query->{limit};
515 delete $query->{offset};
518 $query->{where}->{import_time} = undef if $$options{non_imported};
520 if($$options{with_import_error}) {
522 $query->{from} = {$class => {vii => {type => 'left'}}};
523 $query->{where}->{'-or'} = [
524 {'+vqbr' => {import_error => {'!=' => undef}}},
525 {'+vii' => {import_error => {'!=' => undef}}}
530 if($$options{with_rec_import_error}) {
531 $query->{where}->{import_error} = {'!=' => undef};
533 } elsif( $$options{with_item_import_error} and $type eq 'bib') {
535 $query->{from} = {$class => 'vii'};
536 $query->{where}->{'+vii'} = {import_error => {'!=' => undef}};
540 if($self->api_name =~ /matches/) {
541 # find only records that have matches
542 $query->{from} = {$class => {$mclass => {type => 'right'}}};
544 # join to mclass for sorting (see below)
545 $query->{from} = {$class => {$mclass => {type => 'left'}}};
548 # order by the matched bib records to group like queued records
549 $query->{order_by} = [
550 {class => $mclass, field => 'eg_record', transform => 'min'},
551 {class => $class, field => 'id'}
554 my $record_ids = $e->json_query($query);
556 my $retrieve = ($type eq 'bib') ?
557 'retrieve_vandelay_queued_bib_record' : 'retrieve_vandelay_queued_authority_record';
558 my $search = ($type eq 'bib') ?
559 'search_vandelay_queued_bib_record' : 'search_vandelay_queued_authority_record';
561 if ($self->api_name =~ /export/) {
562 my $rec_list = $e->$search({id => [map { $_->{id} } @$record_ids]}, {substream => 1});
563 if ($self->api_name =~ /print/) {
566 return $U->fire_object_event(
568 'vandelay.queued_'.$type.'_record.print',
573 } elsif ($self->api_name =~ /csv/) {
576 return $U->fire_object_event(
578 'vandelay.queued_'.$type.'_record.csv',
583 } elsif ($self->api_name =~ /email/) {
585 $conn->respond_complete(1);
587 for my $rec (@$rec_list) {
588 $U->create_events_for_hook(
589 'vandelay.queued_'.$type.'_record.email',
591 $e->requestor->home_ou,
600 for my $rec_id (@$record_ids) {
601 my $flesh = ['attributes', 'matches'];
602 push(@$flesh, 'import_items') if $$options{flesh_import_items};
603 my $params = {flesh => 1, flesh_fields => {$class => $flesh}};
604 my $rec = $e->$retrieve([$rec_id->{id}, $params]);
605 $rec->clear_marc if $$options{clear_marc};
606 $conn->respond($rec);
614 __PACKAGE__->register_method(
615 api_name => 'open-ils.vandelay.import_item.queue.retrieve',
616 method => 'retrieve_queue_import_items',
622 Returns Import Item (vii) objects for the selected queue.
624 with_import_error : only return items that failed to import
627 __PACKAGE__->register_method(
628 api_name => 'open-ils.vandelay.import_item.queue.export.print',
629 method => 'retrieve_queue_import_items',
635 Returns template-generated printable output of Import Item (vii) objects for the selected queue.
637 with_import_error : only return items that failed to import
640 __PACKAGE__->register_method(
641 api_name => 'open-ils.vandelay.import_item.queue.export.csv',
642 method => 'retrieve_queue_import_items',
648 Returns template-generated CSV output of Import Item (vii) objects for the selected queue.
650 with_import_error : only return items that failed to import
653 __PACKAGE__->register_method(
654 api_name => 'open-ils.vandelay.import_item.queue.export.email',
655 method => 'retrieve_queue_import_items',
661 Emails template-generated output of Import Item (vii) objects for the selected queue.
663 with_import_error : only return items that failed to import
667 sub retrieve_queue_import_items {
668 my($self, $conn, $auth, $q_id, $options) = @_;
671 my $limit = $$options{limit} || 20;
672 my $offset = $$options{offset} || 0;
674 my $e = new_editor(authtoken => $auth);
675 return $e->event unless $e->checkauth;
677 my $queue = $e->retrieve_vandelay_bib_queue($q_id) or return $e->event;
678 my $evt = check_queue_perms($e, 'bib', $queue);
682 select => {vii => ['id']},
690 filter => {id => $q_id}
696 order_by => {'vii' => ['record','id']},
700 if($self->api_name =~ /export/) {
701 delete $query->{limit};
702 delete $query->{offset};
705 $query->{where} = {'+vii' => {import_error => {'!=' => undef}}}
706 if $$options{with_import_error};
708 my $items = $e->json_query($query);
709 my $item_list = $e->search_vandelay_import_item({id => [map { $_->{id} } @$items]});
710 if ($self->api_name =~ /export/) {
711 if ($self->api_name =~ /print/) {
713 return $U->fire_object_event(
715 'vandelay.import_items.print',
720 } elsif ($self->api_name =~ /csv/) {
722 return $U->fire_object_event(
724 'vandelay.import_items.csv',
729 } elsif ($self->api_name =~ /email/) {
731 $conn->respond_complete(1);
733 for my $item (@$item_list) {
734 $U->create_events_for_hook(
735 'vandelay.import_items.email',
737 $e->requestor->home_ou,
746 for my $item (@$item_list) {
747 $conn->respond($item);
754 sub check_queue_perms {
755 my($e, $type, $queue) = @_;
756 if ($type eq 'bib') {
757 return $e->die_event unless
758 ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
759 $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
761 return $e->die_event unless
762 ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
763 $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
769 __PACKAGE__->register_method(
770 api_name => "open-ils.vandelay.bib_record.list.import",
771 method => 'import_record_list',
778 __PACKAGE__->register_method(
779 api_name => "open-ils.vandelay.auth_record.list.import",
780 method => 'import_record_list',
784 record_type => 'auth'
787 sub import_record_list {
788 my($self, $conn, $auth, $rec_ids, $args) = @_;
789 my $e = new_editor(authtoken => $auth, xact => 1);
790 return $e->die_event unless $e->checkauth;
792 my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $args);
793 try {$e->rollback} otherwise {};
795 return {complete => 1};
799 __PACKAGE__->register_method(
800 api_name => "open-ils.vandelay.bib_queue.import",
801 method => 'import_queue',
805 max_bundle_count => 1,
806 record_type => 'bib',
809 Attempts to import all non-imported records for the selected queue.
810 Will also attempt import of all non-imported items.
815 __PACKAGE__->register_method(
816 api_name => "open-ils.vandelay.auth_queue.import",
817 method => 'import_queue',
821 max_bundle_count => 1,
822 record_type => 'auth'
826 my($self, $conn, $auth, $q_id, $options) = @_;
827 $conn->max_chunk_count($self->{max_bundle_count}) if (!$conn->can('max_bundle_count') && $self->{max_bundle_count});
829 my $e = new_editor(authtoken => $auth, xact => 1);
830 return $e->die_event unless $e->checkauth;
832 my $type = $self->{record_type};
833 my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
835 # First, collect the not-yet-imported records
836 my $query = {queue => $q_id, import_time => undef};
837 my $search = ($type eq 'bib') ?
838 'search_vandelay_queued_bib_record' :
839 'search_vandelay_queued_authority_record';
840 my $rec_ids = $e->$search($query, {idlist => 1});
842 # Now add any imported records that have un-imported items
845 my $item_recs = $e->json_query({
846 select => {vqbr => ['id']},
847 from => {vqbr => 'vii'},
851 import_time => {'!=' => undef}
853 '+vii' => {import_time => undef}
857 push(@$rec_ids, map {$_->{id}} @$item_recs);
860 my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $options);
861 try {$e->rollback} otherwise {}; # only using this to make the read authoritative -- don't die from it
863 return {complete => 1};
866 # returns a list of queued record IDs for a given queue that
867 # have at least one entry in the match table
869 sub queued_records_with_matches {
870 my($e, $type, $q_id, $limit, $offset, $filter) = @_;
872 my $match_class = 'vbm';
873 my $rec_class = 'vqbr';
874 if($type eq 'auth') {
875 $match_class = 'vam';
880 $filter->{queue} = $q_id;
884 select => {$match_class => ['queued_record']},
889 fkey => 'queued_record',
896 if($limit or defined $offset) {
899 $query->{limit} = $limit;
900 $query->{offset} = $offset;
903 my $data = $e->json_query($query);
904 return [ map {$_->{queued_record}} @$data ];
907 # Returns (tracker, err_event)
908 # Runs within its own transaction.
909 sub create_session_tracker {
910 my ($user_id, $ws_id, $key, $name, $type, $queue_id, $action, $total_acts) = @_;
911 my $e = new_editor(xact => 1);
914 # if other trackers exist for this key, adopt the name
916 $e->search_vandelay_session_tracker({session_key => $key})->[0];
917 $name = $existing->name if $name;
921 $key = md5_hex(time."$$".rand());
924 my $tracker = Fieldmapper::vandelay::session_tracker->new;
925 $tracker->session_key($key);
926 $tracker->name($name || $key);
927 $tracker->usr($user_id);
928 $tracker->workstation($ws_id);
929 $tracker->record_type($type);
930 $tracker->queue($queue_id);
931 $tracker->action_type($action);
932 $tracker->total_actions($total_acts) if $total_acts;
934 # caller responsible for rolling back transaction
935 return (undef, $e->die_event) unless
936 $e->create_vandelay_session_tracker($tracker);
938 # Re-fetch to ensure we have all defaults applied for future updates.
939 return (undef, $e->die_event) unless
940 $tracker = $e->retrieve_vandelay_session_tracker($tracker->id);
947 # Increment the actions_performed count.
948 # Must happen in its own transaction
949 # Returns undef on success, Event on error
950 sub increment_session_tracker {
952 my $amount = shift || 1;
953 my $e = new_editor(xact => 1);
954 $tracker->update_time('now');
955 $tracker->actions_performed($tracker->actions_performed + $amount);
956 return $e->die_event unless
957 $e->update_vandelay_session_tracker($tracker);
964 # cache of import item org unit settings.
965 # used in apply_import_item_defaults() below,
966 # but reset on each call to import_record_list_impl()
967 my %item_defaults_cache;
969 sub import_record_list_impl {
970 my($self, $conn, $rec_ids, $requestor, $args) = @_;
972 my $overlay_map = $args->{overlay_map} || {};
973 my $type = $self->{record_type};
975 %item_defaults_cache = ();
976 my $exit_early = $args->{exit_early};
982 total => scalar(@$rec_ids),
983 report_all => $$args{report_all},
984 exit_early => $exit_early
987 $conn->max_chunk_count(1) if (!$conn->can('max_bundle_size') && $conn->can('max_chunk_size') && $$args{report_all});
989 my $auto_overlay_exact = $$args{auto_overlay_exact};
990 my $auto_overlay_1match = $$args{auto_overlay_1match};
991 my $auto_overlay_best = $$args{auto_overlay_best_match};
992 my $match_quality_ratio = $$args{match_quality_ratio};
993 my $merge_profile = $$args{merge_profile};
994 my $ft_merge_profile = $$args{fall_through_merge_profile};
995 my $bib_source = $$args{bib_source};
996 my $import_no_match = $$args{import_no_match};
997 my $strip_grps = $$args{strip_field_groups}; # bib-only
999 my $overlay_func = 'vandelay.overlay_bib_record';
1000 my $auto_overlay_func = 'vandelay.auto_overlay_bib_record';
1001 my $auto_overlay_best_func = 'vandelay.auto_overlay_bib_record_with_best';
1002 my $retrieve_func = 'retrieve_vandelay_queued_bib_record';
1003 my $update_func = 'update_vandelay_queued_bib_record';
1004 my $search_func = 'search_vandelay_queued_bib_record';
1005 my $retrieve_queue_func = 'retrieve_vandelay_bib_queue';
1006 my $update_queue_func = 'update_vandelay_bib_queue';
1007 my $delete_queue_func = 'delete_vandelay_bib_queue';
1008 my $rec_class = 'vqbr';
1010 my $editor = new_editor();
1013 my $sources = $editor->search_config_bib_source({id => {'!=' => undef}});
1014 $bib_sources{$_->id} = $_->source for @$sources;
1016 if($type eq 'auth') {
1017 $overlay_func =~ s/bib/authority/o;
1018 $auto_overlay_func =~ s/bib/authority/o;
1019 $auto_overlay_best_func =~ s/bib/authority/o;
1020 $retrieve_func =~ s/bib/authority/o;
1021 $retrieve_queue_func =~ s/bib/authority/o;
1022 $update_queue_func =~ s/bib/authority/o;
1023 $update_func =~ s/bib/authority/o;
1024 $search_func =~ s/bib/authority/o;
1025 $delete_queue_func =~ s/bib/authority/o;
1026 $rec_class = 'vqar';
1032 my $new_rec_perm_cache;
1033 my @success_rec_ids;
1034 for my $rec_id (@$rec_ids) {
1037 my $overlay_target = $overlay_map->{$rec_id};
1039 my $e = new_editor(xact => 1);
1040 $e->requestor($requestor);
1042 $$report_args{e} = $e;
1043 $$report_args{evt} = undef;
1044 $$report_args{import_error} = undef;
1045 $$report_args{no_import} = 0;
1047 my $rec = $e->$retrieve_func([
1050 flesh_fields => { $rec_class => ['matches']},
1055 $$report_args{evt} = $e->event;
1056 finish_rec_import_attempt($report_args);
1061 # Create the import tracker using the queue of the first
1062 # retrieved record. I'm fairly certain in practice all
1063 # lists of records for import come from a single queue.
1064 # We could get the queue from the previously created
1065 # 'enqueue' tracker, but this is a safetly valve to handle
1066 # imports where no enqueue tracker exists, e.g. records
1067 # enqueued pre-upgrade.
1068 ($tracker, $tevt) = create_session_tracker(
1069 $e->requestor->id, $e->requestor->wsid, $args->{session_key},
1070 undef, $type, $rec->queue, 'import', scalar(@$rec_ids));
1077 $report_args->{tracker} = $tracker;
1079 $conn->respond_complete($tracker) if $exit_early;
1082 if($rec->import_time) {
1083 # if the record is already imported, that means it may have
1084 # un-imported copies. Add to success list for later processing.
1085 push(@success_rec_ids, $rec_id);
1090 $$report_args{rec} = $rec;
1091 $queues{$rec->queue} = 1;
1096 if ($type eq 'bib') {
1097 # strip configured / selected MARC tags from inbound records
1099 my $marcdoc = XML::LibXML->new->parse_string($rec->marc);
1100 $rec->marc($U->strip_marc_fields($e, $marcdoc, $strip_grps));
1103 # Set the imported record's 905$u, so
1104 # editor/edit_date are set correctly.
1105 my $marcdoc = XML::LibXML->new->parse_string($rec->marc);
1106 $rec->marc($U->set_marc_905u($marcdoc, $requestor->usrname));
1108 unless ($e->$update_func($rec)) {
1109 $$report_args{evt} = $e->die_event;
1110 finish_rec_import_attempt($report_args);
1114 if(defined $overlay_target) {
1115 # Caller chose an explicit overlay target
1117 my $res = $e->json_query(
1128 if($res and ($res = $res->[0])) {
1130 if($res->{$overlay_func} eq 't') {
1131 $logger->info("vl: $type direct overlay succeeded for queued rec ".
1132 "$rec_id and overlay target $overlay_target");
1134 $rec->imported_as($overlay_target);
1139 $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
1144 if($auto_overlay_1match) { # overlay if there is exactly 1 match
1146 my %match_recs = map { $_->eg_record => 1 } @{$rec->matches};
1148 if( scalar(keys %match_recs) == 1) { # all matches point to the same record
1150 ($imported, $error, $rec) = try_auto_overlay(
1153 $auto_overlay_best_func,
1157 $match_quality_ratio,
1164 if(!$imported and !$error and $auto_overlay_exact and scalar(@{$rec->matches}) == 1 ) {
1166 # caller says to overlay if there is an /exact/ match
1167 # $auto_overlay_func only proceeds and returns true on exact matches
1169 my $res = $e->json_query(
1179 if($res and ($res = $res->[0])) {
1181 if($res->{$auto_overlay_func} eq 't') {
1182 $logger->info("vl: $type auto-overlay succeeded for queued rec $rec_id");
1185 # re-fetch the record to pick up the imported_as value from the DB
1186 $$report_args{rec} = $rec = $e->$retrieve_func([
1187 $rec_id, {flesh => 1, flesh_fields => {$rec_class => ['matches']}}]);
1190 $logger->info("vl: $type auto-overlay failed for queued rec $rec_id");
1195 $logger->error("vl: Error attempting overlay with func=$auto_overlay_func, profile=$merge_profile, record=$rec_id");
1199 if(!$imported and !$error and $auto_overlay_best and scalar(@{$rec->matches}) > 0 ) {
1200 # caller says to overlay the best match
1202 ($imported, $error, $rec) = try_auto_overlay(
1205 $auto_overlay_best_func,
1209 $match_quality_ratio,
1215 if(!$imported and !$error and $import_no_match and scalar(@{$rec->matches}) == 0) {
1217 # No overlay / merge occurred. Do a traditional record import by creating a new record
1219 if (!$new_rec_perm_cache) {
1220 $new_rec_perm_cache = {};
1222 # all users creating new records are required to have the basic permission.
1223 # if the client requests, we can enforce extra permissions for creating new records.
1224 # for speed, check the permissions the first time then cache the result.
1226 my $perm = ($type eq 'bib') ? 'IMPORT_MARC' : 'IMPORT_AUTHORITY_MARC';
1227 my $xperm = $$args{new_rec_perm};
1228 my $rec_ou = $e->requestor->ws_ou;
1230 $new_rec_perm_cache->{evt} = $e->die_event
1231 if !$e->allowed($perm, $rec_ou) || ($xperm and !$e->allowed($xperm, $rec_ou));
1234 if ($new_rec_perm_cache->{evt}) {
1236 # a cached event won't roll back the transaction (a la die_event), but
1237 # the transaction will get rolled back in finish_rec_import_attempt() below
1238 $$report_args{evt} = $new_rec_perm_cache->{evt};
1239 $$report_args{import_error} = 'import.record.perm_failure';
1241 } else { # perm checks succeeded
1243 $logger->info("vl: creating new $type record for queued record $rec_id");
1245 if ($type eq 'bib') {
1247 $record = OpenILS::Application::Cat::BibCommon->biblio_record_xml_import(
1248 $e, $rec->marc, $bib_sources{$rec->bib_source}, undef, 1);
1250 } else { # authority record
1252 $record = OpenILS::Application::Cat::AuthCommon->import_authority_record($e, $rec->marc); #$source);
1255 if($U->event_code($record)) {
1256 $$report_args{import_error} = 'import.duplicate.tcn'
1257 if $record->{textcode} eq 'OPEN_TCN_NOT_FOUND';
1258 $$report_args{evt} = $record;
1262 $logger->info("vl: successfully imported new $type record");
1263 $rec->imported_as($record->id);
1272 $rec->import_time('now');
1273 $rec->clear_import_error;
1274 $rec->clear_error_detail;
1276 if($e->$update_func($rec)) {
1278 if($type eq 'bib') {
1280 # see if this record is linked from an acq record.
1281 my $li = $e->search_acq_lineitem(
1282 {queued_record => $rec->id, state => {'!=' => 'canceled'}})->[0];
1285 # if so, update the acq lineitem to point to the imported record
1286 $li->eg_bib_id($rec->imported_as);
1287 $$report_args{evt} = $e->die_event unless $e->update_acq_lineitem($li);
1291 push @success_rec_ids, $rec_id;
1292 finish_rec_import_attempt($report_args);
1300 $logger->info("vl: record $rec_id was not imported");
1301 $$report_args{evt} = $e->event unless $$report_args{evt};
1302 $$report_args{no_import} = 1;
1303 finish_rec_import_attempt($report_args);
1307 # see if we need to mark any queues as complete
1308 for my $q_id (keys %queues) {
1310 my $e = new_editor(xact => 1);
1311 my $remaining = $e->$search_func(
1312 [{queue => $q_id, import_time => undef}, {limit =>1}], {idlist => 1});
1314 unless(@$remaining) {
1315 my $queue = $e->$retrieve_queue_func($q_id);
1316 unless($U->is_true($queue->complete)) {
1317 $queue->complete('t');
1318 $e->$update_queue_func($queue) or return $e->die_event;
1326 import_record_asset_list_impl($conn,
1327 \@success_rec_ids, $requestor, $args, $tracker) if @success_rec_ids;
1329 if ($tracker) { # there are edge cases where it may not exist
1330 my $e = new_editor(xact => 1);
1331 $e->requestor($requestor);
1332 $tracker->update_time('now');
1333 $tracker->state('complete');
1334 $e->update_vandelay_session_tracker($tracker) or return $e->die_event;
1338 $conn->respond({total => $$report_args{total}, progress => $$report_args{progress}});
1343 sub try_auto_overlay {
1346 my $report_args = shift;
1347 my $overlay_func = shift;
1348 my $retrieve_func = shift;
1349 my $rec_class = shift;
1351 my $match_quality_ratio = shift;
1352 my $merge_profile = shift;
1353 my $ft_merge_profile = shift;
1358 # Find the best match and overlay if the quality ratio allows it.
1359 my $res = $e->json_query(
1365 $match_quality_ratio
1370 if($res and ($res = $res->[0])) {
1372 if($res->{$overlay_func} eq 't') {
1374 # first attempt succeeded
1379 # quality-limited merge failed with insufficient quality. If there is a
1380 # fall-through merge profile, re-do the merge with the alternate profile
1381 # and no quality restriction.
1383 if($ft_merge_profile and $match_quality_ratio > 0) {
1385 $logger->info("vl: $type auto-merge failed with profile $merge_profile; ".
1386 "re-merging with fall-through profile $ft_merge_profile");
1388 my $res = $e->json_query(
1394 0 # minimum quality not required
1399 if($res and ($res = $res->[0])) {
1401 if($res->{$overlay_func} eq 't') {
1403 # second attempt succeeded
1408 # failed to merge on second attempt
1409 $logger->info("vl: $type auto-merge with fall-through failed for queued rec $rec_id");
1413 # second attempt died
1415 $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
1420 # failed to merge on first attempt, no fall-through was provided
1421 $$report_args{import_error} = 'overlay.record.quality' if $match_quality_ratio > 0;
1422 $logger->info("vl: $type auto-merge failed for queued rec $rec_id");
1428 # first attempt died
1430 $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
1435 # at least 1 of the attempts succeeded
1436 $logger->info("vl: $type auto-merge succeeded for queued rec $rec_id");
1438 # re-fetch the record to pick up the imported_as value from the DB
1439 $$report_args{rec} = $e->$retrieve_func([
1440 $rec_id, {flesh => 1, flesh_fields => {$rec_class => ['matches']}}]);
1443 return ($imported, $error, $$report_args{rec});
1447 # tracks any import errors, commits the current xact, responds to the client
1448 sub finish_rec_import_attempt {
1450 my $evt = $$args{evt};
1451 my $rec = $$args{rec};
1453 my $tracker = $$args{tracker};
1454 my $exit_early = $$args{exit_early};
1456 my $error = $$args{import_error};
1457 $error = 'general.unknown' if $evt and not $error;
1459 # Note the tracker is updated regardless of whether the individual
1460 # record import succeeded. It's only a failed tracker if the
1461 # entire process fails.
1462 if ($tracker) { # tracker may be undef in rec-not-found situations
1463 my $tevt = increment_session_tracker($tracker);
1464 return $tevt if $tevt;
1470 if($error or $evt) {
1472 # since an error occurred, there's no guarantee the transaction wasn't
1473 # rolled back. force a rollback and create a new editor.
1475 $e = new_editor(xact => 1);
1476 $rec->import_error($error);
1479 my $detail = sprintf("%s : %s", $evt->{textcode}, substr($evt->{desc}, 0, 140));
1480 $rec->error_detail($detail);
1483 my $method = 'update_vandelay_queued_bib_record';
1484 $method =~ s/bib/authority/ if $$args{type} eq 'auth';
1485 $e->$method($rec) and $e->commit or $e->rollback;
1489 # commit the successful import
1494 # requested queued record was not found
1498 # respond to client unless we've already responded-complete
1500 if($$args{report_all} or ($$args{progress} % $$args{step}) == 0) {
1501 $$args{conn}->respond({
1502 total => $$args{total},
1503 progress => $$args{progress},
1504 imported => ($rec) ? $rec->id : undef,
1505 import_error => $error,
1506 no_import => $$args{no_import},
1509 $$args{step} *= 2 unless $$args{step} == 256;
1520 __PACKAGE__->register_method(
1521 api_name => "open-ils.vandelay.bib_queue.owner.retrieve",
1522 method => 'owner_queue_retrieve',
1526 record_type => 'bib'
1528 __PACKAGE__->register_method(
1529 api_name => "open-ils.vandelay.authority_queue.owner.retrieve",
1530 method => 'owner_queue_retrieve',
1534 record_type => 'auth'
1537 sub owner_queue_retrieve {
1538 my($self, $conn, $auth, $owner_id, $filters) = @_;
1539 my $e = new_editor(authtoken => $auth, xact => 1);
1540 return $e->die_event unless $e->checkauth;
1541 $owner_id = $e->requestor->id; # XXX add support for viewing other's queues?
1544 my $search = {owner => $owner_id};
1545 $search->{$_} = $filters->{$_} for keys %$filters;
1547 if($self->{record_type} eq 'bib') {
1548 $queues = $e->search_vandelay_bib_queue(
1549 [$search, {order_by => {vbq => 'evergreen.lowercase(name)'}}]);
1551 $queues = $e->search_vandelay_authority_queue(
1552 [$search, {order_by => {vaq => 'evergreen.lowercase(name)'}}]);
1554 $conn->respond($_) for @$queues;
1559 __PACKAGE__->register_method(
1560 api_name => "open-ils.vandelay.bib_queue.delete",
1561 method => "delete_queue",
1564 record_type => 'bib'
1566 __PACKAGE__->register_method(
1567 api_name => "open-ils.vandelay.auth_queue.delete",
1568 method => "delete_queue",
1571 record_type => 'auth'
1575 my($self, $conn, $auth, $q_id) = @_;
1576 my $e = new_editor(xact => 1, authtoken => $auth);
1577 return $e->die_event unless $e->checkauth;
1578 if($self->{record_type} eq 'bib') {
1579 return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
1580 my $queue = $e->retrieve_vandelay_bib_queue($q_id)
1581 or return $e->die_event;
1582 $e->delete_vandelay_bib_queue($queue)
1583 or return $e->die_event;
1585 return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
1586 my $queue = $e->retrieve_vandelay_authority_queue($q_id)
1587 or return $e->die_event;
1588 $e->delete_vandelay_authority_queue($queue)
1589 or return $e->die_event;
1596 __PACKAGE__->register_method(
1597 api_name => "open-ils.vandelay.queued_bib_record.html",
1598 method => 'queued_record_html',
1602 record_type => 'bib'
1604 __PACKAGE__->register_method(
1605 api_name => "open-ils.vandelay.queued_authority_record.html",
1606 method => 'queued_record_html',
1610 record_type => 'auth'
1613 sub queued_record_html {
1614 my($self, $conn, $auth, $rec_id) = @_;
1615 my $e = new_editor(xact=>1,authtoken => $auth);
1616 return $e->die_event unless $e->checkauth;
1618 if($self->{record_type} eq 'bib') {
1619 $rec = $e->retrieve_vandelay_queued_bib_record($rec_id)
1620 or return $e->die_event;
1622 $rec = $e->retrieve_vandelay_queued_authority_record($rec_id)
1623 or return $e->die_event;
1627 return $U->simplereq(
1629 'open-ils.search.biblio.record.html', undef, 1, $rec->marc);
1633 __PACKAGE__->register_method(
1634 api_name => "open-ils.vandelay.bib_queue.summary.retrieve",
1635 method => 'retrieve_queue_summary',
1639 record_type => 'bib'
1641 __PACKAGE__->register_method(
1642 api_name => "open-ils.vandelay.auth_queue.summary.retrieve",
1643 method => 'retrieve_queue_summary',
1647 record_type => 'auth'
1650 sub retrieve_queue_summary {
1651 my($self, $conn, $auth, $queue_id) = @_;
1652 my $e = new_editor(xact=>1, authtoken => $auth);
1653 return $e->die_event unless $e->checkauth;
1656 my $type = $self->{record_type};
1657 if($type eq 'bib') {
1658 $queue = $e->retrieve_vandelay_bib_queue($queue_id)
1659 or return $e->die_event;
1661 $queue = $e->retrieve_vandelay_authority_queue($queue_id)
1662 or return $e->die_event;
1665 my $evt = check_queue_perms($e, $type, $queue);
1666 return $evt if $evt;
1668 my $search = 'search_vandelay_queued_bib_record';
1669 $search =~ s/bib/authority/ if $type ne 'bib';
1673 total => scalar(@{$e->$search({queue => $queue_id}, {idlist=>1})}),
1674 imported => scalar(@{$e->$search({queue => $queue_id, import_time => {'!=' => undef}}, {idlist=>1})}),
1677 my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
1678 $summary->{rec_import_errors} = $e->json_query({
1679 select => {$class => [{alias => 'count', column => 'id', transform => 'count', aggregate => 1}]},
1681 where => {queue => $queue_id, import_error => {'!=' => undef}}
1684 if($type eq 'bib') {
1686 # count of all items attached to records in the queue in question
1688 select => {vii => [{alias => 'count', column => 'id', transform => 'count', aggregate => 1}]},
1693 select => {vqbr => ['id']},
1695 where => {queue => $queue_id}
1700 $summary->{total_items} = $e->json_query($query)->[0]->{count};
1702 # count of items we attempted to import, but errored, attached to records in the queue in question
1703 $query->{where}->{import_error} = {'!=' => undef};
1704 $summary->{item_import_errors} = $e->json_query($query)->[0]->{count};
1706 # count of items we successfully imported attached to records in the queue in question
1707 delete $query->{where}->{import_error};
1708 $query->{where}->{import_time} = {'!=' => undef};
1709 $summary->{total_items_imported} = $e->json_query($query)->[0]->{count};
1715 # --------------------------------------------------------------------------------
1716 # Given a list of queued record IDs, imports all items attached to those records
1717 # --------------------------------------------------------------------------------
1718 sub import_record_asset_list_impl {
1719 my($conn, $rec_ids, $requestor, $args, $tracker) = @_;
1721 my $roe = new_editor(xact=> 1, requestor => $requestor);
1723 # for speed, filter out any records have not been
1724 # imported or have no import items to load
1725 $rec_ids = $roe->json_query({
1726 select => {vqbr => ['id']},
1727 from => {vqbr => 'vii'},
1728 where => {'+vqbr' => {
1730 import_time => {'!=' => undef}
1734 $rec_ids = [map {$_->{id}} @$rec_ids];
1738 total => scalar(@$rec_ids),
1739 step => 1, # how often to respond
1744 if ($tracker && @$rec_ids) {
1745 if (my $tevt = # assignment
1746 increment_session_tracker($tracker, scalar(@$rec_ids))) {
1752 for my $rec_id (@$rec_ids) {
1753 my $rec = $roe->retrieve_vandelay_queued_bib_record($rec_id);
1754 my $item_ids = $roe->search_vandelay_import_item(
1755 {record => $rec->id, import_error => undef},
1759 if ($tracker) { # increment per record
1760 if (my $tevt = increment_session_tracker($tracker)) {
1766 # if any items have no call_number label and a value should be
1767 # applied automatically (via org settings), we want to use the same
1768 # call number label for every copy per org per record.
1769 my $auto_callnumber = {};
1771 my $opp_acq_copy_overlay = $args->{opp_acq_copy_overlay};
1772 my @overlaid_copy_ids;
1773 for my $item_id (@$item_ids) {
1774 my $e = new_editor(requestor => $requestor, xact => 1);
1775 my $item = $e->retrieve_vandelay_import_item($item_id);
1776 my ($copy, $vol, $evt);
1778 $$report_args{e} = $e;
1779 $$report_args{evt} = undef;
1780 $$report_args{import_item} = $item;
1781 $$report_args{import_error} = undef;
1783 if (my $copy_id = $item->internal_id) { # assignment
1784 # copy matches an existing copy. Overlay instead of create.
1786 $logger->info("vl: performing copy overlay for internal_id=$copy_id");
1788 my $qt = $e->json_query({
1789 select => {vbq => ['queue_type']},
1790 from => {vqbr => 'vbq'},
1791 where => {'+vqbr' => {id => $rec_id}}
1792 })->[0]->{queue_type};
1795 # internal_id for ACQ queues refers to acq.lineitem_detail.id
1796 # pull the real copy id from the acq LID
1798 my $lid = $e->retrieve_acq_lineitem_detail($copy_id);
1800 $$report_args{evt} = $e->die_event;
1801 respond_with_status($report_args);
1804 $copy_id = $lid->eg_copy_id;
1805 $logger->info("vl: performing ACQ copy overlay for copy $copy_id");
1808 $copy = $e->search_asset_copy([
1809 {id => $copy_id, deleted => 'f'},
1810 {flesh => 1, flesh_fields => {acp => ['call_number']}}
1814 $$report_args{evt} = $e->die_event;
1815 respond_with_status($report_args);
1819 # prevent update of unrelated copies
1820 if ($copy->call_number->record != $rec->imported_as) {
1821 $logger->info("vl: attempt to overlay unrelated copy=$copy_id; rec=".$rec->imported_as);
1823 $evt = OpenILS::Event->new('INVALID_IMPORT_COPY_ID',
1824 note => 'Cannot overlay copies for unlinked bib',
1825 bre => $rec->imported_as,
1828 $$report_args{evt} = $evt;
1829 respond_with_status($report_args);
1832 } elsif ($opp_acq_copy_overlay) { # we are going to "opportunistically" overlay received, in-process acq copies
1833 # recv_time should never be null if the copy status is
1834 # "In Process", so that is just a double-check
1837 "recv_time" => {"!=" => undef},
1838 "owning_lib" => $item->owning_lib,
1839 "+acn" => {"record" => $rec->imported_as},
1840 "+acp" => {"status" => OILS_COPY_STATUS_IN_PROCESS}
1850 "acqlid" => ["eg_copy_id"],
1851 "acp" => ["call_number"]
1855 # don't overlay the same copy twice
1856 $query->[0]{"+acp"}{"id"} = {"not in" => \@overlaid_copy_ids} if @overlaid_copy_ids;
1857 if (my $acqlid = $e->search_acq_lineitem_detail($query)->[0]) {
1858 $copy = $acqlid->eg_copy_id;
1859 push(@overlaid_copy_ids, $copy->id);
1863 if ($copy) { # we found a copy to overlay
1865 # overlaying copies requires an extra permission
1866 if (!$e->allowed("IMPORT_OVERLAY_COPY", $copy->call_number->owning_lib)) {
1867 $$report_args{evt} = $e->die_event;
1868 respond_with_status($report_args);
1872 # are we updating the call-number?
1873 if ($item->call_number and $item->call_number ne $copy->call_number->label) {
1875 my $count = $e->json_query({
1876 select => {acp => [{
1879 transform => 'count',
1885 call_number => $copy->call_number->id
1891 my $evol = $e->search_asset_call_number({
1892 id => {'<>' => $copy->call_number->id},
1893 label => $item->call_number,
1894 owning_lib => $copy->call_number->owning_lib,
1895 record => $copy->call_number->record,
1896 prefix => $copy->call_number->prefix,
1897 suffix => $copy->call_number->suffix,
1902 # call number for overlayed copy changed to a
1903 # label already in use by another call number.
1904 # merge the old CN into the new CN
1907 "vl: moving copy to new call number ".
1908 $item->call_number);
1911 OpenILS::Application::Cat::Merge::merge_volumes(
1912 $e, [$copy->call_number], $evol);
1915 $$report_args{evt} = $err;
1916 respond_with_status($report_args);
1920 # update our copy *cough* of the copy to pick up
1921 # any changes made my merge_volumes
1922 $copy = $e->retrieve_asset_copy([
1924 {flesh => 1, flesh_fields => {acp => ['call_number']}}
1929 "vl: updating copy call number label".
1930 $item->call_number);
1932 $copy->call_number->label($item->call_number);
1933 if (!$e->update_asset_call_number($copy->call_number)) {
1934 $$report_args{evt} = $e->die_event;
1935 respond_with_status($report_args);
1942 # otherwise, move the copy to a new/existing
1943 # call-number with the given label/owner
1944 # note that overlay does not allow the owning_lib
1945 # to be changed. Should it?
1947 $logger->info("vl: moving copy to new callnumber in copy overlay");
1950 OpenILS::Application::Cat::AssetCommon->find_or_create_volume(
1951 $e, $item->call_number,
1952 $copy->call_number->record,
1953 $copy->call_number->owning_lib
1957 $$report_args{evt} = $evt;
1958 respond_with_status($report_args);
1962 $copy->call_number($vol);
1966 # for every field that has a non-'' value, overlay the copy value
1967 foreach (qw/ barcode location circ_lib status
1968 circulate deposit deposit_amount ref holdable
1969 price circ_as_type alert_message opac_visible circ_modifier/) {
1971 my $val = $item->$_();
1972 $copy->$_($val) if defined $val and $val ne '';
1975 # de-flesh for update
1976 $copy->call_number($copy->call_number->id);
1977 $copy->ischanged(1);
1979 $evt = OpenILS::Application::Cat::AssetCommon->
1980 update_fleshed_copies($e, {all => 1}, undef, [$copy]);
1983 $$report_args{evt} = $evt;
1984 respond_with_status($report_args);
1990 # Creating a new copy
1991 $logger->info("vl: creating new copy in import");
1993 # appply defaults values from org settings as needed
1994 # if $auto_callnumber is unset, it will be set within
1995 apply_import_item_defaults($e, $item, $auto_callnumber);
1997 # --------------------------------------------------------------------------------
1998 # Find or create the volume
1999 # --------------------------------------------------------------------------------
2001 OpenILS::Application::Cat::AssetCommon->find_or_create_volume(
2002 $e, $item->call_number, $rec->imported_as, $item->owning_lib);
2005 $$report_args{evt} = $evt;
2006 respond_with_status($report_args);
2010 # --------------------------------------------------------------------------------
2011 # Create the new copy
2012 # --------------------------------------------------------------------------------
2013 $copy = Fieldmapper::asset::copy->new;
2014 $copy->loan_duration(2);
2015 $copy->fine_level(2);
2016 $copy->barcode($item->barcode);
2017 $copy->location($item->location);
2018 $copy->circ_lib($item->circ_lib || $item->owning_lib);
2019 $copy->status( defined($item->status) ? $item->status : OILS_COPY_STATUS_IN_PROCESS );
2020 $copy->circulate($item->circulate);
2021 $copy->deposit($item->deposit);
2022 $copy->deposit_amount($item->deposit_amount);
2023 $copy->ref($item->ref);
2024 $copy->holdable($item->holdable);
2025 $copy->price($item->price);
2026 $copy->circ_as_type($item->circ_as_type);
2027 $copy->alert_message($item->alert_message);
2028 $copy->opac_visible($item->opac_visible);
2029 $copy->circ_modifier($item->circ_modifier);
2031 # --------------------------------------------------------------------------------
2032 # Check for dupe barcode
2033 # --------------------------------------------------------------------------------
2034 if($evt = OpenILS::Application::Cat::AssetCommon->create_copy($e, $vol, $copy)) {
2035 $$report_args{evt} = $evt;
2036 $$report_args{import_error} = 'import.item.duplicate.barcode'
2037 if $evt->{textcode} eq 'ITEM_BARCODE_EXISTS';
2038 respond_with_status($report_args);
2042 # --------------------------------------------------------------------------------
2044 # --------------------------------------------------------------------------------
2045 $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
2046 $e, $copy, '', $item->pub_note, 1) if $item->pub_note;
2049 $$report_args{evt} = $evt;
2050 respond_with_status($report_args);
2054 $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
2055 $e, $copy, '', $item->priv_note) if $item->priv_note;
2058 $$report_args{evt} = $evt;
2059 respond_with_status($report_args);
2064 if ($item->stat_cat_data) {
2065 $logger->info("vl: parsing stat cat data: " . $item->stat_cat_data);
2066 my @stat_cat_pairs = split('\|\|', $item->stat_cat_data);
2067 my $stat_cat_entries = [];
2069 foreach my $stat_cat_pair (@stat_cat_pairs) {
2070 my ($stat_cat, $stat_cat_entry);
2071 my @pair_pieces = split('\|', $stat_cat_pair);
2072 if (@pair_pieces == 2) {
2073 $stat_cat = $e->search_asset_stat_cat({name=>$pair_pieces[0]})->[0];
2075 $stat_cat_entry = $e->search_asset_stat_cat_entry({'value' => $pair_pieces[1], 'stat_cat' => $stat_cat->id})->[0];
2076 push (@$stat_cat_entries, $stat_cat_entry) if $stat_cat_entry;
2079 $$report_args{import_error} = "import.item.invalid.stat_cat_format";
2083 if (!$stat_cat or !$stat_cat_entry) {
2084 $$report_args{import_error} = "import.item.invalid.stat_cat_data";
2088 if ($$report_args{import_error}) {
2089 $logger->error("vl: invalid stat cat data: " . $item->stat_cat_data);
2090 respond_with_status($report_args);
2093 $copy->stat_cat_entries( $stat_cat_entries );
2094 $copy->ischanged(1);
2095 $evt = OpenILS::Application::Cat::AssetCommon->update_copy_stat_entries($e, $copy, 0, 1); #delete_stats=0, add_or_update_only=1
2097 $$report_args{evt} = $evt;
2098 respond_with_status($report_args);
2103 if ($item->parts_data) {
2104 $logger->info("vl: parsing parts data: " . $item->parts_data);
2105 my @parts = split('\|', $item->parts_data);
2107 foreach my $part_label (@parts) {
2108 my $part_obj = $e->search_biblio_monograph_part(
2111 record=>$rec->imported_as
2116 $part_obj = Fieldmapper::biblio::monograph_part->new();
2117 $part_obj->label( $part_label );
2118 $part_obj->record( $rec->imported_as );
2119 unless($e->create_biblio_monograph_part($part_obj)) {
2120 $$report_args{evt} = $e->die_event;
2124 push @$part_objs, $part_obj;
2127 if ($$report_args{evt}) {
2128 respond_with_status($report_args);
2131 $copy->parts( $part_objs );
2132 $copy->ischanged(1);
2133 $evt = OpenILS::Application::Cat::AssetCommon->update_copy_parts($e, $copy, 0); #delete_parts=0
2135 $$report_args{evt} = $evt;
2136 respond_with_status($report_args);
2142 # set the import data on the import item
2143 $item->imported_as($copy->id); # $copy->id is set by create_copy() ^--
2144 $item->import_time('now');
2146 unless($e->update_vandelay_import_item($item)) {
2147 $$report_args{evt} = $e->die_event;
2148 respond_with_status($report_args);
2152 # --------------------------------------------------------------------------------
2153 # Item import succeeded
2154 # --------------------------------------------------------------------------------
2156 $$report_args{in_count}++;
2157 respond_with_status($report_args);
2158 $logger->info("vl: successfully imported item " . $item->barcode);
2166 sub apply_import_item_defaults {
2167 my ($e, $item, $auto_cn) = @_;
2168 my $org = $item->owning_lib || $item->circ_lib;
2169 my %c = %item_defaults_cache;
2171 # fetch and cache the org unit setting value (unless
2172 # it's already cached) and return the value to the caller
2175 return $c{$org}{$name} if defined $c{$org}{$name};
2176 my $sname = "vandelay.item.$name";
2177 $c{$org}{$name} = $U->ou_ancestor_setting_value($org, $sname, $e);
2178 $c{$org}{$name} = '' unless defined $c{$org}{$name};
2179 return $c{$org}{$name};
2182 if (!$item->barcode) {
2184 if ($set->('barcode.auto')) {
2186 my $pfx = $set->('barcode.prefix') || 'VAN';
2187 my $barcode = $pfx . $item->record . $item->id;
2189 $logger->info("vl: using auto barcode $barcode for ".$item->id);
2190 $item->barcode($barcode);
2193 $logger->error("vl: no barcode (or defualt) for item ".$item->id);
2197 if (!$item->call_number) {
2199 if ($set->('call_number.auto')) {
2201 if (!$auto_cn->{$org}) {
2202 my $pfx = $set->('call_number.prefix') || 'VAN';
2204 # use the ID of the first item to differentiate this
2205 # call number from others linked to the same record
2206 $auto_cn->{$org} = $pfx . $item->record . $item->id;
2209 $logger->info("vl: using auto call number ".$auto_cn->{$org});
2210 $item->call_number($auto_cn->{$org});
2213 $logger->error("vl: no call number or default for item ".$item->id);
2219 sub respond_with_status {
2223 # If the import failed, track the failure reason
2225 my $error = $$args{import_error};
2226 my $evt = $$args{evt};
2228 if($error or $evt) {
2230 my $item = $$args{import_item};
2231 $logger->info("vl: unable to import item " . $item->barcode);
2233 $error ||= 'general.unknown';
2234 $item->import_error($error);
2237 my $detail = sprintf("%s : %s", $evt->{textcode}, substr($evt->{desc}, 0, 140));
2238 $item->error_detail($detail);
2241 # state of the editor is unknown at this point. Force a rollback and start over.
2243 $e = new_editor(xact => 1);
2244 $e->update_vandelay_import_item($item);
2248 if($$args{report_all} or ($$args{progress} % $$args{step}) == 0) {
2249 $$args{conn}->respond({
2250 total => $$args{total},
2251 progress => $$args{progress},
2252 success_count => $$args{success_count},
2255 $$args{step} *= 2 unless $$args{step} == 256;
2261 __PACKAGE__->register_method(
2262 api_name => "open-ils.vandelay.match_set.get_tree",
2263 method => "match_set_get_tree",
2267 desc => q/For a given vms object, return a tree of match set points
2268 represented by a vmsp object with recursively fleshed
2273 sub match_set_get_tree {
2274 my ($self, $conn, $authtoken, $match_set_id) = @_;
2276 $match_set_id = int($match_set_id) or return;
2278 my $e = new_editor("authtoken" => $authtoken);
2279 $e->checkauth or return $e->die_event;
2281 my $set = $e->retrieve_vandelay_match_set($match_set_id) or
2282 return $e->die_event;
2284 $e->allowed("ADMIN_IMPORT_MATCH_SET", $set->owner) or
2285 return $e->die_event;
2287 my $tree = $e->search_vandelay_match_set_point([
2288 {"match_set" => $match_set_id, "parent" => undef},
2289 {"flesh" => -1, "flesh_fields" => {"vmsp" => ["children"]}}
2290 ]) or return $e->die_event;
2296 __PACKAGE__->register_method(
2297 api_name => "open-ils.vandelay.match_set.update",
2298 method => "match_set_update_tree",
2302 desc => q/Replace any vmsp objects associated with a given (by ID) vms
2303 with the given objects (recursively fleshed vmsp tree)./
2307 sub _walk_new_vmsp {
2308 my ($e, $match_set_id, $node, $parent_id) = @_;
2310 my $point = new Fieldmapper::vandelay::match_set_point;
2311 $point->parent($parent_id);
2312 $point->match_set($match_set_id);
2313 $point->$_($node->$_)
2314 for (qw/bool_op svf tag subfield negate quality heading/);
2316 $e->create_vandelay_match_set_point($point) or return $e->die_event;
2318 $parent_id = $e->data->id;
2319 if ($node->children && @{$node->children}) {
2320 for (@{$node->children}) {
2321 return $e->die_event if
2322 _walk_new_vmsp($e, $match_set_id, $_, $parent_id);
2329 sub match_set_update_tree {
2330 my ($self, $conn, $authtoken, $match_set_id, $tree) = @_;
2332 my $e = new_editor("xact" => 1, "authtoken" => $authtoken);
2333 $e->checkauth or return $e->die_event;
2335 my $set = $e->retrieve_vandelay_match_set($match_set_id) or
2336 return $e->die_event;
2338 $e->allowed("ADMIN_IMPORT_MATCH_SET", $set->owner) or
2339 return $e->die_event;
2341 my $existing = $e->search_vandelay_match_set_point([
2342 {"match_set" => $match_set_id},
2343 {"order_by" => {"vmsp" => "id DESC"}}
2344 ]) or return $e->die_event;
2346 # delete points, working up from leaf points to the root
2348 for my $point (shift @$existing) {
2349 if( grep {$_->parent eq $point->id} @$existing) {
2350 push(@$existing, $point);
2352 $e->delete_vandelay_match_set_point($point) or return $e->die_event;
2357 _walk_new_vmsp($e, $match_set_id, $tree);
2359 $e->commit or return $e->die_event;
2362 __PACKAGE__->register_method(
2363 api_name => 'open-ils.vandelay.bib_queue.to_bucket',
2364 method => 'bib_queue_to_bucket',
2368 desc => q/Add to or create a new bib container (bucket) with the successfully
2369 imported contents of a vandelay queue. Any user that has Vandelay
2370 queue create permissions can append or create buckets from his-her own queues./,
2372 {desc => 'Authtoken', type => 'string'},
2373 {desc => 'Queue ID', type => 'number'},
2374 {desc => 'Bucket Name', type => 'string'}
2376 return => {desc => q/
2377 {bucket => $bucket, addcount => number-of-items-added-to-bucket, item_count => total-bucket-item-count} on success,
2378 {add_count => 0} if there is nothing to do, and Event on error/}
2382 sub bib_queue_to_bucket {
2383 my ($self, $conn, $auth, $q_id, $bucket_name) = @_;
2385 my $e = new_editor(xact => 1, authtoken => $auth);
2386 return $e->die_event unless $e->checkauth;
2388 my $queue = $e->retrieve_vandelay_bib_queue($q_id)
2389 or return $e->die_event;
2391 return OpenILS::Event->new('BAD_PARAMS',
2392 note => q/Bucket creator must be queue owner/)
2393 unless $queue->owner == $e->requestor->id;
2395 # find the bib IDs that will go into the bucket
2396 my $bib_ids = $e->json_query({
2397 select => {vqbr => ['imported_as']},
2399 where => {queue => $q_id, imported_as => {'!=' => undef}}
2402 if (!@$bib_ids) { # no records to add
2404 return {add_count => 0};
2407 # allow user to add to an existing bucket by name
2408 my $bucket = $e->search_container_biblio_record_entry_bucket({
2409 owner => $e->requestor->id,
2410 name => $bucket_name,
2411 btype => 'vandelay_queue'
2414 # if the bucket does not exist, create a new one
2416 $bucket = Fieldmapper::container::biblio_record_entry_bucket->new;
2417 $bucket->name($bucket_name);
2418 $bucket->owner($e->requestor->id);
2419 $bucket->btype('vandelay_queue');
2421 $e->create_container_biblio_record_entry_bucket($bucket)
2422 or return $e->die_event;
2425 # create the new bucket items
2426 for my $bib_id ( map {$_->{imported_as}} @$bib_ids ) {
2427 my $item = Fieldmapper::container::biblio_record_entry_bucket_item->new;
2428 $item->target_biblio_record_entry($bib_id);
2429 $item->bucket($bucket->id);
2430 $e->create_container_biblio_record_entry_bucket_item($item)
2431 or return $e->die_event;
2434 # re-fetch the bucket to pick up the correct create_time
2435 $bucket = $e->retrieve_container_biblio_record_entry_bucket($bucket->id)
2436 or return $e->die_event;
2438 # get the total count of items in this bucket
2439 my $count = $e->json_query({
2440 select => {cbrebi => [{
2442 transform => 'count',
2447 where => {bucket => $bucket->id}
2454 add_count => scalar(@$bib_ids), # items added to the bucket
2455 item_count => $count->{count} # total items in buckets