Preparing for release.
[simpleserver-moved-to-github.git] / SimpleServer.pm
1 ##
2 ##  Copyright (c) 2000-2004, Index Data.
3 ##
4 ##  Permission to use, copy, modify, distribute, and sell this software and
5 ##  its documentation, in whole or in part, for any purpose, is hereby granted,
6 ##  provided that:
7 ##
8 ##  1. This copyright and permission notice appear in all copies of the
9 ##  software and its documentation. Notices of copyright or attribution
10 ##  which appear at the beginning of any file must remain unchanged.
11 ##
12 ##  2. The name of Index Data or the individual authors may not be used to
13 ##  endorse or promote products derived from this software without specific
14 ##  prior written permission.
15 ##
16 ##  THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
17 ##  EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
18 ##  WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
19 ##  IN NO EVENT SHALL INDEX DATA BE LIABLE FOR ANY SPECIAL, INCIDENTAL,
20 ##  INDIRECT OR CONSEQUENTIAL DAMAGES OF ANY KIND, OR ANY DAMAGES
21 ##  WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER OR
22 ##  NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND ON ANY THEORY OF
23 ##  LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE
24 ##  OF THIS SOFTWARE.
25 ##
26 ##
27
28 ## $Id: SimpleServer.pm,v 1.20 2004-05-28 20:14:28 sondberg Exp $
29
30 package Net::Z3950::SimpleServer;
31
32 use strict;
33 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
34 use Carp;
35
36 require Exporter;
37 require DynaLoader;
38 require AutoLoader;
39
40 @ISA = qw(Exporter AutoLoader DynaLoader);
41 @EXPORT = qw( );
42 $VERSION = '0.08';
43
44 bootstrap Net::Z3950::SimpleServer $VERSION;
45
46 # Preloaded methods go here.
47
48 my $count = 0;
49
50 sub new {
51         my $class = shift;
52         my %args = @_;
53         my $self = \%args;
54
55         if ($count) {
56                 carp "SimpleServer.pm: WARNING: Multithreaded server unsupported";
57         }
58         $count = 1;
59
60         croak "SimpleServer.pm: ERROR: Unspecified search handler" unless defined($self->{SEARCH});
61         croak "SimpleServer.pm: ERROR: Unspecified fetch handler" unless defined($self->{FETCH});
62
63         bless $self, $class;
64         return $self;
65 }
66
67
68 sub launch_server {
69         my $self = shift;
70         my @args = @_;
71
72         if (defined($self->{INIT})) {
73                 set_init_handler($self->{INIT});
74         }
75         set_search_handler($self->{SEARCH});
76         set_fetch_handler($self->{FETCH});
77         if (defined($self->{CLOSE})) {
78                 set_close_handler($self->{CLOSE});
79         }
80         if (defined($self->{PRESENT})) {
81                 set_present_handler($self->{PRESENT});
82         }
83         if (defined($self->{SCAN})) {
84                 set_scan_handler($self->{SCAN});
85         }
86
87         start_server(@args);
88 }
89
90
91 # Register packages that we will use in translated RPNs
92 package Net::Z3950::APDU::Query;
93 package Net::Z3950::APDU::OID;
94 package Net::Z3950::RPN::And;
95 package Net::Z3950::RPN::Or;
96 package Net::Z3950::RPN::AndNot;
97 package Net::Z3950::RPN::Term;
98 package Net::Z3950::RPN::Attributes;
99 package Net::Z3950::RPN::Attribute;
100
101 # Must revert to original package for Autoloader's benefit
102 package Net::Z3950::SimpleServer;
103
104
105 # Autoload methods go after =cut, and are processed by the autosplit program.
106
107 1;
108 __END__
109 # Below is the stub of documentation for your module. You better edit it!
110
111 =head1 NAME
112
113 Net::Z3950::SimpleServer - Simple Perl API for building Z39.50 servers. 
114
115 =head1 SYNOPSIS
116
117   use Net::Z3950::SimpleServer;
118
119   sub my_search_handler {
120         my $args = shift;
121
122         my $set_id = $args->{SETNAME};
123         my @database_list = @{ $args->{DATABASES} };
124         my $query = $args->{QUERY};
125
126         ## Perform the query on the specified set of databases
127         ## and return the number of hits:
128
129         $args->{HITS} = $hits;
130   }
131
132   sub my_fetch_handler {        # Get a record for the user
133         my $args = shift;
134
135         my $set_id = $args->{SETNAME};
136
137         my $record = fetch_a_record($args->{OFFSET});
138
139         $args->{RECORD} = $record;
140         if (number_of_hits() == $args->{OFFSET}) {      ## Last record in set?
141                 $args->{LAST} = 1;
142         } else {
143                 $args->{LAST} = 0;
144         }
145   }
146
147
148   ## Register custom event handlers:
149
150   my $z = new Net::Z3950::SimpleServer(         INIT   =>  \&my_init_handler,
151                                                 CLOSE  =>  \&my_close_handler,
152                                                 SEARCH =>  \&my_search_handler,
153                                                 FETCH  =>  \&my_fetch_handler);
154   ## Launch server:
155
156   $z->launch_server("ztest.pl", @ARGV);
157
158 =head1 DESCRIPTION
159
160 The SimpleServer module is a tool for constructing Z39.50 "Information
161 Retrieval" servers in Perl. The module is easy to use, but it
162 does help to have an understanding of the Z39.50 query
163 structure and the construction of structured retrieval records.
164
165 Z39.50 is a network protocol for searching remote databases and
166 retrieving the results in the form of structured "records". It is widely
167 used in libraries around the world, as well as in the US Federal Government.
168 In addition, it is generally useful whenever you wish to integrate a number
169 of different database systems around a shared, asbtract data model.
170
171 The model of the module is simple: It implements a "generic" Z39.50
172 server, which invokes callback functions supplied by you to search
173 for content in your database. You can use any tools available in
174 Perl to supply the content, including modules like DBI and
175 WWW::Search.
176
177 The server will take care of managing the network connections for
178 you, and it will spawn a new process (or thread, in some
179 environments) whenever a new connection is received.
180
181 The programmer can specify subroutines to take care of the following type
182 of events:
183
184   - Initialize request
185   - Search request
186   - Present request
187   - Fetching of records
188   - Scan request (browsing) 
189   - Closing down connection
190
191 Note that only the Search and Fetch handler functions are required.
192 The module can supply default responses to the other on its own.
193
194 After the launching of the server, all control is given away from
195 the Perl script to the server. The server calls the registered
196 subroutines to field incoming requests from Z39.50 clients.
197
198 A reference to an anonymous hash is passed to each handle. Some of
199 the entries of these hashes are to be considered input and others
200 output parameters.
201
202 The Perl programmer specifies the event handles for the server by
203 means of the the SimpleServer object constructor
204
205   my $z = new Net::Z3950::SimpleServer(
206                         INIT    =>      \&my_init_handler,
207                         CLOSE   =>      \&my_close_handler,
208                         SEARCH  =>      \&my_search_handler,
209                         PRESENT =>      \&my_present_handler,
210                         SCAN    =>      \&my_scan_handler,
211                         FETCH   =>      \&my_fetch_handler);
212
213 After the custom event handles are declared, the server is launched
214 by means of the method
215
216   $z->launch_server("MyServer.pl", @ARGV);
217
218 Notice, the first argument should be the name of your server
219 script (for logging purposes), while the rest of the arguments
220 are documented in the YAZ toolkit manual: The section on
221 application invocation: <http://www.indexdata.dk/yaz/yaz-7.php>
222
223 =head2 Init handler
224
225 The init handler is called whenever a Z39.50 client is attempting
226 to logon to the server. The exchange of parameters between the
227 server and the handler is carried out via an anonymous hash reached
228 by a reference, i.e.
229
230   $args = shift;
231
232 The argument hash passed to the init handler has the form
233
234   $args = {
235                                     ## Response parameters:
236
237              IMP_ID    =>  "",      ## Z39.50 Implementation ID
238              IMP_NAME  =>  "",      ## Z39.50 Implementation name
239              IMP_VER   =>  "",      ## Z39.50 Implementation version
240              ERR_CODE  =>  0,       ## Error code, cnf. Z39.50 manual
241              ERR_STR   =>  "",      ## Error string (additional info.)
242              USER      =>  "xxx"    ## If Z39.50 authentication is used,
243                                     ## this member contains user name
244              PASS      =>  "yyy"    ## Under same conditions, this member
245                                     ## contains the password in clear text
246              HANDLE    =>  undef    ## Handler of Perl data structure
247           };
248
249 The HANDLE member can be used to store any scalar value which will then
250 be provided as input to all subsequent calls (ie. for searching, record
251 retrieval, etc.). A common use of the handle is to store a reference to
252 a hash which may then be used to store session-specific parameters.
253 If you have any session-specific information (such as a list of
254 result sets or a handle to a back-end search engine of some sort),
255 it is always best to store them in a private session structure -
256 rather than leaving them in global variables in your script.
257
258 The Implementation ID, name and version are only really used by Z39.50
259 client developers to see what kind of server they're dealing with.
260 Filling these in is optional.
261
262 The ERR_CODE should be left at 0 (the default value) if you wish to
263 accept the connection. Any other value is interpreted as a failure
264 and the client will be shown the door, with the code and the
265 associated additional information, ERR_STR returned.
266
267 =head2 Search handler
268
269 Similarly, the search handler is called with a reference to an anony-
270 mous hash. The structure is the following:
271
272   $args = {
273                                     ## Request parameters:
274
275              HANDLE    =>  ref,     ## Your session reference.
276              SETNAME   =>  "id",    ## ID of the result set
277              REPL_SET  =>  0,       ## Replace set if already existing?
278              DATABASES =>  ["xxx"], ## Reference to a list of data-
279                                     ## bases to search
280              QUERY     =>  "query", ## The query expression
281              RPN       =>  $obj,    ## Reference to a Net::Z3950::APDU::Query
282
283                                     ## Response parameters:
284
285              ERR_CODE  =>  0,       ## Error code (0=Succesful search)
286              ERR_STR   =>  "",      ## Error string
287              HITS      =>  0        ## Number of matches
288           };
289
290 Note that a search which finds 0 hits is considered successful in
291 Z39.50 terms - you should only set the ERR_CODE to a non-zero value
292 if there was a problem processing the request. The Z39.50 standard
293 provides a comprehensive list of standard diagnostic codes, and you
294 should use these whenever possible.
295
296 The QUERY is a tree-structure of terms combined by operators, the
297 terms being qualified by lists of attributes. The query is presented
298 to the search function in the Prefix Query Format (PQF) which is
299 used in many applications based on the YAZ toolkit. The full grammar
300 is described in the YAZ manual.
301
302 The following are all examples of valid queries in the PQF. 
303
304         dylan
305
306         "bob dylan"
307
308         @or "dylan" "zimmerman"
309
310         @set Result-1
311
312         @or @and bob dylan @set Result-1
313
314         @and @attr 1=1 "bob dylan" @attr 1=4 "slow train coming"
315
316         @attrset @attr 4=1 @attr 1=4 "self portrait"
317
318 You will need to write a recursive function or something similar to
319 parse incoming query expressions, and this is usually where a lot of
320 the work in writing a database-backend happens. Fortunately, you don't
321 need to support anymore functionality than you want to. For instance,
322 it is perfectly legal to not accept boolean operators, but you SHOULD
323 try to return good error codes if you run into something you can't or
324 won't support.
325
326 A more convenient alternative to the QUERY member may be the RPN
327 member, which is a reference to a Net::Z3950::APDU::Query object
328 representing the RPN query tree.  The structure of that object is
329 supposed to be self-documenting, but here's a brief summary of what
330 you get:
331
332 =over 4
333
334 =item *
335
336 C<Net::Z3950::APDU::Query> is a hash with two fields:
337
338 Z<>
339
340 =over 4
341
342 =item C<attributeSet>
343
344 Optional.  If present, it is a reference to a
345 C<Net::Z3950::APDU::OID>.  This is a string of dot-separated integers
346 representing the OID of the query's top-level attribute set.
347
348 =item C<query>
349
350 Mandatory: a refererence to the RPN tree itself.
351
352 =back
353
354 =item *
355
356 Each node of the tree is an object of one of the following types:
357
358 Z<>
359
360 =over 4
361
362 =item C<Net::Z3950::RPN::And>
363
364 =item C<Net::Z3950::RPN::Or>
365
366 =item C<Net::Z3950::RPN::AndNot>
367
368 These three classes are all arrays of two elements, each of which is a
369 node of one of the above types.
370
371 =item C<Net::Z3950::RPN::Term>
372
373 See below for details.
374
375 =back
376
377 (I guess I should make a superclass C<Net::Z3950::RPN::Node> and make
378 all of these subclasses of it.  Not done that yet, but will do soon.)
379
380 =back
381
382 =over 4
383
384 =item *
385
386 C<Net::Z3950::RPN::Term> is a hash with two fields:
387
388 Z<>
389
390 =over 4
391
392 =item C<term>
393
394 A string containing the search term itself.
395
396 =item C<attributes>
397
398 A reference to a C<Net::Z3950::RPN::Attributes> object.
399
400 =back
401
402 =item *
403
404 C<Net::Z3950::RPN::Attributes> is an array of references to
405 C<Net::Z3950::RPN::Attribute> objects.  (Note the plural/singular
406 distinction.)
407
408 =item *
409
410 C<Net::Z3950::RPN::Attribute> is a hash with three elements:
411
412 Z<>
413
414 =over 4
415
416 =item C<attributeSet>
417
418 Optional.  If present, it is dot-separated OID string, as above.
419
420 =item C<attributeType>
421
422 An integer indicating the type of the attribute - for example, under
423 the BIB-1 attribute set, type 1 indicates a ``use'' attribute, type 2
424 a ``relation'' attribute, etc.
425
426 =item C<attributeValue>
427
428 An integer indicating the value of the attribute - for example, under
429 BIB-1, if the attribute type is 1, then value 4 indictates a title
430 search and 7 indictates an ISBN search; but if the attribute type is
431 2, then value 4 indicates a ``greater than or equal'' search, and 102
432 indicates a relevance match.
433
434 =back
435
436 =back
437
438 Note that, at the moment, none of these classes have any methods at
439 all: the blessing into classes is largely just a documentation thing
440 so that, for example, if you do
441
442         { use Data::Dumper; print Dumper($args->{RPN}) }
443
444 you get something fairly human-readable.  But of course, the type
445 distinction between the three different kinds of boolean node is
446 important.
447
448 By adding your own methods to these classes (building what I call
449 ``augmented classes''), you can easily build code that walks the tree
450 of the incoming RPN.  Take a look at C<samples/render-search.pl> for a
451 sample implementation of such an augmented classes technique.
452
453
454 =head2 Present handler
455
456 The presence of a present handler in a SimpleServer front-end is optional.
457 Each time a client wishes to retrieve records, the present service is
458 called. The present service allows the origin to request a certain number
459 of records retrieved from a given result set.
460 When the present handler is called, the front-end server should prepare a
461 result set for fetching. In practice, this means to get access to the
462 data from the backend database and store the data in a temporary fashion
463 for fast and efficient fetching. The present handler does *not* fetch
464 anything. This task is taken care of by the fetch handler, which will be
465 called the correct number of times by the YAZ library. More about this
466 below.
467 If no present handler is implemented in the front-end, the YAZ toolkit
468 will take care of a minimum of preparations itself. This default present
469 handler is sufficient in many situations, where only a small amount of
470 records are expected to be retrieved. If on the other hand, large result
471 sets are likely to occur, the implementation of a reasonable present
472 handler can gain performance significantly.
473
474 The informations exchanged between client and present handle are:
475
476   $args = {
477                                     ## Client/server request:
478
479              HANDLE    =>  ref,     ## Reference to datastructure
480              SETNAME   =>  "id",    ## Result set ID
481              START     =>  xxx,     ## Start position
482              COMP      =>  "",      ## Desired record composition
483              NUMBER    =>  yyy,     ## Number of requested records
484
485
486                                     ## Respons parameters:
487
488              HITS      =>  zzz,     ## Number of returned records
489              ERR_CODE  =>  0,       ## Error code
490              ERR_STR   =>  ""       ## Error message
491           };
492
493
494 =head2 Fetch handler
495
496 The fetch handler is asked to retrieve a SINGLE record from a given
497 result set (the front-end server will automatically call the fetch
498 handler as many times as required).
499
500 The parameters exchanged between the server and the fetch handler are
501
502   $args = {
503                                     ## Client/server request:
504
505              HANDLE    =>  ref      ## Reference to data structure
506              SETNAME   =>  "id"     ## ID of the requested result set
507              OFFSET    =>  nnn      ## Record offset number
508              REQ_FORM  =>  "n.m.k.l"## Client requested format OID
509              COMP      =>  "xyz"    ## Formatting instructions
510
511                                     ## Handler response:
512
513              RECORD    =>  ""       ## Record string
514              BASENAME  =>  ""       ## Origin of returned record
515              LAST      =>  0        ## Last record in set?
516              ERR_CODE  =>  0        ## Error code
517              ERR_STR   =>  ""       ## Error string
518              SUR_FLAG  =>  0        ## Surrogate diagnostic flag
519              REP_FORM  =>  "n.m.k.l"## Provided format OID
520           };
521
522 The REP_FORM value has by default the REQ_FORM value but can be set to
523 something different if the handler desires. The BASENAME value should
524 contain the name of the database from where the returned record originates.
525 The ERR_CODE and ERR_STR works the same way they do in the search
526 handler. If there is an error condition, the SUR_FLAG is used to
527 indicate whether the error condition pertains to the record currently
528 being retrieved, or whether it pertains to the operation as a whole
529 (eg. the client has specified a result set which does not exist.)
530
531 If you need to return USMARC records, you might want to have a look at
532 the MARC module on CPAN, if you don't already have a way of generating
533 these.
534
535 NOTE: The record offset is 1-indexed - 1 is the offset of the first
536 record in the set.
537
538 =head2 Scan handler
539
540 A full featured Z39.50 server should support scan (or in some literature
541 browse). The client specifies a starting term of the scan, and the server
542 should return an ordered list of specified length consisting of terms
543 actually occurring in the data base. Each of these terms should be close
544 to or equal to the term originally specified. The quality of scan compared
545 to simple search is a guarantee of hits. It is simply like browsing through
546 an index of a book, you always find something! The parameters exchanged are
547
548   $args = {
549                                                 ## Client request
550
551                 HANDLE          => $ref         ## Reference to data structure
552                 TERM            => 'start',     ## The start term
553                 NUMBER          => xx,          ## Number of requested terms
554                 POS             => yy,          ## Position of starting point
555                                                 ## within returned list
556                 STEP            => 0,           ## Step size
557
558                                                 ## Server response
559
560                 ERR_CODE        => 0,           ## Error code
561                 ERR_STR         => '',          ## Diagnostic message
562                 NUMBER          => zz,          ## Number of returned terms
563                 STATUS          => $status,     ## ScanSuccess/ScanFailure
564                 ENTRIES         => $entries     ## Referenced list of terms
565         };
566
567 where the term list is returned by reference in the scalar $entries, which
568 should point at a data structure of this kind,
569
570   my $entries = [
571                         {       TERM            => 'energy',
572                                 OCCURRENCE      => 5            },
573
574                         {       TERM            => 'energy density',
575                                 OCCURRENCE      => 6,           },
576
577                         {       TERM            => 'energy flow',
578                                 OCCURRENCE      => 3            },
579
580                                 ...
581
582                                 ...
583         ];
584
585 The $status flag should be assigned one of two values:
586
587   Net::Z3950::SimpleServer::ScanSuccess  On success (default)
588   Net::Z3950::SimpleServer::ScanPartial  Less terms returned than requested
589
590 The STEP member contains the requested number of entries in the term-list
591 between two adjacent entries in the response.
592
593 =head2 Close handler
594
595 The argument hash recieved by the close handler has one element only:
596
597   $args = {
598                                     ## Server provides:
599              HANDLE    =>  ref      ## Reference to data structure
600           };
601
602 What ever data structure the HANDLE value points at goes out of scope
603 after this call. If you need to close down a connection to your server
604 or something similar, this is the place to do it.
605
606 =head1 AUTHORS
607
608 Anders S√łnderberg (sondberg@indexdata.dk) and Sebastian Hammer
609 (quinn@indexdata.dk). Substantial contributions made by Mike Taylor
610 (mike@miketaylor.org.uk).
611
612 =head1 SEE ALSO
613
614 Any Perl module which is useful for accessing the database of your
615 choice.
616
617 =cut