d11fd2117a9fecc0bd6c801d73cc5470673484fe
[Evergreen.git] / Open-ILS / src / perlmods / 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;
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::Application::AppUtils;
20 use OpenILS::Application::Cat::BibCommon;
21 use OpenILS::Application::Cat::AuthCommon;
22 my $U = 'OpenILS::Application::AppUtils';
23
24 sub initialize {}
25 sub child_init {}
26
27 # --------------------------------------------------------------------------------
28 # Biblio ingest
29
30 sub create_bib_queue {
31         my $self = shift;
32         my $client = shift;
33         my $auth = shift;
34         my $name = shift;
35         my $owner = shift;
36         my $type = shift;
37
38         my $e = new_editor(authtoken => $auth, xact => 1);
39
40         return $e->die_event unless $e->checkauth;
41         return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
42     $owner ||= $e->requestor->id;
43
44     return OpenILS::Event->new('BIB_QUEUE_EXISTS') 
45         if $e->search_vandelay_bib_queue(
46             {name => $name, owner => $owner, queue_type => $type})->[0];
47
48         my $queue = new Fieldmapper::vandelay::bib_queue();
49         $queue->name( $name );
50         $queue->owner( $owner );
51         $queue->queue_type( $type ) if ($type);
52
53         my $new_q = $e->create_vandelay_bib_queue( $queue );
54         return $e->die_event unless ($new_q);
55         $e->commit;
56
57     return $new_q;
58 }
59 __PACKAGE__->register_method(  
60         api_name        => "open-ils.vandelay.bib_queue.create",
61         method          => "create_bib_queue",
62         api_level       => 1,
63         argc            => 3,
64 );                      
65
66
67 sub create_auth_queue {
68         my $self = shift;
69         my $client = shift;
70         my $auth = shift;
71         my $name = shift;
72         my $owner = shift;
73         my $type = shift;
74
75         my $e = new_editor(authtoken => $auth, xact => 1);
76
77         return $e->die_event unless $e->checkauth;
78         return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
79     $owner ||= $e->requestor->id;
80
81     return OpenILS::Event->new('AUTH_QUEUE_EXISTS') 
82         if $e->search_vandelay_bib_queue(
83             {name => $name, owner => $owner, queue_type => $type})->[0];
84
85         my $queue = new Fieldmapper::vandelay::authority_queue();
86         $queue->name( $name );
87         $queue->owner( $owner );
88         $queue->queue_type( $type ) if ($type);
89
90         my $new_q = $e->create_vandelay_authority_queue( $queue );
91         $e->die_event unless ($new_q);
92         $e->commit;
93
94     return $new_q;
95 }
96 __PACKAGE__->register_method(  
97         api_name        => "open-ils.vandelay.authority_queue.create",
98         method          => "create_auth_queue",
99         api_level       => 1,
100         argc            => 3,
101 );                      
102
103 sub add_record_to_bib_queue {
104         my $self = shift;
105         my $client = shift;
106         my $auth = shift;
107         my $queue = shift;
108         my $marc = shift;
109         my $purpose = shift;
110
111         my $e = new_editor(authtoken => $auth, xact => 1);
112
113         $queue = $e->retrieve_vandelay_bib_queue($queue);
114
115         return $e->die_event unless $e->checkauth;
116         return $e->die_event unless
117                 ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
118                  $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
119
120         my $new_rec = _add_bib_rec($e, $marc, $queue->id, $purpose);
121
122         return $e->die_event unless ($new_rec);
123         $e->commit;
124     return $new_rec;
125 }
126 __PACKAGE__->register_method(  
127         api_name        => "open-ils.vandelay.queued_bib_record.create",
128         method          => "add_record_to_bib_queue",
129         api_level       => 1,
130         argc            => 3,
131 );                      
132
133 sub _add_bib_rec {
134         my $e = shift;
135         my $marc = shift;
136         my $queue = shift;
137         my $purpose = shift;
138
139         my $rec = new Fieldmapper::vandelay::queued_bib_record();
140         $rec->marc( $marc );
141         $rec->queue( $queue );
142         $rec->purpose( $purpose ) if ($purpose);
143
144         return $e->create_vandelay_queued_bib_record( $rec );
145 }
146
147 sub add_record_to_authority_queue {
148         my $self = shift;
149         my $client = shift;
150         my $auth = shift;
151         my $queue = shift;
152         my $marc = shift;
153         my $purpose = shift;
154
155         my $e = new_editor(authtoken => $auth, xact => 1);
156
157         $queue = $e->retrieve_vandelay_authority_queue($queue);
158
159         return $e->die_event unless $e->checkauth;
160         return $e->die_event unless
161                 ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
162                  $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
163
164         my $new_rec = _add_auth_rec($e, $marc, $queue->id, $purpose);
165
166         return $e->die_event unless ($new_rec);
167         $e->commit;
168     return $new_rec;
169 }
170 __PACKAGE__->register_method(
171         api_name        => "open-ils.vandelay.queued_authority_record.create",
172         method          => "add_record_to_authority_queue",
173         api_level       => 1,
174         argc            => 3,
175 );
176
177 sub _add_auth_rec {
178         my $e = shift;
179         my $marc = shift;
180         my $queue = shift;
181     my $purpose = shift;
182
183         my $rec = new Fieldmapper::vandelay::queued_authority_record();
184         $rec->marc( $marc );
185         $rec->queue( $queue );
186         $rec->purpose( $purpose ) if ($purpose);
187
188         return $e->create_vandelay_queued_authority_record( $rec );
189 }
190
191 sub process_spool {
192         my $self = shift;
193         my $client = shift;
194         my $auth = shift;
195         my $fingerprint = shift;
196         my $queue_id = shift;
197
198         my $e = new_editor(authtoken => $auth, xact => 1);
199     return $e->die_event unless $e->checkauth;
200
201     my $queue;
202     my $type = $self->{record_type};
203
204     if($type eq 'bib') {
205         $queue = $e->retrieve_vandelay_bib_queue($queue_id) or return $e->die_event;
206     } else {
207         $queue = $e->retrieve_vandelay_authority_queue($queue_id) or return $e->die_event;
208     }
209
210     my $evt = check_queue_perms($e, $type, $queue);
211     return $evt if $evt;
212
213         my $method = "open-ils.vandelay.queued_${type}_record.create";
214         $method = $self->method_lookup( $method );
215
216     my $cache = new OpenSRF::Utils::Cache();
217
218     my $data = $cache->get_cache('vandelay_import_spool_' . $fingerprint);
219         my $purpose = $data->{purpose};
220     $data = decode_base64($data->{marc});
221
222     $logger->info("vandelay loaded $fingerprint purpose=$purpose and ".length($data)." bytes of data");
223
224     my $fh;
225     open $fh, '<', \$data;
226
227     my $marctype = 'USMARC'; # ?
228         my $batch = new MARC::Batch ( $marctype, $fh );
229         $batch->strict_off;
230
231         my $count = 0;
232         while (my $r = $batch->next) {
233         $logger->info("processing record $count");
234                 try {
235                         (my $xml = $r->as_xml_record()) =~ s/\n//sog;
236                         $xml =~ s/^<\?xml.+\?\s*>//go;
237                         $xml =~ s/>\s+</></go;
238                         $xml =~ s/\p{Cc}//go;
239                         $xml = $U->entityize($xml);
240                         $xml =~ s/[\x00-\x1f]//go;
241
242                         if ($type eq 'bib') {
243                                 _add_bib_rec( $e, $xml, $queue_id, $purpose ) or return $e->die_event;
244                         } else {
245                                 _add_auth_rec( $e, $xml, $queue_id, $purpose ) or return $e->die_event;
246                         }
247                         $count++;
248                         
249                         $client->respond( $count );
250                 } catch Error with {
251                         my $error = shift;
252                         $logger->warn("Encountered a bad record at Vandelay ingest: ".$error);
253                 }
254         }
255
256         $e->commit;
257         return undef;
258 }
259 __PACKAGE__->register_method(  
260         api_name        => "open-ils.vandelay.bib.process_spool",
261         method          => "process_spool",
262         api_level       => 1,
263         argc            => 3,
264         record_type     => 'bib'
265 );                      
266 __PACKAGE__->register_method(  
267         api_name        => "open-ils.vandelay.auth.process_spool",
268         method          => "process_spool",
269         api_level       => 1,
270         argc            => 3,
271         record_type     => 'auth'
272 );                      
273
274
275 __PACKAGE__->register_method(  
276         api_name        => "open-ils.vandelay.bib_queue.records.retrieve",
277         method          => 'retrieve_queue',
278         api_level       => 1,
279         argc            => 2,
280     stream      => 1,
281         record_type     => 'bib'
282 );
283 __PACKAGE__->register_method(  
284         api_name        => "open-ils.vandelay.auth_queue.records.retrieve",
285         method          => 'retrieve_queue',
286         api_level       => 1,
287         argc            => 2,
288     stream      => 1,
289         record_type     => 'auth'
290 );
291
292 __PACKAGE__->register_method(  
293         api_name        => "open-ils.vandelay.bib_queue.records.matches.retrieve",
294         method          => 'retrieve_queue',
295         api_level       => 1,
296         argc            => 2,
297     stream      => 1,
298         record_type     => 'bib',
299     signature   => {
300         desc => q/Only retrieve queued bib records that have matches against existing records/
301     }
302 );
303 __PACKAGE__->register_method(  
304         api_name        => "open-ils.vandelay.auth_queue.records.matches.retrieve",
305         method          => 'retrieve_queue',
306         api_level       => 1,
307         argc            => 2,
308     stream      => 1,
309         record_type     => 'auth',
310     signature   => {
311         desc => q/Only retrieve queued authority records that have matches against existing records/
312     }
313
314 );
315
316 sub retrieve_queue {
317     my($self, $conn, $auth, $queue_id, $options) = @_;
318     my $e = new_editor(authtoken => $auth);
319     return $e->event unless $e->checkauth;
320     $options ||= {};
321     my $limit = $$options{limit} || 20;
322     my $offset = $$options{offset} || 0;
323
324     my $type = $self->{record_type};
325     my $queue;
326     if($type eq 'bib') {
327         $queue = $e->retrieve_vandelay_bib_queue($queue_id) or return $e->die_event;
328     } else {
329         $queue = $e->retrieve_vandelay_authority_queue($queue_id) or return $e->die_event;
330     }
331     my $evt = check_queue_perms($e, $type, $queue);
332     return $evt if $evt;
333
334     my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
335     my $search = ($type eq 'bib') ? 
336         'search_vandelay_queued_bib_record' : 'search_vandelay_queued_authority_record';
337     my $retrieve = ($type eq 'bib') ? 
338         'retrieve_vandelay_queued_bib_record' : 'retrieve_vandelay_queued_authority_record';
339
340     my $record_ids;
341     if($self->api_name =~ /matches/) {
342         # fetch only matched records
343         $record_ids = queued_records_with_matches($e, $type, $queue_id, $limit, $offset);
344     } else {
345         # fetch all queue records
346         $record_ids = $e->$search([
347                 {queue => $queue_id}, 
348                 {order_by => {$class => 'id'}, limit => $limit, offset => $offset}
349             ],
350             {idlist => 1}
351         );
352     }
353
354
355     for my $rec_id (@$record_ids) {
356         my $params = {   
357             flesh => 1,
358             flesh_fields => {$class => ['attributes', 'matches']},
359         };
360         my $rec = $e->$retrieve([$rec_id, $params]);
361         $rec->clear_marc if $$options{clear_marc};
362         $conn->respond($rec);
363     }
364     return undef;
365 }
366
367 sub check_queue_perms {
368     my($e, $type, $queue) = @_;
369         if ($type eq 'bib') {
370                 return $e->die_event unless
371                         ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
372                          $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
373         } else {
374                 return $e->die_event unless
375                         ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
376                          $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
377         }
378
379     return undef;
380 }
381
382 __PACKAGE__->register_method(  
383         api_name        => "open-ils.vandelay.bib_record.list.import",
384         method          => 'import_record_list',
385         api_level       => 1,
386         argc            => 2,
387     stream      => 1,
388         record_type     => 'bib'
389 );
390
391 __PACKAGE__->register_method(  
392         api_name        => "open-ils.vandelay.auth_record.list.import",
393         method          => 'import_record_list',
394         api_level       => 1,
395         argc            => 2,
396     stream      => 1,
397         record_type     => 'auth'
398 );
399
400 sub import_record_list {
401     my($self, $conn, $auth, $rec_ids, $args) = @_;
402     my $e = new_editor(xact => 1, authtoken => $auth);
403     return $e->die_event unless $e->checkauth;
404     $args ||= {};
405     my $err = import_record_list_impl($self, $conn, $auth, $e, $rec_ids, $args);
406     return $err if $err;
407     $e->commit;
408     return {complete => 1};
409 }
410
411
412 __PACKAGE__->register_method(  
413         api_name        => "open-ils.vandelay.bib_queue.import",
414         method          => 'import_queue',
415         api_level       => 1,
416         argc            => 2,
417     stream      => 1,
418         record_type     => 'bib'
419 );
420
421 __PACKAGE__->register_method(  
422         api_name        => "open-ils.vandelay.auth_queue.import",
423         method          => 'import_queue',
424         api_level       => 1,
425         argc            => 2,
426     stream      => 1,
427         record_type     => 'auth'
428 );
429 __PACKAGE__->register_method(  
430         api_name        => "open-ils.vandelay.bib_queue.nomatch.import",
431         method          => 'import_queue',
432         api_level       => 1,
433         argc            => 2,
434     stream      => 1,
435     signature   => {
436         desc => q/Only import records that have no collisions/
437     },
438         record_type     => 'bib'
439 );
440
441 __PACKAGE__->register_method(  
442         api_name        => "open-ils.vandelay.auth_queue.nomatch.import",
443         method          => 'import_queue',
444         api_level       => 1,
445         argc            => 2,
446     stream      => 1,
447     signature   => {
448         desc => q/Only import records that have no collisions/
449     },
450         record_type     => 'auth'
451 );
452 sub import_queue {
453     my($self, $conn, $auth, $q_id, $options) = @_;
454     my $e = new_editor(xact => 1, authtoken => $auth);
455     return $e->die_event unless $e->checkauth;
456     $options ||= {};
457     my $type = $self->{record_type};
458     my $class = ($type eq 'bib') ? 'vqbr' : 'vqar';
459
460     my $query = {queue => $q_id, import_time => undef};
461
462     if($self->api_name =~ /nomatch/) {
463         my $matched_recs = queued_records_with_matches($e, $type, $q_id, undef, undef, {import_time => undef});
464         $query->{id} = {'not in' => $matched_recs} if @$matched_recs;
465     }
466
467     my $search = ($type eq 'bib') ? 
468         'search_vandelay_queued_bib_record' : 'search_vandelay_queued_authority_record';
469     my $rec_ids = $e->$search($query, {idlist => 1});
470     my $err = import_record_list_impl($self, $conn, $auth, $e, $rec_ids, $options);
471     return $err if $err;
472     $e->commit;
473     return {complete => 1};
474 }
475
476
477 # returns a list of queued record IDs for a given queue that 
478 # have at least one entry in the match table
479 sub queued_records_with_matches {
480     my($e, $type, $q_id, $limit, $offset, $filter) = @_;
481
482     my $match_class = 'vbm';
483     my $rec_class = 'vqbr';
484     if($type eq 'auth') {
485         $match_class = 'vam';
486          $rec_class = 'vqar';
487     }
488
489     $filter ||= {};
490     $filter->{queue} = $q_id;
491
492     my $query = {
493         distinct => 1, 
494         select => {$match_class => ['queued_record']}, 
495         from => {
496             $match_class => {
497                 $rec_class => {
498                     field => 'id',
499                     fkey => 'queued_record',
500                     filter => $filter,
501                 }
502             }
503         }
504     };        
505
506     if($limit or defined $offset) {
507         $limit ||= 20;
508         $offset ||= 0;
509         $query->{limit} = $limit;
510         $query->{offset} = $offset;
511     }
512
513     my $data = $e->json_query($query);
514     return [ map {$_->{queued_record}} @$data ];
515 }
516
517 sub import_record_list_impl {
518     my($self, $conn, $auth, $e, $rec_ids, $args) = @_;
519
520     my $overlay_map = $args->{overlay_map} || {};
521     my $type = $self->{record_type};
522     my $total = @$rec_ids;
523     my $count = 0;
524     my %queues;
525
526     for my $rec_id (@$rec_ids) {
527
528         my $overlay_target = $overlay_map->{$rec_id};
529
530         if($type eq 'bib') {
531
532             my $rec = $e->retrieve_vandelay_queued_bib_record($rec_id) 
533                 or return $e->die_event;
534
535             next if $rec->import_time;
536             $queues{$rec->queue} = 1;
537
538             my $record;
539             if(defined $overlay_target) {
540                 $logger->info("vl: overlaying record $overlay_target");
541                 $record = OpenILS::Application::Cat::BibCommon->biblio_record_replace_marc(
542                     $e, $overlay_target, $rec->marc); #$rec->bib_source
543             } else {
544                 $logger->info("vl: importing new record");
545                 $record = OpenILS::Application::Cat::BibCommon->biblio_record_xml_import(
546                     $e, $rec->marc); #$rec->bib_source
547             }
548
549             return $record if $U->event_code($record);
550             $rec->imported_as($record->id);
551             $rec->import_time('now');
552             $e->update_vandelay_queued_bib_record($rec) or return $e->die_event;
553
554         } else { # authority
555
556             my $rec = $e->retrieve_vandelay_queued_authority_record($rec_id) 
557                 or return $e->die_event;
558
559             next if $rec->import_time;
560             $queues{$rec->queue} = 1;
561
562             my $record;
563             if(defined $overlay_target) {
564                 $logger->info("vl: overlaying record $overlay_target");
565                 $record = OpenILS::Utils::Cat::AuthCommon->overlay_authority_record(
566                     $overlay_target, $rec->marc); #$source);
567             } else {
568                 $logger->info("vl: importing new record");
569                 $record = OpenILS::Utils::Cat::AuthCommon->import_authority_record(
570                     $rec->marc) #$source);
571             }
572
573             return $record if $U->event_code($record);
574             $rec->imported_as($record->id);
575             $rec->import_time('now');
576             $e->update_vandelay_queued_authority_record($rec) or return $e->die_event;
577         }
578
579         $conn->respond({total => $total, progress => ++$count, imported => $rec_id});
580     }
581
582     # see if we need to mark any queues as complete
583     for my $q_id (keys %queues) {
584         if($type eq 'bib') {
585             my $remaining = $e->search_vandelay_queued_bib_record(
586                 {queue => $q_id, import_time => undef}, {idlist => 1});
587             unless(@$remaining) {
588                 my $queue = $e->retrieve_vandelay_bib_queue($q_id);
589                 unless($U->is_true($queue->complete)) {
590                     $queue->complete('t');
591                     $e->update_vandelay_bib_queue($queue) or return $e->die_event;
592                 }
593             }
594         } else {
595             my $remaining = $e->search_vandelay_queued_authority_record(
596                 {queue => $q_id, import_time => undef}, {idlist => 1});
597             unless(@$remaining) {
598                 my $queue = $e->retrieve_vandelay_authority_queue($q_id);
599                 unless($U->is_true($queue->complete)) {
600                     $queue->complete('t');
601                     $e->update_vandelay_authority_queue($queue) or return $e->die_event;
602                 }
603             }
604         }
605     }
606
607     return undef;
608 }
609
610
611 __PACKAGE__->register_method(  
612         api_name        => "open-ils.vandelay.bib_queue.owner.retrieve",
613         method          => 'owner_queue_retrieve',
614         api_level       => 1,
615         argc            => 2,
616     stream      => 1,
617         record_type     => 'bib'
618 );
619 __PACKAGE__->register_method(  
620         api_name        => "open-ils.vandelay.authority_queue.owner.retrieve",
621         method          => 'owner_queue_retrieve',
622         api_level       => 1,
623         argc            => 2,
624     stream      => 1,
625         record_type     => 'auth'
626 );
627
628 sub owner_queue_retrieve {
629     my($self, $conn, $auth, $owner_id) = @_;
630     my $e = new_editor(authtoken => $auth);
631     return $e->die_event unless $e->checkauth;
632     $owner_id = $e->requestor->id; # XXX add support for viewing other's queues?
633     my $queues;
634     if($self->{record_type} eq 'bib') {
635         $queues = $e->search_vandelay_bib_queue(
636             {complete => 'f', owner => $owner_id});
637     } else {
638         $queues = $e->search_vandelay_authority_queue(
639             {complete => 'f', owner => $owner_id});
640     }
641     $conn->respond($_) for @$queues;
642     return undef;
643 }
644
645 __PACKAGE__->register_method(  
646         api_name        => "open-ils.vandelay.bib_queue.delete",
647         method          => "delete_queue",
648         api_level       => 1,
649         argc            => 2,
650         record_type     => 'bib'
651 );            
652 __PACKAGE__->register_method(  
653         api_name        => "open-ils.vandelay.auth_queue.delete",
654         method          => "delete_queue",
655         api_level       => 1,
656         argc            => 2,
657         record_type     => 'auth'
658 );  
659
660 sub delete_queue {
661     my($self, $conn, $auth, $q_id) = @_;
662     my $e = new_editor(xact => 1, authtoken => $auth);
663     return $e->die_event unless $e->checkauth;
664     if($self->{record_type} eq 'bib') {
665             return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
666         my $queue = $e->retrieve_vandelay_bib_queue($q_id)
667             or return $e->die_event;
668         $e->delete_vandelay_bib_queue($queue)
669             or return $e->die_event;
670     } else {
671             return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
672         my $queue = $e->retrieve_vandelay_authority_queue($q_id)
673             or return $e->die_event;
674         $e->delete_vandelay_authority_queue($queue)
675             or return $e->die_event;
676     }
677     $e->commit;
678     return 1;
679 }
680
681 1;