make in-db authoritative, but allow config file values as well
[Evergreen.git] / Open-ILS / src / perlmods / OpenILS / Application / Search / Z3950.pm
1 package OpenILS::Application::Search::Z3950;
2 use strict; use warnings;
3 use base qw/OpenILS::Application/;
4
5 use OpenILS::Utils::ZClient;
6 use MARC::Record;
7 use MARC::File::XML;
8 use Unicode::Normalize;
9 use XML::LibXML;
10 use Data::Dumper;
11
12 use OpenILS::Event;
13 use OpenSRF::EX qw(:try);
14 use OpenILS::Utils::ModsParser;
15 use OpenSRF::Utils::SettingsClient;
16 use OpenILS::Application::AppUtils;
17 use OpenSRF::Utils::Logger qw/$logger/;
18 use OpenILS::Utils::CStoreEditor q/:funcs/;
19
20 my $output      = "usmarc"; 
21 my $U = 'OpenILS::Application::AppUtils'; 
22
23 my $sclient;
24 my %services;
25 my $default_service;
26
27
28 __PACKAGE__->register_method(
29         method          => 'do_class_search',
30         api_name                => 'open-ils.search.z3950.search_class',
31         stream          => 1,
32         signature       => q/
33                 Performs a class based Z search.  The classes available
34                 are defined by the 'attr' fields in the config for the
35                 requested service.
36                 @param auth The login session key
37                 @param shash The search hash : { attr : value, attr2: value, ...}
38                 @param service The service to connect to
39                 @param username The username to use when connecting to the service
40                 @param password The password to use when connecting to the service
41         /
42 );
43
44 __PACKAGE__->register_method(
45         method          => 'do_service_search',
46         api_name                => 'open-ils.search.z3950.search_service',
47         signature       => q/
48                 @param auth The login session key
49                 @param query The Z3950 search string to use
50                 @param service The service to connect to
51                 @param username The username to use when connecting to the service
52                 @param password The password to use when connecting to the service
53         /
54 );
55
56
57 __PACKAGE__->register_method(
58         method          => 'do_service_search',
59         api_name                => 'open-ils.search.z3950.search_raw',
60         signature       => q/
61                 @param auth The login session key
62                 @param args An object of search params which must include:
63                         host, port, db and query.  
64                         optional fields include username and password
65         /
66 );
67
68
69 __PACKAGE__->register_method(
70         method  => "query_services",
71         api_name        => "open-ils.search.z3950.retrieve_services",
72         signature       => q/
73                 Returns a list of service names that we have config
74                 data for
75         /
76 );
77
78
79
80 # -------------------------------------------------------------------
81 # What services do we have config info for?
82 # -------------------------------------------------------------------
83 sub query_services {
84         my( $self, $client, $auth ) = @_;
85         my $e = new_editor(authtoken=>$auth);
86         return $e->event unless $e->checkauth;
87         return $e->event unless $e->allowed('REMOTE_Z3950_QUERY');
88
89     my $hash = $sclient->config_value('z3950', 'services');
90
91     # overlay config file values with in-db values
92     if($e->can('search_config_z3950_source')) {
93
94         my $sources = $e->search_config_z3950_source(
95             [ { name => { '!=' => undef } },
96               { flesh => 1, flesh_fields => { czs => ['attrs'] } } ]
97         );
98
99         for my $s ( @$sources ) {
100             $$hash{ $s->name } = {
101                 name => $s->name,
102                 label => $s->label,
103                 host => $s->host,
104                 port => $s->port,
105                 db => $s->db,
106                 record_format => $s->record_format,
107                 transmission_format => $s->transmission_format,
108                 auth => $s->auth,
109             };
110
111             for my $a ( @{ $s->attrs } ) {
112                 $$hash{ $a->source }{attrs}{ $a->name } = {
113                     name => $a->name,
114                     label => $a->label,
115                     code => $a->code,
116                     format => $a->format,
117                     source => $a->source,
118                     truncation => $a->truncation,
119                 };
120             }
121         }
122     }
123
124     return $hash;
125 }
126
127
128
129 # -------------------------------------------------------------------
130 # Load the pre-defined Z server configs
131 # -------------------------------------------------------------------
132 sub initialize {
133         $sclient = OpenSRF::Utils::SettingsClient->new();
134         $default_service = $sclient->config_value("z3950", "default" );
135         my $servs = $sclient->config_value("z3950", "services" );
136         $services{$_} = $$servs{$_} for keys %$servs;
137 }
138
139
140 # -------------------------------------------------------------------
141 # High-level class based search. 
142 # -------------------------------------------------------------------
143 sub do_class_search {
144
145         my $self                        = shift;
146         my $conn                        = shift;
147         my $auth                        = shift;
148         my $args                        = shift;
149
150         if (!ref($$args{service})) {
151                 $$args{service} = [$$args{service}];
152                 $$args{username} = [$$args{username}];
153                 $$args{password} = [$$args{password}];
154         }
155
156         $$args{async} = 1;
157
158         my @connections;
159         my @results;
160     my @services; 
161         for (my $i = 0; $i < @{$$args{service}}; $i++) {
162                 my %tmp_args = %$args;
163                 $tmp_args{service} = $$args{service}[$i];
164                 $tmp_args{username} = $$args{username}[$i];
165                 $tmp_args{password} = $$args{password}[$i];
166
167                 $logger->debug("z3950: service: $tmp_args{service}, async: $tmp_args{async}");
168
169         if ($tmp_args{service} eq 'native-evergreen-catalog') { 
170             my $method = $self->method_lookup('open-ils.search.biblio.zstyle'); 
171             $conn->respond( 
172                 $self->method_lookup('open-ils.search.biblio.zstyle')->run($auth, \%tmp_args) 
173             ); 
174
175         } else { 
176
177             $tmp_args{query} = compile_query('and', $tmp_args{service}, $tmp_args{search}); 
178     
179             my $res = do_service_search( $self, $conn, $auth, \%tmp_args ); 
180     
181             if ($U->event_code($res)) { 
182                 $conn->respond($res) if $U->event_code($res); 
183
184             } else { 
185                 push @services, $tmp_args{service}; 
186                 push @results, $res->{result}; 
187                 push @connections, $res->{connection}; 
188             } 
189         }
190
191                 $logger->debug("z3950: Result object: $results[$i], Connection object: $connections[$i]");
192         }
193
194         $logger->debug("z3950: Connections created");
195
196     return undef unless (@connections);
197         my @records;
198
199     # local catalog search is not processed with other z39 results;
200     $$args{service} = [grep {$_ ne 'native-evergreen-catalog'} @{$$args{service}}];
201
202         while ((my $index = OpenILS::Utils::ZClient::event( \@connections )) != 0) {
203                 my $ev = $connections[$index - 1]->last_event();
204                 $logger->debug("z3950: Received event $ev");
205                 if ($ev == OpenILS::Utils::ZClient::EVENT_END()) {
206                         my $munged = process_results( $results[$index - 1], $$args{limit}, $$args{offset}, $$args{service}[$index -1] );
207                         $$munged{service} = $$args{service}[$index - 1];
208                         $conn->respond($munged);
209                 }
210         }
211
212         $logger->debug("z3950: Search Complete");
213     return undef;
214 }
215
216
217 # -------------------------------------------------------------------
218 # This handles the host settings, but expects a fully formed z query
219 # -------------------------------------------------------------------
220 sub do_service_search {
221
222         my $self                        = shift;
223         my $conn                        = shift;
224         my $auth                        = shift;
225         my $args                        = shift;
226         
227         my $info = $services{$$args{service}};
228
229         $$args{host}    = $$info{host};
230         $$args{port}    = $$info{port};
231         $$args{db}              = $$info{db};
232     $logger->debug("z3950: do_search...");
233
234         return do_search( $self, $conn, $auth, $args );
235 }
236
237
238
239 # -------------------------------------------------------------------
240 # This is the low level search method.  All config and query
241 # data must be provided to this method
242 # -------------------------------------------------------------------
243 sub do_search {
244
245         my $self        = shift;
246         my $conn        = shift;
247         my $auth = shift;
248         my $args = shift;
249
250         my $host                = $$args{host} or return undef;
251         my $port                = $$args{port} or return undef;
252         my $db          = $$args{db}    or return undef;
253         my $query       = $$args{query} or return undef;
254         my $async       = $$args{async} || 0;
255
256         my $limit       = $$args{limit} || 10;
257         my $offset      = $$args{offset} || 0;
258
259         my $username = $$args{username} || "";
260         my $password = $$args{password} || "";
261
262     my $tformat = $services{$args->{service}}->{transmission_format} || $output;
263
264         my $editor = new_editor(authtoken => $auth);
265         return $editor->event unless $editor->checkauth;
266         return $editor->event unless $editor->allowed('REMOTE_Z3950_QUERY');
267
268     $logger->info("z3950: connecting to server $host:$port:$db as $username");
269
270         my $connection = OpenILS::Utils::ZClient->new(
271                 $host, $port,
272                 databaseName                            => $db, 
273                 user                                                    => $username,
274                 password                                                => $password,
275                 async                                                   => $async,
276                 preferredRecordSyntax   => $tformat, 
277         );
278
279         if( ! $connection ) {
280                 $logger->error("z3950: Unable to connect to Z server: ".
281                         "$host:$port:$db:$username:$password");
282                 return OpenILS::Event->new('Z3950_LOGIN_FAILED') unless $connection;
283         }
284
285         my $start = time;
286         my $results;
287         my $err;
288
289         $logger->info("z3950: query => $query");
290
291         try {
292                 $results = $connection->search_pqf( $query );
293         } catch Error with { $err = shift; };
294
295         return OpenILS::Event->new(
296                 'Z3950_BAD_QUERY', payload => $query, debug => "$err") if $err;
297
298         return OpenILS::Event->new('Z3950_SEARCH_FAILED', 
299                 debug => $connection->errcode." => ".$connection->errmsg." : query = $query") unless $results;
300
301         $logger->info("z3950: search [$query] took ".(time - $start)." seconds");
302
303         return {result => $results, connection => $connection} if ($async);
304
305         my $munged = process_results($results, $limit, $offset, $$args{service});
306         $munged->{query} = $query;
307
308         return $munged;
309 }
310
311
312 # -------------------------------------------------------------------
313 # Takes a result batch and returns the hitcount and a list of xml
314 # and mvr objects
315 # -------------------------------------------------------------------
316 sub process_results {
317         my $results     = shift;
318         my $limit       = shift || 10;
319         my $offset      = shift || 0;
320     my $service = shift;
321
322     my $rformat = $services{$service}->{record_format};
323     my $tformat = $services{$service}->{transmission_format} || $output;
324
325     $results->option(elementSetName => $rformat);
326     $results->option(preferredRecordSyntax => $tformat);
327     $logger->info("z3950: using record format '$rformat' and transmission format '$tformat'");
328
329         my @records;
330         my $res = {};
331         my $count = $$res{count} = $results->size;
332
333         $logger->info("z3950: search returned $count hits");
334
335         my $tend = $limit + $offset;
336
337         my $end = ($tend <= $count) ? $tend : $count;
338
339         for($offset..$end - 1) {
340
341                 my $err;
342                 my $mods;
343                 my $marc;
344                 my $marcs;
345                 my $marcxml;
346
347                 $logger->info("z3950: fetching record $_");
348
349                 try {
350
351                         my $rec = $results->record($_);
352
353             if ($tformat eq 'usmarc') {
354                         $marc           = MARC::Record->new_from_usmarc($rec->raw());
355             } elsif ($tformat eq 'xml') {
356                         $marc           = MARC::Record->new_from_xml($rec->raw());
357             } else {
358                 die "Unsupported record transmission format $tformat"
359             }
360
361                         $marcs  = entityize($marc->as_xml_record);
362                         my $doc = XML::LibXML->new->parse_string($marcs);
363                         $marcxml = entityize( $doc->documentElement->toString );
364         
365                         my $u = OpenILS::Utils::ModsParser->new();
366                         $u->start_mods_batch( $marcxml );
367                         $mods = $u->finish_mods_batch();
368         
369
370                 } catch Error with { $err = shift; };
371
372                 push @records, { 'mvr' => $mods, 'marcxml' => $marcxml } unless $err;
373                 $logger->error("z3950: bad XML : $err") if $err;
374
375                 if( $err ) {
376                         warn "\n\n$marcs\n\n";
377                 }
378         }
379         
380         $res->{records} = \@records;
381         return $res;
382 }
383
384
385
386 # -------------------------------------------------------------------
387 # Compiles the class based search query
388 # -------------------------------------------------------------------
389 sub compile_query {
390
391         my $seperator   = shift;
392         my $service             = shift;
393         my $hash                        = shift;
394
395         my $count = scalar(keys %$hash);
396
397         my $str = "";
398         $str .= "\@$seperator " for (1..$count-1);
399         
400     # -------------------------------------------------------------------
401     # "code" is the bib-1 "use attribute", "format" is the bib-1 
402     # "structure attribute"
403     # -------------------------------------------------------------------
404         for( keys %$hash ) {
405                 next unless ( exists $services{$service}->{attrs}->{$_} );
406                 $str .= '@attr 1=' . $services{$service}->{attrs}->{$_}->{code} . # add the use attribute
407                         ' @attr 4=' . $services{$service}->{attrs}->{$_}->{format}; # add the structure attribute
408                 if (exists $services{$service}->{attrs}->{$_}->{truncation}){
409                         $str .= ' @attr 5=' . $services{$service}->{attrs}->{$_}->{truncation};
410                 }
411                 $str .= " \"" . $$hash{$_} . "\" "; # add the search term
412         }
413         return $str;
414 }
415
416
417
418 # -------------------------------------------------------------------
419 # Handles the unicode
420 # -------------------------------------------------------------------
421 sub entityize {
422         my $stuff = shift;
423         my $form = shift || "";
424         
425         if ($form eq 'D') {
426                 $stuff = NFD($stuff);
427         } else {
428                 $stuff = NFC($stuff);
429         }
430         
431         $stuff =~ s/([\x{0080}-\x{fffd}])/sprintf('&#x%X;',ord($1))/sgoe;
432
433         # strip some other unfriendly chars that may leak in
434    $stuff =~ s/([\x{0000}-\x{0008}])//sgoe; 
435
436         return $stuff;
437 }
438
439
440 1;