X-Git-Url: http://lists.indexdata.dk/cgi-bin?a=blobdiff_plain;f=SimpleServer.pm;h=c3963fe68bb754f02e5bb8bf17ad6f23d2e8c696;hb=49c233671c73a64f891026ddb93b0eba158461d4;hp=bfff66411cb9fef3c6e75d77bd0f6ed12098c503;hpb=eed5b890fd5be803bf5ac5f27bb3aa5e2c81ee0f;p=simpleserver-moved-to-github.git diff --git a/SimpleServer.pm b/SimpleServer.pm index bfff664..c3963fe 100644 --- a/SimpleServer.pm +++ b/SimpleServer.pm @@ -1,5 +1,5 @@ ## -## Copyright (c) 2000-2004, Index Data. +## Copyright (c) 2000-2006, Index Data. ## ## Permission to use, copy, modify, distribute, and sell this software and ## its documentation, in whole or in part, for any purpose, is hereby granted, @@ -25,7 +25,7 @@ ## ## -## $Id: SimpleServer.pm,v 1.29 2006-08-08 16:27:04 mike Exp $ +## $Id: SimpleServer.pm,v 1.41 2007-08-20 15:34:29 mike Exp $ package Net::Z3950::SimpleServer; @@ -39,7 +39,7 @@ require AutoLoader; @ISA = qw(Exporter AutoLoader DynaLoader); @EXPORT = qw( ); -$VERSION = '1.03'; +$VERSION = '1.07'; bootstrap Net::Z3950::SimpleServer $VERSION; @@ -69,6 +69,13 @@ sub launch_server { my $self = shift; my @args = @_; + ### This modal internal interface, in which we set a bunch of + # globals and then call start_server(), is asking for + # trouble. Instead, we should just pass the $self object + # as a parameter into start_server(). + if (defined($self->{GHANDLE})) { + set_ghandle($self->{GHANDLE}); + } if (defined($self->{INIT})) { set_init_handler($self->{INIT}); } @@ -89,22 +96,69 @@ sub launch_server { if (defined($self->{EXPLAIN})) { set_explain_handler($self->{EXPLAIN}); } + if (defined($self->{DELETE})) { + set_delete_handler($self->{DELETE}); + } start_server(@args); } # Register packages that we will use in translated RPNs +package Net::Z3950::RPN::Node; package Net::Z3950::APDU::Query; +our @ISA = qw(Net::Z3950::RPN::Node); package Net::Z3950::APDU::OID; package Net::Z3950::RPN::And; +our @ISA = qw(Net::Z3950::RPN::Node); package Net::Z3950::RPN::Or; +our @ISA = qw(Net::Z3950::RPN::Node); package Net::Z3950::RPN::AndNot; +our @ISA = qw(Net::Z3950::RPN::Node); package Net::Z3950::RPN::Term; +our @ISA = qw(Net::Z3950::RPN::Node); package Net::Z3950::RPN::RSID; +our @ISA = qw(Net::Z3950::RPN::Node); package Net::Z3950::RPN::Attributes; package Net::Z3950::RPN::Attribute; + +# Utility method for re-rendering Type-1 query back down to PQF +package Net::Z3950::RPN::Node; + +sub toPQF { + my $this = shift(); + my $class = ref $this; + + if ($class eq "Net::Z3950::APDU::Query") { + my $res = ""; + my $set = $this->{attributeSet}; + $res .= "\@attrset $set " if defined $set; + return $res . $this->{query}->toPQF(); + } elsif ($class eq "Net::Z3950::RPN::Or") { + return '@or ' . $this->[0]->toPQF() . ' ' . $this->[1]->toPQF(); + } elsif ($class eq "Net::Z3950::RPN::And") { + return '@and ' . $this->[0]->toPQF() . ' ' . $this->[1]->toPQF(); + } elsif ($class eq "Net::Z3950::RPN::AndNot") { + return '@not ' . $this->[0]->toPQF() . ' ' . $this->[1]->toPQF(); + } elsif ($class eq "Net::Z3950::RPN::RSID") { + return '@set ' . $this->{id}; + } elsif ($class ne "Net::Z3950::RPN::Term") { + die "unknown PQF node-type '$class'"; + } + + my $res = ""; + foreach my $attr (@{ $this->{attributes} }) { + $res .= "\@attr "; + my $set = $attr->{attributeSet}; + $res .= "$set " if defined $set; + $res .= $attr->{attributeType} . "=" . $attr->{attributeValue} . " "; + } + + return $res . $this->{term}; +} + + # Must revert to original package for Autoloader's benefit package Net::Z3950::SimpleServer; @@ -151,15 +205,14 @@ Net::Z3950::SimpleServer - Simple Perl API for building Z39.50 servers. } } - ## Register custom event handlers: + my $z = new Net::Z3950::SimpleServer(GHANDLE = $someObject, + INIT => \&my_init_handler, + CLOSE => \&my_close_handler, + SEARCH => \&my_search_handler, + FETCH => \&my_fetch_handler); - my $z = new Net::Z3950::SimpleServer( INIT => \&my_init_handler, - CLOSE => \&my_close_handler, - SEARCH => \&my_search_handler, - FETCH => \&my_fetch_handler); ## Launch server: - $z->launch_server("ztest.pl", @ARGV); =head1 DESCRIPTION @@ -216,7 +269,13 @@ means of the SimpleServer object constructor PRESENT => \&my_present_handler, SCAN => \&my_scan_handler, FETCH => \&my_fetch_handler, - EXPLAIN => \&my_explain_handler); + EXPLAIN => \&my_explain_handler, + DELETE => \&my_delete_handler); + +In addition, the arguments to the constructor may include GHANDLE, a +global handle which is made available to each invocation of every +callback function. This is typically a reference to either a hash or +an object. If you want your SimpleServer to start a thread (threaded mode) to handle each incoming Z39.50 request instead of forking a process @@ -269,6 +328,7 @@ The argument hash passed to the init handler has the form ## this member contains user name PASS => "yyy" ## Under same conditions, this member ## contains the password in clear text + GHANDLE => $obj ## Global handler specified at creation HANDLE => undef ## Handler of Perl data structure }; @@ -298,6 +358,7 @@ mous hash. The structure is the following: $args = { ## Request parameters: + GHANDLE => $obj ## Global handler specified at creation HANDLE => ref, ## Your session reference. SETNAME => "id", ## ID of the result set REPL_SET => 0, ## Replace set if already existing? @@ -405,9 +466,6 @@ of the result-set is in the C element. =back -(I guess I should make a superclass C and make -all of these subclasses of it. Not done that yet, but will do one day.) - =back =over 4 @@ -456,7 +514,7 @@ a ``relation'' attribute, etc. =item C -An integer indicating the value of the attribute - for example, under +An integer or string indicating the value of the attribute - for example, under BIB-1, if the attribute type is 1, then value 4 indictates a title search and 7 indictates an ISBN search; but if the attribute type is 2, then value 4 indicates a ``greater than or equal'' search, and 102 @@ -466,7 +524,12 @@ indicates a relevance match. =back -Note that, at the moment, none of these classes have any methods at +All of these classes except C and C are +subclasses of the abstract class C. That class +has a single method, C, which may be used to turn an RPN +tree, or part of one, back into a textual prefix query. + +Note that, apart to C, none of these classes have any methods at all: the blessing into classes is largely just a documentation thing so that, for example, if you do @@ -507,6 +570,7 @@ The informations exchanged between client and present handle are: $args = { ## Client/server request: + GHANDLE => $obj ## Global handler specified at creation HANDLE => ref, ## Reference to datastructure SETNAME => "id", ## Result set ID START => xxx, ## Start position @@ -533,6 +597,7 @@ The parameters exchanged between the server and the fetch handler are $args = { ## Client/server request: + GHANDLE => $obj ## Global handler specified at creation HANDLE => ref ## Reference to data structure SETNAME => "id" ## ID of the requested result set OFFSET => nnn ## Record offset number @@ -581,8 +646,13 @@ an index of a book, you always find something! The parameters exchanged are $args = { ## Client request - HANDLE => $ref ## Reference to data structure + GHANDLE => $obj, ## Global handler specified at creation + HANDLE => $ref, ## Reference to data structure + DATABASES => ["xxx"], ## Reference to a list of data- + ## bases to search TERM => 'start', ## The start term + RPN => $obj, ## Reference to a Net::Z3950::RPN::Term + NUMBER => xx, ## Number of requested terms POS => yy, ## Position of starting point ## within returned list @@ -615,20 +685,31 @@ should point at a data structure of this kind, ... ]; -The $status flag should be assigned one of two values: +The $status flag is only meaningful after a successful scan, and +should be assigned one of two values: - Net::Z3950::SimpleServer::ScanSuccess On success (default) - Net::Z3950::SimpleServer::ScanPartial Less terms returned than requested + Net::Z3950::SimpleServer::ScanSuccess Full success (default) + Net::Z3950::SimpleServer::ScanPartial Fewer terms returned than requested The STEP member contains the requested number of entries in the term-list between two adjacent entries in the response. +A better alternative to the TERM member is the the RPN +member, which is a reference to a Net::Z3950::RPN::Term object +representing the scan cloause. The structure of that object is the +same as for Term objects included as part of the RPN tree passed to +search handlers. This is more useful than the simple TERM because it +includes attributes (e.g. access points associated with the term), +which are discarded by the TERM element. + =head2 Close handler -The argument hash recieved by the close handler has one element only: +The argument hash recieved by the close handler has two elements only: $args = { ## Server provides: + + GHANDLE => $obj ## Global handler specified at creation HANDLE => ref ## Reference to data structure }; @@ -636,6 +717,30 @@ What ever data structure the HANDLE value points at goes out of scope after this call. If you need to close down a connection to your server or something similar, this is the place to do it. +=head2 Delete handler + +The argument hash recieved by the delete handler has the following elements: + + $args = { + ## Client request: + GHANDLE => $obj, ## Global handler specified at creation + HANDLE => ref, ## Reference to data structure + SETNAME => "id", ## Result set ID + + ## Server response: + STATUS => 0 ## Deletion status + }; + +The SETNAME element of the argument hash may or may not be defined. +If it is, then SETNAME is the name of a result set to be deleted; if +not, then all result-sets associated with the current session should +be deleted. In either case, the callback function should report on +success or failure by setting the STATUS element either to zero, on +success, or to an integer from 1 to 10, to indicate one of the ten +possible failure codes described in section 3.2.4.1.4 of the Z39.50 +standard -- see +http://www.loc.gov/z3950/agency/markup/05.html#Delete-list-statuses1 + =head2 Support for SRU and SRW Since release 1.0, SimpleServer includes support for serving the SRU