]> git.evergreen-ils.org Git - working/Evergreen.git/blob - Open-ILS/src/perlmods/lib/OpenILS/Application/Vandelay.pm
added 'with_import_error' option to queued record retrieval; returns recs with eithe...
[working/Evergreen.git] / Open-ILS / src / perlmods / lib / OpenILS / Application / Vandelay.pm
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 MARC::Batch;
13 use MARC::Record;
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/;
18 use MIME::Base64;
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';
25
26 # A list of LDR/06 values from http://loc.gov/marc
27 my %record_types = (
28         a => 'bib',
29         c => 'bib',
30         d => 'bib',
31         e => 'bib',
32         f => 'bib',
33         g => 'bib',
34         i => 'bib',
35         j => 'bib',
36         k => 'bib',
37         m => 'bib',
38         o => 'bib',
39         p => 'bib',
40         r => 'bib',
41         t => 'bib',
42         u => 'holdings',
43         v => 'holdings',
44         x => 'holdings',
45         y => 'holdings',
46         z => 'auth',
47       ' ' => 'bib',
48 );
49
50 sub initialize {}
51 sub child_init {}
52
53 # --------------------------------------------------------------------------------
54 # Biblio ingest
55
56 sub create_bib_queue {
57     my $self = shift;
58     my $client = shift;
59     my $auth = shift;
60     my $name = shift;
61     my $owner = shift;
62     my $type = shift;
63     my $import_def = shift;
64
65     my $e = new_editor(authtoken => $auth, xact => 1);
66
67     return $e->die_event unless $e->checkauth;
68     return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
69     $owner ||= $e->requestor->id;
70
71     if ($e->search_vandelay_bib_queue( {name => $name, owner => $owner, queue_type => $type})->[0]) {
72         $e->rollback;
73         return OpenILS::Event->new('BIB_QUEUE_EXISTS') 
74     }
75
76     my $queue = new Fieldmapper::vandelay::bib_queue();
77     $queue->name( $name );
78     $queue->owner( $owner );
79     $queue->queue_type( $type ) if ($type);
80     $queue->item_attr_def( $import_def ) if ($import_def);
81
82     my $new_q = $e->create_vandelay_bib_queue( $queue );
83     return $e->die_event unless ($new_q);
84     $e->commit;
85
86     return $new_q;
87 }
88 __PACKAGE__->register_method(  
89     api_name   => "open-ils.vandelay.bib_queue.create",
90     method     => "create_bib_queue",
91     api_level  => 1,
92     argc       => 4,
93 );                      
94
95
96 sub create_auth_queue {
97     my $self = shift;
98     my $client = shift;
99     my $auth = shift;
100     my $name = shift;
101     my $owner = shift;
102     my $type = shift;
103
104     my $e = new_editor(authtoken => $auth, xact => 1);
105
106     return $e->die_event unless $e->checkauth;
107     return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
108     $owner ||= $e->requestor->id;
109
110     if ($e->search_vandelay_bib_queue({name => $name, owner => $owner, queue_type => $type})->[0]) {
111         $e->rollback;
112         return OpenILS::Event->new('AUTH_QUEUE_EXISTS') 
113     }
114
115     my $queue = new Fieldmapper::vandelay::authority_queue();
116     $queue->name( $name );
117     $queue->owner( $owner );
118     $queue->queue_type( $type ) if ($type);
119
120     my $new_q = $e->create_vandelay_authority_queue( $queue );
121     $e->die_event unless ($new_q);
122     $e->commit;
123
124     return $new_q;
125 }
126 __PACKAGE__->register_method(  
127     api_name   => "open-ils.vandelay.authority_queue.create",
128     method     => "create_auth_queue",
129     api_level  => 1,
130     argc       => 3,
131 );                      
132
133 sub add_record_to_bib_queue {
134     my $self = shift;
135     my $client = shift;
136     my $auth = shift;
137     my $queue = shift;
138     my $marc = shift;
139     my $purpose = shift;
140     my $bib_source = shift;
141
142     my $e = new_editor(authtoken => $auth, xact => 1);
143
144     $queue = $e->retrieve_vandelay_bib_queue($queue);
145
146     return $e->die_event unless $e->checkauth;
147     return $e->die_event unless
148         ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
149          $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
150
151     my $new_rec = _add_bib_rec($e, $marc, $queue->id, $purpose, $bib_source);
152
153     return $e->die_event unless ($new_rec);
154     $e->commit;
155     return $new_rec;
156 }
157 __PACKAGE__->register_method(  
158     api_name   => "open-ils.vandelay.queued_bib_record.create",
159     method     => "add_record_to_bib_queue",
160     api_level  => 1,
161     argc       => 3,
162 );                      
163
164 sub _add_bib_rec {
165     my $e = shift;
166     my $marc = shift;
167     my $queue = shift;
168     my $purpose = shift;
169     my $bib_source = shift;
170
171     my $rec = new Fieldmapper::vandelay::queued_bib_record();
172     $rec->marc( $marc );
173     $rec->queue( $queue );
174     $rec->purpose( $purpose ) if ($purpose);
175     $rec->bib_source($bib_source);
176
177     return $e->create_vandelay_queued_bib_record( $rec );
178 }
179
180 sub add_record_to_authority_queue {
181     my $self = shift;
182     my $client = shift;
183     my $auth = shift;
184     my $queue = shift;
185     my $marc = shift;
186     my $purpose = shift;
187
188     my $e = new_editor(authtoken => $auth, xact => 1);
189
190     $queue = $e->retrieve_vandelay_authority_queue($queue);
191
192     return $e->die_event unless $e->checkauth;
193     return $e->die_event unless
194         ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
195          $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
196
197     my $new_rec = _add_auth_rec($e, $marc, $queue->id, $purpose);
198
199     return $e->die_event unless ($new_rec);
200     $e->commit;
201     return $new_rec;
202 }
203 __PACKAGE__->register_method(
204     api_name   => "open-ils.vandelay.queued_authority_record.create",
205     method     => "add_record_to_authority_queue",
206     api_level  => 1,
207     argc       => 3,
208 );
209
210 sub _add_auth_rec {
211     my $e = shift;
212     my $marc = shift;
213     my $queue = shift;
214     my $purpose = shift;
215
216     my $rec = new Fieldmapper::vandelay::queued_authority_record();
217     $rec->marc( $marc );
218     $rec->queue( $queue );
219     $rec->purpose( $purpose ) if ($purpose);
220
221     return $e->create_vandelay_queued_authority_record( $rec );
222 }
223
224 sub process_spool {
225     my $self = shift;
226     my $client = shift;
227     my $auth = shift;
228     my $fingerprint = shift || '';
229     my $queue_id = shift;
230     my $purpose = shift;
231     my $filename = shift;
232     my $bib_source = shift;
233
234     my $e = new_editor(authtoken => $auth, xact => 1);
235     return $e->die_event unless $e->checkauth;
236
237     my $queue;
238     my $type = $self->{record_type};
239
240     if($type eq 'bib') {
241         $queue = $e->retrieve_vandelay_bib_queue($queue_id) or return $e->die_event;
242     } else {
243         $queue = $e->retrieve_vandelay_authority_queue($queue_id) or return $e->die_event;
244     }
245
246     my $evt = check_queue_perms($e, $type, $queue);
247     return $evt if ($evt);
248
249     my $cache = new OpenSRF::Utils::Cache();
250
251     if($fingerprint) {
252         my $data = $cache->get_cache('vandelay_import_spool_' . $fingerprint);
253         $purpose = $data->{purpose};
254         $filename = $data->{path};
255         $bib_source = $data->{bib_source};
256     }
257
258     unless(-r $filename) {
259         $logger->error("unable to read MARC file $filename");
260         return -1; # make this an event XXX
261     }
262
263     $logger->info("vandelay spooling $fingerprint purpose=$purpose file=$filename");
264
265     my $marctype = 'USMARC'; 
266
267     open F, $filename;
268     $marctype = 'XML' if (getc(F) =~ /^\D/o);
269     close F;
270
271     my $batch = new MARC::Batch ($marctype, $filename);
272     $batch->strict_off;
273
274     my $response_scale = 10;
275     my $count = 0;
276     my $r = -1;
277     while (try { $r = $batch->next } otherwise { $r = -1 }) {
278         if ($r == -1) {
279             $logger->warn("Processing of record $count in set $filename failed.  Skipping this record");
280             $count++;
281         }
282
283         $logger->info("processing record $count");
284
285         try {
286             (my $xml = $r->as_xml_record()) =~ s/\n//sog;
287             $xml =~ s/^<\?xml.+\?\s*>//go;
288             $xml =~ s/>\s+</></go;
289             $xml =~ s/\p{Cc}//go;
290             $xml = $U->entityize($xml);
291             $xml =~ s/[\x00-\x1f]//go;
292
293             my $qrec;
294             # Check the leader to ensure we've got something resembling the expected
295             # Allow spaces to give records the benefit of the doubt
296             my $ldr_type = substr($r->leader(), 6, 1);
297             if ($type eq 'bib' && ($record_types{$ldr_type}) eq 'bib' || $ldr_type eq ' ') {
298                 $qrec = _add_bib_rec( $e, $xml, $queue_id, $purpose, $bib_source ) or return $e->die_event;
299             } elsif ($type eq 'auth' && ($record_types{$ldr_type}) eq 'auth' || $ldr_type eq ' ') {
300                 $qrec = _add_auth_rec( $e, $xml, $queue_id, $purpose ) or return $e->die_event;
301             } else {
302                 # I don't know how to handle this type; rock on
303                 $logger->error("In process_spool(), type was $type and leader type was $ldr_type ; not currently supported");
304                 next;
305             }
306
307             if($self->api_name =~ /stream_results/ and $qrec) {
308                 $client->respond($qrec->id)
309             } else {
310                 $client->respond($count) if (++$count % $response_scale) == 0;
311                 $response_scale *= 10 if ($count == ($response_scale * 10));
312             }
313         } catch Error with {
314             my $error = shift;
315             $logger->warn("Encountered a bad record at Vandelay ingest: ".$error);
316         }
317     }
318
319     $e->commit;
320     unlink($filename);
321     $cache->delete_cache('vandelay_import_spool_' . $fingerprint) if $fingerprint;
322     return $count;
323 }
324
325 __PACKAGE__->register_method(  
326     api_name    => "open-ils.vandelay.bib.process_spool",
327     method      => "process_spool",
328     api_level   => 1,
329     argc        => 3,
330     max_chunk_size => 0,
331     record_type => 'bib'
332 );                      
333 __PACKAGE__->register_method(  
334     api_name    => "open-ils.vandelay.auth.process_spool",
335     method      => "process_spool",
336     api_level   => 1,
337     argc        => 3,
338     max_chunk_size => 0,
339     record_type => 'auth'
340 );                      
341
342 __PACKAGE__->register_method(  
343     api_name    => "open-ils.vandelay.bib.process_spool.stream_results",
344     method      => "process_spool",
345     api_level   => 1,
346     argc        => 3,
347     stream      => 1,
348     max_chunk_size => 0,
349     record_type => 'bib'
350 );                      
351 __PACKAGE__->register_method(  
352     api_name    => "open-ils.vandelay.auth.process_spool.stream_results",
353     method      => "process_spool",
354     api_level   => 1,
355     argc        => 3,
356     stream      => 1,
357     max_chunk_size => 0,
358     record_type => 'auth'
359 );
360
361 __PACKAGE__->register_method(  
362     api_name    => "open-ils.vandelay.bib_queue.records.retrieve",
363     method      => 'retrieve_queued_records',
364     api_level   => 1,
365     argc        => 2,
366     stream      => 1,
367     record_type => 'bib'
368 );
369 __PACKAGE__->register_method(  
370     api_name    => "open-ils.vandelay.auth_queue.records.retrieve",
371     method      => 'retrieve_queued_records',
372     api_level   => 1,
373     argc        => 2,
374     stream      => 1,
375     record_type => 'auth'
376 );
377
378 __PACKAGE__->register_method(  
379     api_name    => "open-ils.vandelay.bib_queue.records.matches.retrieve",
380     method      => 'retrieve_queued_records',
381     api_level   => 1,
382     argc        => 2,
383     stream      => 1,
384     record_type => 'bib',
385     signature   => {
386         desc => q/Only retrieve queued bib records that have matches against existing records/
387     }
388 );
389 __PACKAGE__->register_method(  
390     api_name    => "open-ils.vandelay.auth_queue.records.matches.retrieve",
391     method      => 'retrieve_queued_records',
392     api_level   => 1,
393     argc        => 2,
394     stream      => 1,
395     record_type => 'auth',
396     signature   => {
397         desc => q/Only retrieve queued authority records that have matches against existing records/
398     }
399 );
400
401 sub retrieve_queued_records {
402     my($self, $conn, $auth, $queue_id, $options) = @_;
403
404     $options ||= {};
405     my $limit = $$options{limit} || 20;
406     my $offset = $$options{offset} || 0;
407     my $type = $self->{record_type};
408
409     my $e = new_editor(authtoken => $auth, xact => 1);
410     return $e->die_event unless $e->checkauth;
411
412     my $queue;
413     if($type eq 'bib') {
414         $queue = $e->retrieve_vandelay_bib_queue($queue_id) or return $e->die_event;
415     } else {
416         $queue = $e->retrieve_vandelay_authority_queue($queue_id) or return $e->die_event;
417     }
418     my $evt = check_queue_perms($e, $type, $queue);
419     return $evt if ($evt);
420
421     my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
422     my $query = {
423         select => {$class => ['id']},
424         from => $class,
425         where => {queue => $queue_id},
426         distinct => 1,
427         order_by => {$class => ['id']}, 
428         limit => $limit,
429         offset => $offset,
430     };
431
432     $query->{where}->{import_time} = undef if $$options{non_imported};
433
434     if($$options{with_import_error}) {
435
436         $query->{from} = {$class => {vii => {type => 'right'}}};
437         $query->{where}->{'-or'} = [
438             {'+vqbr' => {import_error => {'!=' => undef}}},
439             {'+vii' => {import_error => {'!=' => undef}}}
440         ];
441
442     } else {
443         
444         if($$options{with_rec_import_error}) {
445             $query->{where}->{import_error} = {'!=' => undef};
446
447         } elsif( $$options{with_item_import_error} and $type eq 'bib') {
448
449             $query->{from} = {$class => 'vii'};
450             $query->{where}->{'+vii'} = {import_error => {'!=' => undef}};
451         }
452     }
453
454     if($self->api_name =~ /matches/) {
455         # find only records that have matches
456         my $mclass = $type eq 'bib' ? 'vbm' : 'vam';
457         $query->{from} = {$class => {$mclass => {type => 'right'}}};
458     } 
459
460     my $record_ids = $e->json_query($query);
461
462     my $retrieve = ($type eq 'bib') ? 
463         'retrieve_vandelay_queued_bib_record' : 'retrieve_vandelay_queued_authority_record';
464
465     for my $rec_id (@$record_ids) {
466         my $flesh = ['attributes', 'matches'];
467         push(@$flesh, 'import_items') if $$options{flesh_import_items};
468         my $params = {flesh => 1, flesh_fields => {$class => $flesh}};
469         my $rec = $e->$retrieve([$rec_id->{id}, $params]);
470         $rec->clear_marc if $$options{clear_marc};
471         $conn->respond($rec);
472     }
473
474     $e->rollback;
475     return undef;
476 }
477
478 __PACKAGE__->register_method(  
479     api_name    => 'open-ils.vandelay.import_item.queue.retrieve',
480     method      => 'retrieve_queue_import_items',
481     api_level   => 1,
482     argc        => 2,
483     stream      => 1,
484     authoritative => 1,
485     signature => q/
486         Returns Import Item (vii) objects for the selected queue.
487         Filter options:
488             with_import_error : only return items that failed to import
489     /
490 );
491
492 sub retrieve_queue_import_items {
493     my($self, $conn, $auth, $q_id, $options) = @_;
494
495     $options ||= {};
496     my $limit = $$options{limit} || 20;
497     my $offset = $$options{offset} || 0;
498
499     my $e = new_editor(authtoken => $auth);
500     return $e->event unless $e->checkauth;
501
502     my $queue = $e->retrieve_vandelay_bib_queue($q_id) or return $e->event;
503     my $evt = check_queue_perms($e, 'bib', $queue);
504     return $evt if $evt;
505
506     my $query = {
507         select => {vii => ['id']},
508         from => {
509             vii => {
510                 vqbr => {
511                     join => {
512                         'vbq' => {
513                             field => 'id',
514                             fkey => 'queue',
515                             filter => {id => $q_id}
516                         }
517                     }
518                 }
519             }
520         },
521         order_by => {'vii' => ['record','id']}
522     };
523
524     $query->{where} = {'+vii' => {import_error => {'!=' => undef}}}
525         if $$options{with_import_error};
526
527     my $items = $e->json_query($query);
528     for my $item (@$items) {
529         $conn->respond($e->retrieve_vandelay_import_item($item->{id}));
530     }
531
532     return undef;
533 }
534
535 sub check_queue_perms {
536     my($e, $type, $queue) = @_;
537     if ($type eq 'bib') {
538         return $e->die_event unless
539             ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
540              $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
541     } else {
542         return $e->die_event unless
543             ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
544              $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
545     }
546
547     return undef;
548 }
549
550 __PACKAGE__->register_method(  
551     api_name    => "open-ils.vandelay.bib_record.list.import",
552     method      => 'import_record_list',
553     api_level   => 1,
554     argc        => 2,
555     stream      => 1,
556     record_type => 'bib'
557 );
558
559 __PACKAGE__->register_method(  
560     api_name    => "open-ils.vandelay.auth_record.list.import",
561     method      => 'import_record_list',
562     api_level   => 1,
563     argc        => 2,
564     stream      => 1,
565     record_type => 'auth'
566 );
567
568 sub import_record_list {
569     my($self, $conn, $auth, $rec_ids, $args) = @_;
570     my $e = new_editor(authtoken => $auth, xact => 1);
571     return $e->die_event unless $e->checkauth;
572     $args ||= {};
573     my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $args);
574     $e->rollback;
575     return $err if $err;
576     return {complete => 1};
577 }
578
579
580 __PACKAGE__->register_method(  
581     api_name    => "open-ils.vandelay.bib_queue.import",
582     method      => 'import_queue',
583     api_level   => 1,
584     argc        => 2,
585     stream      => 1,
586     max_chunk_size => 0,
587     record_type => 'bib'
588 );
589
590 __PACKAGE__->register_method(  
591     api_name    => "open-ils.vandelay.auth_queue.import",
592     method      => 'import_queue',
593     api_level   => 1,
594     argc        => 2,
595     stream      => 1,
596     max_chunk_size => 0,
597     record_type => 'auth'
598 );
599 __PACKAGE__->register_method(  
600     api_name    => "open-ils.vandelay.bib_queue.nomatch.import",
601     method      => 'import_queue',
602     api_level   => 1,
603     argc        => 2,
604     stream      => 1,
605     signature   => {
606         desc => q/Only import records that have no collisions/
607     },
608     max_chunk_size => 0,
609     record_type => 'bib'
610 );
611
612 __PACKAGE__->register_method(  
613     api_name    => "open-ils.vandelay.auth_queue.nomatch.import",
614     method      => 'import_queue',
615     api_level   => 1,
616     argc        => 2,
617     stream      => 1,
618     signature   => {
619         desc => q/Only import records that have no collisions/
620     },
621     max_chunk_size => 0,
622     record_type => 'auth'
623 );
624 sub import_queue {
625     my($self, $conn, $auth, $q_id, $options) = @_;
626     my $e = new_editor(authtoken => $auth, xact => 1);
627     return $e->die_event unless $e->checkauth;
628     $options ||= {};
629     my $type = $self->{record_type};
630     my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
631
632     my $query = {queue => $q_id, import_time => undef};
633
634     if($self->api_name =~ /nomatch/) {
635         my $matched_recs = queued_records_with_matches($e, $type, $q_id, undef, undef, {import_time => undef});
636         $query->{id} = {'not in' => $matched_recs} if @$matched_recs;
637     }
638
639     my $search = ($type eq 'bib') ? 
640         'search_vandelay_queued_bib_record' : 'search_vandelay_queued_authority_record';
641     my $rec_ids = $e->$search($query, {idlist => 1});
642     my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $options);
643     try {$e->rollback} otherwise {}; # only using this to make the read authoritative -- don't die from it
644     return $err if $err;
645     return {complete => 1};
646 }
647
648 # returns a list of queued record IDs for a given queue that 
649 # have at least one entry in the match table
650 sub queued_records_with_matches {
651     my($e, $type, $q_id, $limit, $offset, $filter) = @_;
652
653     my $match_class = 'vbm';
654     my $rec_class = 'vqbr';
655     if($type eq 'auth') {
656         $match_class = 'vam';
657          $rec_class = 'vqar';
658     }
659
660     $filter ||= {};
661     $filter->{queue} = $q_id;
662
663     my $query = {
664         distinct => 1, 
665         select => {$match_class => ['queued_record']}, 
666         from => {
667             $match_class => {
668                 $rec_class => {
669                     field => 'id',
670                     fkey => 'queued_record',
671                     filter => $filter,
672                 }
673             }
674         }
675     };        
676
677     if($limit or defined $offset) {
678         $limit ||= 20;
679         $offset ||= 0;
680         $query->{limit} = $limit;
681         $query->{offset} = $offset;
682     }
683
684     my $data = $e->json_query($query);
685     return [ map {$_->{queued_record}} @$data ];
686 }
687
688
689 sub import_record_list_impl {
690     my($self, $conn, $rec_ids, $requestor, $args) = @_;
691
692     my $overlay_map = $args->{overlay_map} || {};
693     my $type = $self->{record_type};
694     my %queues;
695
696     my %report_args = (
697         progress => 0,
698         step => 1,
699         conn => $conn,
700         total => scalar(@$rec_ids),
701         report_all => $$args{report_all}
702     );
703
704     my $auto_overlay_exact = $$args{auto_overlay_exact};
705     my $auto_overlay_1match = $$args{auto_overlay_1match};
706     my $merge_profile = $$args{merge_profile};
707     my $bib_source = $$args{bib_source};
708
709     my $overlay_func = 'vandelay.overlay_bib_record';
710     my $auto_overlay_func = 'vandelay.auto_overlay_bib_record';
711     my $retrieve_func = 'retrieve_vandelay_queued_bib_record';
712     my $update_func = 'update_vandelay_queued_bib_record';
713     my $search_func = 'search_vandelay_queued_bib_record';
714     my $retrieve_queue_func = 'retrieve_vandelay_bib_queue';
715     my $update_queue_func = 'update_vandelay_bib_queue';
716     my $rec_class = 'vqbr';
717
718     my $editor = new_editor();
719
720     my %bib_sources;
721     my $sources = $editor->search_config_bib_source({id => {'!=' => undef}});
722     $bib_sources{$_->id} = $_->source for @$sources;
723
724     if($type eq 'auth') {
725         $overlay_func =~ s/bib/auth/o;
726         $auto_overlay_func = s/bib/auth/o;
727         $retrieve_func =~ s/bib/authority/o;
728         $retrieve_queue_func =~ s/bib/authority/o;
729         $update_queue_func =~ s/bib/authority/o;
730         $update_func =~ s/bib/authority/o;
731         $search_func =~ s/bib/authority/o;
732         $rec_class = 'vqar';
733     }
734
735     my @success_rec_ids;
736     for my $rec_id (@$rec_ids) {
737
738         my $error = 0;
739         my $overlay_target = $overlay_map->{$rec_id};
740
741         my $e = new_editor(xact => 1);
742         $e->requestor($requestor);
743
744         $report_args{progress}++;
745         $report_args{e} = $e;
746
747         my $rec = $e->$retrieve_func([
748             $rec_id,
749             {   flesh => 1,
750                 flesh_fields => { $rec_class => ['matches']},
751             }
752         ]);
753
754         unless($rec) {
755             finish_rec_import_attempt(%report_args, evt => $e->event);
756             next;
757         }
758
759         $report_args{rec} = $rec;
760
761         if($rec->import_time) {
762             $e->rollback;
763             next;
764         }
765
766         $queues{$rec->queue} = 1;
767
768         my $record;
769         my $imported = 0;
770
771         if(defined $overlay_target) {
772             # Caller chose an explicit overlay target
773
774             my $res = $e->json_query(
775                 {
776                     from => [
777                         $overlay_func,
778                         $rec->id, 
779                         $overlay_target, 
780                         $merge_profile
781                     ]
782                 }
783             );
784
785             if($res and ($res = $res->[0])) {
786
787                 if($res->{$overlay_func} eq 't') {
788                     $logger->info("vl: $type direct overlay succeeded for queued rec " . 
789                         $rec->id . " and overlay target $overlay_target");
790                     $imported = 1;
791                 }
792
793             } else {
794                 $error = 1;
795                 $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
796             }
797
798         } else {
799
800             if($auto_overlay_1match) { 
801                 # caller says to overlay if there is exactly 1 match
802
803                 my %match_recs = map { $_->eg_record => 1 } @{$rec->matches};
804
805                 if( scalar(keys %match_recs) == 1) { # all matches point to the same record
806
807                     my $res = $e->json_query(
808                         {
809                             from => [
810                                 $overlay_func,
811                                 $rec->id, 
812                                 $rec->matches->[0]->eg_record,
813                                 $merge_profile
814                             ]
815                         }
816                     );
817
818                     if($res and ($res = $res->[0])) {
819     
820                         if($res->{$overlay_func} eq 't') {
821                             $logger->info("vl: $type overlay-1match succeeded for queued rec " . $rec->id);
822                             $imported = 1;
823                         }
824
825                     } else {
826                         $error = 1;
827                         $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
828                     }
829                 }
830             }
831
832             if(!$imported and !$error and $auto_overlay_exact and scalar(@{$rec->matches}) == 1 ) {
833                 
834                 # caller says to overlay if there is an /exact/ match
835
836                 my $res = $e->json_query(
837                     {
838                         from => [
839                             $auto_overlay_func,
840                             $rec->id, 
841                             $merge_profile
842                         ]
843                     }
844                 );
845
846                 if($res and ($res = $res->[0])) {
847
848                     if($res->{$auto_overlay_func} eq 't') {
849                         $logger->info("vl: $type auto-overlay succeeded for queued rec " . $rec->id);
850                         $imported = 1;
851                     } else {
852                         $logger->info("vl: $type auto-overlay failed for queued rec " . $rec->id);
853                     }
854
855                 } else {
856                     $error = 1;
857                     $logger->error("vl: Error attempting overlay with func=$auto_overlay_func, profile=$merge_profile, record=$rec_id");
858                 }
859             }
860
861             if(!$imported and !$error) {
862             
863                 # No overlay / merge occurred.  Do a traditional record import by creating a new record
864             
865                 $logger->info("vl: creating new $type record for queued record $rec_id");
866                 if($type eq 'bib') {
867                     $record = OpenILS::Application::Cat::BibCommon->biblio_record_xml_import($e, $rec->marc, $bib_sources{$rec->bib_source});
868                 } else {
869
870                     $record = OpenILS::Application::Cat::AuthCommon->import_authority_record($e, $rec->marc); #$source);
871                 }
872
873                 if($U->event_code($record)) {
874                     my $import_error = 'import.duplicate.tcn' if $record->{textcode} eq 'TCN_EXISTS';
875                     finish_rec_import_attempt(%report_args, import_error => $import_error, evt => $record);
876
877                 } else {
878
879                     $logger->info("vl: successfully imported new $type record");
880                     $rec->imported_as($record->id);
881                     $rec->import_time('now');
882
883                     $imported = 1 if $e->$update_func($rec);
884                 }
885             }
886         }
887
888         if($imported) {
889             push @success_rec_ids, $rec_id;
890             finish_rec_import_attempt(%report_args);
891
892         } else {
893             # Send an update whenever there's an error
894             finish_rec_import_attempt(%report_args, evt => $e->event);
895         }
896     }
897
898     # see if we need to mark any queues as complete
899     for my $q_id (keys %queues) {
900
901         my $e = new_editor(xact => 1);
902         my $remaining = $e->$search_func(
903             [{queue => $q_id, import_time => undef}, {limit =>1}], {idlist => 1});
904
905         unless(@$remaining) {
906             my $queue = $e->$retrieve_queue_func($q_id);
907
908             unless($U->is_true($queue->complete)) {
909                 $queue->complete('t');
910                 $e->$update_queue_func($queue) or return $e->die_event;
911                 $e->commit;
912                 next;
913             }
914         } 
915         $e->rollback;
916     }
917
918     # import the copies
919     import_record_asset_list_impl($conn, \@success_rec_ids, $requestor);
920
921     $conn->respond({total => $report_args{total}, progress => $report_args{progress}});
922     return undef;
923 }
924
925 # tracks any import errors, commits the current xact, responds to the client
926 sub finish_rec_import_attempt {
927     my %args = @_;
928     my $evt = $args{evt};
929     my $rec = $args{rec};
930     my $e = $args{e};
931
932     my $error = $args{import_error};
933     $error = 'general.unknown' if $evt and not $error;
934
935     # error tracking
936     if($rec) {
937
938         if($error or $evt) {
939             # failed import
940             # since an error occurred, there's no guarantee the transaction wasn't 
941             # rolled back.  force a rollback and create a new editor.
942             $e->rollback;
943             $e = new_editor(xact => 1);
944             $rec->import_error($error);
945
946             if($evt) {
947                 my $detail = sprintf("%s : %s", $evt->{textcode}, substr($evt->{desc}, 0, 140));
948                 $rec->error_detail($detail);
949             }
950
951             my $method = 'update_vandelay_queued_bib_record';
952             $method =~ s/bib/authority/ if $args{type} eq 'auth';
953             $e->$method($rec) and $e->commit or $e->rollback;
954
955         } else {
956             # successful import
957             $rec->clear_import_error;
958             $rec->clear_error_detail;
959             $e->commit;
960         }
961
962     } else {
963         # requested queued record was not found
964         $e->rollback;
965     }
966         
967     # respond to client
968     if($args{report_all} or ($args{progress} % $args{step}) == 0) {
969
970         $args{conn}->respond({
971             total => $args{total}, 
972             progress => $args{progress}, 
973             imported => ($rec) ? $rec->id : undef,
974             err_event => $evt
975         });
976
977         # report often at first, climb quickly, then hold steady
978         $args{step} *= 2 unless $args{step} == 256;
979     }
980 }
981
982
983
984
985
986 __PACKAGE__->register_method(  
987     api_name    => "open-ils.vandelay.bib_queue.owner.retrieve",
988     method      => 'owner_queue_retrieve',
989     api_level   => 1,
990     argc        => 2,
991     stream      => 1,
992     record_type => 'bib'
993 );
994 __PACKAGE__->register_method(  
995     api_name    => "open-ils.vandelay.authority_queue.owner.retrieve",
996     method      => 'owner_queue_retrieve',
997     api_level   => 1,
998     argc        => 2,
999     stream      => 1,
1000     record_type => 'auth'
1001 );
1002
1003 sub owner_queue_retrieve {
1004     my($self, $conn, $auth, $owner_id, $filters) = @_;
1005     my $e = new_editor(authtoken => $auth, xact => 1);
1006     return $e->die_event unless $e->checkauth;
1007     $owner_id = $e->requestor->id; # XXX add support for viewing other's queues?
1008     my $queues;
1009     $filters ||= {};
1010     my $search = {owner => $owner_id};
1011     $search->{$_} = $filters->{$_} for keys %$filters;
1012
1013     if($self->{record_type} eq 'bib') {
1014         $queues = $e->search_vandelay_bib_queue(
1015             [$search, {order_by => {vbq => 'evergreen.lowercase(name)'}}]);
1016     } else {
1017         $queues = $e->search_vandelay_authority_queue(
1018             [$search, {order_by => {vaq => 'evergreen.lowercase(name)'}}]);
1019     }
1020     $conn->respond($_) for @$queues;
1021     $e->rollback;
1022     return undef;
1023 }
1024
1025 __PACKAGE__->register_method(  
1026     api_name    => "open-ils.vandelay.bib_queue.delete",
1027     method      => "delete_queue",
1028     api_level   => 1,
1029     argc        => 2,
1030     record_type => 'bib'
1031 );            
1032 __PACKAGE__->register_method(  
1033     api_name    => "open-ils.vandelay.auth_queue.delete",
1034     method      => "delete_queue",
1035     api_level   => 1,
1036     argc        => 2,
1037     record_type => 'auth'
1038 );  
1039
1040 sub delete_queue {
1041     my($self, $conn, $auth, $q_id) = @_;
1042     my $e = new_editor(xact => 1, authtoken => $auth);
1043     return $e->die_event unless $e->checkauth;
1044     if($self->{record_type} eq 'bib') {
1045         return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
1046         my $queue = $e->retrieve_vandelay_bib_queue($q_id)
1047             or return $e->die_event;
1048         $e->delete_vandelay_bib_queue($queue)
1049             or return $e->die_event;
1050     } else {
1051            return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
1052         my $queue = $e->retrieve_vandelay_authority_queue($q_id)
1053             or return $e->die_event;
1054         $e->delete_vandelay_authority_queue($queue)
1055             or return $e->die_event;
1056     }
1057     $e->commit;
1058     return 1;
1059 }
1060
1061
1062 __PACKAGE__->register_method(  
1063     api_name    => "open-ils.vandelay.queued_bib_record.html",
1064     method      => 'queued_record_html',
1065     api_level   => 1,
1066     argc        => 2,
1067     stream      => 1,
1068     record_type => 'bib'
1069 );
1070 __PACKAGE__->register_method(  
1071     api_name    => "open-ils.vandelay.queued_authority_record.html",
1072     method      => 'queued_record_html',
1073     api_level   => 1,
1074     argc        => 2,
1075     stream      => 1,
1076     record_type => 'auth'
1077 );
1078
1079 sub queued_record_html {
1080     my($self, $conn, $auth, $rec_id) = @_;
1081     my $e = new_editor(xact=>1,authtoken => $auth);
1082     return $e->die_event unless $e->checkauth;
1083     my $rec;
1084     if($self->{record_type} eq 'bib') {
1085         $rec = $e->retrieve_vandelay_queued_bib_record($rec_id)
1086             or return $e->die_event;
1087     } else {
1088         $rec = $e->retrieve_vandelay_queued_authority_record($rec_id)
1089             or return $e->die_event;
1090     }
1091
1092     $e->rollback;
1093     return $U->simplereq(
1094         'open-ils.search',
1095         'open-ils.search.biblio.record.html', undef, 1, $rec->marc);
1096 }
1097
1098
1099 __PACKAGE__->register_method(  
1100     api_name    => "open-ils.vandelay.bib_queue.summary.retrieve", 
1101     method      => 'retrieve_queue_summary',
1102     api_level   => 1,
1103     argc        => 2,
1104     stream      => 1,
1105     record_type => 'bib'
1106 );
1107 __PACKAGE__->register_method(  
1108     api_name    => "open-ils.vandelay.auth_queue.summary.retrieve",
1109     method      => 'retrieve_queue_summary',
1110     api_level   => 1,
1111     argc        => 2,
1112     stream      => 1,
1113     record_type => 'auth'
1114 );
1115
1116 sub retrieve_queue_summary {
1117     my($self, $conn, $auth, $queue_id) = @_;
1118     my $e = new_editor(xact=>1, authtoken => $auth);
1119     return $e->die_event unless $e->checkauth;
1120
1121     my $queue;
1122     my $type = $self->{record_type};
1123     if($type eq 'bib') {
1124         $queue = $e->retrieve_vandelay_bib_queue($queue_id)
1125             or return $e->die_event;
1126     } else {
1127         $queue = $e->retrieve_vandelay_authority_queue($queue_id)
1128             or return $e->die_event;
1129     }
1130
1131     my $evt = check_queue_perms($e, $type, $queue);
1132     return $evt if $evt;
1133
1134     my $search = 'search_vandelay_queued_bib_record';
1135     $search =~ s/bib/authority/ if $type ne 'bib';
1136
1137     my $summary = {
1138         queue => $queue,
1139         total => scalar(@{$e->$search({queue => $queue_id}, {idlist=>1})}),
1140         imported => scalar(@{$e->$search({queue => $queue_id, import_time => {'!=' => undef}}, {idlist=>1})}),
1141     };
1142
1143     my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
1144     $summary->{rec_import_errors} = $e->json_query({
1145         select => {$class => [{alias => 'count', column => 'id', transform => 'count', aggregate => 1}]},
1146         from => $class,
1147         where => {queue => $queue_id, import_error => {'!=' => undef}}
1148     })->[0]->{count};
1149
1150     if($type eq 'bib') {
1151         
1152         my $query = {
1153             select => {vii => [{alias => 'count', column => 'id', transform => 'count', aggregate => 1}]},
1154             from => 'vii',
1155             where => {
1156                 record => {
1157                     in => {
1158                         select => {vqbr => ['id']},
1159                         from => 'vqbr',
1160                         where => {queue => $queue_id}
1161                     }
1162                 }
1163             }
1164         };
1165
1166         $summary->{total_items} = $e->json_query($query)->[0]->{count};
1167         $query->{where}->{import_error} = {'!=' => undef};
1168         $summary->{item_import_errors} = $e->json_query($query)->[0]->{count};
1169     }
1170
1171     return $summary;
1172 }
1173
1174 # --------------------------------------------------------------------------------
1175 # Given a list of queued record IDs, imports all items attached to those records
1176 # --------------------------------------------------------------------------------
1177 sub import_record_asset_list_impl {
1178     my($conn, $rec_ids, $requestor) = @_;
1179
1180     my $roe = new_editor(xact=> 1, requestor => $requestor);
1181
1182     my %report_args = (
1183         conn => $conn,
1184         total => scalar(@$rec_ids),
1185         step => 1, # how often to respond
1186         progress => 0,
1187         in_count => 0,
1188     );
1189
1190     for my $rec_id (@$rec_ids) {
1191         my $rec = $roe->retrieve_vandelay_queued_bib_record($rec_id);
1192         next unless $rec and $rec->import_time;
1193         my $item_ids = $roe->search_vandelay_import_item({record => $rec->id}, {idlist=>1});
1194
1195         for my $item_id (@$item_ids) {
1196             my $e = new_editor(requestor => $requestor, xact => 1);
1197             my $item = $e->retrieve_vandelay_import_item($item_id);
1198             $report_args{progress}++;
1199             $report_args{import_item} = $item;
1200             $report_args{e} = $e;
1201
1202             # --------------------------------------------------------------------------------
1203             # Find or create the volume
1204             # --------------------------------------------------------------------------------
1205             my ($vol, $evt) =
1206                 OpenILS::Application::Cat::AssetCommon->find_or_create_volume(
1207                     $e, $item->call_number, $rec->imported_as, $item->owning_lib);
1208
1209             if($evt) {
1210                 respond_with_status(%report_args, evt => $evt);
1211                 next;
1212             }
1213
1214             # --------------------------------------------------------------------------------
1215             # Create the new copy
1216             # --------------------------------------------------------------------------------
1217             my $copy = Fieldmapper::asset::copy->new;
1218             $copy->loan_duration(2);
1219             $copy->fine_level(2);
1220             $copy->barcode($item->barcode);
1221             $copy->location($item->location);
1222             $copy->circ_lib($item->circ_lib || $item->owning_lib);
1223             $copy->status( defined($item->status) ? $item->status : OILS_COPY_STATUS_IN_PROCESS );
1224             $copy->circulate($item->circulate);
1225             $copy->deposit($item->deposit);
1226             $copy->deposit_amount($item->deposit_amount);
1227             $copy->ref($item->ref);
1228             $copy->holdable($item->holdable);
1229             $copy->price($item->price);
1230             $copy->circ_as_type($item->circ_as_type);
1231             $copy->alert_message($item->alert_message);
1232             $copy->opac_visible($item->opac_visible);
1233             $copy->circ_modifier($item->circ_modifier);
1234
1235             # --------------------------------------------------------------------------------
1236             # see if a valid circ_modifier was provided
1237             # --------------------------------------------------------------------------------
1238             if($copy->circ_modifier and not $e->search_config_circ_modifier({code=>$item->circ_modifier})->[0]) {
1239                 respond_with_status(
1240                     %report_args, 
1241                     evt => $e->die_event,
1242                     import_error => 'import.item.invalid.circ_modifier'
1243                 );
1244                 next;
1245             }
1246
1247             if($copy->location and not $e->retrieve_asset_copy_location($copy->location)) {
1248                 respond_with_status(
1249                     %report_args, 
1250                     evt => $e->die_event,
1251                     import_error => 'import.item.invalid.location'
1252                 );
1253                 next;
1254             }
1255
1256             if($evt = OpenILS::Application::Cat::AssetCommon->create_copy($e, $vol, $copy)) {
1257                 respond_with_status(
1258                     %report_args,
1259                     evt => $evt,
1260                     import_error => ($evt->{textcode} eq 'ITEM_BARCODE_EXISTS') ? 
1261                         'import.item.duplicate.barcode' : undef
1262                 );
1263                 next;
1264             }
1265
1266             # --------------------------------------------------------------------------------
1267             # create copy notes
1268             # --------------------------------------------------------------------------------
1269             $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
1270                 $e, $copy, '', $item->pub_note, 1) if $item->pub_note;
1271
1272             if($evt) {
1273                 respond_with_status(%report_args, evt => $evt);
1274                 next;
1275             }
1276
1277             $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
1278                 $e, $copy, '', $item->priv_note, 1) if $item->priv_note;
1279
1280             if($evt) {
1281                 respond_with_status(%report_args, evt => $evt);
1282                 next;
1283             }
1284
1285             # --------------------------------------------------------------------------------
1286             # Item import succeeded
1287             # --------------------------------------------------------------------------------
1288             $e->commit;
1289             $report_args{in_count}++;
1290             respond_with_status(%report_args, imported_as => $copy->id);
1291             $logger->info("vl: successfully imported item " . $item->barcode);
1292         }
1293     }
1294     $roe->rollback;
1295     return undef;
1296 }
1297
1298
1299 sub respond_with_status {
1300     my %args = @_;
1301     my $e = $args{e};
1302
1303     #  If the import failed, track the failure reason
1304
1305     my $error = $args{import_error};
1306     my $evt = $args{evt};
1307
1308     if($error or $evt) {
1309
1310         my $item = $args{import_item};
1311         $logger->info("vl: unable to import item " . $item->barcode);
1312
1313         $error ||= 'general.unknown';
1314         $item->import_error($error);
1315
1316         if($evt) {
1317             my $detail = sprintf("%s : %s", $evt->{textcode}, substr($evt->{desc}, 0, 140));
1318             $item->error_detail($detail);
1319         }
1320
1321         # state of the editor is unknown at this point.  Force a rollback and start over.
1322         $e->rollback;
1323         $e = new_editor(xact => 1);
1324         $e->update_vandelay_import_item($item);
1325         $e->commit;
1326     }
1327
1328     return unless $args{report_all} or ($args{progress} % $args{step}) == 0;
1329     $args{step} *= 2 unless $args{step} == 256;
1330
1331     $args{conn}->respond({
1332         map { $_ => $args{$_} } qw/total progress success_count/,
1333         err_event => $evt
1334     });
1335 }
1336
1337 __PACKAGE__->register_method(  
1338     api_name    => "open-ils.vandelay.match_set.get_tree",
1339     method      => "match_set_get_tree",
1340     api_level   => 1,
1341     argc        => 2,
1342     signature   => {
1343         desc    => q/For a given vms object, return a tree of match set points
1344                     represented by a vmsp object with recursively fleshed
1345                     children./
1346     }
1347 );
1348
1349 sub match_set_get_tree {
1350     my ($self, $conn, $authtoken, $match_set_id) = @_;
1351
1352     $match_set_id = int($match_set_id) or return;
1353
1354     my $e = new_editor("authtoken" => $authtoken);
1355     $e->checkauth or return $e->die_event;
1356
1357     my $set = $e->retrieve_vandelay_match_set($match_set_id) or
1358         return $e->die_event;
1359
1360     $e->allowed("ADMIN_IMPORT_MATCH_SET", $set->owner) or
1361         return $e->die_event;
1362
1363     my $tree = $e->search_vandelay_match_set_point([
1364         {"match_set" => $match_set_id, "parent" => undef},
1365         {"flesh" => -1, "flesh_fields" => {"vmsp" => ["children"]}}
1366     ]) or return $e->die_event;
1367
1368     return pop @$tree;
1369 }
1370
1371
1372 __PACKAGE__->register_method(
1373     api_name    => "open-ils.vandelay.match_set.update",
1374     method      => "match_set_update_tree",
1375     api_level   => 1,
1376     argc        => 3,
1377     signature   => {
1378         desc => q/Replace any vmsp objects associated with a given (by ID) vms
1379                 with the given objects (recursively fleshed vmsp tree)./
1380     }
1381 );
1382
1383 sub _walk_new_vmsp {
1384     my ($e, $match_set_id, $node, $parent_id) = @_;
1385
1386     my $point = new Fieldmapper::vandelay::match_set_point;
1387     $point->parent($parent_id);
1388     $point->match_set($match_set_id);
1389     $point->$_($node->$_) for (qw/bool_op svf tag subfield negate quality/);
1390
1391     $e->create_vandelay_match_set_point($point) or return $e->die_event;
1392
1393     $parent_id = $e->data->id;
1394     if ($node->children && @{$node->children}) {
1395         for (@{$node->children}) {
1396             return $e->die_event if
1397                 _walk_new_vmsp($e, $match_set_id, $_, $parent_id);
1398         }
1399     }
1400
1401     return;
1402 }
1403
1404 sub match_set_update_tree {
1405     my ($self, $conn, $authtoken, $match_set_id, $tree) = @_;
1406
1407     my $e = new_editor("xact" => 1, "authtoken" => $authtoken);
1408     $e->checkauth or return $e->die_event;
1409
1410     my $set = $e->retrieve_vandelay_match_set($match_set_id) or
1411         return $e->die_event;
1412
1413     $e->allowed("ADMIN_IMPORT_MATCH_SET", $set->owner) or
1414         return $e->die_event;
1415
1416     my $existing = $e->search_vandelay_match_set_point([
1417         {"match_set" => $match_set_id},
1418         {"order_by" => {"vmsp" => "id DESC"}}
1419     ]) or return $e->die_event;
1420
1421     foreach (@$existing) {
1422         $e->delete_vandelay_match_set_point($_) or return $e->die_event;
1423     }
1424
1425     _walk_new_vmsp($e, $match_set_id, $tree);
1426
1427     $e->commit or return $e->die_event;
1428 }
1429
1430 1;