]> git.evergreen-ils.org Git - Evergreen.git/blob - Open-ILS/src/perlmods/OpenILS/Application/Vandelay.pm
added method to retrieve fleshed bib/authority records by queue. abstracted out...
[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
6 use Unicode::Normalize;
7 use OpenSRF::EX qw/:try/;
8
9 use OpenSRF::AppSession;
10 use OpenSRF::Utils::SettingsClient;
11 use OpenSRF::Utils::Cache;
12
13 use OpenILS::Utils::Fieldmapper;
14 use OpenILS::Utils::CStoreEditor qw/:funcs/;
15
16 use MARC::Batch;
17 use MARC::Record;
18 use MARC::File::XML;
19
20 use OpenILS::Utils::Fieldmapper;
21
22 use Time::HiRes qw(time);
23
24 use OpenSRF::Utils::Logger qw/$logger/;
25 use MIME::Base64;
26
27 sub initialize {}
28 sub child_init {}
29
30 sub entityize {
31         my $stuff = shift;
32         my $form = shift;
33
34         if ($form eq 'D') {
35                 $stuff = NFD($stuff);
36         } else {
37                 $stuff = NFC($stuff);
38         }
39
40         $stuff =~ s/([\x{0080}-\x{fffd}])/sprintf('&#x%X;',ord($1))/sgoe;
41         return $stuff;
42 }
43
44 # --------------------------------------------------------------------------------
45 # Biblio ingest
46
47 sub create_bib_queue {
48         my $self = shift;
49         my $client = shift;
50         my $auth = shift;
51         my $name = shift;
52         my $owner = shift;
53         my $type = shift;
54
55         my $e = new_editor(authtoken => $auth, xact => 1);
56
57         return $e->die_event unless $e->checkauth;
58         return $e->die_event unless $e->allowed('CREATE_BIB_IMPORT_QUEUE');
59     $owner ||= $e->requestor->id;
60
61         my $queue = new Fieldmapper::vandelay::bib_queue();
62         $queue->name( $name );
63         $queue->owner( $owner );
64         $queue->queue_type( $type ) if ($type);
65
66         my $new_q = $e->create_vandelay_bib_queue( $queue );
67         return $e->die_event unless ($new_q);
68         $e->commit;
69
70     return $new_q;
71 }
72 __PACKAGE__->register_method(  
73         api_name        => "open-ils.vandelay.bib_queue.create",
74         method          => "create_bib_queue",
75         api_level       => 1,
76         argc            => 3,
77 );                      
78
79
80 sub create_auth_queue {
81         my $self = shift;
82         my $client = shift;
83         my $auth = shift;
84         my $name = shift;
85         my $owner = shift;
86         my $type = shift;
87
88         my $e = new_editor(authtoken => $auth, xact => 1);
89
90         return $e->die_event unless $e->checkauth;
91         return $e->die_event unless $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE');
92     $owner ||= $e->requestor->id;
93
94         my $queue = new Fieldmapper::vandelay::authority_queue();
95         $queue->name( $name );
96         $queue->owner( $owner );
97         $queue->queue_type( $type ) if ($type);
98
99         my $new_q = $e->create_vandelay_authority_queue( $queue );
100         $e->die_event unless ($new_q);
101         $e->commit;
102
103     return $new_q;
104 }
105 __PACKAGE__->register_method(  
106         api_name        => "open-ils.vandelay.authority_queue.create",
107         method          => "create_auth_queue",
108         api_level       => 1,
109         argc            => 3,
110 );                      
111
112 sub add_record_to_bib_queue {
113         my $self = shift;
114         my $client = shift;
115         my $auth = shift;
116         my $queue = shift;
117         my $marc = shift;
118         my $purpose = shift;
119
120         my $e = new_editor(authtoken => $auth, xact => 1);
121
122         $queue = $e->retrieve_vandelay_bib_queue($queue);
123
124         return $e->die_event unless $e->checkauth;
125         return $e->die_event unless
126                 ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
127                  $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
128
129         my $new_rec = _add_bib_rec($e, $marc, $queue->id, $purpose);
130
131         return $e->die_event unless ($new_rec);
132         $e->commit;
133     return $new_rec;
134 }
135 __PACKAGE__->register_method(  
136         api_name        => "open-ils.vandelay.queued_bib_record.create",
137         method          => "add_record_to_bib_queue",
138         api_level       => 1,
139         argc            => 3,
140 );                      
141
142 sub _add_bib_rec {
143         my $e = shift;
144         my $marc = shift;
145         my $queue = shift;
146         my $purpose = shift;
147
148         my $rec = new Fieldmapper::vandelay::queued_bib_record();
149         $rec->marc( $marc );
150         $rec->queue( $queue );
151         $rec->purpose( $purpose ) if ($purpose);
152
153         return $e->create_vandelay_queued_bib_record( $rec );
154 }
155
156 sub add_record_to_authority_queue {
157         my $self = shift;
158         my $client = shift;
159         my $auth = shift;
160         my $queue = shift;
161         my $marc = shift;
162         my $purpose = shift;
163
164         my $e = new_editor(authtoken => $auth, xact => 1);
165
166         $queue = $e->retrieve_vandelay_authority_queue($queue);
167
168         return $e->die_event unless $e->checkauth;
169         return $e->die_event unless
170                 ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
171                  $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
172
173         my $new_rec = _add_auth_rec($e, $marc, $queue->id, $purpose);
174
175         return $e->die_event unless ($new_rec);
176         $e->commit;
177     return $new_rec;
178 }
179 __PACKAGE__->register_method(
180         api_name        => "open-ils.vandelay.queued_authority_record.create",
181         method          => "add_record_to_authority_queue",
182         api_level       => 1,
183         argc            => 3,
184 );
185
186 sub _add_auth_rec {
187         my $e = shift;
188         my $marc = shift;
189         my $queue = shift;
190     my $purpose = shift;
191
192         my $rec = new Fieldmapper::vandelay::queued_authority_record();
193         $rec->marc( $marc );
194         $rec->queue( $queue );
195         $rec->purpose( $purpose ) if ($purpose);
196
197         return $e->create_vandelay_queued_authority_record( $rec );
198 }
199
200 sub process_spool {
201         my $self = shift;
202         my $client = shift;
203         my $auth = shift;
204         my $fingerprint = shift;
205         my $queue_id = shift;
206
207         my $e = new_editor(authtoken => $auth, xact => 1);
208     return $e->die_event unless $e->checkauth;
209     my $queue = $e->retrieve_vandelay_queue($queue_id) or return $e->die_event;
210
211     my $type = ($self->api_name =~ /auth/) ? 'auth' : 'bib';
212     my $evt = check_queue_perms($e, $type, $queue);
213     return $evt if $evt;
214
215         my $method = "open-ils.vandelay.queued_${type}_record.create";
216         $method = $self->method_lookup( $method );
217
218     my $cache = new OpenSRF::Utils::Cache();
219
220     my $data = $cache->get_cache('vandelay_import_spool_' . $fingerprint);
221         my $purpose = $data->{purpose};
222     $data = decode_base64($data->{marc});
223
224     $logger->info("vandelay loaded $fingerprint purpose=$purpose and ".length($data)." bytes of data");
225
226     my $fh;
227     open $fh, '<', \$data;
228
229     my $marctype = 'USMARC'; # ?
230         my $batch = new MARC::Batch ( $marctype, $fh );
231         $batch->strict_off;
232
233         my $count = 0;
234         while (my $r = $batch->next) {
235         $logger->info("processing record $count");
236                 try {
237                         (my $xml = $r->as_xml_record()) =~ s/\n//sog;
238                         $xml =~ s/^<\?xml.+\?\s*>//go;
239                         $xml =~ s/>\s+</></go;
240                         $xml =~ s/\p{Cc}//go;
241                         $xml = entityize($xml);
242                         $xml =~ s/[\x00-\x1f]//go;
243
244                         if ($self->{record_type} eq 'bib') {
245                                 _add_bib_rec( $e, $xml, $queue_id, $purpose ) or return $e->die_event;
246                         } else {
247                                 _add_auth_rec( $e, $xml, $queue_id, $purpose ) or return $e->die_event;
248                         }
249                         $count++;
250                         
251                         $client->respond( $count );
252                 } catch Error with {
253                         my $error = shift;
254                         $logger->warn("Encountered a bad record at Vandelay ingest: ".$error);
255                 }
256         }
257
258         $e->commit;
259         return undef;
260 }
261 __PACKAGE__->register_method(  
262         api_name        => "open-ils.vandelay.bib.process_spool",
263         method          => "process_spool",
264         api_level       => 1,
265         argc            => 3,
266         record_type     => 'bib'
267 );                      
268 __PACKAGE__->register_method(  
269         api_name        => "open-ils.vandelay.auth.process_spool",
270         method          => "process_spool",
271         api_level       => 1,
272         argc            => 3,
273         record_type     => 'auth'
274 );                      
275
276
277 __PACKAGE__->register_method(  
278         api_name        => "open-ils.vandelay.bib_queue.records.retrieve",
279         method          => 'retrieve_queue',
280         api_level       => 1,
281         argc            => 2,
282     stream      => 1,
283         record_type     => 'bib'
284 );
285 __PACKAGE__->register_method(  
286         api_name        => "open-ils.vandelay.auth_queue.records.retrieve",
287         method          => 'retrieve_queue',
288         api_level       => 1,
289         argc            => 2,
290     stream      => 1,
291         record_type     => 'auth'
292 );
293
294 sub retrieve_queue {
295     my($self, $conn, $auth, $queue_id, $options) = @_;
296     my $e = new_editor(authtoken => $auth);
297     return $e->event unless $e->checkauth;
298
299     my $queue = $e->retrieve_vandelay_bib_queue($queue_id) or return $e->event;
300     my $type = $self->{record_type};
301     my $evt = check_queue_perms($e, $type, $queue);
302     return $evt if $evt;
303
304     if($type eq 'bib') {
305         my $record_ids = $e->search_vandelay_queued_bib_record({queue => $queue_id}, {idlist => 1});
306         for my $rec_id (@$record_ids) {
307             my $rec = $e->retrieve_vandelay_queued_bib_record([
308                 $rec_id,
309                 {   flesh => 1,
310                     flesh_fields => {vqbr => ['attributes']}
311                 }
312             ]);
313             $rec->clear_marc if $$options{clear_marc};
314             $conn->respond($rec);
315         }
316     } else {
317         my $record_ids = $e->search_vandelay_queued_authority_record({queue => $queue_id}, {idlist => 1});
318         for my $rec_id (@$record_ids) {
319             for my $rec_id (@$record_ids) {
320                 my $rec = $e->retrieve_vandelay_queued_bib_record([
321                     $rec_id,
322                     {   flesh => 1,
323                         flesh_fields => {vqar => ['attributes']}
324                     }
325                 ]);
326                 $rec->clear_marc if $$options{clear_marc};
327                 $conn->respond($rec);
328             }
329         }
330     }
331     return undef;
332 }
333
334 sub check_queue_perms {
335     my($e, $type, $queue) = @_;
336         if ($type eq 'bib') {
337                 return $e->die_event unless
338                         ($e->allowed('CREATE_BIB_IMPORT_QUEUE', undef, $queue) ||
339                          $e->allowed('CREATE_BIB_IMPORT_QUEUE'));
340         } else {
341                 return $e->die_event unless
342                         ($e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE', undef, $queue) ||
343                          $e->allowed('CREATE_AUTHORITY_IMPORT_QUEUE'));
344         }
345
346     return undef;
347 }
348
349
350 1;
351