X-Git-Url: http://git.indexdata.com/?p=simpleserver-moved-to-github.git;a=blobdiff_plain;f=SimpleServer.pm;h=bc8a9abdcec08a8469403c36d666dfbfc978287b;hp=399d189af722f8ca6f1dd764f9d557a4773c0f19;hb=dc9e19f7a9e21e09bd1563530aa58d3df95cd189;hpb=087378f313eacdda6ee90fed9e48ae34a4afae5e diff --git a/SimpleServer.pm b/SimpleServer.pm index 399d189..bc8a9ab 100644 --- a/SimpleServer.pm +++ b/SimpleServer.pm @@ -25,7 +25,7 @@ ## ## -## $Id: SimpleServer.pm,v 1.38 2007-08-20 10:55:29 mike Exp $ +## $Id: SimpleServer.pm,v 1.46 2007-09-25 09:02:14 mike Exp $ package Net::Z3950::SimpleServer; @@ -39,7 +39,7 @@ require AutoLoader; @ISA = qw(Exporter AutoLoader DynaLoader); @EXPORT = qw( ); -$VERSION = '1.07'; +$VERSION = '1.10'; bootstrap Net::Z3950::SimpleServer $VERSION; @@ -96,6 +96,9 @@ sub launch_server { if (defined($self->{EXPLAIN})) { set_explain_handler($self->{EXPLAIN}); } + if (defined($self->{DELETE})) { + set_delete_handler($self->{DELETE}); + } start_server(@args); } @@ -146,7 +149,6 @@ sub toPQF { my $res = ""; foreach my $attr (@{ $this->{attributes} }) { - use Data::Dumper; print "considering attr: ", Dumper($attr); $res .= "\@attr "; my $set = $attr->{attributeSet}; $res .= "$set " if defined $set; @@ -267,7 +269,9 @@ 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, + SORT => \&my_sort_handler); In addition, the arguments to the constructor may include GHANDLE, a global handle which is made available to each invocation of every @@ -316,6 +320,7 @@ The argument hash passed to the init handler has the form $args = { ## Response parameters: + PEER_NAME => "", ## Name or IP address of connecting client IMP_ID => "", ## Z39.50 Implementation ID IMP_NAME => "", ## Z39.50 Implementation name IMP_VER => "", ## Z39.50 Implementation version @@ -463,11 +468,6 @@ of the result-set is in the C element. =back -All of these classes are subclasses of the abstrac 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. - =back =over 4 @@ -526,6 +526,11 @@ indicates a relevance match. =back +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 @@ -714,6 +719,108 @@ 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 Sort handler + +The argument hash recieved by the sort handler has the following elements: + + $args = { + ## Client request: + GHANDLE => $obj, ## Global handler specified at creation + HANDLE => ref, ## Reference to data structure + INPUT => [ a, b ... ], ## Names of result-sets to sort + OUTPUT => "name", ## Name of result-set to sort into + SEQUENCE ## Sort specification: see below + + ## Server response: + STATUS => 0, ## Success, Partial or Failure + ERR_CODE => 0, ## Error code + ERR_STR => '', ## Diagnostic message + + }; + +The SEQUENCE element is a reference to an array, each element of which +is a hash representing a sort key. Each hash contains the following +elements: + +=over 4 + +=item RELATION + +0 for an ascending sort, 1 for descending, 3 for ascending by +frequency, or 4 for descending by frequency. + +=item CASE + +0 for a case-sensitive sort, 1 for case-insensitive + +=item MISSING + +How to respond if one or more records in the set to be sorted are +missing the fields indicated in the sort specification. 1 to abort +the sort, 2 to use a "null value", 3 if a value is provided to use in +place of the missing data (although in the latter case, the actual +value to use is currently not made available, so this is useless). + +=back + +And one or other of the following: + +=over 4 + +=item SORTFIELD + +A string indicating the field to be sorted, which the server may +interpret as it sees fit (presumably by an out-of-band agreement with +the client). + +=item ELEMENTSPEC_TYPE and ELEMENTSPEC_VALUE + +I have no idea what this is. + +=item ATTRSET and SORT_ATTR + +ATTRSET is the attribute set from which the attributes are taken, and +SORT_ATTR is a reference to an array containing the attributes +themselves. Each attribute is represented by (are you following this +carefully?) yet another hash, this one containing the elements +ATTR_TYPE and ATTR_VALUE: for example, type=1 and value=4 in the BIB-1 +attribute set would indicate access-point 4 which is title, so that a +sort of title is requested. + +=back + +Precisely why all of the above is so is not clear, but goes some way +to explain why, in the Z39.50 world, the developers of the standard +are not so much worshipped as blamed. + +The backend function should set STATUS to 0 on success, 1 for "partial +success" (don't ask) or 2 on failure, in which case ERR_CODE and +ERR_STR should be set. + =head2 Support for SRU and SRW Since release 1.0, SimpleServer includes support for serving the SRU