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