SimpleServer.pm

   1 ##
   2 ##  Copyright (c) 2000, 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 package Net::Z3950::SimpleServer;
  29
  30 use strict;
  31 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK);
  32 use Carp;
  33
  34 require Exporter;
  35 require DynaLoader;
  36 require AutoLoader;
  37
  38 @ISA = qw(Exporter AutoLoader DynaLoader);
  39 # Items to export into callers namespace by default. Note: do not export
  40 # names by default without a very good reason. Use EXPORT_OK instead.
  41 # Do not simply export all your public functions/methods/constants.
  42 @EXPORT = qw(
  43
  44 );
  45 $VERSION = '0.02';
  46
  47 bootstrap Net::Z3950::SimpleServer $VERSION;
  48
  49 # Preloaded methods go here.
  50
  51 my $count = 0;
  52
  53 sub new {
  54         my $class = shift;
  55         my $args = shift || croak "SimpleServer::new: Usage new(argument hash)";
  56         my $self = {};
  57
  58         if ($count) {
  59                 carp "SimpleServer.pm: WARNING: Multithreaded server unsupported";
  60         }
  61         $count = 1;
  62
  63         $self->{INIT} = $args->{INIT};
  64         $self->{SEARCH} = $args->{SEARCH} || croak "SimpleServer.pm: ERROR: Unspecified search handler";
  65         $self->{FETCH} = $args->{FETCH} || croak "SimpleServer.pm: ERROR: Unspecified fetch handler";
  66         $self->{CLOSE} = $args->{CLOSE};
  67
  68         bless $self, $class;
  69         return $self;
  70 }
  71
  72
  73 sub launch_server {
  74         my $self = shift;
  75         my @args = @_;
  76
  77         if (defined($self->{INIT})) {
  78                 set_init_handler($self->{INIT});
  79         }
  80         set_search_handler($self->{SEARCH});
  81         set_fetch_handler($self->{FETCH});
  82         if (defined($self->{CLOSE})) {
  83                 set_close_handler($self->{CLOSE});
  84         }
  85
  86         start_server(@args);
  87 }
  88
  89
  90 # Autoload methods go after =cut, and are processed by the autosplit program.
  91
  92 1;
  93 __END__
  94 # Below is the stub of documentation for your module. You better edit it!
  95
  96 =head1 NAME
  97
  98 Net::Z3950::SimpleServer - Simple Perl API for building Z39.50 servers.
  99
 100 =head1 SYNOPSIS
 101
 102   use Net::Z3950::SimpleServer;
 103
 104   sub my_search_handler {
 105         my $args = shift;
 106
 107         my $set_id = $args->{SETNAME};
 108         my @database_list = @{ $args->{DATABASES} };
 109         my $query = $args->{QUERY};
 110
 111         ## Perform the query on the specified set of databases
 112         ## and return the number of hits:
 113
 114         $args->{HITS} = $hits;
 115   }
 116
 117   sub my_fetch_handler {        # Get a record for the user
 118         my $args = shift;
 119
 120         my $set_id = $args->{SETNAME};
 121
 122         my $record = fetch_a_record($args->{OFFSET);
 123
 124         $args->{RECORD} = $record;
 125         if (number_of_hits() == $args->{OFFSET}) {      ## Last record in set?
 126                 $args->{LAST} = 1;
 127         } else {
 128                 $args->{LAST} = 0;
 129         }
 130   }
 131
 132
 133   ## Register custom event handlers:
 134
 135   my $handle = Net::Z3950::SimpleServer->new({
 136                                                 INIT   =>  \&my_init_handler,
 137                                                 CLOSE  =>  \&my_close_handler,
 138                                                 SEARCH =>  \&my_search_handler,
 139                                                 FETCH  =>  \&my_fetch_handler
 140                                              });
 141   ## Launch server:
 142
 143   $handle->launch_server("ztest.pl", @ARGV);
 144
 145 =head1 DESCRIPTION
 146
 147 The SimpleServer module is a tool for constructing Z39.50 "Information
 148 Retrieval" servers in Perl. The module is easy to use, but it
 149 does help to have an understanding of the Z39.50 query
 150 structure and the construction of structured retrieval records.
 151
 152 Z39.50 is a network protocol for searching remote databases and
 153 retrieving the results in the form of structured "records". It is widely
 154 used in libraries around the world, as well as in the US Federal Government.
 155 In addition, it is generally useful whenever you wish to integrate a number
 156 of different database systems around a shared, asbtract data model.
 157
 158 The model of the module is simple: It implements a "generic" Z39.50
 159 server, which invokes callback functions supplied by you to search
 160 for content in your database. You can use any tools available in
 161 Perl to supply the content, including modules like DBI and
 162 WWW::Search.
 163
 164 The server will take care of managing the network connections for
 165 you, and it will spawn a new process (or thread, in some
 166 environments) whenever a new connection is received.
 167
 168 The programmer can specify subroutines to take care of the following type
 169 of events:
 170
 171   - Initialize request
 172   - Search request
 173   - Fetching of records
 174   - Closing down connection
 175
 176 Note that only the Search and Fetch handler functions are required.
 177 The module can supply default responses to the other on its own.
 178
 179 After the launching of the server, all control is given away from
 180 the Perl script to the server. The server calls the registered
 181 subroutines to field incoming requests from Z39.50 clients.
 182
 183 A reference to an anonymous hash is passed to each handle. Some of
 184 the entries of these hashes are to be considered input and others
 185 output parameters.
 186
 187 The Perl programmer specifies the event handles for the server by
 188 means of the the SimpleServer object constructor
 189
 190   my $handle = Net::Z3950::SimpleServer->new({
 191                 INIT    =>      \&my_init_handler,
 192                 CLOSE   =>      \&my_close_handler,
 193                 SEARCH  =>      \&my_search_handler,
 194                 FETCH   =>      \&my_fetch_handler });
 195
 196 After the custom event handles are declared, the server is launched
 197 by means of the method
 198
 199   $handle->launch_server("MyServer.pl", @ARGV);
 200
 201 Notice, the first argument should be the name of your server
 202 script (for logging purposes), while the rest of the arguments
 203 are documented in the YAZ toolkit manual: The section on
 204 application invocation: <http://www.indexdata.dk/yaz/yaz-7.php>
 205
 206 =head2 Init handler
 207
 208 The init handler is called whenever a Z39.50 client is attempting
 209 to logon to the server. The exchange of parameters between the
 210 server and the handler is carried out via an anonymous hash reached
 211 by a reference, i.e.
 212
 213   $args = shift;
 214
 215 The argument hash passed to the init handler has the form
 216
 217   $args = {
 218                                     ## Response parameters:
 219
 220              IMP_NAME  =>  ""       ## Z39.50 Implementation name
 221              IMP_VER   =>  ""       ## Z39.50 Implementation version
 222              ERR_CODE  =>  0        ## Error code, cnf. Z39.50 manual
 223              HANDLE    =>  undef    ## Handler of Perl data structure
 224           };
 225
 226 The HANDLE member can be used to store any scalar value which will then
 227 be provided as input to all subsequent calls (ie. for searching, record
 228 retrieval, etc.). A common use of the handle is to store a reference to
 229 a hash which may then be used to store session-specific parameters.
 230 If you have any session-specific information (such as a list of
 231 result sets or a handle to a back-end search engine of some sort),
 232 it is always best to store them in a private session structure -
 233 rather than leaving them in global variables in your script.
 234
 235 The Implementation name and version are only really used by Z39.50
 236 client developers to see what kind of server they're dealing with.
 237 Filling these in is optional.
 238
 239 The ERR_CODE should be left at 0 (the default value) if you wish to
 240 accept the connection. Any other value is interpreted as a failure
 241 and the client will be shown the door.
 242
 243 =head2 Search handler
 244
 245 Similarly, the search handler is called with a reference to an anony-
 246 mous hash. The structure is the following:
 247
 248   $args = {
 249                                     ## Request parameters:
 250
 251              HANDLE    =>  ref      ## Your session reference.
 252              SETNAME   =>  "id"     ## ID of the result set
 253              REPL_SET  =>  0        ## Replace set if already existing?
 254              DATABASES =>  ["xxx"]  ## Reference to a list of data-
 255                                     ## bases to search
 256              QUERY     =>  "query"  ## The query expression
 257
 258                                     ## Response parameters:
 259
 260              ERR_CODE  =>  0        ## Error code (0=Succesful search)
 261              ERR_STR   =>  ""       ## Error string
 262              HITS      =>  0        ## Number of matches
 263           };
 264
 265 Note that a search which finds 0 hits is considered successful in
 266 Z39.50 terms - you should only set the ERR_CODE to a non-zero value
 267 if there was a problem processing the request. The Z39.50 standard
 268 provides a comprehensive list of standard diagnostic codes, and you
 269 should use these whenever possible.
 270
 271 The QUERY is a tree-structure of terms combined by operators, the
 272 terms being qualified by lists of attributes. The query is presented
 273 to the search function in the Prefix Query Format (PQF) which is
 274 used in many applications based on the YAZ toolkit. The full grammar
 275 is described in the YAZ manual.
 276
 277 The following are all examples of valid queries in the PQF.
 278
 279         dylan
 280
 281         "bob dylan"
 282
 283         @or "dylan" "zimmerman"
 284
 285         @set Result-1
 286
 287         @or @and bob dylan @set Result-1
 288
 289         @and @attr 1=1 "bob dylan" @attr 1=4 "slow train coming"
 290
 291         @attrset @attr 4=1 @attr 1=4 "self portrait"
 292
 293 You will need to write a recursive function or something similar to
 294 parse incoming query expressions, and this is usually where a lot of
 295 the work in writing a database-backend happens. Fortunately, you don't
 296 need to support anymore functionality than you want to. For instance,
 297 it is perfectly legal to not accept boolean operators, but you SHOULD
 298 try to return good error codes if you run into something you can't or
 299 won't support.
 300
 301 =head2 Fetch handler
 302
 303 The fetch handler is asked to retrieve a SINGLE record from a given
 304 result set (the front-end server will automatically call the fetch
 305 handler as many times as required).
 306
 307 The parameters exchanged between the server and the fetch handler are
 308
 309   $args = {
 310                                     ## Client/server request:
 311
 312              HANDLE    =>  ref      ## Reference to data structure
 313              SETNAME   =>  "id"     ## ID of the requested result set
 314              OFFSET    =>  nnn      ## Record offset number
 315              REQ_FORM  =>  "n.m.k.l"## Client requested format OID
 316              COMP      =>  "xyz"    ## Formatting instructions
 317
 318                                     ## Handler response:
 319
 320              RECORD    =>  ""       ## Record string
 321              BASENAME  =>  ""       ## Origin of returned record
 322              LAST      =>  0        ## Last record in set?
 323              ERR_CODE  =>  0        ## Error code
 324              ERR_STR   =>  ""       ## Error string
 325              SUR_FLAG  =>  0        ## Surrogate diagnostic flag
 326              REP_FORM  =>  "n.m.k.l"## Provided format OID
 327           };
 328
 329 The REP_FORM value has by default the REQ_FORM value but can be set to
 330 something different if the handler desires. The BASENAME value should
 331 contain the name of the database from where the returned record originates.
 332 The ERR_CODE and ERR_STR works the same way they do in the search
 333 handler. If there is an error condition, the SUR_FLAG is used to
 334 indicate whether the error condition pertains to the record currently
 335 being retrieved, or whether it pertains to the operation as a whole
 336 (eg. the client has specified a result set which does not exist.)
 337
 338 If you need to return USMARC records, you might want to have a look at
 339 the MARC module on CPAN, if you don't already have a way of generating
 340 these.
 341
 342 NOTE: The record offset is 1-indexed - 1 is the offset of the first
 343 record in the set.
 344
 345 =head2 Close handler
 346
 347 The argument hash recieved by the close handler has one element only:
 348
 349   $args = {
 350                                     ## Server provides:
 351              HANDLE    =>  ref      ## Reference to data structure
 352           };
 353
 354 What ever data structure the HANDLE value points at goes out of scope
 355 after this call. If you need to close down a connection to your server
 356 or something similar, this is the place to do it.
 357
 358 =head1 AUTHORS
 359
 360 Anders Sønderberg (sondberg@indexdata.dk) and Sebastian Hammer
 361 (quinn@indexdata.dk).
 362
 363 =head1 SEE ALSO
 364
 365 perl(1).
 366
 367 Any Perl module which is useful for accessing the database of your
 368 choice.
 369
 370 =cut
 371
 372