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 if (ref $query->{from}) {
543 $query->{from}{$class}{$mclass} = {type => 'right'};
545 $query->{from} = {$class => {$mclass => {type => 'right'}}};
548 # join to mclass for sorting (see below)
549 if (ref $query->{from}) {
550 $query->{from}{$class}{$mclass} = {type => 'left'};
552 $query->{from} = {$class => {$mclass => {type => 'left'}}};
556 # order by the matched bib records to group like queued records
557 $query->{order_by} = [
558 {class => $mclass, field => 'eg_record', transform => 'min'},
559 {class => $class, field => 'id'}
562 my $record_ids = $e->json_query($query);
564 my $retrieve = ($type eq 'bib') ?
565 'retrieve_vandelay_queued_bib_record' : 'retrieve_vandelay_queued_authority_record';
566 my $search = ($type eq 'bib') ?
567 'search_vandelay_queued_bib_record' : 'search_vandelay_queued_authority_record';
569 if ($self->api_name =~ /export/) {
570 my $rec_list = $e->$search({id => [map { $_->{id} } @$record_ids]}, {substream => 1});
571 if ($self->api_name =~ /print/) {
574 return $U->fire_object_event(
576 'vandelay.queued_'.$type.'_record.print',
581 } elsif ($self->api_name =~ /csv/) {
584 return $U->fire_object_event(
586 'vandelay.queued_'.$type.'_record.csv',
591 } elsif ($self->api_name =~ /email/) {
593 $conn->respond_complete(1);
595 for my $rec (@$rec_list) {
596 $U->create_events_for_hook(
597 'vandelay.queued_'.$type.'_record.email',
599 $e->requestor->home_ou,
608 for my $rec_id (@$record_ids) {
609 my $flesh = ['attributes', 'matches'];
610 push(@$flesh, 'import_items') if $$options{flesh_import_items};
611 my $params = {flesh => 1, flesh_fields => {$class => $flesh}};
612 my $rec = $e->$retrieve([$rec_id->{id}, $params]);
613 $rec->clear_marc if $$options{clear_marc};
614 $conn->respond($rec);
622 __PACKAGE__->register_method(
623 api_name => 'open-ils.vandelay.import_item.queue.retrieve',
624 method => 'retrieve_queue_import_items',
630 Returns Import Item (vii) objects for the selected queue.
632 with_import_error : only return items that failed to import
635 __PACKAGE__->register_method(
636 api_name => 'open-ils.vandelay.import_item.queue.export.print',
637 method => 'retrieve_queue_import_items',
643 Returns template-generated printable output of Import Item (vii) objects for the selected queue.
645 with_import_error : only return items that failed to import
648 __PACKAGE__->register_method(
649 api_name => 'open-ils.vandelay.import_item.queue.export.csv',
650 method => 'retrieve_queue_import_items',
656 Returns template-generated CSV output of Import Item (vii) objects for the selected queue.
658 with_import_error : only return items that failed to import
661 __PACKAGE__->register_method(
662 api_name => 'open-ils.vandelay.import_item.queue.export.email',
663 method => 'retrieve_queue_import_items',
669 Emails template-generated output of Import Item (vii) objects for the selected queue.
671 with_import_error : only return items that failed to import
675 sub retrieve_queue_import_items {
676 my($self, $conn, $auth, $q_id, $options) = @_;
679 my $limit = $$options{limit} || 20;
680 my $offset = $$options{offset} || 0;
682 my $e = new_editor(authtoken => $auth);
683 return $e->event unless $e->checkauth;
685 my $queue = $e->retrieve_vandelay_bib_queue($q_id) or return $e->event;
686 my $evt = check_queue_perms($e, 'bib', $queue);
690 select => {vii => ['id']},
698 filter => {id => $q_id}
704 order_by => {'vii' => ['record','id']},
708 if($self->api_name =~ /export/) {
709 delete $query->{limit};
710 delete $query->{offset};
713 $query->{where} = {'+vii' => {import_error => {'!=' => undef}}}
714 if $$options{with_import_error};
716 my $items = $e->json_query($query);
717 my $item_list = $e->search_vandelay_import_item({id => [map { $_->{id} } @$items]});
718 if ($self->api_name =~ /export/) {
719 if ($self->api_name =~ /print/) {
721 return $U->fire_object_event(
723 'vandelay.import_items.print',
728 } elsif ($self->api_name =~ /csv/) {
730 return $U->fire_object_event(
732 'vandelay.import_items.csv',
737 } elsif ($self->api_name =~ /email/) {
739 $conn->respond_complete(1);
741 for my $item (@$item_list) {
742 $U->create_events_for_hook(
743 'vandelay.import_items.email',
745 $e->requestor->home_ou,
754 for my $item (@$item_list) {
755 $conn->respond($item);
762 sub check_queue_perms {
763 my($e, $type, $queue) = @_;
764 if ($type eq 'bib') {
765 return $e->die_event unless
766 ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
767 $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
769 return $e->die_event unless
770 ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
771 $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
777 __PACKAGE__->register_method(
778 api_name => "open-ils.vandelay.bib_record.list.import",
779 method => 'import_record_list',
786 __PACKAGE__->register_method(
787 api_name => "open-ils.vandelay.auth_record.list.import",
788 method => 'import_record_list',
792 record_type => 'auth'
795 sub import_record_list {
796 my($self, $conn, $auth, $rec_ids, $args) = @_;
797 my $e = new_editor(authtoken => $auth, xact => 1);
798 return $e->die_event unless $e->checkauth;
800 my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $args);
801 try {$e->rollback} otherwise {};
803 return {complete => 1};
807 __PACKAGE__->register_method(
808 api_name => "open-ils.vandelay.bib_queue.import",
809 method => 'import_queue',
813 max_bundle_count => 1,
814 record_type => 'bib',
817 Attempts to import all non-imported records for the selected queue.
818 Will also attempt import of all non-imported items.
823 __PACKAGE__->register_method(
824 api_name => "open-ils.vandelay.auth_queue.import",
825 method => 'import_queue',
829 max_bundle_count => 1,
830 record_type => 'auth'
834 my($self, $conn, $auth, $q_id, $options) = @_;
835 $conn->max_chunk_count($self->{max_bundle_count}) if (!$conn->can('max_bundle_count') && $self->{max_bundle_count});
837 my $e = new_editor(authtoken => $auth, xact => 1);
838 return $e->die_event unless $e->checkauth;
840 my $type = $self->{record_type};
841 my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
843 # First, collect the not-yet-imported records
844 my $query = {queue => $q_id, import_time => undef};
845 my $search = ($type eq 'bib') ?
846 'search_vandelay_queued_bib_record' :
847 'search_vandelay_queued_authority_record';
848 my $rec_ids = $e->$search($query, {idlist => 1});
850 # Now add any imported records that have un-imported items
853 my $item_recs = $e->json_query({
854 select => {vqbr => ['id']},
855 from => {vqbr => 'vii'},
859 import_time => {'!=' => undef}
861 '+vii' => {import_time => undef}
865 push(@$rec_ids, map {$_->{id}} @$item_recs);
868 my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $options);
869 try {$e->rollback} otherwise {}; # only using this to make the read authoritative -- don't die from it
871 return {complete => 1};
874 # returns a list of queued record IDs for a given queue that
875 # have at least one entry in the match table
877 sub queued_records_with_matches {
878 my($e, $type, $q_id, $limit, $offset, $filter) = @_;
880 my $match_class = 'vbm';
881 my $rec_class = 'vqbr';
882 if($type eq 'auth') {
883 $match_class = 'vam';
888 $filter->{queue} = $q_id;
892 select => {$match_class => ['queued_record']},
897 fkey => 'queued_record',
904 if($limit or defined $offset) {
907 $query->{limit} = $limit;
908 $query->{offset} = $offset;
911 my $data = $e->json_query($query);
912 return [ map {$_->{queued_record}} @$data ];
915 # Returns (tracker, err_event)
916 # Runs within its own transaction.
917 sub create_session_tracker {
918 my ($user_id, $ws_id, $key, $name, $type, $queue_id, $action, $total_acts) = @_;
919 my $e = new_editor(xact => 1);
920 $type = 'authority' if $type =~ /auth/;
923 # if other trackers exist for this key, adopt the name
925 $e->search_vandelay_session_tracker({session_key => $key})->[0];
926 $name = $existing->name if $existing;
930 $key = md5_hex(time."$$".rand());
933 my $tracker = Fieldmapper::vandelay::session_tracker->new;
934 $tracker->session_key($key);
935 $tracker->name($name || $key);
936 $tracker->usr($user_id);
937 $tracker->workstation($ws_id);
938 $tracker->record_type($type);
939 $tracker->queue($queue_id);
940 $tracker->action_type($action);
941 $tracker->total_actions($total_acts) if $total_acts;
943 # caller responsible for rolling back transaction
944 return (undef, $e->die_event) unless
945 $e->create_vandelay_session_tracker($tracker);
947 # Re-fetch to ensure we have all defaults applied for future updates.
948 return (undef, $e->die_event) unless
949 $tracker = $e->retrieve_vandelay_session_tracker($tracker->id);
956 # Increment the actions_performed count.
957 # Must happen in its own transaction
958 # Returns undef on success, Event on error
959 sub increment_session_tracker {
961 my $amount = shift || 1;
962 my $e = new_editor(xact => 1);
963 $tracker->update_time('now');
964 $tracker->actions_performed($tracker->actions_performed + $amount);
965 return $e->die_event unless
966 $e->update_vandelay_session_tracker($tracker);
973 # cache of import item org unit settings.
974 # used in apply_import_item_defaults() below,
975 # but reset on each call to import_record_list_impl()
976 my %item_defaults_cache;
978 sub import_record_list_impl {
979 my($self, $conn, $rec_ids, $requestor, $args) = @_;
981 my $overlay_map = $args->{overlay_map} || {};
982 my $type = $self->{record_type};
984 %item_defaults_cache = ();
985 my $exit_early = $args->{exit_early};
991 total => scalar(@$rec_ids),
992 report_all => $$args{report_all},
993 exit_early => $exit_early
996 $conn->max_chunk_count(1) if (!$conn->can('max_bundle_size') && $conn->can('max_chunk_size') && $$args{report_all});
998 my $auto_overlay_exact = $$args{auto_overlay_exact};
999 my $auto_overlay_1match = $$args{auto_overlay_1match};
1000 my $auto_overlay_best = $$args{auto_overlay_best_match};
1001 my $auto_overlay_org_unit_copies = $$args{auto_overlay_org_unit_copies};
1002 my $match_quality_ratio = $$args{match_quality_ratio};
1003 my $merge_profile = $$args{merge_profile};
1004 my $ft_merge_profile = $$args{fall_through_merge_profile};
1005 my $bib_source = $$args{bib_source};
1006 my $import_no_match = $$args{import_no_match};
1007 my $strip_grps = $$args{strip_field_groups}; # bib-only
1009 my $overlay_func = 'vandelay.overlay_bib_record';
1010 my $auto_overlay_func = 'vandelay.auto_overlay_bib_record';
1011 my $auto_overlay_best_func = 'vandelay.auto_overlay_bib_record_with_best';
1012 my $auto_overlay_org_unit_copies_func = 'vandelay.auto_overlay_org_unit_copies';
1013 my $retrieve_func = 'retrieve_vandelay_queued_bib_record';
1014 my $update_func = 'update_vandelay_queued_bib_record';
1015 my $search_func = 'search_vandelay_queued_bib_record';
1016 my $retrieve_queue_func = 'retrieve_vandelay_bib_queue';
1017 my $update_queue_func = 'update_vandelay_bib_queue';
1018 my $delete_queue_func = 'delete_vandelay_bib_queue';
1019 my $rec_class = 'vqbr';
1021 my $editor = new_editor();
1024 my $sources = $editor->search_config_bib_source({id => {'!=' => undef}});
1025 $bib_sources{$_->id} = $_->source for @$sources;
1027 if($type eq 'auth') {
1028 $overlay_func =~ s/bib/authority/o;
1029 $auto_overlay_func =~ s/bib/authority/o;
1030 $auto_overlay_best_func =~ s/bib/authority/o;
1031 $retrieve_func =~ s/bib/authority/o;
1032 $retrieve_queue_func =~ s/bib/authority/o;
1033 $update_queue_func =~ s/bib/authority/o;
1034 $update_func =~ s/bib/authority/o;
1035 $search_func =~ s/bib/authority/o;
1036 $delete_queue_func =~ s/bib/authority/o;
1037 $rec_class = 'vqar';
1043 my $new_rec_perm_cache;
1044 my @success_rec_ids;
1045 for my $rec_id (@$rec_ids) {
1048 my $overlay_target = $overlay_map->{$rec_id};
1050 my $e = new_editor(xact => 1);
1051 $e->requestor($requestor);
1053 $$report_args{e} = $e;
1054 $$report_args{evt} = undef;
1055 $$report_args{import_error} = undef;
1056 $$report_args{no_import} = 0;
1058 my $rec = $e->$retrieve_func([
1061 flesh_fields => { $rec_class => ['matches']},
1066 $$report_args{evt} = $e->event;
1067 finish_rec_import_attempt($report_args);
1072 # Create the import tracker using the queue of the first
1073 # retrieved record. I'm fairly certain in practice all
1074 # lists of records for import come from a single queue.
1075 # We could get the queue from the previously created
1076 # 'enqueue' tracker, but this is a safetly valve to handle
1077 # imports where no enqueue tracker exists, e.g. records
1078 # enqueued pre-upgrade.
1079 ($tracker, $tevt) = create_session_tracker(
1080 $e->requestor->id, $e->requestor->wsid, $args->{session_key},
1081 undef, $type, $rec->queue, 'import', scalar(@$rec_ids));
1088 $report_args->{tracker} = $tracker;
1090 $conn->respond_complete($tracker) if $exit_early;
1093 if($rec->import_time) {
1094 # if the record is already imported, that means it may have
1095 # un-imported copies. Add to success list for later processing.
1096 push(@success_rec_ids, $rec_id);
1101 $$report_args{rec} = $rec;
1102 $queues{$rec->queue} = 1;
1108 if ($type eq 'bib') {
1109 # strip configured / selected MARC tags from inbound records
1111 my $marcdoc = XML::LibXML->new->parse_string($rec->marc);
1112 $rec->marc($U->strip_marc_fields($e, $marcdoc, $strip_grps));
1115 # Set the imported record's 905$u, so
1116 # editor/edit_date are set correctly.
1117 my $marcdoc = XML::LibXML->new->parse_string($rec->marc);
1118 $rec->marc($U->set_marc_905u($marcdoc, $requestor->usrname));
1120 unless ($e->$update_func($rec)) {
1121 $$report_args{evt} = $e->die_event;
1122 finish_rec_import_attempt($report_args);
1126 if(defined $overlay_target) {
1127 # Caller chose an explicit overlay target
1129 my $res = $e->json_query(
1140 if($res and ($res = $res->[0])) {
1142 if($res->{$overlay_func} eq 't') {
1143 $logger->info("vl: $type direct overlay succeeded for queued rec ".
1144 "$rec_id and overlay target $overlay_target");
1146 $rec->imported_as($overlay_target);
1151 $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
1156 if($auto_overlay_1match) { # overlay if there is exactly 1 match
1158 my %match_recs = map { $_->eg_record => 1 } @{$rec->matches};
1160 if( scalar(keys %match_recs) == 1) { # all matches point to the same record
1162 ($imported, $error, $rec) = try_auto_overlay(
1165 $auto_overlay_best_func,
1169 $match_quality_ratio,
1176 if(!$imported and !$error and $auto_overlay_exact and scalar(@{$rec->matches}) == 1 ) {
1178 # caller says to overlay if there is an /exact/ match
1179 # $auto_overlay_func only proceeds and returns true on exact matches
1181 my $res = $e->json_query(
1191 if($res and ($res = $res->[0])) {
1193 if($res->{$auto_overlay_func} eq 't') {
1194 $logger->info("vl: $type auto-overlay succeeded for queued rec $rec_id");
1197 # re-fetch the record to pick up the imported_as value from the DB
1198 $$report_args{rec} = $rec = $e->$retrieve_func([
1199 $rec_id, {flesh => 1, flesh_fields => {$rec_class => ['matches']}}]);
1202 $logger->info("vl: $type auto-overlay failed for queued rec $rec_id");
1207 $logger->error("vl: Error attempting overlay with func=$auto_overlay_func, profile=$merge_profile, record=$rec_id");
1211 if(!$imported and !$error and $auto_overlay_best and scalar(@{$rec->matches}) > 0 ) {
1212 # caller says to overlay the best match
1214 ($imported, $error, $rec) = try_auto_overlay(
1217 $auto_overlay_best_func,
1221 $match_quality_ratio,
1227 if(!$imported and !$error and $auto_overlay_org_unit_copies and scalar(@{$rec->matches}) > 0 ) {
1228 # caller says to overlay depending on the number of copies attached to a record, whose OU
1229 # matches the OU of the import record's Holding's Import Profile.
1231 my $perm = 'IMPORT_USE_ORG_UNIT_COPIES';
1232 my $rec_ou = $e->requestor->ws_ou;
1234 if (!$e->allowed($perm, $rec_ou)) {
1235 return $e->die_event;
1238 ($imported, $error, $rec) = try_auto_overlay(
1241 $auto_overlay_org_unit_copies_func,
1245 $match_quality_ratio,
1251 if(!$imported and !$error and $import_no_match and scalar(@{$rec->matches}) == 0) {
1253 # No overlay / merge occurred. Do a traditional record import by creating a new record
1255 if (!$new_rec_perm_cache) {
1256 $new_rec_perm_cache = {};
1258 # all users creating new records are required to have the basic permission.
1259 # if the client requests, we can enforce extra permissions for creating new records.
1260 # for speed, check the permissions the first time then cache the result.
1262 my $perm = ($type eq 'bib') ? 'IMPORT_MARC' : 'IMPORT_AUTHORITY_MARC';
1263 my $xperm = $$args{new_rec_perm};
1264 my $rec_ou = $e->requestor->ws_ou;
1266 $new_rec_perm_cache->{evt} = $e->die_event
1267 if !$e->allowed($perm, $rec_ou) || ($xperm and !$e->allowed($xperm, $rec_ou));
1270 if ($new_rec_perm_cache->{evt}) {
1272 # a cached event won't roll back the transaction (a la die_event), but
1273 # the transaction will get rolled back in finish_rec_import_attempt() below
1274 $$report_args{evt} = $new_rec_perm_cache->{evt};
1275 $$report_args{import_error} = 'import.record.perm_failure';
1277 } else { # perm checks succeeded
1279 $logger->info("vl: creating new $type record for queued record $rec_id");
1281 if ($type eq 'bib') {
1283 $record = OpenILS::Application::Cat::BibCommon->biblio_record_xml_import(
1284 $e, $rec->marc, $bib_sources{$rec->bib_source}, undef, 1);
1286 } else { # authority record
1288 $record = OpenILS::Application::Cat::AuthCommon->import_authority_record($e, $rec->marc); #$source);
1291 if($U->event_code($record)) {
1292 $$report_args{import_error} = 'import.duplicate.tcn'
1293 if $record->{textcode} eq 'OPEN_TCN_NOT_FOUND';
1294 $$report_args{evt} = $record;
1298 $logger->info("vl: successfully imported new $type record");
1299 $rec->imported_as($record->id);
1308 $rec->import_time('now');
1309 $rec->clear_import_error;
1310 $rec->clear_error_detail;
1312 if($e->$update_func($rec)) {
1314 if($type eq 'bib') {
1316 # see if this record is linked from an acq record.
1317 my $li = $e->search_acq_lineitem(
1318 {queued_record => $rec->id, state => {'!=' => 'canceled'}})->[0];
1321 # if so, update the acq lineitem to point to the imported record
1322 $li->eg_bib_id($rec->imported_as);
1323 $$report_args{evt} = $e->die_event unless $e->update_acq_lineitem($li);
1327 push @success_rec_ids, $rec_id;
1328 finish_rec_import_attempt($report_args);
1336 $logger->info("vl: record $rec_id was not imported");
1337 $$report_args{evt} = $e->event unless $$report_args{evt};
1338 $$report_args{no_import} = 1;
1339 finish_rec_import_attempt($report_args);
1343 # see if we need to mark any queues as complete
1344 for my $q_id (keys %queues) {
1346 my $e = new_editor(xact => 1);
1347 my $remaining = $e->$search_func(
1348 [{queue => $q_id, import_time => undef}, {limit =>1}], {idlist => 1});
1350 unless(@$remaining) {
1351 my $queue = $e->$retrieve_queue_func($q_id);
1352 unless($U->is_true($queue->complete)) {
1353 $queue->complete('t');
1354 $e->$update_queue_func($queue) or return $e->die_event;
1362 import_record_asset_list_impl($conn,
1363 \@success_rec_ids, $requestor, $args, $tracker) if @success_rec_ids;
1365 if ($tracker) { # there are edge cases where it may not exist
1366 my $e = new_editor(xact => 1);
1367 $e->requestor($requestor);
1368 $tracker->update_time('now');
1369 $tracker->state('complete');
1370 $e->update_vandelay_session_tracker($tracker) or return $e->die_event;
1374 $conn->respond({total => $$report_args{total}, progress => $$report_args{progress}});
1379 sub try_auto_overlay {
1382 my $report_args = shift;
1383 my $overlay_func = shift;
1384 my $retrieve_func = shift;
1385 my $rec_class = shift;
1387 my $match_quality_ratio = shift;
1388 my $merge_profile = shift;
1389 my $ft_merge_profile = shift;
1394 # Find the best match and overlay if the quality ratio allows it.
1395 my $res = $e->json_query(
1401 $match_quality_ratio
1406 if($res and ($res = $res->[0])) {
1408 if($res->{$overlay_func} eq 't') {
1410 # first attempt succeeded
1415 # quality-limited merge failed with insufficient quality. If there is a
1416 # fall-through merge profile, re-do the merge with the alternate profile
1417 # and no quality restriction.
1419 if($ft_merge_profile and $match_quality_ratio > 0) {
1421 $logger->info("vl: $type auto-merge failed with profile $merge_profile; ".
1422 "re-merging with fall-through profile $ft_merge_profile");
1424 my $res = $e->json_query(
1430 0 # minimum quality not required
1435 if($res and ($res = $res->[0])) {
1437 if($res->{$overlay_func} eq 't') {
1439 # second attempt succeeded
1444 # failed to merge on second attempt
1445 $logger->info("vl: $type auto-merge with fall-through failed for queued rec $rec_id");
1449 # second attempt died
1451 $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
1456 # failed to merge on first attempt, no fall-through was provided
1457 $$report_args{import_error} = 'overlay.record.quality' if $match_quality_ratio > 0;
1458 $logger->info("vl: $type auto-merge failed for queued rec $rec_id");
1464 # first attempt died
1466 $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
1471 # at least 1 of the attempts succeeded
1472 $logger->info("vl: $type auto-merge succeeded for queued rec $rec_id");
1474 # re-fetch the record to pick up the imported_as value from the DB
1475 $$report_args{rec} = $e->$retrieve_func([
1476 $rec_id, {flesh => 1, flesh_fields => {$rec_class => ['matches']}}]);
1479 return ($imported, $error, $$report_args{rec});
1483 # tracks any import errors, commits the current xact, responds to the client
1484 sub finish_rec_import_attempt {
1486 my $evt = $$args{evt};
1487 my $rec = $$args{rec};
1489 my $tracker = $$args{tracker};
1490 my $exit_early = $$args{exit_early};
1492 my $error = $$args{import_error};
1493 $error = 'general.unknown' if $evt and not $error;
1495 # Note the tracker is updated regardless of whether the individual
1496 # record import succeeded. It's only a failed tracker if the
1497 # entire process fails.
1498 if ($tracker) { # tracker may be undef in rec-not-found situations
1499 my $tevt = increment_session_tracker($tracker);
1500 return $tevt if $tevt;
1506 if($error or $evt) {
1508 # since an error occurred, there's no guarantee the transaction wasn't
1509 # rolled back. force a rollback and create a new editor.
1511 $e = new_editor(xact => 1);
1512 $rec->import_error($error);
1515 my $detail = sprintf("%s : %s", $evt->{textcode}, substr($evt->{desc}, 0, 140));
1516 $rec->error_detail($detail);
1519 my $method = 'update_vandelay_queued_bib_record';
1520 $method =~ s/bib/authority/ if $$args{type} eq 'auth';
1521 $e->$method($rec) and $e->commit or $e->rollback;
1525 # commit the successful import
1530 # requested queued record was not found
1534 # respond to client unless we've already responded-complete
1536 if($$args{report_all} or ($$args{progress} % $$args{step}) == 0) {
1537 $$args{conn}->respond({
1538 total => $$args{total},
1539 progress => $$args{progress},
1540 imported => ($rec) ? $rec->id : undef,
1541 import_error => $error,
1542 no_import => $$args{no_import},
1545 $$args{step} *= 2 unless $$args{step} == 256;
1556 __PACKAGE__->register_method(
1557 api_name => "open-ils.vandelay.bib_queue.owner.retrieve",
1558 method => 'owner_queue_retrieve',
1562 record_type => 'bib'
1564 __PACKAGE__->register_method(
1565 api_name => "open-ils.vandelay.authority_queue.owner.retrieve",
1566 method => 'owner_queue_retrieve',
1570 record_type => 'auth'
1573 sub owner_queue_retrieve {
1574 my($self, $conn, $auth, $owner_id, $filters, $pager) = @_;
1575 my $e = new_editor(authtoken => $auth, xact => 1);
1576 return $e->die_event unless $e->checkauth;
1577 $owner_id = $e->requestor->id; # XXX add support for viewing other's queues?
1580 my $search = {owner => $owner_id};
1581 $search->{$_} = $filters->{$_} for keys %$filters;
1585 $paging{limit} = $pager->{limit} || 1000;
1586 $paging{offset} = $pager->{offset} || 0;
1589 if($self->{record_type} eq 'bib') {
1590 $queues = $e->search_vandelay_bib_queue(
1591 [$search, {%paging, order_by => {vbq => 'evergreen.lowercase(name)'}}]);
1593 $queues = $e->search_vandelay_authority_queue(
1594 [$search, {%paging, order_by => {vaq => 'evergreen.lowercase(name)'}}]);
1596 $conn->respond($_) for @$queues;
1601 __PACKAGE__->register_method(
1602 api_name => "open-ils.vandelay.bib_queue.delete",
1603 method => "delete_queue",
1606 record_type => 'bib'
1608 __PACKAGE__->register_method(
1609 api_name => "open-ils.vandelay.auth_queue.delete",
1610 method => "delete_queue",
1613 record_type => 'auth'
1617 my($self, $conn, $auth, $q_id) = @_;
1618 my $e = new_editor(xact => 1, authtoken => $auth);
1619 return $e->die_event unless $e->checkauth;
1620 if($self->{record_type} eq 'bib') {
1621 return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
1622 my $queue = $e->retrieve_vandelay_bib_queue($q_id)
1623 or return $e->die_event;
1624 $e->delete_vandelay_bib_queue($queue)
1625 or return $e->die_event;
1627 return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
1628 my $queue = $e->retrieve_vandelay_authority_queue($q_id)
1629 or return $e->die_event;
1630 $e->delete_vandelay_authority_queue($queue)
1631 or return $e->die_event;
1638 __PACKAGE__->register_method(
1639 api_name => "open-ils.vandelay.queued_bib_record.html",
1640 method => 'queued_record_html',
1644 record_type => 'bib'
1646 __PACKAGE__->register_method(
1647 api_name => "open-ils.vandelay.queued_authority_record.html",
1648 method => 'queued_record_html',
1652 record_type => 'auth'
1655 sub queued_record_html {
1656 my($self, $conn, $auth, $rec_id) = @_;
1657 my $e = new_editor(xact=>1,authtoken => $auth);
1658 return $e->die_event unless $e->checkauth;
1660 if($self->{record_type} eq 'bib') {
1661 $rec = $e->retrieve_vandelay_queued_bib_record($rec_id)
1662 or return $e->die_event;
1664 $rec = $e->retrieve_vandelay_queued_authority_record($rec_id)
1665 or return $e->die_event;
1669 return $U->simplereq(
1671 'open-ils.search.biblio.record.html', undef, 1, $rec->marc);
1675 __PACKAGE__->register_method(
1676 api_name => "open-ils.vandelay.bib_queue.summary.retrieve",
1677 method => 'retrieve_queue_summary',
1681 record_type => 'bib'
1683 __PACKAGE__->register_method(
1684 api_name => "open-ils.vandelay.auth_queue.summary.retrieve",
1685 method => 'retrieve_queue_summary',
1689 record_type => 'auth'
1692 sub retrieve_queue_summary {
1693 my($self, $conn, $auth, $queue_id) = @_;
1694 my $e = new_editor(xact=>1, authtoken => $auth);
1695 return $e->die_event unless $e->checkauth;
1698 my $type = $self->{record_type};
1699 if($type eq 'bib') {
1700 $queue = $e->retrieve_vandelay_bib_queue($queue_id)
1701 or return $e->die_event;
1703 $queue = $e->retrieve_vandelay_authority_queue($queue_id)
1704 or return $e->die_event;
1707 my $evt = check_queue_perms($e, $type, $queue);
1708 return $evt if $evt;
1710 my $search = 'search_vandelay_queued_bib_record';
1711 $search =~ s/bib/authority/ if $type ne 'bib';
1715 total => scalar(@{$e->$search({queue => $queue_id}, {idlist=>1})}),
1716 imported => scalar(@{$e->$search({queue => $queue_id, import_time => {'!=' => undef}}, {idlist=>1})}),
1719 my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
1720 $summary->{rec_import_errors} = $e->json_query({
1721 select => {$class => [{alias => 'count', column => 'id', transform => 'count', aggregate => 1}]},
1723 where => {queue => $queue_id, import_error => {'!=' => undef}}
1726 if($type eq 'bib') {
1728 # count of all items attached to records in the queue in question
1730 select => {vii => [{alias => 'count', column => 'id', transform => 'count', aggregate => 1}]},
1735 select => {vqbr => ['id']},
1737 where => {queue => $queue_id}
1742 $summary->{total_items} = $e->json_query($query)->[0]->{count};
1744 # count of items we attempted to import, but errored, attached to records in the queue in question
1745 $query->{where}->{import_error} = {'!=' => undef};
1746 $summary->{item_import_errors} = $e->json_query($query)->[0]->{count};
1748 # count of items we successfully imported attached to records in the queue in question
1749 delete $query->{where}->{import_error};
1750 $query->{where}->{import_time} = {'!=' => undef};
1751 $summary->{total_items_imported} = $e->json_query($query)->[0]->{count};
1757 # --------------------------------------------------------------------------------
1758 # Given a list of queued record IDs, imports all items attached to those records
1759 # --------------------------------------------------------------------------------
1760 sub import_record_asset_list_impl {
1761 my($conn, $rec_ids, $requestor, $args, $tracker) = @_;
1763 my $roe = new_editor(xact=> 1, requestor => $requestor);
1765 # for speed, filter out any records have not been
1766 # imported or have no import items to load
1767 $rec_ids = $roe->json_query({
1768 select => {vqbr => ['id']},
1769 from => {vqbr => 'vii'},
1770 where => {'+vqbr' => {
1772 import_time => {'!=' => undef}
1776 $rec_ids = [map {$_->{id}} @$rec_ids];
1780 total => scalar(@$rec_ids),
1781 step => 1, # how often to respond
1786 if ($tracker && @$rec_ids) {
1787 if (my $tevt = # assignment
1788 increment_session_tracker($tracker, scalar(@$rec_ids))) {
1794 for my $rec_id (@$rec_ids) {
1795 my $rec = $roe->retrieve_vandelay_queued_bib_record($rec_id);
1796 my $item_ids = $roe->search_vandelay_import_item(
1797 {record => $rec->id, import_error => undef},
1801 if ($tracker) { # increment per record
1802 if (my $tevt = increment_session_tracker($tracker)) {
1808 # if any items have no call_number label and a value should be
1809 # applied automatically (via org settings), we want to use the same
1810 # call number label for every copy per org per record.
1811 my $auto_callnumber = {};
1813 my $opp_acq_copy_overlay = $args->{opp_acq_copy_overlay};
1814 my $opp_oo_cat_copy_overlay = $args->{opp_oo_cat_copy_overlay};
1815 my @overlaid_copy_ids;
1816 for my $item_id (@$item_ids) {
1817 my $e = new_editor(requestor => $requestor, xact => 1);
1818 my $item = $e->retrieve_vandelay_import_item($item_id);
1819 my ($copy, $vol, $evt);
1821 $$report_args{e} = $e;
1822 $$report_args{evt} = undef;
1823 $$report_args{import_item} = $item;
1824 $$report_args{import_error} = undef;
1826 if (my $copy_id = $item->internal_id) { # assignment
1827 # copy matches an existing copy. Overlay instead of create.
1829 $logger->info("vl: performing copy overlay for internal_id=$copy_id");
1831 my $qt = $e->json_query({
1832 select => {vbq => ['queue_type']},
1833 from => {vqbr => 'vbq'},
1834 where => {'+vqbr' => {id => $rec_id}}
1835 })->[0]->{queue_type};
1838 # internal_id for ACQ queues refers to acq.lineitem_detail.id
1839 # pull the real copy id from the acq LID
1841 my $lid = $e->retrieve_acq_lineitem_detail($copy_id);
1843 $$report_args{evt} = $e->die_event;
1844 respond_with_status($report_args);
1847 $copy_id = $lid->eg_copy_id;
1848 $logger->info("vl: performing ACQ copy overlay for copy $copy_id");
1851 $copy = $e->search_asset_copy([
1852 {id => $copy_id, deleted => 'f'},
1853 {flesh => 1, flesh_fields => {acp => ['call_number']}}
1857 $$report_args{evt} = $e->die_event;
1858 respond_with_status($report_args);
1862 # prevent update of unrelated copies
1863 if ($copy->call_number->record != $rec->imported_as) {
1864 $logger->info("vl: attempt to overlay unrelated copy=$copy_id; rec=".$rec->imported_as);
1866 $evt = OpenILS::Event->new('INVALID_IMPORT_COPY_ID',
1867 note => 'Cannot overlay copies for unlinked bib',
1868 bre => $rec->imported_as,
1871 $$report_args{evt} = $evt;
1872 respond_with_status($report_args);
1875 } elsif ($opp_acq_copy_overlay) { # we are going to "opportunistically" overlay received, in-process acq copies
1876 # recv_time should never be null if the copy status is
1877 # "In Process", so that is just a double-check
1880 "recv_time" => {"!=" => undef},
1881 "owning_lib" => $item->owning_lib,
1882 "+acn" => {"record" => $rec->imported_as},
1883 "+acp" => {"status" => OILS_COPY_STATUS_IN_PROCESS}
1893 "acqlid" => ["eg_copy_id"],
1894 "acp" => ["call_number"]
1898 # don't overlay the same copy twice
1899 $query->[0]{"+acp"}{"id"} = {"not in" => \@overlaid_copy_ids} if @overlaid_copy_ids;
1900 if (my $acqlid = $e->search_acq_lineitem_detail($query)->[0]) {
1901 $copy = $acqlid->eg_copy_id;
1902 push(@overlaid_copy_ids, $copy->id);
1904 } elsif ($opp_oo_cat_copy_overlay) { # we are going to "opportunistically" overlay received, On-order catalogue copies
1906 my $perm = 'IMPORT_ON_ORDER_CAT_COPY';
1907 my $rec_ou = $e->requestor->ws_ou;
1909 if (!$e->allowed($perm, $rec_ou)) {
1910 return $e->die_event;
1914 if ($item->copy_number) {
1917 "status" => OILS_COPY_STATUS_ON_ORDER,
1918 "copy_number" => $item->copy_number,
1919 "+acn" => [{"owning_lib" => $item->owning_lib},
1920 {"record" => $rec->imported_as}]
1926 "acp" => ["call_number"]
1931 #see if we have copies in vandelay.import_item that
1932 #belong to the current record, but do not have $item->copy_number defined
1933 #in their on-order records. Retrieve them by create date from oldest to
1934 #newest ORDER BY acp.create_date ASC
1937 "status" => OILS_COPY_STATUS_ON_ORDER,
1938 "+acn" => [{"record" => $rec->imported_as},
1939 {"owning_lib" => $item->owning_lib}]
1945 "acp" => ["call_number"]
1947 "order_by" => { "acp" => "create_date" }
1951 # don't overlay the same copy twice
1952 $query->[0]{"+acp"}{"id"} = {"not in" => \@overlaid_copy_ids} if @overlaid_copy_ids;
1953 if ($copy = $e->search_asset_copy($query)->[0]) {
1954 push(@overlaid_copy_ids, $copy->id);
1958 if ($copy) { # we found a copy to overlay
1960 # overlaying copies requires an extra permission
1961 if (!$e->allowed("IMPORT_OVERLAY_COPY", $copy->call_number->owning_lib)) {
1962 $$report_args{evt} = $e->die_event;
1963 respond_with_status($report_args);
1967 # are we updating the call-number?
1968 if ($item->call_number and $item->call_number ne $copy->call_number->label) {
1970 my $count = $e->json_query({
1971 select => {acp => [{
1974 transform => 'count',
1980 call_number => $copy->call_number->id
1986 my $evol = $e->search_asset_call_number({
1987 id => {'<>' => $copy->call_number->id},
1988 label => $item->call_number,
1989 owning_lib => $copy->call_number->owning_lib,
1990 record => $copy->call_number->record,
1991 prefix => $copy->call_number->prefix,
1992 suffix => $copy->call_number->suffix,
1997 # call number for overlayed copy changed to a
1998 # label already in use by another call number.
1999 # merge the old CN into the new CN
2002 "vl: moving copy to new call number ".
2003 $item->call_number);
2006 OpenILS::Application::Cat::Merge::merge_volumes(
2007 $e, [$copy->call_number], $evol);
2010 $$report_args{evt} = $err;
2011 respond_with_status($report_args);
2015 # update our copy *cough* of the copy to pick up
2016 # any changes made my merge_volumes
2017 $copy = $e->retrieve_asset_copy([
2019 {flesh => 1, flesh_fields => {acp => ['call_number']}}
2024 "vl: updating copy call number label".
2025 $item->call_number);
2027 $copy->call_number->label($item->call_number);
2028 if (!$e->update_asset_call_number($copy->call_number)) {
2029 $$report_args{evt} = $e->die_event;
2030 respond_with_status($report_args);
2037 # otherwise, move the copy to a new/existing
2038 # call-number with the given label/owner
2039 # note that overlay does not allow the owning_lib
2040 # to be changed. Should it?
2042 $logger->info("vl: moving copy to new callnumber in copy overlay");
2045 OpenILS::Application::Cat::AssetCommon->find_or_create_volume(
2046 $e, $item->call_number,
2047 $copy->call_number->record,
2048 $copy->call_number->owning_lib
2052 $$report_args{evt} = $evt;
2053 respond_with_status($report_args);
2057 $copy->call_number($vol);
2061 # for every field that has a non-'' value, overlay the copy value
2062 foreach (qw/ barcode location circ_lib status
2063 circulate deposit deposit_amount ref holdable
2064 price circ_as_type alert_message opac_visible circ_modifier/) {
2066 my $val = $item->$_();
2067 $copy->$_($val) if defined $val and $val ne '';
2070 # de-flesh for update
2071 $copy->call_number($copy->call_number->id);
2072 $copy->ischanged(1);
2074 $evt = OpenILS::Application::Cat::AssetCommon->
2075 update_fleshed_copies($e, {all => 1}, undef, [$copy]);
2078 $$report_args{evt} = $evt;
2079 respond_with_status($report_args);
2085 # Creating a new copy
2086 $logger->info("vl: creating new copy in import");
2088 # appply defaults values from org settings as needed
2089 # if $auto_callnumber is unset, it will be set within
2090 apply_import_item_defaults($e, $item, $auto_callnumber);
2092 # --------------------------------------------------------------------------------
2093 # Find or create the volume
2094 # --------------------------------------------------------------------------------
2096 OpenILS::Application::Cat::AssetCommon->find_or_create_volume(
2097 $e, $item->call_number, $rec->imported_as, $item->owning_lib);
2100 $$report_args{evt} = $evt;
2101 respond_with_status($report_args);
2105 # --------------------------------------------------------------------------------
2106 # Create the new copy
2107 # --------------------------------------------------------------------------------
2108 $copy = Fieldmapper::asset::copy->new;
2109 $copy->loan_duration(2);
2110 $copy->fine_level(2);
2111 $copy->barcode($item->barcode);
2112 $copy->location($item->location);
2113 $copy->circ_lib($item->circ_lib || $item->owning_lib);
2114 $copy->status( defined($item->status) ? $item->status : OILS_COPY_STATUS_IN_PROCESS );
2115 $copy->circulate($item->circulate);
2116 $copy->deposit($item->deposit);
2117 $copy->deposit_amount($item->deposit_amount);
2118 $copy->ref($item->ref);
2119 $copy->holdable($item->holdable);
2120 $copy->price($item->price);
2121 $copy->circ_as_type($item->circ_as_type);
2122 $copy->alert_message($item->alert_message);
2123 $copy->opac_visible($item->opac_visible);
2124 $copy->circ_modifier($item->circ_modifier);
2126 # --------------------------------------------------------------------------------
2127 # Check for dupe barcode
2128 # --------------------------------------------------------------------------------
2129 if($evt = OpenILS::Application::Cat::AssetCommon->create_copy($e, $vol, $copy)) {
2130 $$report_args{evt} = $evt;
2131 $$report_args{import_error} = 'import.item.duplicate.barcode'
2132 if $evt->{textcode} eq 'ITEM_BARCODE_EXISTS';
2133 respond_with_status($report_args);
2137 # --------------------------------------------------------------------------------
2139 # --------------------------------------------------------------------------------
2140 $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
2141 $e, $copy, '', $item->pub_note, 1) if $item->pub_note;
2144 $$report_args{evt} = $evt;
2145 respond_with_status($report_args);
2149 $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
2150 $e, $copy, '', $item->priv_note) if $item->priv_note;
2153 $$report_args{evt} = $evt;
2154 respond_with_status($report_args);
2159 if ($item->stat_cat_data) {
2160 $logger->info("vl: parsing stat cat data: " . $item->stat_cat_data);
2161 my @stat_cat_pairs = split('\|\|', $item->stat_cat_data);
2162 my $stat_cat_entries = [];
2164 foreach my $stat_cat_pair (@stat_cat_pairs) {
2165 my ($stat_cat, $stat_cat_entry);
2166 my @pair_pieces = split('\|', $stat_cat_pair);
2167 if (@pair_pieces == 2) {
2168 $stat_cat = $e->search_asset_stat_cat({name=>$pair_pieces[0]})->[0];
2170 $stat_cat_entry = $e->search_asset_stat_cat_entry({'value' => $pair_pieces[1], 'stat_cat' => $stat_cat->id})->[0];
2171 push (@$stat_cat_entries, $stat_cat_entry) if $stat_cat_entry;
2174 $$report_args{import_error} = "import.item.invalid.stat_cat_format";
2178 if (!$stat_cat or !$stat_cat_entry) {
2179 $$report_args{import_error} = "import.item.invalid.stat_cat_data";
2183 if ($$report_args{import_error}) {
2184 $logger->error("vl: invalid stat cat data: " . $item->stat_cat_data);
2185 respond_with_status($report_args);
2188 $copy->stat_cat_entries( $stat_cat_entries );
2189 $copy->ischanged(1);
2190 $evt = OpenILS::Application::Cat::AssetCommon->update_copy_stat_entries($e, $copy, 0, 1); #delete_stats=0, add_or_update_only=1
2192 $$report_args{evt} = $evt;
2193 respond_with_status($report_args);
2198 if ($item->parts_data) {
2199 $logger->info("vl: parsing parts data: " . $item->parts_data);
2200 my @parts = split('\|', $item->parts_data);
2202 foreach my $part_label (@parts) {
2203 my $part_obj = $e->search_biblio_monograph_part(
2206 record=>$rec->imported_as
2211 $part_obj = Fieldmapper::biblio::monograph_part->new();
2212 $part_obj->label( $part_label );
2213 $part_obj->record( $rec->imported_as );
2214 unless($e->create_biblio_monograph_part($part_obj)) {
2215 $$report_args{evt} = $e->die_event;
2219 push @$part_objs, $part_obj;
2222 if ($$report_args{evt}) {
2223 respond_with_status($report_args);
2226 $copy->parts( $part_objs );
2227 $copy->ischanged(1);
2228 $evt = OpenILS::Application::Cat::AssetCommon->update_copy_parts($e, $copy, 0); #delete_parts=0
2230 $$report_args{evt} = $evt;
2231 respond_with_status($report_args);
2237 # set the import data on the import item
2238 $item->imported_as($copy->id); # $copy->id is set by create_copy() ^--
2239 $item->import_time('now');
2241 unless($e->update_vandelay_import_item($item)) {
2242 $$report_args{evt} = $e->die_event;
2243 respond_with_status($report_args);
2247 # --------------------------------------------------------------------------------
2248 # Item import succeeded
2249 # --------------------------------------------------------------------------------
2251 $$report_args{in_count}++;
2252 respond_with_status($report_args);
2253 $logger->info("vl: successfully imported item " . $item->barcode);
2261 sub apply_import_item_defaults {
2262 my ($e, $item, $auto_cn) = @_;
2263 my $org = $item->owning_lib || $item->circ_lib;
2264 my %c = %item_defaults_cache;
2266 # fetch and cache the org unit setting value (unless
2267 # it's already cached) and return the value to the caller
2270 return $c{$org}{$name} if defined $c{$org}{$name};
2271 my $sname = "vandelay.item.$name";
2272 $c{$org}{$name} = $U->ou_ancestor_setting_value($org, $sname, $e);
2273 $c{$org}{$name} = '' unless defined $c{$org}{$name};
2274 return $c{$org}{$name};
2277 if (!$item->barcode) {
2279 if ($set->('barcode.auto')) {
2281 my $pfx = $set->('barcode.prefix') || 'VAN';
2282 my $barcode = $pfx . $item->record . $item->id;
2284 $logger->info("vl: using auto barcode $barcode for ".$item->id);
2285 $item->barcode($barcode);
2288 $logger->error("vl: no barcode (or defualt) for item ".$item->id);
2292 if (!$item->call_number) {
2294 if ($set->('call_number.auto')) {
2296 if (!$auto_cn->{$org}) {
2297 my $pfx = $set->('call_number.prefix') || 'VAN';
2299 # use the ID of the first item to differentiate this
2300 # call number from others linked to the same record
2301 $auto_cn->{$org} = $pfx . $item->record . $item->id;
2304 $logger->info("vl: using auto call number ".$auto_cn->{$org});
2305 $item->call_number($auto_cn->{$org});
2308 $logger->error("vl: no call number or default for item ".$item->id);
2314 sub respond_with_status {
2318 # If the import failed, track the failure reason
2320 my $error = $$args{import_error};
2321 my $evt = $$args{evt};
2323 if($error or $evt) {
2325 my $item = $$args{import_item};
2326 $logger->info("vl: unable to import item " . $item->barcode);
2328 $error ||= 'general.unknown';
2329 $item->import_error($error);
2332 my $detail = sprintf("%s : %s", $evt->{textcode}, substr($evt->{desc}, 0, 140));
2333 $item->error_detail($detail);
2336 # state of the editor is unknown at this point. Force a rollback and start over.
2338 $e = new_editor(xact => 1);
2339 $e->update_vandelay_import_item($item);
2343 if($$args{report_all} or ($$args{progress} % $$args{step}) == 0) {
2344 $$args{conn}->respond({
2345 total => $$args{total},
2346 progress => $$args{progress},
2347 success_count => $$args{success_count},
2350 $$args{step} *= 2 unless $$args{step} == 256;
2356 __PACKAGE__->register_method(
2357 api_name => "open-ils.vandelay.match_set.get_tree",
2358 method => "match_set_get_tree",
2362 desc => q/For a given vms object, return a tree of match set points
2363 represented by a vmsp object with recursively fleshed
2368 sub match_set_get_tree {
2369 my ($self, $conn, $authtoken, $match_set_id) = @_;
2371 $match_set_id = int($match_set_id) or return;
2373 my $e = new_editor("authtoken" => $authtoken);
2374 $e->checkauth or return $e->die_event;
2376 my $set = $e->retrieve_vandelay_match_set($match_set_id) or
2377 return $e->die_event;
2379 $e->allowed("ADMIN_IMPORT_MATCH_SET", $set->owner) or
2380 return $e->die_event;
2382 my $tree = $e->search_vandelay_match_set_point([
2383 {"match_set" => $match_set_id, "parent" => undef},
2384 {"flesh" => -1, "flesh_fields" => {"vmsp" => ["children"]}}
2385 ]) or return $e->die_event;
2391 __PACKAGE__->register_method(
2392 api_name => "open-ils.vandelay.match_set.update",
2393 method => "match_set_update_tree",
2397 desc => q/Replace any vmsp objects associated with a given (by ID) vms
2398 with the given objects (recursively fleshed vmsp tree)./
2402 sub _walk_new_vmsp {
2403 my ($e, $match_set_id, $node, $parent_id) = @_;
2405 my $point = new Fieldmapper::vandelay::match_set_point;
2406 $point->parent($parent_id);
2407 $point->match_set($match_set_id);
2408 $point->$_($node->$_)
2409 for (qw/bool_op svf tag subfield negate quality heading/);
2411 $e->create_vandelay_match_set_point($point) or return $e->die_event;
2413 $parent_id = $e->data->id;
2414 if ($node->children && @{$node->children}) {
2415 for (@{$node->children}) {
2416 return $e->die_event if
2417 _walk_new_vmsp($e, $match_set_id, $_, $parent_id);
2424 sub match_set_update_tree {
2425 my ($self, $conn, $authtoken, $match_set_id, $tree) = @_;
2427 my $e = new_editor("xact" => 1, "authtoken" => $authtoken);
2428 $e->checkauth or return $e->die_event;
2430 my $set = $e->retrieve_vandelay_match_set($match_set_id) or
2431 return $e->die_event;
2433 $e->allowed("ADMIN_IMPORT_MATCH_SET", $set->owner) or
2434 return $e->die_event;
2436 my $existing = $e->search_vandelay_match_set_point([
2437 {"match_set" => $match_set_id},
2438 {"order_by" => {"vmsp" => "id DESC"}}
2439 ]) or return $e->die_event;
2441 # delete points, working up from leaf points to the root
2443 for my $point (shift @$existing) {
2444 if( grep {$_->parent eq $point->id} @$existing) {
2445 push(@$existing, $point);
2447 $e->delete_vandelay_match_set_point($point) or return $e->die_event;
2452 _walk_new_vmsp($e, $match_set_id, $tree);
2454 $e->commit or return $e->die_event;
2457 __PACKAGE__->register_method(
2458 api_name => 'open-ils.vandelay.bib_queue.to_bucket',
2459 method => 'bib_queue_to_bucket',
2463 desc => q/Add to or create a new bib container (bucket) with the successfully
2464 imported contents of a vandelay queue. Any user that has Vandelay
2465 queue create permissions can append or create buckets from his-her own queues./,
2467 {desc => 'Authtoken', type => 'string'},
2468 {desc => 'Queue ID', type => 'number'},
2469 {desc => 'Bucket Name', type => 'string'}
2471 return => {desc => q/
2472 {bucket => $bucket, addcount => number-of-items-added-to-bucket, item_count => total-bucket-item-count} on success,
2473 {add_count => 0} if there is nothing to do, and Event on error/}
2477 sub bib_queue_to_bucket {
2478 my ($self, $conn, $auth, $q_id, $bucket_name) = @_;
2480 my $e = new_editor(xact => 1, authtoken => $auth);
2481 return $e->die_event unless $e->checkauth;
2483 my $queue = $e->retrieve_vandelay_bib_queue($q_id)
2484 or return $e->die_event;
2486 return OpenILS::Event->new('BAD_PARAMS',
2487 note => q/Bucket creator must be queue owner/)
2488 unless $queue->owner == $e->requestor->id;
2490 # find the bib IDs that will go into the bucket
2491 my $bib_ids = $e->json_query({
2492 select => {vqbr => ['imported_as']},
2494 where => {queue => $q_id, imported_as => {'!=' => undef}}
2497 if (!@$bib_ids) { # no records to add
2499 return {add_count => 0};
2502 # allow user to add to an existing bucket by name
2503 my $bucket = $e->search_container_biblio_record_entry_bucket({
2504 owner => $e->requestor->id,
2505 name => $bucket_name,
2506 btype => 'vandelay_queue'
2509 # if the bucket does not exist, create a new one
2511 $bucket = Fieldmapper::container::biblio_record_entry_bucket->new;
2512 $bucket->name($bucket_name);
2513 $bucket->owner($e->requestor->id);
2514 $bucket->btype('vandelay_queue');
2516 $e->create_container_biblio_record_entry_bucket($bucket)
2517 or return $e->die_event;
2520 # create the new bucket items
2521 for my $bib_id ( map {$_->{imported_as}} @$bib_ids ) {
2522 my $item = Fieldmapper::container::biblio_record_entry_bucket_item->new;
2523 $item->target_biblio_record_entry($bib_id);
2524 $item->bucket($bucket->id);
2525 $e->create_container_biblio_record_entry_bucket_item($item)
2526 or return $e->die_event;
2529 # re-fetch the bucket to pick up the correct create_time
2530 $bucket = $e->retrieve_container_biblio_record_entry_bucket($bucket->id)
2531 or return $e->die_event;
2533 # get the total count of items in this bucket
2534 my $count = $e->json_query({
2535 select => {cbrebi => [{
2537 transform => 'count',
2542 where => {bucket => $bucket->id}
2549 add_count => scalar(@$bib_ids), # items added to the bucket
2550 item_count => $count->{count} # total items in buckets