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