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