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/;
14 use MARC::File::XML ( BinaryEncoding => 'UTF-8' );
15 use OpenILS::Utils::Fieldmapper;
16 use Time::HiRes qw(time);
17 use OpenSRF::Utils::Logger qw/$logger/;
19 use OpenILS::Const qw/:const/;
20 use OpenILS::Application::AppUtils;
21 use OpenILS::Application::Cat::BibCommon;
22 use OpenILS::Application::Cat::AuthCommon;
23 use OpenILS::Application::Cat::AssetCommon;
24 my $U = 'OpenILS::Application::AppUtils';
26 # A list of LDR/06 values from http://loc.gov/marc
53 # --------------------------------------------------------------------------------
56 sub create_bib_queue {
63 my $match_set = shift;
64 my $import_def = shift;
66 my $e = new_editor(authtoken => $auth, xact => 1);
68 return $e->die_event unless $e->checkauth;
69 return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
70 $owner ||= $e->requestor->id;
72 if ($e->search_vandelay_bib_queue( {name => $name, owner => $owner, queue_type => $type})->[0]) {
74 return OpenILS::Event->new('BIB_QUEUE_EXISTS')
77 my $queue = new Fieldmapper::vandelay::bib_queue();
78 $queue->name( $name );
79 $queue->owner( $owner );
80 $queue->queue_type( $type ) if ($type);
81 $queue->item_attr_def( $import_def ) if ($import_def);
82 $queue->match_set($match_set) if $match_set;
84 my $new_q = $e->create_vandelay_bib_queue( $queue );
85 return $e->die_event unless ($new_q);
90 __PACKAGE__->register_method(
91 api_name => "open-ils.vandelay.bib_queue.create",
92 method => "create_bib_queue",
98 sub create_auth_queue {
105 my $match_set = shift;
107 my $e = new_editor(authtoken => $auth, xact => 1);
109 return $e->die_event unless $e->checkauth;
110 return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
111 $owner ||= $e->requestor->id;
113 if ($e->search_vandelay_bib_queue({name => $name, owner => $owner, queue_type => $type})->[0]) {
115 return OpenILS::Event->new('AUTH_QUEUE_EXISTS')
118 my $queue = new Fieldmapper::vandelay::authority_queue();
119 $queue->name( $name );
120 $queue->owner( $owner );
121 $queue->queue_type( $type ) if ($type);
123 my $new_q = $e->create_vandelay_authority_queue( $queue );
124 $e->die_event unless ($new_q);
129 __PACKAGE__->register_method(
130 api_name => "open-ils.vandelay.authority_queue.create",
131 method => "create_auth_queue",
136 sub add_record_to_bib_queue {
143 my $bib_source = shift;
145 my $e = new_editor(authtoken => $auth, xact => 1);
147 $queue = $e->retrieve_vandelay_bib_queue($queue);
149 return $e->die_event unless $e->checkauth;
150 return $e->die_event unless
151 ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
152 $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
154 my $new_rec = _add_bib_rec($e, $marc, $queue->id, $purpose, $bib_source);
156 return $e->die_event unless ($new_rec);
160 __PACKAGE__->register_method(
161 api_name => "open-ils.vandelay.queued_bib_record.create",
162 method => "add_record_to_bib_queue",
172 my $bib_source = shift;
174 my $rec = new Fieldmapper::vandelay::queued_bib_record();
176 $rec->queue( $queue );
177 $rec->purpose( $purpose ) if ($purpose);
178 $rec->bib_source($bib_source);
180 return $e->create_vandelay_queued_bib_record( $rec );
183 sub add_record_to_authority_queue {
191 my $e = new_editor(authtoken => $auth, xact => 1);
193 $queue = $e->retrieve_vandelay_authority_queue($queue);
195 return $e->die_event unless $e->checkauth;
196 return $e->die_event unless
197 ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
198 $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
200 my $new_rec = _add_auth_rec($e, $marc, $queue->id, $purpose);
202 return $e->die_event unless ($new_rec);
206 __PACKAGE__->register_method(
207 api_name => "open-ils.vandelay.queued_authority_record.create",
208 method => "add_record_to_authority_queue",
219 my $rec = new Fieldmapper::vandelay::queued_authority_record();
221 $rec->queue( $queue );
222 $rec->purpose( $purpose ) if ($purpose);
224 return $e->create_vandelay_queued_authority_record( $rec );
231 my $fingerprint = shift || '';
232 my $queue_id = shift;
234 my $filename = shift;
235 my $bib_source = shift;
237 my $e = new_editor(authtoken => $auth, xact => 1);
238 return $e->die_event unless $e->checkauth;
241 my $type = $self->{record_type};
244 $queue = $e->retrieve_vandelay_bib_queue($queue_id) or return $e->die_event;
246 $queue = $e->retrieve_vandelay_authority_queue($queue_id) or return $e->die_event;
249 my $evt = check_queue_perms($e, $type, $queue);
250 return $evt if ($evt);
252 my $cache = new OpenSRF::Utils::Cache();
255 my $data = $cache->get_cache('vandelay_import_spool_' . $fingerprint);
256 $purpose = $data->{purpose};
257 $filename = $data->{path};
258 $bib_source = $data->{bib_source};
261 unless(-r $filename) {
262 $logger->error("unable to read MARC file $filename");
263 return -1; # make this an event XXX
266 $logger->info("vandelay spooling $fingerprint purpose=$purpose file=$filename");
268 my $marctype = 'USMARC';
271 $marctype = 'XML' if (getc(F) =~ /^\D/o);
274 my $batch = new MARC::Batch ($marctype, $filename);
277 my $response_scale = 10;
280 while (try { $r = $batch->next } otherwise { $r = -1 }) {
282 $logger->warn("Processing of record $count in set $filename failed. Skipping this record");
286 $logger->info("processing record $count");
289 (my $xml = $r->as_xml_record()) =~ s/\n//sog;
290 $xml =~ s/^<\?xml.+\?\s*>//go;
291 $xml =~ s/>\s+</></go;
292 $xml =~ s/\p{Cc}//go;
293 $xml = $U->entityize($xml);
294 $xml =~ s/[\x00-\x1f]//go;
297 # Check the leader to ensure we've got something resembling the expected
298 # Allow spaces to give records the benefit of the doubt
299 my $ldr_type = substr($r->leader(), 6, 1);
300 if ($type eq 'bib' && ($record_types{$ldr_type}) eq 'bib' || $ldr_type eq ' ') {
301 $qrec = _add_bib_rec( $e, $xml, $queue_id, $purpose, $bib_source ) or return $e->die_event;
302 } elsif ($type eq 'auth' && ($record_types{$ldr_type}) eq 'auth' || $ldr_type eq ' ') {
303 $qrec = _add_auth_rec( $e, $xml, $queue_id, $purpose ) or return $e->die_event;
305 # I don't know how to handle this type; rock on
306 $logger->error("In process_spool(), type was $type and leader type was $ldr_type ; not currently supported");
310 if($self->api_name =~ /stream_results/ and $qrec) {
311 $client->respond($qrec->id)
313 $client->respond($count) if (++$count % $response_scale) == 0;
314 $response_scale *= 10 if ($count == ($response_scale * 10));
318 $logger->warn("Encountered a bad record at Vandelay ingest: ".$error);
324 $cache->delete_cache('vandelay_import_spool_' . $fingerprint) if $fingerprint;
328 __PACKAGE__->register_method(
329 api_name => "open-ils.vandelay.bib.process_spool",
330 method => "process_spool",
336 __PACKAGE__->register_method(
337 api_name => "open-ils.vandelay.auth.process_spool",
338 method => "process_spool",
342 record_type => 'auth'
345 __PACKAGE__->register_method(
346 api_name => "open-ils.vandelay.bib.process_spool.stream_results",
347 method => "process_spool",
354 __PACKAGE__->register_method(
355 api_name => "open-ils.vandelay.auth.process_spool.stream_results",
356 method => "process_spool",
361 record_type => 'auth'
364 __PACKAGE__->register_method(
365 api_name => "open-ils.vandelay.bib_queue.records.retrieve",
366 method => 'retrieve_queued_records',
372 __PACKAGE__->register_method(
373 api_name => "open-ils.vandelay.auth_queue.records.retrieve",
374 method => 'retrieve_queued_records',
378 record_type => 'auth'
381 __PACKAGE__->register_method(
382 api_name => "open-ils.vandelay.bib_queue.records.matches.retrieve",
383 method => 'retrieve_queued_records',
387 record_type => 'bib',
389 desc => q/Only retrieve queued bib records that have matches against existing records/
392 __PACKAGE__->register_method(
393 api_name => "open-ils.vandelay.auth_queue.records.matches.retrieve",
394 method => 'retrieve_queued_records',
398 record_type => 'auth',
400 desc => q/Only retrieve queued authority records that have matches against existing records/
404 sub retrieve_queued_records {
405 my($self, $conn, $auth, $queue_id, $options) = @_;
408 my $limit = $$options{limit} || 20;
409 my $offset = $$options{offset} || 0;
410 my $type = $self->{record_type};
412 my $e = new_editor(authtoken => $auth, xact => 1);
413 return $e->die_event unless $e->checkauth;
417 $queue = $e->retrieve_vandelay_bib_queue($queue_id) or return $e->die_event;
419 $queue = $e->retrieve_vandelay_authority_queue($queue_id) or return $e->die_event;
421 my $evt = check_queue_perms($e, $type, $queue);
422 return $evt if ($evt);
424 my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
426 select => {$class => ['id']},
428 where => {queue => $queue_id},
430 order_by => {$class => ['id']},
435 $query->{where}->{import_time} = undef if $$options{non_imported};
437 if($$options{with_import_error}) {
439 $query->{from} = {$class => {vii => {type => 'right'}}};
440 $query->{where}->{'-or'} = [
441 {'+vqbr' => {import_error => {'!=' => undef}}},
442 {'+vii' => {import_error => {'!=' => undef}}}
447 if($$options{with_rec_import_error}) {
448 $query->{where}->{import_error} = {'!=' => undef};
450 } elsif( $$options{with_item_import_error} and $type eq 'bib') {
452 $query->{from} = {$class => 'vii'};
453 $query->{where}->{'+vii'} = {import_error => {'!=' => undef}};
457 if($self->api_name =~ /matches/) {
458 # find only records that have matches
459 my $mclass = $type eq 'bib' ? 'vbm' : 'vam';
460 $query->{from} = {$class => {$mclass => {type => 'right'}}};
463 my $record_ids = $e->json_query($query);
465 my $retrieve = ($type eq 'bib') ?
466 'retrieve_vandelay_queued_bib_record' : 'retrieve_vandelay_queued_authority_record';
468 for my $rec_id (@$record_ids) {
469 my $flesh = ['attributes', 'matches'];
470 push(@$flesh, 'import_items') if $$options{flesh_import_items};
471 my $params = {flesh => 1, flesh_fields => {$class => $flesh}};
472 my $rec = $e->$retrieve([$rec_id->{id}, $params]);
473 $rec->clear_marc if $$options{clear_marc};
474 $conn->respond($rec);
481 __PACKAGE__->register_method(
482 api_name => 'open-ils.vandelay.import_item.queue.retrieve',
483 method => 'retrieve_queue_import_items',
489 Returns Import Item (vii) objects for the selected queue.
491 with_import_error : only return items that failed to import
495 sub retrieve_queue_import_items {
496 my($self, $conn, $auth, $q_id, $options) = @_;
499 my $limit = $$options{limit} || 20;
500 my $offset = $$options{offset} || 0;
502 my $e = new_editor(authtoken => $auth);
503 return $e->event unless $e->checkauth;
505 my $queue = $e->retrieve_vandelay_bib_queue($q_id) or return $e->event;
506 my $evt = check_queue_perms($e, 'bib', $queue);
510 select => {vii => ['id']},
518 filter => {id => $q_id}
524 order_by => {'vii' => ['record','id']},
529 $query->{where} = {'+vii' => {import_error => {'!=' => undef}}}
530 if $$options{with_import_error};
532 my $items = $e->json_query($query);
533 for my $item (@$items) {
534 $conn->respond($e->retrieve_vandelay_import_item($item->{id}));
540 sub check_queue_perms {
541 my($e, $type, $queue) = @_;
542 if ($type eq 'bib') {
543 return $e->die_event unless
544 ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
545 $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
547 return $e->die_event unless
548 ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
549 $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
555 __PACKAGE__->register_method(
556 api_name => "open-ils.vandelay.bib_record.list.import",
557 method => 'import_record_list',
564 __PACKAGE__->register_method(
565 api_name => "open-ils.vandelay.auth_record.list.import",
566 method => 'import_record_list',
570 record_type => 'auth'
573 sub import_record_list {
574 my($self, $conn, $auth, $rec_ids, $args) = @_;
575 my $e = new_editor(authtoken => $auth, xact => 1);
576 return $e->die_event unless $e->checkauth;
578 my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $args);
579 try {$e->rollback} otherwise {};
581 return {complete => 1};
585 __PACKAGE__->register_method(
586 api_name => "open-ils.vandelay.bib_queue.import",
587 method => 'import_queue',
595 __PACKAGE__->register_method(
596 api_name => "open-ils.vandelay.auth_queue.import",
597 method => 'import_queue',
602 record_type => 'auth'
604 __PACKAGE__->register_method(
605 api_name => "open-ils.vandelay.bib_queue.nomatch.import",
606 method => 'import_queue',
611 desc => q/Only import records that have no collisions/
617 __PACKAGE__->register_method(
618 api_name => "open-ils.vandelay.auth_queue.nomatch.import",
619 method => 'import_queue',
624 desc => q/Only import records that have no collisions/
627 record_type => 'auth'
630 my($self, $conn, $auth, $q_id, $options) = @_;
631 my $e = new_editor(authtoken => $auth, xact => 1);
632 return $e->die_event unless $e->checkauth;
634 my $type = $self->{record_type};
635 my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
637 my $query = {queue => $q_id, import_time => undef};
639 if($self->api_name =~ /nomatch/) {
640 my $matched_recs = queued_records_with_matches($e, $type, $q_id, undef, undef, {import_time => undef});
641 $query->{id} = {'not in' => $matched_recs} if @$matched_recs;
644 my $search = ($type eq 'bib') ?
645 'search_vandelay_queued_bib_record' : 'search_vandelay_queued_authority_record';
646 my $rec_ids = $e->$search($query, {idlist => 1});
647 my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $options);
648 try {$e->rollback} otherwise {}; # only using this to make the read authoritative -- don't die from it
650 return {complete => 1};
653 # returns a list of queued record IDs for a given queue that
654 # have at least one entry in the match table
655 sub queued_records_with_matches {
656 my($e, $type, $q_id, $limit, $offset, $filter) = @_;
658 my $match_class = 'vbm';
659 my $rec_class = 'vqbr';
660 if($type eq 'auth') {
661 $match_class = 'vam';
666 $filter->{queue} = $q_id;
670 select => {$match_class => ['queued_record']},
675 fkey => 'queued_record',
682 if($limit or defined $offset) {
685 $query->{limit} = $limit;
686 $query->{offset} = $offset;
689 my $data = $e->json_query($query);
690 return [ map {$_->{queued_record}} @$data ];
694 sub import_record_list_impl {
695 my($self, $conn, $rec_ids, $requestor, $args) = @_;
697 my $overlay_map = $args->{overlay_map} || {};
698 my $type = $self->{record_type};
705 total => scalar(@$rec_ids),
706 report_all => $$args{report_all}
709 my $auto_overlay_exact = $$args{auto_overlay_exact};
710 my $auto_overlay_1match = $$args{auto_overlay_1match};
711 my $auto_overlay_best = $$args{auto_overlay_best_match};
712 my $match_quality_ratio = $$args{match_quality_ratio};
713 my $merge_profile = $$args{merge_profile};
714 my $bib_source = $$args{bib_source};
715 my $import_no_match = $$args{import_no_match};
717 my $overlay_func = 'vandelay.overlay_bib_record';
718 my $auto_overlay_func = 'vandelay.auto_overlay_bib_record';
719 my $auto_overlay_best_func = 'vandelay.auto_overlay_bib_record_with_best'; # XXX bib-only
720 my $retrieve_func = 'retrieve_vandelay_queued_bib_record';
721 my $update_func = 'update_vandelay_queued_bib_record';
722 my $search_func = 'search_vandelay_queued_bib_record';
723 my $retrieve_queue_func = 'retrieve_vandelay_bib_queue';
724 my $update_queue_func = 'update_vandelay_bib_queue';
725 my $rec_class = 'vqbr';
727 my $editor = new_editor();
730 my $sources = $editor->search_config_bib_source({id => {'!=' => undef}});
731 $bib_sources{$_->id} = $_->source for @$sources;
733 if($type eq 'auth') {
734 $overlay_func =~ s/bib/auth/o;
735 $auto_overlay_func = s/bib/auth/o;
736 $retrieve_func =~ s/bib/authority/o;
737 $retrieve_queue_func =~ s/bib/authority/o;
738 $update_queue_func =~ s/bib/authority/o;
739 $update_func =~ s/bib/authority/o;
740 $search_func =~ s/bib/authority/o;
745 for my $rec_id (@$rec_ids) {
748 my $overlay_target = $overlay_map->{$rec_id};
750 my $e = new_editor(xact => 1);
751 $e->requestor($requestor);
753 $$report_args{e} = $e;
754 $$report_args{import_error} = undef;
755 $$report_args{evt} = undef;
757 my $rec = $e->$retrieve_func([
760 flesh_fields => { $rec_class => ['matches']},
765 $$report_args{evt} = $e->event;
766 finish_rec_import_attempt($report_args);
770 $$report_args{rec} = $rec;
772 if($rec->import_time) {
777 $queues{$rec->queue} = 1;
782 if(defined $overlay_target) {
783 # Caller chose an explicit overlay target
785 my $res = $e->json_query(
796 if($res and ($res = $res->[0])) {
798 if($res->{$overlay_func} eq 't') {
799 $logger->info("vl: $type direct overlay succeeded for queued rec " .
800 $rec->id . " and overlay target $overlay_target");
806 $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
811 if($auto_overlay_1match) {
812 # caller says to overlay if there is exactly 1 match
814 my %match_recs = map { $_->eg_record => 1 } @{$rec->matches};
816 if( scalar(keys %match_recs) == 1) { # all matches point to the same record
818 my $res = $e->json_query(
823 $rec->matches->[0]->eg_record,
829 if($res and ($res = $res->[0])) {
831 if($res->{$overlay_func} eq 't') {
832 $logger->info("vl: $type overlay-1match succeeded for queued rec " . $rec->id);
838 $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
843 if(!$imported and !$error and $auto_overlay_exact and scalar(@{$rec->matches}) == 1 ) {
845 # caller says to overlay if there is an /exact/ match
847 my $res = $e->json_query(
857 if($res and ($res = $res->[0])) {
859 if($res->{$auto_overlay_func} eq 't') {
860 $logger->info("vl: $type auto-overlay succeeded for queued rec " . $rec->id);
863 $logger->info("vl: $type auto-overlay failed for queued rec " . $rec->id);
868 $logger->error("vl: Error attempting overlay with func=$auto_overlay_func, profile=$merge_profile, record=$rec_id");
872 if(!$imported and !$error and $auto_overlay_best and scalar(@{$rec->matches}) > 0 ) {
874 # caller says to overlay the best match
876 my $res = $e->json_query(
879 $auto_overlay_best_func,
887 if($res and ($res = $res->[0])) {
889 if($res->{$auto_overlay_best_func} eq 't') {
890 $logger->info("vl: $type auto-overlay-best succeeded for queued rec " . $rec->id);
893 $$report_args{import_error} = 'overlay.record.quality' if $match_quality_ratio > 0;
894 $logger->info("vl: $type auto-overlay-best failed for queued rec " . $rec->id);
899 $logger->error("vl: Error attempting overlay with func=$auto_overlay_best_func, ".
900 "quality_ratio=$match_quality_ratio, profile=$merge_profile, record=$rec_id");
904 if(!$imported and !$error and $import_no_match and scalar(@{$rec->matches}) == 0) {
906 # No overlay / merge occurred. Do a traditional record import by creating a new record
908 $logger->info("vl: creating new $type record for queued record $rec_id");
910 $record = OpenILS::Application::Cat::BibCommon->biblio_record_xml_import($e, $rec->marc, $bib_sources{$rec->bib_source});
913 $record = OpenILS::Application::Cat::AuthCommon->import_authority_record($e, $rec->marc); #$source);
916 if($U->event_code($record)) {
917 $$report_args{import_error} = 'import.duplicate.tcn' if $record->{textcode} eq 'TCN_EXISTS';
918 $$report_args{evt} = $record;
922 $logger->info("vl: successfully imported new $type record");
923 $rec->imported_as($record->id);
924 $rec->import_time('now');
925 $rec->clear_import_error;
926 $rec->clear_error_detail;
927 $imported = 1 if $e->$update_func($rec);
933 push @success_rec_ids, $rec_id;
934 finish_rec_import_attempt($report_args);
937 # Send an update whenever there's an error
938 $$report_args{evt} = $e->event unless $$report_args{evt};
939 finish_rec_import_attempt($report_args);
943 # see if we need to mark any queues as complete
944 for my $q_id (keys %queues) {
946 my $e = new_editor(xact => 1);
947 my $remaining = $e->$search_func(
948 [{queue => $q_id, import_time => undef}, {limit =>1}], {idlist => 1});
950 unless(@$remaining) {
951 my $queue = $e->$retrieve_queue_func($q_id);
953 unless($U->is_true($queue->complete)) {
954 $queue->complete('t');
955 $e->$update_queue_func($queue) or return $e->die_event;
964 import_record_asset_list_impl($conn, \@success_rec_ids, $requestor);
966 $conn->respond({total => $$report_args{total}, progress => $$report_args{progress}});
970 # tracks any import errors, commits the current xact, responds to the client
971 sub finish_rec_import_attempt {
973 my $evt = $$args{evt};
974 my $rec = $$args{rec};
977 my $error = $$args{import_error};
978 $error = 'general.unknown' if $evt and not $error;
985 # since an error occurred, there's no guarantee the transaction wasn't
986 # rolled back. force a rollback and create a new editor.
988 $e = new_editor(xact => 1);
989 $rec->import_error($error);
992 my $detail = sprintf("%s : %s", $evt->{textcode}, substr($evt->{desc}, 0, 140));
993 $rec->error_detail($detail);
996 my $method = 'update_vandelay_queued_bib_record';
997 $method =~ s/bib/authority/ if $$args{type} eq 'auth';
998 $e->$method($rec) and $e->commit or $e->rollback;
1001 # commit the successful import
1006 # requested queued record was not found
1011 if($$args{report_all} or ($$args{progress} % $$args{step}) == 0) {
1012 $$args{conn}->respond({
1013 total => $$args{total},
1014 progress => $$args{progress},
1015 imported => ($rec) ? $rec->id : undef,
1018 $$args{step} *= 2 unless $$args{step} == 256;
1028 __PACKAGE__->register_method(
1029 api_name => "open-ils.vandelay.bib_queue.owner.retrieve",
1030 method => 'owner_queue_retrieve',
1034 record_type => 'bib'
1036 __PACKAGE__->register_method(
1037 api_name => "open-ils.vandelay.authority_queue.owner.retrieve",
1038 method => 'owner_queue_retrieve',
1042 record_type => 'auth'
1045 sub owner_queue_retrieve {
1046 my($self, $conn, $auth, $owner_id, $filters) = @_;
1047 my $e = new_editor(authtoken => $auth, xact => 1);
1048 return $e->die_event unless $e->checkauth;
1049 $owner_id = $e->requestor->id; # XXX add support for viewing other's queues?
1052 my $search = {owner => $owner_id};
1053 $search->{$_} = $filters->{$_} for keys %$filters;
1055 if($self->{record_type} eq 'bib') {
1056 $queues = $e->search_vandelay_bib_queue(
1057 [$search, {order_by => {vbq => 'evergreen.lowercase(name)'}}]);
1059 $queues = $e->search_vandelay_authority_queue(
1060 [$search, {order_by => {vaq => 'evergreen.lowercase(name)'}}]);
1062 $conn->respond($_) for @$queues;
1067 __PACKAGE__->register_method(
1068 api_name => "open-ils.vandelay.bib_queue.delete",
1069 method => "delete_queue",
1072 record_type => 'bib'
1074 __PACKAGE__->register_method(
1075 api_name => "open-ils.vandelay.auth_queue.delete",
1076 method => "delete_queue",
1079 record_type => 'auth'
1083 my($self, $conn, $auth, $q_id) = @_;
1084 my $e = new_editor(xact => 1, authtoken => $auth);
1085 return $e->die_event unless $e->checkauth;
1086 if($self->{record_type} eq 'bib') {
1087 return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
1088 my $queue = $e->retrieve_vandelay_bib_queue($q_id)
1089 or return $e->die_event;
1090 $e->delete_vandelay_bib_queue($queue)
1091 or return $e->die_event;
1093 return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
1094 my $queue = $e->retrieve_vandelay_authority_queue($q_id)
1095 or return $e->die_event;
1096 $e->delete_vandelay_authority_queue($queue)
1097 or return $e->die_event;
1104 __PACKAGE__->register_method(
1105 api_name => "open-ils.vandelay.queued_bib_record.html",
1106 method => 'queued_record_html',
1110 record_type => 'bib'
1112 __PACKAGE__->register_method(
1113 api_name => "open-ils.vandelay.queued_authority_record.html",
1114 method => 'queued_record_html',
1118 record_type => 'auth'
1121 sub queued_record_html {
1122 my($self, $conn, $auth, $rec_id) = @_;
1123 my $e = new_editor(xact=>1,authtoken => $auth);
1124 return $e->die_event unless $e->checkauth;
1126 if($self->{record_type} eq 'bib') {
1127 $rec = $e->retrieve_vandelay_queued_bib_record($rec_id)
1128 or return $e->die_event;
1130 $rec = $e->retrieve_vandelay_queued_authority_record($rec_id)
1131 or return $e->die_event;
1135 return $U->simplereq(
1137 'open-ils.search.biblio.record.html', undef, 1, $rec->marc);
1141 __PACKAGE__->register_method(
1142 api_name => "open-ils.vandelay.bib_queue.summary.retrieve",
1143 method => 'retrieve_queue_summary',
1147 record_type => 'bib'
1149 __PACKAGE__->register_method(
1150 api_name => "open-ils.vandelay.auth_queue.summary.retrieve",
1151 method => 'retrieve_queue_summary',
1155 record_type => 'auth'
1158 sub retrieve_queue_summary {
1159 my($self, $conn, $auth, $queue_id) = @_;
1160 my $e = new_editor(xact=>1, authtoken => $auth);
1161 return $e->die_event unless $e->checkauth;
1164 my $type = $self->{record_type};
1165 if($type eq 'bib') {
1166 $queue = $e->retrieve_vandelay_bib_queue($queue_id)
1167 or return $e->die_event;
1169 $queue = $e->retrieve_vandelay_authority_queue($queue_id)
1170 or return $e->die_event;
1173 my $evt = check_queue_perms($e, $type, $queue);
1174 return $evt if $evt;
1176 my $search = 'search_vandelay_queued_bib_record';
1177 $search =~ s/bib/authority/ if $type ne 'bib';
1181 total => scalar(@{$e->$search({queue => $queue_id}, {idlist=>1})}),
1182 imported => scalar(@{$e->$search({queue => $queue_id, import_time => {'!=' => undef}}, {idlist=>1})}),
1185 my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
1186 $summary->{rec_import_errors} = $e->json_query({
1187 select => {$class => [{alias => 'count', column => 'id', transform => 'count', aggregate => 1}]},
1189 where => {queue => $queue_id, import_error => {'!=' => undef}}
1192 if($type eq 'bib') {
1195 select => {vii => [{alias => 'count', column => 'id', transform => 'count', aggregate => 1}]},
1200 select => {vqbr => ['id']},
1202 where => {queue => $queue_id}
1208 $summary->{total_items} = $e->json_query($query)->[0]->{count};
1209 $query->{where}->{import_error} = {'!=' => undef};
1210 $summary->{item_import_errors} = $e->json_query($query)->[0]->{count};
1216 # --------------------------------------------------------------------------------
1217 # Given a list of queued record IDs, imports all items attached to those records
1218 # --------------------------------------------------------------------------------
1219 sub import_record_asset_list_impl {
1220 my($conn, $rec_ids, $requestor) = @_;
1222 my $roe = new_editor(xact=> 1, requestor => $requestor);
1224 # for speed, filter out any records have not been
1225 # imported or have no import items to load
1226 $rec_ids = $roe->json_query({
1227 select => {vqbr => ['id']},
1228 from => {vqbr => 'vii'},
1229 where => {'+vqbr' => {import_time => {'!=' => undef}}},
1232 $rec_ids = [map {$_->{id}} @$rec_ids];
1236 total => scalar(@$rec_ids),
1237 step => 1, # how often to respond
1242 for my $rec_id (@$rec_ids) {
1243 my $rec = $roe->retrieve_vandelay_queued_bib_record($rec_id);
1244 my $item_ids = $roe->search_vandelay_import_item({record => $rec->id}, {idlist=>1});
1246 for my $item_id (@$item_ids) {
1247 my $e = new_editor(requestor => $requestor, xact => 1);
1248 my $item = $e->retrieve_vandelay_import_item($item_id);
1249 $$report_args{import_item} = $item;
1250 $$report_args{e} = $e;
1251 $$report_args{import_error} = undef;
1252 $$report_args{evt} = undef;
1254 # --------------------------------------------------------------------------------
1255 # Find or create the volume
1256 # --------------------------------------------------------------------------------
1258 OpenILS::Application::Cat::AssetCommon->find_or_create_volume(
1259 $e, $item->call_number, $rec->imported_as, $item->owning_lib);
1263 $$report_args{evt} = $evt;
1264 respond_with_status($report_args);
1268 # --------------------------------------------------------------------------------
1269 # Create the new copy
1270 # --------------------------------------------------------------------------------
1271 my $copy = Fieldmapper::asset::copy->new;
1272 $copy->loan_duration(2);
1273 $copy->fine_level(2);
1274 $copy->barcode($item->barcode);
1275 $copy->location($item->location);
1276 $copy->circ_lib($item->circ_lib || $item->owning_lib);
1277 $copy->status( defined($item->status) ? $item->status : OILS_COPY_STATUS_IN_PROCESS );
1278 $copy->circulate($item->circulate);
1279 $copy->deposit($item->deposit);
1280 $copy->deposit_amount($item->deposit_amount);
1281 $copy->ref($item->ref);
1282 $copy->holdable($item->holdable);
1283 $copy->price($item->price);
1284 $copy->circ_as_type($item->circ_as_type);
1285 $copy->alert_message($item->alert_message);
1286 $copy->opac_visible($item->opac_visible);
1287 $copy->circ_modifier($item->circ_modifier);
1289 # --------------------------------------------------------------------------------
1290 # see if a valid circ_modifier was provided
1291 # --------------------------------------------------------------------------------
1292 if($copy->circ_modifier and not $e->search_config_circ_modifier({code=>$item->circ_modifier})->[0]) {
1293 $$report_args{evt} = $e->die_event;
1294 $$report_args{import_error} = 'import.item.invalid.circ_modifier';
1295 respond_with_status($report_args);
1299 if($copy->location and not $e->retrieve_asset_copy_location($copy->location)) {
1300 $$report_args{evt} = $e->die_event;
1301 $$report_args{import_error} = 'import.item.invalid.location';
1302 respond_with_status($report_args);
1306 if($evt = OpenILS::Application::Cat::AssetCommon->create_copy($e, $vol, $copy)) {
1307 $$report_args{evt} = $evt;
1308 $$report_args{import_error} = 'import.item.duplicate.barcode'
1309 if $evt->{textcode} eq 'ITEM_BARCODE_EXISTS';
1310 respond_with_status($report_args);
1314 # --------------------------------------------------------------------------------
1316 # --------------------------------------------------------------------------------
1317 $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
1318 $e, $copy, '', $item->pub_note, 1) if $item->pub_note;
1321 $$report_args{evt} = $evt;
1322 respond_with_status($report_args);
1326 $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
1327 $e, $copy, '', $item->priv_note, 1) if $item->priv_note;
1330 $$report_args{evt} = $evt;
1331 respond_with_status($report_args);
1335 # --------------------------------------------------------------------------------
1336 # Item import succeeded
1337 # --------------------------------------------------------------------------------
1339 $$report_args{in_count}++;
1340 respond_with_status($report_args);
1341 $logger->info("vl: successfully imported item " . $item->barcode);
1351 sub respond_with_status {
1355 # If the import failed, track the failure reason
1357 my $error = $$args{import_error};
1358 my $evt = $$args{evt};
1360 if($error or $evt) {
1362 my $item = $$args{import_item};
1363 $logger->info("vl: unable to import item " . $item->barcode);
1365 $error ||= 'general.unknown';
1366 $item->import_error($error);
1369 my $detail = sprintf("%s : %s", $evt->{textcode}, substr($evt->{desc}, 0, 140));
1370 $item->error_detail($detail);
1373 # state of the editor is unknown at this point. Force a rollback and start over.
1375 $e = new_editor(xact => 1);
1376 $e->update_vandelay_import_item($item);
1380 if($$args{report_all} or ($$args{progress} % $$args{step}) == 0) {
1381 $$args{conn}->respond({
1382 map { $_ => $args->{$_} } qw/total progress success_count/,
1385 $$args{step} *= 2 unless $$args{step} == 256;
1391 __PACKAGE__->register_method(
1392 api_name => "open-ils.vandelay.match_set.get_tree",
1393 method => "match_set_get_tree",
1397 desc => q/For a given vms object, return a tree of match set points
1398 represented by a vmsp object with recursively fleshed
1403 sub match_set_get_tree {
1404 my ($self, $conn, $authtoken, $match_set_id) = @_;
1406 $match_set_id = int($match_set_id) or return;
1408 my $e = new_editor("authtoken" => $authtoken);
1409 $e->checkauth or return $e->die_event;
1411 my $set = $e->retrieve_vandelay_match_set($match_set_id) or
1412 return $e->die_event;
1414 $e->allowed("ADMIN_IMPORT_MATCH_SET", $set->owner) or
1415 return $e->die_event;
1417 my $tree = $e->search_vandelay_match_set_point([
1418 {"match_set" => $match_set_id, "parent" => undef},
1419 {"flesh" => -1, "flesh_fields" => {"vmsp" => ["children"]}}
1420 ]) or return $e->die_event;
1426 __PACKAGE__->register_method(
1427 api_name => "open-ils.vandelay.match_set.update",
1428 method => "match_set_update_tree",
1432 desc => q/Replace any vmsp objects associated with a given (by ID) vms
1433 with the given objects (recursively fleshed vmsp tree)./
1437 sub _walk_new_vmsp {
1438 my ($e, $match_set_id, $node, $parent_id) = @_;
1440 my $point = new Fieldmapper::vandelay::match_set_point;
1441 $point->parent($parent_id);
1442 $point->match_set($match_set_id);
1443 $point->$_($node->$_) for (qw/bool_op svf tag subfield negate quality/);
1445 $e->create_vandelay_match_set_point($point) or return $e->die_event;
1447 $parent_id = $e->data->id;
1448 if ($node->children && @{$node->children}) {
1449 for (@{$node->children}) {
1450 return $e->die_event if
1451 _walk_new_vmsp($e, $match_set_id, $_, $parent_id);
1458 sub match_set_update_tree {
1459 my ($self, $conn, $authtoken, $match_set_id, $tree) = @_;
1461 my $e = new_editor("xact" => 1, "authtoken" => $authtoken);
1462 $e->checkauth or return $e->die_event;
1464 my $set = $e->retrieve_vandelay_match_set($match_set_id) or
1465 return $e->die_event;
1467 $e->allowed("ADMIN_IMPORT_MATCH_SET", $set->owner) or
1468 return $e->die_event;
1470 my $existing = $e->search_vandelay_match_set_point([
1471 {"match_set" => $match_set_id},
1472 {"order_by" => {"vmsp" => "id DESC"}}
1473 ]) or return $e->die_event;
1475 # delete points, working up from leaf points to the root
1477 for my $point (shift @$existing) {
1478 if( grep {$_->parent eq $point->id} @$existing) {
1479 push(@$existing, $point);
1481 $e->delete_vandelay_match_set_point($point) or return $e->die_event;
1486 _walk_new_vmsp($e, $match_set_id, $tree);
1488 $e->commit or return $e->die_event;