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