X-Git-Url: http://git.indexdata.com/?p=simpleserver-moved-to-github.git;a=blobdiff_plain;f=SimpleServer.pm;h=02101f99b44031f4c161e8a2a4c01f8544615600;hp=2fbaf7fd7d5874f181a5cfeffa3d2734a91c7fbb;hb=3ee948d799b9207fd02662bcb66b1d8848da48f6;hpb=18dfeef374769f1739e820f8b66b4d145c70112c diff --git a/SimpleServer.pm b/SimpleServer.pm index 2fbaf7f..02101f9 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.23 2006-03-24 01:21:15 mike Exp $ +## $Id: SimpleServer.pm,v 1.31 2006-12-27 12:24:50 sondberg Exp $ package Net::Z3950::SimpleServer; @@ -39,7 +39,7 @@ require AutoLoader; @ISA = qw(Exporter AutoLoader DynaLoader); @EXPORT = qw( ); -$VERSION = '1.00'; +$VERSION = '1.05'; bootstrap Net::Z3950::SimpleServer $VERSION; @@ -83,6 +83,12 @@ sub launch_server { if (defined($self->{SCAN})) { set_scan_handler($self->{SCAN}); } + if (defined($self->{SORT})) { + set_sort_handler($self->{SORT}); + } + if (defined($self->{EXPLAIN})) { + set_explain_handler($self->{EXPLAIN}); + } start_server(@args); } @@ -209,7 +215,8 @@ means of the SimpleServer object constructor SEARCH => \&my_search_handler, PRESENT => \&my_present_handler, SCAN => \&my_scan_handler, - FETCH => \&my_fetch_handler); + FETCH => \&my_fetch_handler, + EXPLAIN => \&my_explain_handler); If you want your SimpleServer to start a thread (threaded mode) to handle each incoming Z39.50 request instead of forking a process @@ -531,6 +538,7 @@ The parameters exchanged between the server and the fetch handler are OFFSET => nnn ## Record offset number REQ_FORM => "n.m.k.l"## Client requested format OID COMP => "xyz" ## Formatting instructions + SCHEMA => "abc" ## Requested schema, if any ## Handler response: @@ -541,6 +549,7 @@ The parameters exchanged between the server and the fetch handler are ERR_STR => "" ## Error string SUR_FLAG => 0 ## Surrogate diagnostic flag REP_FORM => "n.m.k.l"## Provided format OID + SCHEMA => "abc" ## Provided schema, if any }; The REP_FORM value has by default the REQ_FORM value but can be set to @@ -627,11 +636,70 @@ 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 Support for SRU and SRW + +Since release 1.0, SimpleServer includes support for serving the SRU +and SRW protocols as well as Z39.50. These ``web-friendly'' protocols +enable similar functionality to that of Z39.50, but by means of rich +URLs in the case of SRU, and a SOAP-based web-service in the case of +SRW. These protocols are described at +http://www.loc.gov/sru + +In order to serve these protocols from a SimpleServer-based +application, it is necessary to launch the application with a YAZ +Generic Frontend Server (GFS) configuration file, which can be +specified using the command-line argument C<-f> I. A +minimal configuration file looks like this: + + + + pqf.properties + + + +This file specifies only that C should be used to +translate the CQL queries of SRU and SRW into corresponding Z39.50 +Type-1 queries. For more information about YAZ GFS configuration, +including how to specify an Explain record, see the I +section of the YAZ manual at +http://indexdata.com/yaz/doc/server.vhosts.tkl + +The mapping of CQL queries into Z39.50 Type-1 queries is specified by +a file that indicates which BIB-1 attributes should be generated for +each CQL index, relation, modifiers, etc. A typical section of this +file looks like this: + + index.dc.title = 1=4 + index.dc.subject = 1=21 + index.dc.creator = 1=1003 + relation.< = 2=1 + relation.le = 2=2 + +This file specifies the BIB-1 access points (type=1) for the Dublin +Core indexes C, C<subject> and C<creator>, and the BIB-1 +relations (type=2) corresponding to the CQL relations C<E<lt>> and +C<E<lt>=>. For more information about the format of this file, see +the I<CQL> section of the YAZ manual at +http://indexdata.com/yaz/doc/tools.tkl#tools.cql + +The YAZ distribution include a sample CQL-to-PQF mapping configuration +file called C<pqf.properties>; this is sufficient for many +applications, and a good base to work from for most others. + +If a SimpleServer-based application is run without this SRU-specific +configuration, it can still serve SRU; however, CQL queries will not +be translated, but passed straight through to the search-handler +function, as the C<CQL> member of the parameters hash. It is then the +responsibility of the back-end application to parse and handle the CQL +query, which is most easily done using Ed Summers' fine C<CQL::Parser> +module, available from CPAN at +http://search.cpan.org/~esummers/CQL-Parser/ + =head1 AUTHORS -Anders Sønderberg (sondberg@indexdata.dk) and Sebastian Hammer -(quinn@indexdata.dk). Substantial contributions made by Mike Taylor -(mike@miketaylor.org.uk). +Anders Sønderberg (sondberg@indexdata.dk), +Sebastian Hammer (quinn@indexdata.dk), +Mike Taylor (indexdata.com). =head1 SEE ALSO