]> git.evergreen-ils.org Git - Evergreen.git/blob - Open-ILS/src/perlmods/lib/OpenILS/Application/Vandelay.pm
add error and item import/error summary info to queue summary api call
[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     $query->{where}->{import_error} = {'!=' => undef} if $$options{with_rec_import_error};
434
435     if($$options{with_item_import_error} and $type eq 'bib') {
436         # limit to recs that have at least 1 item import error
437         $query->{from} = {
438             $class => {
439                 vii => {
440                     field => 'record',
441                     fkey => 'id',
442                     filter => {import_error => {'!=' => undef}}
443                 }
444             }
445         };
446     }
447
448     if($self->api_name =~ /matches/) {
449         # find only records that have matches
450         my $mclass = $type eq 'bib' ? 'vbm' : 'vam';
451         $query->{from} = {$class => {$mclass => {type => 'right'}}};
452     } 
453
454     my $record_ids = $e->json_query($query);
455
456     my $retrieve = ($type eq 'bib') ? 
457         'retrieve_vandelay_queued_bib_record' : 'retrieve_vandelay_queued_authority_record';
458
459     for my $rec_id (@$record_ids) {
460         my $flesh = ['attributes', 'matches'];
461         push(@$flesh, 'import_items') if $$options{flesh_import_items};
462         my $params = {flesh => 1, flesh_fields => {$class => $flesh}};
463         my $rec = $e->$retrieve([$rec_id->{id}, $params]);
464         $rec->clear_marc if $$options{clear_marc};
465         $conn->respond($rec);
466     }
467
468     $e->rollback;
469     return undef;
470 }
471
472 __PACKAGE__->register_method(  
473     api_name    => 'open-ils.vandelay.import_item.queue.retrieve',
474     method      => 'retrieve_queue_import_items',
475     api_level   => 1,
476     argc        => 2,
477     stream      => 1,
478     authoritative => 1,
479     signature => q/
480         Returns Import Item (vii) objects for the selected queue.
481         Filter options:
482             with_import_error : only return items that failed to import
483     /
484 );
485
486 sub retrieve_queue_import_items {
487     my($self, $conn, $auth, $q_id, $options) = @_;
488
489     $options ||= {};
490     my $limit = $$options{limit} || 20;
491     my $offset = $$options{offset} || 0;
492
493     my $e = new_editor(authtoken => $auth);
494     return $e->event unless $e->checkauth;
495
496     my $queue = $e->retrieve_vandelay_bib_queue($q_id) or return $e->event;
497     my $evt = check_queue_perms($e, 'bib', $queue);
498     return $evt if $evt;
499
500     my $query = {
501         select => {vii => ['id']},
502         from => {
503             vii => {
504                 vqbr => {
505                     join => {
506                         'vbq' => {
507                             field => 'id',
508                             fkey => 'queue',
509                             filter => {id => $q_id}
510                         }
511                     }
512                 }
513             }
514         },
515         order_by => {'vii' => ['record','id']}
516     };
517
518     $query->{where} = {'+vii' => {import_error => {'!=' => undef}}}
519         if $$options{with_import_error};
520
521     my $items = $e->json_query($query);
522     for my $item (@$items) {
523         $conn->respond($e->retrieve_vandelay_import_item($item->{id}));
524     }
525
526     return undef;
527 }
528
529 sub check_queue_perms {
530     my($e, $type, $queue) = @_;
531     if ($type eq 'bib') {
532         return $e->die_event unless
533             ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
534              $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
535     } else {
536         return $e->die_event unless
537             ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
538              $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
539     }
540
541     return undef;
542 }
543
544 __PACKAGE__->register_method(  
545     api_name    => "open-ils.vandelay.bib_record.list.import",
546     method      => 'import_record_list',
547     api_level   => 1,
548     argc        => 2,
549     stream      => 1,
550     record_type => 'bib'
551 );
552
553 __PACKAGE__->register_method(  
554     api_name    => "open-ils.vandelay.auth_record.list.import",
555     method      => 'import_record_list',
556     api_level   => 1,
557     argc        => 2,
558     stream      => 1,
559     record_type => 'auth'
560 );
561
562 sub import_record_list {
563     my($self, $conn, $auth, $rec_ids, $args) = @_;
564     my $e = new_editor(authtoken => $auth, xact => 1);
565     return $e->die_event unless $e->checkauth;
566     $args ||= {};
567     my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $args);
568     $e->rollback;
569     return $err if $err;
570     return {complete => 1};
571 }
572
573
574 __PACKAGE__->register_method(  
575     api_name    => "open-ils.vandelay.bib_queue.import",
576     method      => 'import_queue',
577     api_level   => 1,
578     argc        => 2,
579     stream      => 1,
580     max_chunk_size => 0,
581     record_type => 'bib'
582 );
583
584 __PACKAGE__->register_method(  
585     api_name    => "open-ils.vandelay.auth_queue.import",
586     method      => 'import_queue',
587     api_level   => 1,
588     argc        => 2,
589     stream      => 1,
590     max_chunk_size => 0,
591     record_type => 'auth'
592 );
593 __PACKAGE__->register_method(  
594     api_name    => "open-ils.vandelay.bib_queue.nomatch.import",
595     method      => 'import_queue',
596     api_level   => 1,
597     argc        => 2,
598     stream      => 1,
599     signature   => {
600         desc => q/Only import records that have no collisions/
601     },
602     max_chunk_size => 0,
603     record_type => 'bib'
604 );
605
606 __PACKAGE__->register_method(  
607     api_name    => "open-ils.vandelay.auth_queue.nomatch.import",
608     method      => 'import_queue',
609     api_level   => 1,
610     argc        => 2,
611     stream      => 1,
612     signature   => {
613         desc => q/Only import records that have no collisions/
614     },
615     max_chunk_size => 0,
616     record_type => 'auth'
617 );
618 sub import_queue {
619     my($self, $conn, $auth, $q_id, $options) = @_;
620     my $e = new_editor(authtoken => $auth, xact => 1);
621     return $e->die_event unless $e->checkauth;
622     $options ||= {};
623     my $type = $self->{record_type};
624     my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
625
626     my $query = {queue => $q_id, import_time => undef};
627
628     if($self->api_name =~ /nomatch/) {
629         my $matched_recs = queued_records_with_matches($e, $type, $q_id, undef, undef, {import_time => undef});
630         $query->{id} = {'not in' => $matched_recs} if @$matched_recs;
631     }
632
633     my $search = ($type eq 'bib') ? 
634         'search_vandelay_queued_bib_record' : 'search_vandelay_queued_authority_record';
635     my $rec_ids = $e->$search($query, {idlist => 1});
636     my $err = import_record_list_impl($self, $conn, $rec_ids, $e->requestor, $options);
637     try {$e->rollback} otherwise {}; # only using this to make the read authoritative -- don't die from it
638     return $err if $err;
639     return {complete => 1};
640 }
641
642 # returns a list of queued record IDs for a given queue that 
643 # have at least one entry in the match table
644 sub queued_records_with_matches {
645     my($e, $type, $q_id, $limit, $offset, $filter) = @_;
646
647     my $match_class = 'vbm';
648     my $rec_class = 'vqbr';
649     if($type eq 'auth') {
650         $match_class = 'vam';
651          $rec_class = 'vqar';
652     }
653
654     $filter ||= {};
655     $filter->{queue} = $q_id;
656
657     my $query = {
658         distinct => 1, 
659         select => {$match_class => ['queued_record']}, 
660         from => {
661             $match_class => {
662                 $rec_class => {
663                     field => 'id',
664                     fkey => 'queued_record',
665                     filter => $filter,
666                 }
667             }
668         }
669     };        
670
671     if($limit or defined $offset) {
672         $limit ||= 20;
673         $offset ||= 0;
674         $query->{limit} = $limit;
675         $query->{offset} = $offset;
676     }
677
678     my $data = $e->json_query($query);
679     return [ map {$_->{queued_record}} @$data ];
680 }
681
682
683 sub import_record_list_impl {
684     my($self, $conn, $rec_ids, $requestor, $args) = @_;
685
686     my $overlay_map = $args->{overlay_map} || {};
687     my $type = $self->{record_type};
688     my %queues;
689
690     my %report_args = (
691         progress => 0,
692         step => 1,
693         conn => $conn,
694         total => scalar(@$rec_ids),
695         report_all => $$args{report_all}
696     );
697
698     my $auto_overlay_exact = $$args{auto_overlay_exact};
699     my $auto_overlay_1match = $$args{auto_overlay_1match};
700     my $merge_profile = $$args{merge_profile};
701     my $bib_source = $$args{bib_source};
702
703     my $overlay_func = 'vandelay.overlay_bib_record';
704     my $auto_overlay_func = 'vandelay.auto_overlay_bib_record';
705     my $retrieve_func = 'retrieve_vandelay_queued_bib_record';
706     my $update_func = 'update_vandelay_queued_bib_record';
707     my $search_func = 'search_vandelay_queued_bib_record';
708     my $retrieve_queue_func = 'retrieve_vandelay_bib_queue';
709     my $update_queue_func = 'update_vandelay_bib_queue';
710     my $rec_class = 'vqbr';
711
712     my $editor = new_editor();
713
714     my %bib_sources;
715     my $sources = $editor->search_config_bib_source({id => {'!=' => undef}});
716     $bib_sources{$_->id} = $_->source for @$sources;
717
718     if($type eq 'auth') {
719         $overlay_func =~ s/bib/auth/o;
720         $auto_overlay_func = s/bib/auth/o;
721         $retrieve_func =~ s/bib/authority/o;
722         $retrieve_queue_func =~ s/bib/authority/o;
723         $update_queue_func =~ s/bib/authority/o;
724         $update_func =~ s/bib/authority/o;
725         $search_func =~ s/bib/authority/o;
726         $rec_class = 'vqar';
727     }
728
729     my @success_rec_ids;
730     for my $rec_id (@$rec_ids) {
731
732         my $error = 0;
733         my $overlay_target = $overlay_map->{$rec_id};
734
735         my $e = new_editor(xact => 1);
736         $e->requestor($requestor);
737
738         $report_args{progress}++;
739         $report_args{e} = $e;
740
741         my $rec = $e->$retrieve_func([
742             $rec_id,
743             {   flesh => 1,
744                 flesh_fields => { $rec_class => ['matches']},
745             }
746         ]);
747
748         unless($rec) {
749             finish_rec_import_attempt(%report_args, evt => $e->event);
750             next;
751         }
752
753         $report_args{rec} = $rec;
754
755         if($rec->import_time) {
756             $e->rollback;
757             next;
758         }
759
760         $queues{$rec->queue} = 1;
761
762         my $record;
763         my $imported = 0;
764
765         if(defined $overlay_target) {
766             # Caller chose an explicit overlay target
767
768             my $res = $e->json_query(
769                 {
770                     from => [
771                         $overlay_func,
772                         $rec->id, 
773                         $overlay_target, 
774                         $merge_profile
775                     ]
776                 }
777             );
778
779             if($res and ($res = $res->[0])) {
780
781                 if($res->{$overlay_func} eq 't') {
782                     $logger->info("vl: $type direct overlay succeeded for queued rec " . 
783                         $rec->id . " and overlay target $overlay_target");
784                     $imported = 1;
785                 }
786
787             } else {
788                 $error = 1;
789                 $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
790             }
791
792         } else {
793
794             if($auto_overlay_1match) { 
795                 # caller says to overlay if there is exactly 1 match
796
797                 my %match_recs = map { $_->eg_record => 1 } @{$rec->matches};
798
799                 if( scalar(keys %match_recs) == 1) { # all matches point to the same record
800
801                     my $res = $e->json_query(
802                         {
803                             from => [
804                                 $overlay_func,
805                                 $rec->id, 
806                                 $rec->matches->[0]->eg_record,
807                                 $merge_profile
808                             ]
809                         }
810                     );
811
812                     if($res and ($res = $res->[0])) {
813     
814                         if($res->{$overlay_func} eq 't') {
815                             $logger->info("vl: $type overlay-1match succeeded for queued rec " . $rec->id);
816                             $imported = 1;
817                         }
818
819                     } else {
820                         $error = 1;
821                         $logger->error("vl: Error attempting overlay with func=$overlay_func, profile=$merge_profile, record=$rec_id");
822                     }
823                 }
824             }
825
826             if(!$imported and !$error and $auto_overlay_exact and scalar(@{$rec->matches}) == 1 ) {
827                 
828                 # caller says to overlay if there is an /exact/ match
829
830                 my $res = $e->json_query(
831                     {
832                         from => [
833                             $auto_overlay_func,
834                             $rec->id, 
835                             $merge_profile
836                         ]
837                     }
838                 );
839
840                 if($res and ($res = $res->[0])) {
841
842                     if($res->{$auto_overlay_func} eq 't') {
843                         $logger->info("vl: $type auto-overlay succeeded for queued rec " . $rec->id);
844                         $imported = 1;
845                     } else {
846                         $logger->info("vl: $type auto-overlay failed for queued rec " . $rec->id);
847                     }
848
849                 } else {
850                     $error = 1;
851                     $logger->error("vl: Error attempting overlay with func=$auto_overlay_func, profile=$merge_profile, record=$rec_id");
852                 }
853             }
854
855             if(!$imported and !$error) {
856             
857                 # No overlay / merge occurred.  Do a traditional record import by creating a new record
858             
859                 $logger->info("vl: creating new $type record for queued record $rec_id");
860                 if($type eq 'bib') {
861                     $record = OpenILS::Application::Cat::BibCommon->biblio_record_xml_import($e, $rec->marc, $bib_sources{$rec->bib_source});
862                 } else {
863
864                     $record = OpenILS::Application::Cat::AuthCommon->import_authority_record($e, $rec->marc); #$source);
865                 }
866
867                 if($U->event_code($record)) {
868                     my $import_error = 'import.duplicate.tcn' if $record->{textcode} eq 'TCN_EXISTS';
869                     finish_rec_import_attempt(%report_args, import_error => $import_error, evt => $record);
870
871                 } else {
872
873                     $logger->info("vl: successfully imported new $type record");
874                     $rec->imported_as($record->id);
875                     $rec->import_time('now');
876
877                     $imported = 1 if $e->$update_func($rec);
878                 }
879             }
880         }
881
882         if($imported) {
883             push @success_rec_ids, $rec_id;
884             finish_rec_import_attempt(%report_args);
885
886         } else {
887             # Send an update whenever there's an error
888             finish_rec_import_attempt(%report_args, evt => $e->event);
889         }
890     }
891
892     # see if we need to mark any queues as complete
893     for my $q_id (keys %queues) {
894
895         my $e = new_editor(xact => 1);
896         my $remaining = $e->$search_func(
897             [{queue => $q_id, import_time => undef}, {limit =>1}], {idlist => 1});
898
899         unless(@$remaining) {
900             my $queue = $e->$retrieve_queue_func($q_id);
901
902             unless($U->is_true($queue->complete)) {
903                 $queue->complete('t');
904                 $e->$update_queue_func($queue) or return $e->die_event;
905                 $e->commit;
906                 next;
907             }
908         } 
909         $e->rollback;
910     }
911
912     # import the copies
913     import_record_asset_list_impl($conn, \@success_rec_ids, $requestor);
914
915     $conn->respond({total => $report_args{total}, progress => $report_args{progress}});
916     return undef;
917 }
918
919 # tracks any import errors, commits the current xact, responds to the client
920 sub finish_rec_import_attempt {
921     my %args = @_;
922     my $evt = $args{evt};
923     my $rec = $args{rec};
924     my $e = $args{e};
925
926     my $error = $args{import_error};
927     $error = 'general.unknown' if $evt and not $error;
928
929     # error tracking
930     if($rec) {
931
932         if($error or $evt) {
933             # failed import
934             # since an error occurred, there's no guarantee the transaction wasn't 
935             # rolled back.  force a rollback and create a new editor.
936             $e->rollback;
937             $e = new_editor(xact => 1);
938             $rec->import_error($error);
939
940             if($evt) {
941                 my $detail = sprintf("%s : %s", $evt->{textcode}, substr($evt->{desc}, 0, 140));
942                 $rec->error_detail($detail);
943             }
944
945             my $method = 'update_vandelay_queued_bib_record';
946             $method =~ s/bib/authority/ if $args{type} eq 'auth';
947             $e->$method($rec) and $e->commit or $e->rollback;
948
949         } else {
950             # successful import
951             $rec->clear_import_error;
952             $rec->clear_error_detail;
953             $e->commit;
954         }
955
956     } else {
957         # requested queued record was not found
958         $e->rollback;
959     }
960         
961     # respond to client
962     if($args{report_all} or ($args{progress} % $args{step}) == 0) {
963
964         $args{conn}->respond({
965             total => $args{total}, 
966             progress => $args{progress}, 
967             imported => ($rec) ? $rec->id : undef,
968             err_event => $evt
969         });
970
971         # report often at first, climb quickly, then hold steady
972         $args{step} *= 2 unless $args{step} == 256;
973     }
974 }
975
976
977
978
979
980 __PACKAGE__->register_method(  
981     api_name    => "open-ils.vandelay.bib_queue.owner.retrieve",
982     method      => 'owner_queue_retrieve',
983     api_level   => 1,
984     argc        => 2,
985     stream      => 1,
986     record_type => 'bib'
987 );
988 __PACKAGE__->register_method(  
989     api_name    => "open-ils.vandelay.authority_queue.owner.retrieve",
990     method      => 'owner_queue_retrieve',
991     api_level   => 1,
992     argc        => 2,
993     stream      => 1,
994     record_type => 'auth'
995 );
996
997 sub owner_queue_retrieve {
998     my($self, $conn, $auth, $owner_id, $filters) = @_;
999     my $e = new_editor(authtoken => $auth, xact => 1);
1000     return $e->die_event unless $e->checkauth;
1001     $owner_id = $e->requestor->id; # XXX add support for viewing other's queues?
1002     my $queues;
1003     $filters ||= {};
1004     my $search = {owner => $owner_id};
1005     $search->{$_} = $filters->{$_} for keys %$filters;
1006
1007     if($self->{record_type} eq 'bib') {
1008         $queues = $e->search_vandelay_bib_queue(
1009             [$search, {order_by => {vbq => 'evergreen.lowercase(name)'}}]);
1010     } else {
1011         $queues = $e->search_vandelay_authority_queue(
1012             [$search, {order_by => {vaq => 'evergreen.lowercase(name)'}}]);
1013     }
1014     $conn->respond($_) for @$queues;
1015     $e->rollback;
1016     return undef;
1017 }
1018
1019 __PACKAGE__->register_method(  
1020     api_name    => "open-ils.vandelay.bib_queue.delete",
1021     method      => "delete_queue",
1022     api_level   => 1,
1023     argc        => 2,
1024     record_type => 'bib'
1025 );            
1026 __PACKAGE__->register_method(  
1027     api_name    => "open-ils.vandelay.auth_queue.delete",
1028     method      => "delete_queue",
1029     api_level   => 1,
1030     argc        => 2,
1031     record_type => 'auth'
1032 );  
1033
1034 sub delete_queue {
1035     my($self, $conn, $auth, $q_id) = @_;
1036     my $e = new_editor(xact => 1, authtoken => $auth);
1037     return $e->die_event unless $e->checkauth;
1038     if($self->{record_type} eq 'bib') {
1039         return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
1040         my $queue = $e->retrieve_vandelay_bib_queue($q_id)
1041             or return $e->die_event;
1042         $e->delete_vandelay_bib_queue($queue)
1043             or return $e->die_event;
1044     } else {
1045            return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
1046         my $queue = $e->retrieve_vandelay_authority_queue($q_id)
1047             or return $e->die_event;
1048         $e->delete_vandelay_authority_queue($queue)
1049             or return $e->die_event;
1050     }
1051     $e->commit;
1052     return 1;
1053 }
1054
1055
1056 __PACKAGE__->register_method(  
1057     api_name    => "open-ils.vandelay.queued_bib_record.html",
1058     method      => 'queued_record_html',
1059     api_level   => 1,
1060     argc        => 2,
1061     stream      => 1,
1062     record_type => 'bib'
1063 );
1064 __PACKAGE__->register_method(  
1065     api_name    => "open-ils.vandelay.queued_authority_record.html",
1066     method      => 'queued_record_html',
1067     api_level   => 1,
1068     argc        => 2,
1069     stream      => 1,
1070     record_type => 'auth'
1071 );
1072
1073 sub queued_record_html {
1074     my($self, $conn, $auth, $rec_id) = @_;
1075     my $e = new_editor(xact=>1,authtoken => $auth);
1076     return $e->die_event unless $e->checkauth;
1077     my $rec;
1078     if($self->{record_type} eq 'bib') {
1079         $rec = $e->retrieve_vandelay_queued_bib_record($rec_id)
1080             or return $e->die_event;
1081     } else {
1082         $rec = $e->retrieve_vandelay_queued_authority_record($rec_id)
1083             or return $e->die_event;
1084     }
1085
1086     $e->rollback;
1087     return $U->simplereq(
1088         'open-ils.search',
1089         'open-ils.search.biblio.record.html', undef, 1, $rec->marc);
1090 }
1091
1092
1093 __PACKAGE__->register_method(  
1094     api_name    => "open-ils.vandelay.bib_queue.summary.retrieve", 
1095     method      => 'retrieve_queue_summary',
1096     api_level   => 1,
1097     argc        => 2,
1098     stream      => 1,
1099     record_type => 'bib'
1100 );
1101 __PACKAGE__->register_method(  
1102     api_name    => "open-ils.vandelay.auth_queue.summary.retrieve",
1103     method      => 'retrieve_queue_summary',
1104     api_level   => 1,
1105     argc        => 2,
1106     stream      => 1,
1107     record_type => 'auth'
1108 );
1109
1110 sub retrieve_queue_summary {
1111     my($self, $conn, $auth, $queue_id) = @_;
1112     my $e = new_editor(xact=>1, authtoken => $auth);
1113     return $e->die_event unless $e->checkauth;
1114
1115     my $queue;
1116     my $type = $self->{record_type};
1117     if($type eq 'bib') {
1118         $queue = $e->retrieve_vandelay_bib_queue($queue_id)
1119             or return $e->die_event;
1120     } else {
1121         $queue = $e->retrieve_vandelay_authority_queue($queue_id)
1122             or return $e->die_event;
1123     }
1124
1125     my $evt = check_queue_perms($e, $type, $queue);
1126     return $evt if $evt;
1127
1128     my $search = 'search_vandelay_queued_bib_record';
1129     $search =~ s/bib/authority/ if $type ne 'bib';
1130
1131     my $summary = {
1132         queue => $queue,
1133         total => scalar(@{$e->$search({queue => $queue_id}, {idlist=>1})}),
1134         imported => scalar(@{$e->$search({queue => $queue_id, import_time => {'!=' => undef}}, {idlist=>1})}),
1135     };
1136
1137     my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
1138     $summary->{rec_import_errors} = $e->json_query({
1139         select => {$class => [{alias => 'count', column => 'id', transform => 'count', aggregate => 1}]},
1140         from => $class,
1141         where => {queue => $queue_id, import_error => {'!=' => undef}}
1142     })->[0]->{count};
1143
1144     if($type eq 'bib') {
1145         
1146         my $query = {
1147             select => {vii => [{alias => 'count', column => 'id', transform => 'count', aggregate => 1}]},
1148             from => 'vii',
1149             where => {
1150                 record => {
1151                     in => {
1152                         select => {vqbr => ['id']},
1153                         from => 'vqbr',
1154                         where => {queue => $queue_id}
1155                     }
1156                 }
1157             }
1158         };
1159
1160         $summary->{total_items} = $e->json_query($query)->[0]->{count};
1161         $query->{where}->{import_error} = {'!=' => undef};
1162         $summary->{item_import_errors} = $e->json_query($query)->[0]->{count};
1163     }
1164
1165     return $summary;
1166 }
1167
1168 # --------------------------------------------------------------------------------
1169 # Given a list of queued record IDs, imports all items attached to those records
1170 # --------------------------------------------------------------------------------
1171 sub import_record_asset_list_impl {
1172     my($conn, $rec_ids, $requestor) = @_;
1173
1174     my $roe = new_editor(xact=> 1, requestor => $requestor);
1175
1176     my %report_args = (
1177         conn => $conn,
1178         total => scalar(@$rec_ids),
1179         step => 1, # how often to respond
1180         progress => 0,
1181         in_count => 0,
1182     );
1183
1184     for my $rec_id (@$rec_ids) {
1185         my $rec = $roe->retrieve_vandelay_queued_bib_record($rec_id);
1186         next unless $rec and $rec->import_time;
1187         my $item_ids = $roe->search_vandelay_import_item({record => $rec->id}, {idlist=>1});
1188
1189         for my $item_id (@$item_ids) {
1190             my $e = new_editor(requestor => $requestor, xact => 1);
1191             my $item = $e->retrieve_vandelay_import_item($item_id);
1192             $report_args{progress}++;
1193             $report_args{import_item} = $item;
1194             $report_args{e} = $e;
1195
1196             # --------------------------------------------------------------------------------
1197             # Find or create the volume
1198             # --------------------------------------------------------------------------------
1199             my ($vol, $evt) =
1200                 OpenILS::Application::Cat::AssetCommon->find_or_create_volume(
1201                     $e, $item->call_number, $rec->imported_as, $item->owning_lib);
1202
1203             if($evt) {
1204                 respond_with_status(%report_args, evt => $evt);
1205                 next;
1206             }
1207
1208             # --------------------------------------------------------------------------------
1209             # Create the new copy
1210             # --------------------------------------------------------------------------------
1211             my $copy = Fieldmapper::asset::copy->new;
1212             $copy->loan_duration(2);
1213             $copy->fine_level(2);
1214             $copy->barcode($item->barcode);
1215             $copy->location($item->location);
1216             $copy->circ_lib($item->circ_lib || $item->owning_lib);
1217             $copy->status( defined($item->status) ? $item->status : OILS_COPY_STATUS_IN_PROCESS );
1218             $copy->circulate($item->circulate);
1219             $copy->deposit($item->deposit);
1220             $copy->deposit_amount($item->deposit_amount);
1221             $copy->ref($item->ref);
1222             $copy->holdable($item->holdable);
1223             $copy->price($item->price);
1224             $copy->circ_as_type($item->circ_as_type);
1225             $copy->alert_message($item->alert_message);
1226             $copy->opac_visible($item->opac_visible);
1227             $copy->circ_modifier($item->circ_modifier);
1228
1229             # --------------------------------------------------------------------------------
1230             # see if a valid circ_modifier was provided
1231             # --------------------------------------------------------------------------------
1232             if($copy->circ_modifier and not $e->search_config_circ_modifier({code=>$item->circ_modifier})->[0]) {
1233                 respond_with_status(
1234                     %report_args, 
1235                     evt => $e->die_event,
1236                     import_error => 'import.item.invalid.circ_modifier'
1237                 );
1238                 next;
1239             }
1240
1241             if($copy->location and not $e->retrieve_asset_copy_location($copy->location)) {
1242                 respond_with_status(
1243                     %report_args, 
1244                     evt => $e->die_event,
1245                     import_error => 'import.item.invalid.location'
1246                 );
1247                 next;
1248             }
1249
1250             if($evt = OpenILS::Application::Cat::AssetCommon->create_copy($e, $vol, $copy)) {
1251                 respond_with_status(
1252                     %report_args,
1253                     evt => $evt,
1254                     import_error => ($evt->{textcode} eq 'ITEM_BARCODE_EXISTS') ? 
1255                         'import.item.duplicate.barcode' : undef
1256                 );
1257                 next;
1258             }
1259
1260             # --------------------------------------------------------------------------------
1261             # create copy notes
1262             # --------------------------------------------------------------------------------
1263             $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
1264                 $e, $copy, '', $item->pub_note, 1) if $item->pub_note;
1265
1266             if($evt) {
1267                 respond_with_status(%report_args, evt => $evt);
1268                 next;
1269             }
1270
1271             $evt = OpenILS::Application::Cat::AssetCommon->create_copy_note(
1272                 $e, $copy, '', $item->priv_note, 1) if $item->priv_note;
1273
1274             if($evt) {
1275                 respond_with_status(%report_args, evt => $evt);
1276                 next;
1277             }
1278
1279             # --------------------------------------------------------------------------------
1280             # Item import succeeded
1281             # --------------------------------------------------------------------------------
1282             $e->commit;
1283             $report_args{in_count}++;
1284             respond_with_status(%report_args, imported_as => $copy->id);
1285             $logger->info("vl: successfully imported item " . $item->barcode);
1286         }
1287     }
1288     $roe->rollback;
1289     return undef;
1290 }
1291
1292
1293 sub respond_with_status {
1294     my %args = @_;
1295     my $e = $args{e};
1296
1297     #  If the import failed, track the failure reason
1298
1299     my $error = $args{import_error};
1300     my $evt = $args{evt};
1301
1302     if($error or $evt) {
1303
1304         my $item = $args{import_item};
1305         $logger->info("vl: unable to import item " . $item->barcode);
1306
1307         $error ||= 'general.unknown';
1308         $item->import_error($error);
1309
1310         if($evt) {
1311             my $detail = sprintf("%s : %s", $evt->{textcode}, substr($evt->{desc}, 0, 140));
1312             $item->error_detail($detail);
1313         }
1314
1315         # state of the editor is unknown at this point.  Force a rollback and start over.
1316         $e->rollback;
1317         $e = new_editor(xact => 1);
1318         $e->update_vandelay_import_item($item);
1319         $e->commit;
1320     }
1321
1322     return unless $args{report_all} or ($args{progress} % $args{step}) == 0;
1323     $args{step} *= 2 unless $args{step} == 256;
1324
1325     $args{conn}->respond({
1326         map { $_ => $args{$_} } qw/total progress success_count/,
1327         err_event => $evt
1328     });
1329 }
1330
1331 __PACKAGE__->register_method(  
1332     api_name    => "open-ils.vandelay.match_set.get_tree",
1333     method      => "match_set_get_tree",
1334     api_level   => 1,
1335     argc        => 2,
1336     signature   => {
1337         desc    => q/For a given vms object, return a tree of match set points
1338                     represented by a vmsp object with recursively fleshed
1339                     children./
1340     }
1341 );
1342
1343 sub match_set_get_tree {
1344     my ($self, $conn, $authtoken, $match_set_id) = @_;
1345
1346     $match_set_id = int($match_set_id) or return;
1347
1348     my $e = new_editor("authtoken" => $authtoken);
1349     $e->checkauth or return $e->die_event;
1350
1351     my $set = $e->retrieve_vandelay_match_set($match_set_id) or
1352         return $e->die_event;
1353
1354     $e->allowed("ADMIN_IMPORT_MATCH_SET", $set->owner) or
1355         return $e->die_event;
1356
1357     my $tree = $e->search_vandelay_match_set_point([
1358         {"match_set" => $match_set_id, "parent" => undef},
1359         {"flesh" => -1, "flesh_fields" => {"vmsp" => ["children"]}}
1360     ]) or return $e->die_event;
1361
1362     return pop @$tree;
1363 }
1364
1365
1366 __PACKAGE__->register_method(
1367     api_name    => "open-ils.vandelay.match_set.update",
1368     method      => "match_set_update_tree",
1369     api_level   => 1,
1370     argc        => 3,
1371     signature   => {
1372         desc => q/Replace any vmsp objects associated with a given (by ID) vms
1373                 with the given objects (recursively fleshed vmsp tree)./
1374     }
1375 );
1376
1377 sub _walk_new_vmsp {
1378     my ($e, $match_set_id, $node, $parent_id) = @_;
1379
1380     my $point = new Fieldmapper::vandelay::match_set_point;
1381     $point->parent($parent_id);
1382     $point->match_set($match_set_id);
1383     $point->$_($node->$_) for (qw/bool_op svf tag subfield negate quality/);
1384
1385     $e->create_vandelay_match_set_point($point) or return $e->die_event;
1386
1387     $parent_id = $e->data->id;
1388     if ($node->children && @{$node->children}) {
1389         for (@{$node->children}) {
1390             return $e->die_event if
1391                 _walk_new_vmsp($e, $match_set_id, $_, $parent_id);
1392         }
1393     }
1394
1395     return;
1396 }
1397
1398 sub match_set_update_tree {
1399     my ($self, $conn, $authtoken, $match_set_id, $tree) = @_;
1400
1401     my $e = new_editor("xact" => 1, "authtoken" => $authtoken);
1402     $e->checkauth or return $e->die_event;
1403
1404     my $set = $e->retrieve_vandelay_match_set($match_set_id) or
1405         return $e->die_event;
1406
1407     $e->allowed("ADMIN_IMPORT_MATCH_SET", $set->owner) or
1408         return $e->die_event;
1409
1410     my $existing = $e->search_vandelay_match_set_point([
1411         {"match_set" => $match_set_id},
1412         {"order_by" => {"vmsp" => "id DESC"}}
1413     ]) or return $e->die_event;
1414
1415     foreach (@$existing) {
1416         $e->delete_vandelay_match_set_point($_) or return $e->die_event;
1417     }
1418
1419     _walk_new_vmsp($e, $match_set_id, $tree);
1420
1421     $e->commit or return $e->die_event;
1422 }
1423
1424 1;