1 <?xml version="1.0" standalone="no"?>
2 <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd"
5 <!ENTITY % local SYSTEM "local.ent">
7 <!ENTITY % entities SYSTEM "entities.ent">
9 <!ENTITY % idcommon SYSTEM "common/common.ent">
14 <title>YAZ User's Guide and Reference</title>
16 <author><firstname>Sebastian</firstname><surname>Hammer</surname></author>
17 <author><firstname>Adam</firstname><surname>Dickmeiss</surname></author>
18 <author><firstname>Mike</firstname><surname>Taylor</surname></author>
19 <author><firstname>Heikki</firstname><surname>Levanto</surname></author>
20 <author><firstname>Dennis</firstname><surname>Schafroth</surname></author>
22 <releaseinfo>&version;</releaseinfo>
24 <year>©right-year;</year>
25 <holder>Index Data</holder>
29 This document is the programmer's guide and reference to the &yaz;
30 package version &version;. &yaz; is a compact toolkit that provides
31 access to the Z39.50 and SRU/Solr protocols, as well as a set of
32 higher-level tools for implementing the server and client
34 The documentation can be used on its own, or as a reference when
35 looking at the example applications provided with the package.
40 <imagedata fileref="common/id.png" format="PNG"/>
43 <imagedata fileref="common/id.eps" format="EPS"/>
48 <chapter id="introduction">
49 <title>Introduction</title>
51 &yaz; is a C/C++ library for information retrieval applications
52 using the Z39.50/SRU/Solr protocols for information retrieval.
60 <ulink url="&url.z39.50;">Z39.50</ulink> version 3 support.
61 Amendments and Z39.50-2002 revision is supported.
67 <ulink url="&url.sru;">SRU GET/POST/SOAP</ulink>
68 version 1.1, 1.2 and 2.0 (over HTTP and HTTPS).
73 Includes BER encoders/decoders for the
74 <ulink url="&url.ill;">ISO ILL</ulink>
81 <ulink url="&url.solr;">Solr</ulink> Web Service version 1.4.x
87 Supports the following transports: BER over TCP/IP
88 (<ulink url="&url.ber.over.tcpip;">RFC1729</ulink>),
89 BER over unix local socket, and
90 <ulink url="&url.http.1.1;">HTTP 1.1</ulink>.
95 Secure Socket Layer support using
96 <ulink url="&url.gnutls;">GnuTLS</ulink>.
97 If enabled, &yaz; uses HTTPS transport (for SOAP) or
98 "Secure BER" (for Z39.50).
104 <ulink url="&url.zoom;">ZOOM</ulink> C API implementing
105 Z39.50, SRU and Solr Web Service.
110 The &yaz; library offers a set of useful utilities
111 related to the protocols, such as MARC (ISO2709) parser,
112 CCL (ISO8777) parser,
113 <ulink url="&url.cql;">CQL</ulink>
114 parser, memory management routines, character set conversion.
119 Portable code. &yaz; compiles out-of-the box on most Unixes and
120 on Windows using Microsoft Visual C++.
125 Fast operation. The C based BER encoders/decoders as well
126 as the server component of &yaz; is very fast.
131 Liberal license that allows for commercial use of &yaz;.
137 <sect1 id="introduction.reading">
138 <title>Reading this Manual</title>
140 Most implementors only need to read a fraction of the
141 material in thie manual, so a quick walkthrough of the chapters
147 <xref linkend="installation"/> contains installation
148 instructions for &yaz;. You don't need reading this
149 if you expect to download &yaz; binaries.
150 However, the chapter contains information about how
151 to make <emphasis>your</emphasis> application link
157 <xref linkend="zoom"/> describes the ZOOM API of &yaz;.
158 This is definitely worth a read if you wish to develop a Z39.50/SRU
164 <xref linkend="server"/> describes the generic frontend server
165 and explains how to develop server Z39.50/SRU applications for &yaz;.
166 Obviously worth reading if you're to develop a server.
171 <xref linkend="yaz-client"/> describes how to use the &yaz; Z39.50
172 client. If you're developer and wish to test your server
173 or a server from another party, you might find this chapter
179 <xref linkend="asn"/> documents the most commonly used Z39.50
180 C data structures offered by the &yaz; API. Client
181 developers using ZOOM and non-Z39.50 implementors may skip this.
186 <xref linkend="soap"/> describes how SRU and SOAP is used
187 in &yaz;. Only if you're developing SRU applications
188 this section is a must.
193 <xref linkend="tools"/> contains sections for the various
194 tools offered by &yaz;. Scan through the material quickly
195 and see what's relevant to you! SRU implementors
196 might find the <link linkend="cql">CQL</link> section
202 <xref linkend="odr"/> goes through the details of the
203 ODR module which is the work horse that encodes and decodes
204 BER packages. Implementors using ZOOM only, do <emphasis>not</emphasis>
206 Most other Z39.50 implementors only need to read the first two
207 sections (<xref linkend="odr.introduction"/> and
208 <xref linkend="odr.use"/>).
213 <xref linkend="comstack"/> describes the network layer module
214 COMSTACK. Implementors using ZOOM or the generic frontend server
215 may skip this. Others, presumably, handling client/server
216 communication on their own should read this.
221 <sect1 id="introduction.api">
222 <title>The API</title>
224 The <ulink url="&url.yaz;">&yaz;</ulink>
225 toolkit offers several different levels of access to the
226 <ulink url="&url.z39.50;">ISO23950/Z39.50</ulink>,
227 <ulink url="&url.ill;">ILL</ulink> and
228 <ulink url="&url.sru;">SRU</ulink>
230 The level that you need to use depends on your requirements, and
231 the role (server or client) that you want to implement.
232 If you're developing a client application you should consider the
233 <link linkend="zoom">ZOOM</link> API.
234 It is, by far, the easiest way to develop clients in C.
235 Server implementers should consider the
236 <link linkend="server">generic frontend server</link>.
237 None of those high-level APIs support the whole protocol, but
238 they do include most facilities used in existing Z39.50 applications.
241 If you're using 'exotic' functionality (meaning anything not included in
242 the high-level APIs), developing non-standard extensions to Z39.50 or
243 you're going to develop an ILL application you'll have to learn the lower
247 The YAZ toolkit modules is shown in figure <xref linkend="yaz.layer"/>.
249 <figure id="yaz.layer">
250 <title>YAZ layers</title>
253 <imagedata fileref="apilayer.png" format="PNG"/>
256 <imagedata fileref="apilayer.eps" format="EPS"/>
261 There are four layers.
264 <para>A client or server application (or both).
265 This layer includes ZOOM and the generic frontend server.
270 The second layer provides a C represenation of the
271 protocol units (packages) for Z39.50 ASN.1, ILL ASN.1,
277 The third layer encodes and decodes protocol data units to
278 simple packages (buffer with certain length). The &odr; module
279 encodes and decodes BER whereas the HTTP modules encodes and
280 decodes HTTP ruquests/responses.
285 The lowest layer is &comstack; which exchanges the encoded packages
286 with a peer process over a network.
292 The &asn; module represents the ASN.1 definition of
293 the Z39.50 protocol. It establishes a set of type and
294 structure definitions, with one structure for each of the top-level
295 PDUs, and one structure or type for each of the contained ASN.1 types.
296 For primitive types, or other types that are defined by the ASN.1
297 standard itself (such as the EXTERNAL type), the C representation is
298 provided by the &odr; (Open Data Representation) subsystem.
301 &odr; is a basic mechanism for representing an
302 ASN.1 type in the C programming language, and for implementing BER
303 encoders and decoders for values of that type. The types defined in
304 the &asn; module generally have the prefix <literal>Z_</literal>, and
305 a suffix corresponding to the name of the type in the ASN.1
306 specification of the protocol (generally Z39.50-1995). In the case of
307 base types (those originating in the ASN.1 standard itself), the prefix
308 <literal>Odr_</literal> is sometimes seen. Either way, look for
309 the actual definition in either <filename>z-core.h</filename> (for the types
310 from the protocol), <filename>odr.h</filename> (for the primitive ASN.1
312 The &asn; library also provides functions (which are, in turn,
313 defined using &odr; primitives) for encoding and decoding data values.
314 Their general form is
316 <funcprototype><funcdef>int <function>z_<replaceable>xxx</replaceable></function></funcdef>
317 <paramdef>ODR <parameter>o</parameter></paramdef>
318 <paramdef>Z_<replaceable>xxx</replaceable> **<parameter>p</parameter></paramdef>
319 <paramdef>int <parameter>optional</parameter></paramdef>
320 <paramdef>const char *<parameter>name</parameter></paramdef>
323 (note the lower-case "z" in the function name)
327 If you are using the premade definitions of the &asn; module, and you
328 are not adding new protocol of your own, the only parts of &odr; that you
329 need to worry about are documented in
330 <xref linkend="odr.use"/>.
334 When you have created a BER-encoded buffer, you can use the &comstack;
335 subsystem to transmit (or receive) data over the network. The &comstack;
336 module provides simple functions for establishing a connection
337 (passively or actively, depending on the role of your application),
338 and for exchanging BER-encoded PDUs over that connection. When you
339 create a connection endpoint, you need to specify what transport to
340 use (TCP/IP, SSL or UNIX sockets).
341 For the remainder of the connection's lifetime, you don't have
342 to worry about the underlying transport protocol at all - the &comstack;
343 will ensure that the correct mechanism is used.
346 We call the combined interfaces to &odr;, &asn;, and &comstack; the service
347 level API. It's the API that most closely models the Z39.50
348 service/protocol definition, and it provides unlimited access to all
349 fields and facilities of the protocol definitions.
352 The reason that the &yaz; service-level API is a conglomerate of the
353 APIs from three different submodules is twofold. First, we wanted to allow
354 the user a choice of different options for each major task. For instance,
355 if you don't like the protocol API provided by &odr;/&asn;, you
356 can use SNACC or BERUtils instead, and still have the benefits of the
357 transparent transport approach of the &comstack; module. Secondly,
358 we realize that you may have to fit the toolkit into an existing
359 event-processing structure, in a way that is incompatible with
360 the &comstack; interface or some other part of &yaz;.
364 <chapter id="installation">
365 <title>Compilation and Installation</title>
366 <sect1 id="installation-introduction">
367 <title>Introduction</title>
369 The latest version of the software will generally be found at:
372 <ulink url="&url.yaz.download;"/>
375 We have tried our best to keep the software portable, and on many
376 platforms, you should be able to compile everything with little or
380 The software is regularly tested on
381 <ulink url="&url.debian;">Debian GNU/Linux</ulink>,
382 <ulink url="&url.centos;">CentOS</ulink>,
383 <ulink url="&url.ubuntu;">Ubuntu Linux</ulink>,
384 <ulink url="&url.freebsd;">FreeBSD (i386)</ulink>,
385 <ulink url="&url.macosx;">MAC OSX</ulink>,
386 <ulink url="&url.solaris;">Solaris</ulink>,
387 Windows 7, Windows XP.
390 Some versions have be known to work on HP/UX,
391 DEC Unix, <ulink url="&url.netbsd;">NetBSD</ulink>,
392 <ulink url="&url.openbsd;">OpenBSD</ulink>,
394 Data General DG/UX (with some CFLAGS tinkering),
395 SGI/IRIX, DDE Supermax, Apple Macintosh (using the Codewarrior programming
396 environment and the GUSI socket libraries),
400 If you move the software to other platforms, we'd be grateful if you'd
401 let us know about it. If you run into difficulties, we will try to help
402 if we can, and if you solve the problems, we would be happy to include
403 your fixes in the next release. So far, we have mostly avoided
404 <literal>#ifdefs</literal> for individual platforms, and we'd
405 like to keep it that way as far as it makes sense.
408 We maintain a mailing-list for the purpose of announcing new releases and
409 bug-fixes, as well as general discussion. Subscribe by
411 <ulink url="&url.yaz.mailinglist;">here</ulink>.
412 General questions and problems can be directed at
413 <ulink url="&url.yaz.mail;"/>, or the address given at the top of
417 <sect1 id="installation.unix"><title>UNIX</title>
420 <ulink url="&url.debian;">Debian GNU/Linux</ulink> (i386 and amd64),
421 <ulink url="&url.ubuntu;">Ubuntu</ulink> (i386 and amd64)
423 <ulink url="&url.centos;">CentOS</ulink> (amd64 only) packages for &yaz;.
424 You should be able to create packages for other CPUs by building
425 them from the source package.
428 YAZ is also part of several packages repositories. Some of them are
433 Solaris CSW: <ulink url="http://www.opencsw.org/packages/yaz/"/>
438 Solaris: <ulink url="http://unixpackages.com"/>
443 FreeBSD: <ulink url="http://www.freshports.org/net/yaz"/>
448 Debian: <ulink url="http://packages.debian.org/search?keywords=yaz"/>
453 Ubuntu: <ulink url="https://launchpad.net/ubuntu/+source/yaz"/>
459 <ulink url="http://ftp.netbsd.org/pub/pkgsrc/current/pkgsrc/net/yaz/README.html"/>
463 <sect2 id="installation.source.unix">
464 <title>Compiling from source on Unix</title>
466 Note that if your system doesn't have a native ANSI C compiler, you may
467 have to acquire one separately. We recommend
468 <ulink url="&url.gcc;">GCC</ulink>.
471 If you wish to use character set conversion facilities in &yaz; or if you
472 are compiling &yaz; for use with Zebra it is a good idea to ensure that
473 the iconv library is installed. Some Unixes today already have it
475 <ulink url="&url.libiconv;">GNU libiconv</ulink>.
478 YAZ 3.0.16 and later includes a wrapper for the
479 <ulink url="&url.icu;">ICU</ulink>
480 (International Components for Unicode).
481 In order to use this, the developer version of the ICU library
482 must be available. ICU support is recommended for applications
483 such as Pazpar2 and Zebra.
486 The <ulink url="&url.libxslt;">libxslt</ulink>,
487 <ulink url="&url.libxml2;">libxml2</ulink> librararies are required
488 if &yaz; is to support SRU/Solr.
489 These libraries are very portable and should compile out-of-the
490 box on virtually all Unix platforms. It is available in binary
491 forms for Linux and others.
495 <ulink url="&url.autoconf;">Autoconf</ulink>,
496 <ulink url="&url.automake;">Automake</ulink> and
497 <ulink url="&url.libtool;">Libtool</ulink>
498 are used to generate Makefiles and configure &yaz; for the system.
499 You do <emphasis>not</emphasis> these tools unless you're using the
500 Git version of &yaz;.
503 The CQL parser for &yaz; is built using
504 GNU <ulink url="&url.bison;">Bison</ulink>.
505 This tool is only needed if you're using the Git version of &yaz;.
508 &yaz; includes a tiny ASN.1 compiler. This compiler is
509 written in <ulink url="&url.tcl;">Tcl</ulink>.
510 But as for Bison you do not need it unless you're using Git
511 version of &yaz; or you're using the compiler to built own codecs
515 Generally it should be sufficient to run configure without options,
522 The configure script attempts to use use the C compiler specified by
523 the <literal>CC</literal> environment variable. If not set, GNU C will be
524 used if it is available. The <literal>CFLAGS</literal> environment
525 variable holds options to be passed to the C compiler. If you're using
526 Bourne-compatible shell you may pass something like this to use a
527 particular C compiler with optimization enabled:
530 CC=/opt/ccs/bin/cc CFLAGS=-O ./configure
533 To customize &yaz;, the configure script also accepts a set of options.
534 The most important are:
538 <literal>--prefix</literal>=<replaceable>prefix</replaceable>
541 <para>Specifies installation prefix for &yaz;. This is
542 only needed if you run <literal>make install</literal> later to
543 perform a "system" installation. The prefix is
544 <literal>/usr/local</literal> if not specified.
550 <literal>--enable-tcpd</literal>
553 <para>The front end server will be built using Wietse's
554 <ulink url="&url.tcpwrapper;">TCP wrapper library</ulink>.
555 It allows you to allow/deny clients depending on IP number.
556 The TCP wrapper library is often used in GNU/Linux and
560 <refentrytitle>hosts_access</refentrytitle>
561 <manvolnum>5</manvolnum>
565 <refentrytitle>tcpd</refentrytitle>
566 <manvolnum>8</manvolnum>
573 <literal>--enable-threads</literal>
576 <para>&yaz; will be built using POSIX threads.
577 Specifically, <constant>_REENTRANT</constant> will be defined during
584 <literal>--disable-shared</literal>
587 <para>The make process will not create shared
588 libraries (also known as shared objects <filename>.so</filename>).
589 By default, shared libraries are created -
590 equivalent to <literal>--enable-shared</literal>.
596 <literal>--disable-shared</literal>
599 <para>The make process will not create
600 static libraries (<filename>.a</filename>).
601 By default, static libraries are created -
602 equivalent to <literal>--enable-static</literal>.
608 <literal>--with-iconv</literal>[=<replaceable>prefix</replaceable>]
611 <para>Compile &yaz; with iconv library in directory
612 <replaceable>prefix</replaceable>. By default configure will
613 search for iconv on the system. Use this option if it
614 doesn't find iconv. Alternatively,
615 <literal>--without-iconv</literal>, can be uset to force &yaz;
622 <literal>--with-xslt</literal>[=<replaceable>prefix</replaceable>]
625 <para>Compile &yaz; with
626 <ulink url="&url.libxslt;">libxslt</ulink> in directory
627 <replaceable>prefix</replaceable>.
628 Use this option if you want XSLT and XML support.
629 By default, configure will
630 search for libxslt on the system. Use this option if it
631 libxslt is not found automatically. Alternatively,
632 <literal>--without-xslt</literal>, can be used to force &yaz;
639 <literal>--with-xml2</literal>[=<replaceable>prefix</replaceable>]
642 <para>Compile &yaz; with
643 <ulink url="&url.libxml2;">libxml2</ulink> in directory
644 <replaceable>prefix</replaceable>.
645 Use this option if you want &yaz; to use XML and support SRU/Solr.
646 By default, configure will
647 search for libxml2 on the system. Use this option if it
648 libxml2 is not found automatically. Alternatively,
649 <literal>--without-xml2</literal>, can be used to force &yaz;
653 Note that option <literal>--with-xslt</literal>
654 also enables libxml2.
660 <literal>--with-gnutls</literal>[=<replaceable>prefix</replaceable>]
663 <para>&yaz; will be linked with the GNU TLS libraries and
664 an SSL COMSTACK will be provided. By default configure enables
665 SSL support for YAZ if the GNU TLS development libraries are found
672 <literal>--with-icu</literal>[=<replaceable>prefix</replaceable>]
675 <para>&yaz; will be linked the
676 <ulink url="&url.icu;">ICU</ulink> library in the prefix if given.
677 If prefix is not given, the libraries exposed by the script
678 <application>icu-config</application> will be used if found.
685 <literal>--with-libgcrypt</literal>[=<replaceable>prefix</replaceable>]
688 <para>&yaz; will be linked with
689 <ulink url="&url.libgcrypt;">Libgcrypt</ulink> in the prefix if given.
690 If prefix is not given, the libraries exposed by the script
691 <application>libgcrypt-config</application> will be used if found.
697 <literal>--with-memcached</literal>
700 <para>&yaz; will be linked with
701 <ulink url="&url.libmemcached;">libMemcached</ulink> to allow
702 for result-set caching for ZOOM.
703 The prefix can not be given. Note that YAZ will only search
704 for libMemcached if Libgcrypt is also enabled.
705 Note that 0.40 of libmemcached is required.
711 <literal>--with-redis</literal>
714 <para>&yaz; will be linked with the hiredis C library
715 to allow for result-set caching for ZOOM on a
716 <ulink url="&url.redis;">redis</ulink> server.
717 The prefix can not be given. Note that YAZ will only search
718 for hiredis if Libgcrypt is also enabled.
726 When configured, build the software by typing:
732 The following files are generated by the make process:
735 <term><filename>src/libyaz.la</filename></term>
737 Main &yaz; library. This is no ordinary library. It's
739 By default, &yaz; creates a static library in
740 <filename>lib/.libs/libyaz.a</filename>.
744 <term><filename>src/libyaz_server.la</filename></term>
746 Generic Frontend server. This is an add-on for libyaz.la.
747 Code in this library uses POSIX threads functions - if POSIX
748 threads are available on the platform.
752 <term><filename>src/libyaz_icu.la</filename></term>
754 Functions that wrap the ICU library.
758 <term><filename>ztest/yaz-ztest</filename></term>
759 <listitem><para>Test Z39.50 server.
763 <term><filename>client/yaz-client</filename></term>
764 <listitem><para>Z39.50 client for testing the protocol.
765 See chapter <link linkend="yaz-client">
766 YAZ client</link> for more information.
770 <term><filename>util/yaz-config</filename></term>
771 <listitem><para>A Bourne-shell script, generated by configure, that
772 specifies how external applications should compile - and link with
777 <term><filename>util/yaz-asncomp</filename></term>
778 <listitem><para>The ASN.1 compiler for &yaz;. Requires the
779 Tcl Shell, <application>tclsh</application>, in
780 <literal>PATH</literal> to operate.
784 <term><filename>util/yaz-iconv</filename></term>
785 <listitem><para>This program converts data in one character set to
786 another. This command exercises the YAZ character set
791 <term><filename>util/yaz-marcdump</filename></term>
792 <listitem><para>This program parses ISO2709 encoded MARC records
793 and prints them in line-format or XML.
797 <term><filename>util/yaz-icu</filename></term>
798 <listitem><para>This program exposes the ICU wrapper library if that
799 is enabled for YAZ. Only if ICU is available this program is
804 <term><filename>util/yaz-url</filename></term>
805 <listitem><para>This program is a simple HTTP page fetcher ala
810 <term><filename>zoom/zoomsh</filename></term>
812 A simple shell implemented on top of the
813 <link linkend="zoom">ZOOM</link> functions.
814 The shell is a command line application that allows you to enter
815 simple commands to perform ZOOM operations.
819 <term><filename>zoom/zoomtst1</filename>,
820 <filename>zoom/zoomtst2</filename>, ..</term>
822 Several small applications that demonstrates the ZOOM API.
828 If you wish to install &yaz; in system directories
829 <filename>/usr/local/bin</filename>,
830 <filename>/usr/local/lib</filename> .. etc, you can type:
836 You probably need to have root access in order to perform this.
837 You must specify the <literal>--prefix</literal> option for configure if
838 you wish to install &yaz; in other directories than the default
839 <filename>/usr/local/</filename>.
842 If you wish to perform an un-installation of &yaz;, use:
848 This will only work if you haven't reconfigured &yaz; (and therefore
849 changed installation prefix). Note that uninstall will not
850 remove directories created by make install, e.g.
851 <filename>/usr/local/include/yaz</filename>.
854 <sect2 id="installation-linking-yaz-unix">
855 <title>How to make apps using YAZ on UNIX</title>
857 This section describes how to compile - and link your own
858 applications using the &yaz; toolkit.
859 If you're used to Makefiles this shouldn't be hard. As for
860 other libraries you have used before, you have to set a proper include
861 path for your C/C++ compiler and specify the location of
862 &yaz; libraries. You can do it by hand, but generally we suggest
863 you use the <filename>yaz-config</filename> that is generated
864 by <filename>configure</filename>. This is especially
865 important if you're using the threaded version of &yaz; which
866 require you to pass more options to your linker/compiler.
869 The <filename>yaz-config</filename> script accepts command line
870 options that makes the <filename>yaz-config</filename> script print
871 options that you should use in your make process.
872 The most important ones are:
873 <literal>--cflags</literal>, <literal>--libs</literal>
874 which prints C compiler flags, and linker flags respectively.
877 A small and complete <literal>Makefile</literal> for a C
878 application consisting of one source file,
879 <filename>myprog.c</filename>, may look like this:
881 YAZCONFIG=/usr/local/bin/yaz-config
882 CFLAGS=`$(YAZCONFIG) --cflags`
883 LIBS=`$(YAZCONFIG) --libs`
885 $(CC) $(CFLAGS) -o myprog myprog.o $(LIBS)
889 The CFLAGS variable consists of a C compiler directive that will set
890 the include path to the <emphasis>parent</emphasis> directory
891 of <filename>yaz</filename>. That is, if &yaz; header files were
892 installed in <filename>/usr/local/include/yaz</filename>,
893 then include path is set to <filename>/usr/local/include</filename>.
894 Therefore, in your applications you should use
896 #include <yaz/proto.h>
898 and <emphasis>not</emphasis>
900 #include <proto.h>
904 For Libtool users, the <filename>yaz-config</filename> script provides
905 a different variant of option <literal>--libs</literal>, called
906 <literal>--lalibs</literal> that returns the name of the
907 Libtool archive(s) for &yaz; rather than the ordinary ones.
910 For applications using the threaded version of &yaz;,
911 specify <literal>threads</literal> after the
912 other options. When <literal>threads</literal> is given,
913 more flags and linker flags will be printed by
914 <filename>yaz-config</filename>. If our previous example was
915 using threads, you'd have to modify the lines that set
916 <literal>CFLAGS</literal> and <literal>LIBS</literal> as
919 CFLAGS=`$(YAZCONFIG) --cflags threads`
920 LIBS=`$(YAZCONFIG) --libs threads`
922 There is no need specify POSIX thread libraries in your Makefile.
923 The <literal>LIBS</literal> variable includes that as well.
927 <sect1 id="installation.win32">
928 <title>Windows</title>
929 <para>The easiest way to install YAZ on Windows is by downloading
931 <ulink url="&url.yaz.download.win32;">here</ulink>.
932 The installer comes with source too - in case you wish to
933 compile YAZ with different compiler options, etc.
936 <sect2 id="installation.win32.source">
937 <title>Compiling from Source on Windows</title>
939 &yaz; is shipped with "makefiles" for the NMAKE tool that comes
940 with <ulink url="&url.vstudio;">
941 Microsoft Visual Studio</ulink>. It has been tested with
942 Microsoft Visual Studio 2013.
945 Start a command prompt and switch the sub directory
946 <filename>WIN</filename> where the file <filename>makefile</filename>
947 is located. Customize the installation by editing the
948 <filename>makefile</filename> file (for example by using notepad).
949 The following summarizes the most important settings in that file:
952 <term><literal>DEBUG</literal></term>
954 If set to 1, the software is
955 compiled with debugging libraries (code generation is
956 multi-threaded debug DLL).
957 If set to 0, the software is compiled with release libraries
958 (code generation is multi-threaded DLL).
962 <term><literal>HAVE_TCL</literal>, <literal>TCL</literal></term>
964 If <literal>HAVE_TCL</literal> is set to 1, nmake will
965 use the ASN.1 compiler (<ulink url="&url.tcl;">Tcl</ulink> based).
966 You must set <literal>TCL</literal> to the full path of the Tcl
967 interpreter. A Windows version of Tcl is part of
968 <ulink url="&url.gitwindows;">Git for Windows</ulink>.
971 If you do not have Tcl installed, set
972 <literal>HAVE_TCL</literal> to 0.
976 <term><literal>HAVE_BISON</literal>,
977 <literal>BISON</literal></term>
979 If GNU Bison is present, you might set <literal>HAVE_BISON</literal>
980 to 1 and specify the Bison executable in <literal>BISON</literal>.
981 Bison is only required if you use the Git version of
982 YAZ or if you modify the grammar for CQL
983 (<filename>cql.y</filename>).
986 A Windows version of GNU Bison is part of
987 <ulink url="&url.gitwindows;">Git for Windows</ulink>.
991 <term><literal>HAVE_ICONV</literal>,
992 <literal>ICONV_DIR</literal></term>
994 If <literal>HAVE_ICONV</literal> is set to 1, YAZ is compiled
995 with iconv support. In this configuration, set
996 <literal>ICONV_DIR</literal> to the iconv source directory.
1000 <term><literal>HAVE_LIBXML2</literal>,
1001 <literal>LIBXML2_DIR</literal></term>
1004 If <literal>HAVE_LIBXML2</literal> is set to 1, YAZ is compiled
1005 with SRU support. In this configuration, set
1006 <literal>LIBXML2_DIR</literal> to the
1007 <ulink url="&url.libxml2;">libxml2</ulink> source directory.
1010 You can get pre-compiled Libxml2+Libxslt DLLs and headers from
1011 <ulink url="&url.libxml2.download.windows;">here</ulink>.
1012 Should you with to compile those libraries yourself, refer to
1013 to <xref linkend="installation.windows.libxml2"/>
1018 <term><literal>HAVE_LIBXSLT</literal>,
1019 <literal>LIBXSLT_DIR</literal></term>
1022 If <literal>HAVE_LIBXSLT</literal> is set to 1, YAZ is compiled
1023 with XSLT support. In this configuration, set
1024 <literal>LIBXSLT_DIR</literal> to the
1025 <ulink url="&url.libxslt;">libxslt</ulink> source directory.
1029 libxslt depends libxml2.
1035 <term><literal>HAVE_ICU</literal>,
1036 <literal>ICU_DIR</literal></term>
1039 If <literal>HAVE_ICU</literal> is set to 1, YAZ is compiled
1040 with <ulink url="&url.icu;">ICU</ulink> support.
1041 In this configuration, set
1042 <literal>ICU_DIR</literal> to the
1043 <ulink url="&url.icu;">ICU</ulink> source directory.
1050 When satisfied with the settings in the makefile, type
1057 If the <filename>nmake</filename> command is not found on your system
1058 you probably haven't defined the environment variables required to
1059 use that tool. To fix that, find and run the batch file
1060 <filename>vcvars32.bat</filename>. You need to run it from within
1061 the command prompt or set the environment variables "globally";
1062 otherwise it doesn't work.
1066 If you wish to recompile &yaz; - for example if you modify
1067 settings in the <filename>makefile</filename> you can delete
1068 object files, etc by running.
1074 The following files are generated upon successful compilation:
1077 <term><filename>bin/yaz&soversion;.dll</filename> /
1078 <filename>bin/yaz&soversion;d.dll</filename></term>
1080 &yaz; Release/Debug DLL.
1084 <term><filename>lib/yaz&soversion;.lib</filename> /
1085 <filename>lib/yaz&soversion;d.lib</filename></term>
1087 Import library for <filename>yaz&soversion;.dll</filename> /
1088 <filename>yaz&soversion;d.dll</filename>.
1092 <term><filename>bin/yaz_cond&soversion;.dll</filename> /
1093 <filename>bin/yaz_cond&soversion;d.dll</filename></term>
1095 Release/Debug DLL for condition variable utilities (condvar.c).
1099 <term><filename>lib/yaz_cond&soversion;.lib</filename> /
1100 <filename>lib/yaz_cond&soversion;d.lib</filename></term>
1102 Import library for <filename>yaz_cond&soversion;.dll</filename> /
1103 <filename>yaz_cond&soversion;d.dll</filename>.
1107 <term><filename>bin/yaz_icu&soversion;.dll</filename> /
1108 <filename>bin/yaz_icu&soversion;d.dll</filename></term>
1110 Release/Debug DLL for the ICU wrapper utility.
1111 Only build if HAVE_ICU is 1.
1115 <term><filename>lib/yaz_icu&soversion;.lib</filename> /
1116 <filename>lib/yaz_icu&soversion;d.lib</filename></term>
1118 Import library for <filename>yaz_icu&soversion;.dll</filename> /
1119 <filename>yaz_icu&soversion;d.dll</filename>.
1123 <term><filename>bin/yaz-ztest.exe</filename></term>
1125 Z39.50 multi-threaded test/example server. It's a WIN32
1126 console application.
1130 <term><filename>bin/yaz-client.exe</filename></term>
1132 &yaz; Z39.50 client application. It's a WIN32 console application.
1133 See chapter <link linkend="yaz-client">YAZ client</link> for more
1138 <term><filename>bin/yaz-icu.exe</filename></term>
1139 <listitem><para>This program exposes the ICU wrapper library if that
1140 is enabled for YAZ. Only if ICU is available this program is
1145 <term><filename>bin/zoomsh.exe</filename></term>
1147 Simple console application implemented on top of the
1148 <link linkend="zoom">ZOOM</link> functions.
1149 The application is a command line shell that allows you to enter
1150 simple commands to perform ZOOM operations.
1154 <term><filename>bin/zoomtst1.exe</filename>,
1155 <filename>bin/zoomtst2.exe</filename>, ..</term>
1157 Several small applications that demonstrates the ZOOM API.
1164 <sect2 id="installation-linking-yaz-win32">
1165 <title>How to make apps using YAZ on Windows</title>
1167 This section will go though the process of linking your Windows
1168 applications with &yaz;.
1171 Some people are confused by the fact that we use the nmake
1172 tool to build &yaz;. They think they have to do that too - in order
1173 to make their Windows applications work with &yaz;. The good news is that
1174 you don't have to. You can use the integrated environment of
1175 Visual Studio if desired for your own application.
1178 When setting up a project or Makefile you have to set the following:
1181 <term>include path</term>
1183 Set it to the <filename>include</filename> directory of &yaz;.
1187 <term>import library <filename>yaz&soversion;.lib</filename></term>
1189 You must link with this library. It's located in the
1190 sub directory <filename>lib</filename> of &yaz;.
1191 If you want to link with the debug version of &yaz;, you must
1192 link against <filename>yaz&soversion;d.lib</filename> instead.
1196 <term>dynamic link library
1197 <filename>yaz&soversion;.dll</filename>
1200 This DLL must be in your execution path when you invoke
1201 your application. Specifically, you should distribute this
1202 DLL with your application.
1209 <sect2 id="installation.windows.libxml2">
1210 <title>Compiling Libxml2 and Libxslt on windows</title>
1212 Download libxml2 and Libxslt source and unpack it.
1213 In the example below we install Libxml2 2.9.2 and Libxslt 1.1.28
1214 for 32-bit, so we use the destination directories
1215 libxml2.2.9.2.win32 and libxslt-1.1.28.win32 to reflect both
1216 version and architecture.
1219 cscript configure.js prefix=c:\libxml2-2.9.2.win32 iconv=no
1226 There's an error in <filename>configure.js</filename> for Libxml2 2.9.2.
1227 Line 17 should be assigned to <filename>configure.ac</filename>
1228 rather than <filename>configure.in</filename>.
1232 For Libxslt it is similar. We must ensure that compilation of
1233 Libxslt links against the already installed libxml2.
1236 cscript configure.js prefix=c:\libxslt-1.1.28.win32 iconv=no \
1237 lib=c:\libxml2-2.9.2.win32\lib \
1238 include=c:\libxml2-2.9.2.win32\include\libxml2
1248 ### Still to document:
1249 ZOOM_connection_errcode(c)
1250 ZOOM_connection_errmsg(c)
1251 ZOOM_connection_addinfo(c)
1252 ZOOM_connection_addinfo(c)
1253 ZOOM_connection_diagset(c);
1254 ZOOM_connection_save_apdu_wrbuf
1255 ZOOM_diag_str(error)
1256 ZOOM_resultset_record_immediate(s, pos)
1257 ZOOM_resultset_cache_reset(r)
1258 ZOOM_options_set_callback(opt, function, handle)
1259 ZOOM_options_create_with_parent2(parent1, parent2)
1260 ZOOM_options_getl(opt, name, len)
1261 ZOOM_options_setl(opt, name, value, len)
1262 ZOOM_options_get_bool(opt, name, defa)
1263 ZOOM_options_get_int(opt, name, defa)
1264 ZOOM_options_set_int(opt, name, value)
1269 &zoom; is an acronym for 'Z39.50 Object-Orientation Model' and is
1270 an initiative started by Mike Taylor (Mike is from the UK, which
1271 explains the peculiar name of the model). The goal of &zoom; is to
1272 provide a common Z39.50 client API not bound to a particular
1273 programming language or toolkit.
1276 From YAZ version 2.1.12, <ulink url="&url.sru;">SRU</ulink> is supported.
1277 You can make SRU ZOOM connections by specifying scheme
1278 <literal>http://</literal> for the hostname for a connection.
1279 The dialect of SRU used is specified by the value of the
1280 connection's <literal>sru</literal> option, which may be SRU over
1281 HTTP GET (<literal>get</literal>),
1282 SRU over HTTP POST (<literal>post</literal>), (SRU over
1283 SOAP) (<literal>soap</literal>) or <literal>solr</literal>
1284 (<ulink url="&url.solr;">Solr</ulink> Web Service).
1285 Using the facility for embedding options in target strings, a
1286 connection can be forced to use SRU rather the SRW (the default) by
1287 prefixing the target string with <literal>sru=get,</literal>, like this:
1288 <literal>sru=get,http://sru.miketaylor.org.uk:80/sru.pl</literal>
1291 <ulink url="&url.solr;">Solr</ulink> protocol support was added to
1292 YAZ in version 4.1.0, as a dialect of a SRU protocol, since both are
1293 HTTP based protocols.
1296 The lack of a simple Z39.50 client API for &yaz; has become more
1297 and more apparent over time. So when the first &zoom; specification
1299 an implementation for &yaz; was quickly developed. For the first time, it is
1300 now as easy (or easier!) to develop clients than servers with &yaz;. This
1301 chapter describes the &zoom; C binding. Before going further, please
1302 reconsider whether C is the right programming language for the job.
1303 There are other language bindings available for &yaz;, and still
1305 are in active development. See the
1306 <ulink url="&url.zoom;">ZOOM web-site</ulink> for
1310 In order to fully understand this chapter you should read and
1311 try the example programs <literal>zoomtst1.c</literal>,
1312 <literal>zoomtst2.c</literal>, .. in the <literal>zoom</literal>
1316 The C language misses features found in object oriented languages
1317 such as C++, Java, etc. For example, you'll have to manually,
1318 destroy all objects you create, even though you may think of them as
1319 temporary. Most objects has a <literal>_create</literal> - and a
1320 <literal>_destroy</literal> variant.
1321 All objects are in fact pointers to internal stuff, but you don't see
1322 that because of typedefs. All destroy methods should gracefully ignore a
1323 <literal>NULL</literal> pointer.
1326 In each of the sections below you'll find a sub section called
1327 protocol behavior, that describes how the API maps to the Z39.50
1330 <sect1 id="zoom-connections">
1331 <title>Connections</title>
1332 <para>The Connection object is a session with a target.
1335 #include <yaz/zoom.h>
1337 ZOOM_connection ZOOM_connection_new(const char *host, int portnum);
1339 ZOOM_connection ZOOM_connection_create(ZOOM_options options);
1341 void ZOOM_connection_connect(ZOOM_connection c, const char *host,
1343 void ZOOM_connection_destroy(ZOOM_connection c);
1346 Connection objects are created with either function
1347 <function>ZOOM_connection_new</function> or
1348 <function>ZOOM_connection_create</function>.
1349 The former creates and automatically attempts to establish a network
1350 connection with the target. The latter doesn't establish
1351 a connection immediately, thus allowing you to specify options
1352 before establishing network connection using the function
1353 <function>ZOOM_connection_connect</function>.
1354 If the port number, <literal>portnum</literal>, is zero, the
1355 <literal>host</literal> is consulted for a port specification.
1356 If no port is given, 210 is used. A colon denotes the beginning of
1357 a port number in the host string. If the host string includes a
1358 slash, the following part specifies a database for the connection.
1361 You can prefix the host with a scheme followed by colon. The
1362 default scheme is <literal>tcp</literal> (Z39.50 protocol).
1363 The scheme <literal>http</literal> selects SRU/get over HTTP by default,
1364 but can overridded to use SRU/post, SRW and the Solr protocol.
1367 You can prefix the scheme-qualified host-string with one or more
1369 <literal><parameter>key</parameter>=<parameter>value</parameter></literal>
1370 sequences, each of which represents an option to be set into the
1371 connection structure <emphasis>before</emphasis> the
1372 protocol-level connection is forged and the initialization
1373 handshake takes place. This facility can be used to provide
1374 authentication credentials, as in host-strings such as:
1375 <literal>user=admin,password=halfAm4n,tcp:localhost:8017/db</literal>
1378 Connection objects should be destroyed using the function
1379 <function>ZOOM_connection_destroy</function>.
1382 void ZOOM_connection_option_set(ZOOM_connection c,
1383 const char *key, const char *val);
1385 void ZOOM_connection_option_setl(ZOOM_connection c,
1387 const char *val, int len);
1389 const char *ZOOM_connection_option_get(ZOOM_connection c,
1391 const char *ZOOM_connection_option_getl(ZOOM_connection c,
1396 The functions <function>ZOOM_connection_option_set</function> and
1397 <function>ZOOM_connection_option_setl</function> allows you to
1398 set an option given by <parameter>key</parameter> to the value
1399 <parameter>value</parameter> for the connection.
1400 For <function>ZOOM_connection_option_set</function>, the
1401 value is assumed to be a 0-terminated string. Function
1402 <function>ZOOM_connection_option_setl</function> specifies a
1403 value of a certain size (len).
1406 Functions <function>ZOOM_connection_option_get</function> and
1407 <function>ZOOM_connection_option_getl</function> returns
1408 the value for an option given by <parameter>key</parameter>.
1410 <table id="zoom-connection-options" frame="top">
1411 <title>ZOOM Connection Options</title>
1413 <colspec colwidth="4*" colname="name"></colspec>
1414 <colspec colwidth="7*" colname="description"></colspec>
1415 <colspec colwidth="3*" colname="default"></colspec>
1418 <entry>Option</entry>
1419 <entry>Description</entry>
1420 <entry>Default</entry>
1425 implementationName</entry><entry>Name of Your client
1426 </entry><entry>none</entry></row>
1428 user</entry><entry>Authentication user name
1429 </entry><entry>none</entry></row>
1431 group</entry><entry>Authentication group name
1432 </entry><entry>none</entry></row>
1434 password</entry><entry>Authentication password.
1435 </entry><entry>none</entry></row>
1437 authenticationMode</entry><entry>How authentication is encoded.
1438 </entry><entry>basic</entry></row>
1440 host</entry><entry>Target host. This setting is "read-only".
1441 It's automatically set internally when connecting to a target.
1442 </entry><entry>none</entry></row>
1444 proxy</entry><entry>Proxy host. If set, the logical host
1445 is encoded in the otherInfo area of the Z39.50 Init PDU
1446 with OID 1.2.840.10003.10.1000.81.1.
1447 </entry><entry>none</entry></row>
1449 clientIP</entry><entry>Client IP. If set, is
1450 encoded in the otherInfo area of a Z39.50 PDU with OID
1451 1.2.840.10003.10.1000.81.3. Holds the original IP addreses
1452 of a client. Is used of ZOOM is used in a gateway of some sort.
1453 </entry><entry>none</entry></row>
1455 async</entry><entry>If true (1) the connection operates in
1456 asynchronous operation which means that all calls are non-blocking
1458 <link linkend="zoom.events"><function>ZOOM_event</function></link>.
1459 </entry><entry>0</entry></row>
1461 maximumRecordSize</entry><entry> Maximum size of single record.
1462 </entry><entry>1 MB</entry></row>
1464 preferredMessageSize</entry><entry> Maximum size of multiple records.
1465 </entry><entry>1 MB</entry></row>
1467 lang</entry><entry> Language for negotiation.
1468 </entry><entry>none</entry></row>
1470 charset</entry><entry> Character set for negotiation.
1471 </entry><entry>none</entry></row>
1473 serverImplementationId</entry><entry>
1474 Implementation ID of server. (The old targetImplementationId
1475 option is also supported for the benefit of old applications.)
1476 </entry><entry>none</entry></row>
1478 targetImplementationName</entry><entry>
1479 Implementation Name of server. (The old
1480 targetImplementationName option is also supported for the
1481 benefit of old applications.)
1482 </entry><entry>none</entry></row>
1484 serverImplementationVersion</entry><entry>
1485 Implementation Version of server. (the old
1486 targetImplementationVersion option is also supported for the
1487 benefit of old applications.)
1488 </entry><entry>none</entry></row>
1490 databaseName</entry><entry>One or more database names
1491 separated by character plus (<literal>+</literal>), which to
1492 be used by subsequent search requests on this Connection.
1493 </entry><entry>Default</entry></row>
1495 piggyback</entry><entry>True (1) if piggyback should be
1496 used in searches; false (0) if not.
1497 </entry><entry>1</entry></row>
1499 smallSetUpperBound</entry><entry>If hits is less than or equal to this
1500 value, then target will return all records using small element set name
1501 </entry><entry>0</entry></row>
1503 largeSetLowerBound</entry><entry>If hits is greater than this
1504 value, the target will return no records.
1505 </entry><entry>1</entry></row>
1507 mediumSetPresentNumber</entry><entry>This value represents
1508 the number of records to be returned as part of a search when when
1509 hits is less than or equal to large set lower bound and if hits
1510 is greater than small set upper bound.
1511 </entry><entry>0</entry></row>
1513 smallSetElementSetName</entry><entry>
1514 The element set name to be used for small result sets.
1515 </entry><entry>none</entry></row>
1517 mediumSetElementSetName</entry><entry>
1518 The element set name to be for medium-sized result sets.
1519 </entry><entry>none</entry></row>
1521 init_opt_search, init_opt_present, init_opt_delSet, etc.</entry><entry>
1522 After a successful Init, these options may be interrogated to
1523 discover whether the server claims to support the specified
1525 </entry><entry>none</entry></row>
1527 <entry>sru</entry><entry>
1528 SRU/Solr transport type. Must be either <literal>soap</literal>,
1529 <literal>get</literal>, <literal>post</literal>, or
1530 <literal>solr</literal>.
1531 </entry><entry>soap</entry></row>
1533 sru_version</entry><entry>
1534 SRU/SRW version. Should be <literal>1.1</literal>, or
1535 <literal>1.2</literal>. This is , prior to connect, the version
1536 to offer (highest version). And following connect (in fact
1537 first operation), holds the negotiated version with the server
1538 (same or lower version).
1539 </entry><entry>1.2</entry></row>
1540 <row id="zoom.extraArgs.option"><entry>
1541 extraArgs</entry><entry>
1542 Extra arguments for SRU/Solr URLs. The value must be
1543 URL encoded already.
1544 </entry><entry></entry></row>
1545 <row id="zoom.facets.option"><entry>
1546 facets</entry><entry>
1547 Requested or recommend facets may be given before a search is sent.
1548 The value of this setting is described in <xref linkend="facets"/>
1549 For inspection of the facets returned, refer to the functions
1550 described in <xref linkend="zoom.facets"/>.
1551 </entry><entry>none</entry></row>
1553 apdulog</entry><entry>
1554 If set to a true value such as "1", a log of low-level
1555 protocol packets is emitted on standard error stream. This
1556 can be very useful for debugging.
1557 </entry><entry>0</entry></row>
1559 saveAPDU</entry><entry>
1560 If set to a true value such as "1", a log of low-level
1561 protocol packets is saved. The log can be retrieved by reading
1562 option APDU. Setting saveAPDU always has the side effect of
1563 resetting the currently saved log. This setting is
1564 <emphasis>write-only</emphasis>. If read, NULL will be returned.
1565 It is only recognized in
1566 <function>ZOOM_connection_option_set</function>.
1567 </entry><entry>0</entry></row>
1570 Returns the log of protocol packets. Will be empty if logging
1571 is not enabled (see saveAPDU above). This setting is
1572 <emphasis>read-only</emphasis>. It is only recognized if used
1573 in call to <function>ZOOM_connection_option_get</function> or
1574 <function>ZOOM_connection_option_getl</function>.
1575 </entry><entry></entry></row>
1577 memcached</entry><entry>
1578 If given and non-empty,
1579 <ulink url="&url.libmemcached;">libMemcached</ulink>
1580 will be configured for the connection.
1581 This option is inspected by ZOOM when a connection is established.
1582 If the <literal>memcached</literal> option is given
1583 and YAZ is compiled without libMemcached support, an internal
1584 diagnostic (10018) will be thrown.
1585 libMemcached support is available for YAZ 5.0.13 or later. If this
1586 option is supplied for an earlier version of YAZ, it is
1587 <emphasis>ignored</emphasis>.
1588 The value of this option is a list options - each is of the
1589 form <literal>--name=value</literal>.
1590 Option <literal>--server=</literal>host[:port] specifies a memcached
1591 server. It may be repeated for multiple memcached servers.
1592 Option <literal>--expire=</literal>seconds sets expiry time in seconds
1593 for how long result sets are to be cached.
1594 </entry><entry>none</entry></row>
1596 redis</entry><entry>
1597 If given and non-empty,
1598 a <ulink url="&url.redis;">redis</ulink> context will be created
1600 This option is inspected by ZOOM when a connection is established.
1601 If the <literal>redis</literal> option is given
1602 and YAZ is compiled without redis support, an internal
1603 diagnostic (10018) will be thrown.
1604 redis support is available for YAZ 5.2.0 or later. If this
1605 option is supplied for an earlier version of YAZ, it is
1606 <emphasis>ignored</emphasis>.
1607 The value of this option is a set options, similar to that
1608 of the memcached setting. At this stage only --server=host[:port]
1609 and --expire=seconds is supported.
1610 </entry><entry>none</entry></row>
1615 If either option <literal>lang</literal> or <literal>charset</literal>
1617 <ulink url="&url.z39.50.charneg;">
1618 Character Set and Language Negotiation</ulink> is in effect.
1621 int ZOOM_connection_error(ZOOM_connection c, const char **cp,
1622 const char **addinfo);
1623 int ZOOM_connection_error_x(ZOOM_connection c, const char **cp,
1624 const char **addinfo, const char **dset);
1627 Function <function>ZOOM_connection_error</function> checks for
1628 errors for the last operation(s) performed. The function returns
1629 zero if no errors occurred; non-zero otherwise indicating the error.
1630 Pointers <parameter>cp</parameter> and <parameter>addinfo</parameter>
1631 holds messages for the error and additional-info if passed as
1632 non-<literal>NULL</literal>. Function
1633 <function>ZOOM_connection_error_x</function> is an extended version
1634 of <function>ZOOM_connection_error</function> that is capable of
1635 returning name of diagnostic set in <parameter>dset</parameter>.
1637 <sect2 id="zoom-connection-z39.50">
1638 <title>Z39.50 Protocol behavior</title>
1640 The calls <function>ZOOM_connection_new</function> and
1641 <function>ZOOM_connection_connect</function> establishes a TCP/IP
1642 connection and sends an Initialize Request to the target if
1643 possible. In addition, the calls waits for an Initialize Response
1644 from the target and the result is inspected (OK or rejected).
1647 If <literal>proxy</literal> is set then the client will establish
1648 a TCP/IP connection with the peer as specified by the
1649 <literal>proxy</literal> host and the hostname as part of the
1650 connect calls will be set as part of the Initialize Request.
1651 The proxy server will then "forward" the PDU's transparently
1652 to the target behind the proxy.
1655 For the authentication parameters, if option <literal>user</literal>
1656 is set and both options <literal>group</literal> and
1657 <literal>pass</literal> are unset, then Open style
1658 authentication is used (Version 2/3) in which case the username
1659 is usually followed by a slash, then by a password.
1660 If either <literal>group</literal>
1661 or <literal>pass</literal> is set then idPass authentication
1662 (Version 3 only) is used. If none of the options are set, no
1663 authentication parameters are set as part of the Initialize Request
1667 When option <literal>async</literal> is 1, it really means that
1668 all network operations are postponed (and queued) until the
1669 function <literal>ZOOM_event</literal> is invoked. When doing so
1670 it doesn't make sense to check for errors after
1671 <literal>ZOOM_connection_new</literal> is called since that
1672 operation "connecting - and init" is still incomplete and the
1673 API cannot tell the outcome (yet).
1676 <sect2 id="zoom.sru.init.behavior">
1677 <title>SRU/Solr Protocol behavior</title>
1679 The HTTP based protocols (SRU, SRW, Solr) doesn't feature an
1680 Inititialize Request, so the connection phase merely establishes a
1681 TCP/IP connection with the HTTP server.
1683 <para>Most of the ZOOM connection options do not
1684 affect SRU/Solr and they are ignored. However, future versions
1685 of &yaz; might honor <literal>implementationName</literal> and
1686 put that as part of User-Agent header for HTTP requests.
1689 The <literal>charset</literal> is used in the Content-Type header
1693 Setting <literal>authentcationMode</literal> specifies how
1694 authentication parameters are encoded for HTTP. The default is
1695 "<literal>basic</literal>" where <literal>user</literal> and
1696 <literal>password</literal> are encoded by using HTTP basic
1700 If <literal>authentcationMode</literal> is "<literal>url</literal>", then
1701 user and password are encoded in the URL by parameters
1702 <literal>x-username</literal> and <literal>x-password</literal> as
1703 given by the SRU standard.
1707 <sect1 id="zoom.query">
1708 <title>Queries</title>
1710 Query objects represents queries.
1713 ZOOM_query ZOOM_query_create(void);
1715 void ZOOM_query_destroy(ZOOM_query q);
1717 int ZOOM_query_prefix(ZOOM_query q, const char *str);
1719 int ZOOM_query_cql(ZOOM_query s, const char *str);
1721 int ZOOM_query_sortby(ZOOM_query q, const char *criteria);
1723 int ZOOM_query_sortby2(ZOOM_query q, const char *strategy,
1724 const char *criteria);
1727 Create query objects using <function>ZOOM_query_create</function>
1728 and destroy them by calling <function>ZOOM_query_destroy</function>.
1729 RPN-queries can be specified in <link linkend="PQF">PQF</link>
1730 notation by using the
1731 function <function>ZOOM_query_prefix</function>.
1732 The <function>ZOOM_query_cql</function> specifies a CQL
1733 query to be sent to the server/target.
1734 More query types will be added in future versions of &yaz;, such as
1735 <link linkend="CCL">CCL</link> to RPN-mapping, native CCL query,
1736 etc. In addition to a search, a sort criteria may be set. Function
1737 <function>ZOOM_query_sortby</function> enables Z39.50 sorting and
1738 it takes sort criteria using the same string notation as
1739 yaz-client's <link linkend="sortspec">sort command</link>.
1741 <para id="zoom.query.sortby2">
1742 <function>ZOOM_query_sortby2</function> is similar to
1743 <function>ZOOM_query_sortby</function> but allows a strategy for
1744 sorting. The reason for the strategy parameter is that some
1745 protocols offers multiple ways of performing sorting.
1746 For example, Z39.50 has the standard sort, which is performed after
1747 search on an existing result set.
1748 It's also possible to use CQL in Z39.50 as the query type and use
1749 CQL's SORTBY keyword. Finally, Index Data's
1750 Zebra server also allows sorting to be specified as part of RPN (Type 7).
1752 <table id="zoom-sort-strategy" frame="top">
1753 <title>ZOOM sort strategy</title>
1755 <colspec colwidth="2*" colname="name"/>
1756 <colspec colwidth="5*" colname="description"/>
1760 <entry>Description</entry>
1765 <entry>z39.50</entry><entry>Z39.50 resultset sort</entry>
1768 <entry>type7</entry><entry>Sorting embedded in RPN(Type-7)</entry>
1771 <entry>cql</entry><entry>CQL SORTBY</entry>
1774 <entry>sru11</entry><entry>SRU sortKeys parameter</entry>
1777 <entry>solr</entry><entry>Solr sort</entry>
1780 <entry>embed</entry><entry>type7 for Z39.50, cql for SRU,
1781 solr for Solr protocol</entry>
1787 <sect1 id="zoom.resultsets"><title>Result sets</title>
1789 The result set object is a container for records returned from
1793 ZOOM_resultset ZOOM_connection_search(ZOOM_connection, ZOOM_query q);
1795 ZOOM_resultset ZOOM_connection_search_pqf(ZOOM_connection c,
1797 void ZOOM_resultset_destroy(ZOOM_resultset r);
1800 Function <function>ZOOM_connection_search</function> creates
1801 a result set given a connection and query.
1802 Destroy a result set by calling
1803 <function>ZOOM_resultset_destroy</function>.
1804 Simple clients may using PQF only may use function
1805 <function>ZOOM_connection_search_pqf</function> in which case
1806 creating query objects is not necessary.
1809 void ZOOM_resultset_option_set(ZOOM_resultset r,
1810 const char *key, const char *val);
1812 const char *ZOOM_resultset_option_get(ZOOM_resultset r, const char *key);
1814 size_t ZOOM_resultset_size(ZOOM_resultset r);
1817 Functions <function>ZOOM_resultset_options_set</function> and
1818 <function>ZOOM_resultset_get</function> sets and gets an option
1819 for a result set similar to <function>ZOOM_connection_option_get</function>
1820 and <function>ZOOM_connection_option_set</function>.
1823 The number of hits also called result-count is returned by
1824 function <function>ZOOM_resultset_size</function>.
1826 <table id="zoom.resultset.options"
1827 frame="top"><title>ZOOM Result set Options</title>
1829 <colspec colwidth="4*" colname="name"></colspec>
1830 <colspec colwidth="7*" colname="description"></colspec>
1831 <colspec colwidth="2*" colname="default"></colspec>
1834 <entry>Option</entry>
1835 <entry>Description</entry>
1836 <entry>Default</entry>
1841 start</entry><entry>Offset of first record to be
1842 retrieved from target. First record has offset 0 unlike the
1843 protocol specifications where first record has position 1.
1844 This option affects ZOOM_resultset_search and
1845 ZOOM_resultset_search_pqf and must be set before any of
1846 these functions are invoked. If a range of
1847 records must be fetched manually after search,
1848 function ZOOM_resultset_records should be used.
1849 </entry><entry>0</entry></row>
1851 count</entry><entry>Number of records to be retrieved.
1852 This option affects ZOOM_resultset_search and
1853 ZOOM_resultset_search_pqf and must be set before any of
1854 these functions are invoked.
1855 </entry><entry>0</entry></row>
1857 presentChunk</entry><entry>The number of records to be
1858 requested from the server in each chunk (present request). The
1859 value 0 means to request all the records in a single chunk.
1860 (The old <literal>step</literal>
1861 option is also supported for the benefit of old applications.)
1862 </entry><entry>0</entry></row>
1864 elementSetName</entry><entry>Element-Set name of records.
1865 Most targets should honor element set name <literal>B</literal>
1866 and <literal>F</literal> for brief and full respectively.
1867 </entry><entry>none</entry></row>
1869 preferredRecordSyntax</entry><entry>Preferred Syntax, such as
1870 <literal>USMARC</literal>, <literal>SUTRS</literal>, etc.
1871 </entry><entry>none</entry></row>
1873 schema</entry><entry>Schema for retrieval, such as
1874 <literal>Gils-schema</literal>, <literal>Geo-schema</literal>, etc.
1875 </entry><entry>none</entry></row>
1877 setname</entry><entry>Name of Result Set (Result Set ID).
1878 If this option isn't set, the ZOOM module will automatically
1879 allocate a result set name.
1880 </entry><entry>default</entry></row>
1882 rpnCharset</entry><entry>Character set for RPN terms.
1883 If this is set, ZOOM C will assume that the ZOOM application is
1884 running UTF-8. Terms in RPN queries are then converted to the
1885 rpnCharset. If this is unset, ZOOM C will not assume any encoding
1886 of RPN terms and no conversion is performed.
1887 </entry><entry>none</entry></row>
1892 For servers that support Search Info report, the following
1893 options may be read using <function>ZOOM_resultset_get</function>.
1894 This detailed information is read after a successful search has
1898 This information is a list of of items, where each item is
1899 information about a term or subquery. All items in the list
1901 <literal>SearchResult.</literal><replaceable>no</replaceable>
1902 where no presents the item number (0=first, 1=second).
1903 Read <literal>searchresult.size</literal> to determine the
1906 <table id="zoom.search.info.report.options"
1907 frame="top"><title>Search Info Report Options</title>
1909 <colspec colwidth="4*" colname="name"></colspec>
1910 <colspec colwidth="7*" colname="description"></colspec>
1913 <entry>Option</entry>
1914 <entry>Description</entry>
1919 <entry>searchresult.size</entry>
1921 number of search result entries. This option is-nonexistant
1922 if no entries are returned by the server.
1926 <entry>searchresult.<replaceable>no</replaceable>.id</entry>
1927 <entry>sub query ID</entry>
1930 <entry>searchresult.<replaceable>no</replaceable>.count</entry>
1931 <entry>result count for item (number of hits)</entry>
1934 <entry>searchresult.<replaceable>no</replaceable>.subquery.term</entry>
1935 <entry>subquery term</entry>
1939 searchresult.<replaceable>no</replaceable>.interpretation.term
1941 <entry>interpretation term</entry>
1945 searchresult.<replaceable>no</replaceable>.recommendation.term
1947 <entry>recommendation term</entry>
1952 <sect2 id="zoom.z3950.resultset.sort">
1953 <title>Z39.50 Result-set Sort</title>
1955 void ZOOM_resultset_sort(ZOOM_resultset r,
1956 const char *sort_type, const char *sort_spec);
1958 int ZOOM_resultset_sort1(ZOOM_resultset r,
1959 const char *sort_type, const char *sort_spec);
1962 <function>ZOOM_resultset_sort</function> and
1963 <function>ZOOM_resultset_sort1</function> both sort an existing
1964 result-set. The sort_type parameter is not use. Set it to "yaz".
1965 The sort_spec is same notation as ZOOM_query_sortby and identical
1966 to that offered by yaz-client's
1967 <link linkend="sortspec">sort command</link>.
1970 These functions only work for Z39.50. Use the more generic utility
1971 <link linkend="zoom.query.sortby2">
1972 <function>ZOOM_query_sortby2</function></link>
1973 for other protocols (and even Z39.50).
1976 <sect2 id="zoom.z3950.resultset.behavior">
1977 <title>Z39.50 Protocol behavior</title>
1979 The creation of a result set involves at least a SearchRequest
1980 - SearchResponse protocol handshake. Following that, if a sort
1981 criteria was specified as part of the query, a SortRequest -
1982 SortResponse handshake takes place. Note that it is necessary to
1983 perform sorting before any retrieval takes place, so no records will
1984 be returned from the target as part of the SearchResponse because these
1985 would be unsorted. Hence, piggyback is disabled when sort criteria
1986 are set. Following Search - and a possible sort - Retrieval takes
1987 place - as one or more Present Requests/Response pairs being
1991 The API allows for two different modes for retrieval. A high level
1992 mode which is somewhat more powerful and a low level one.
1993 The low level is enabled when searching on a Connection object
1994 for which the settings
1995 <literal>smallSetUpperBound</literal>,
1996 <literal>mediumSetPresentNumber</literal> and
1997 <literal>largeSetLowerBound</literal> are set. The low level mode
1998 thus allows you to precisely set how records are returned as part
1999 of a search response as offered by the Z39.50 protocol.
2000 Since the client may be retrieving records as part of the
2001 search response, this mode doesn't work well if sorting is used.
2004 The high-level mode allows you to fetch a range of records from
2005 the result set with a given start offset. When you use this mode
2006 the client will automatically use piggyback if that is possible
2007 with the target and perform one or more present requests as needed.
2008 Even if the target returns fewer records as part of a present response
2009 because of a record size limit, etc. the client will repeat sending
2010 present requests. As an example, if option <literal>start</literal>
2011 is 0 (default) and <literal>count</literal> is 4, and
2012 <literal>piggyback</literal> is 1 (default) and no sorting criteria
2013 is specified, then the client will attempt to retrieve the 4
2014 records as part the search response (using piggyback). On the other
2015 hand, if either <literal>start</literal> is positive or if
2016 a sorting criteria is set, or if <literal>piggyback</literal>
2017 is 0, then the client will not perform piggyback but send Present
2021 If either of the options <literal>mediumSetElementSetName</literal> and
2022 <literal>smallSetElementSetName</literal> are unset, the value
2023 of option <literal>elementSetName</literal> is used for piggyback
2024 searches. This means that for the high-level mode you only have
2025 to specify one elementSetName option rather than three.
2028 <sect2 id="zoom.sru.resultset.behavior">
2029 <title>SRU Protocol behavior</title>
2031 Current version of &yaz; does not take advantage of a result set id
2032 returned by the SRU server. Future versions might do, however.
2033 Since, the ZOOM driver does not save result set IDs any
2034 present (retrieval) is transformed to a SRU SearchRetrieveRequest
2035 with same query but, possibly, different offsets.
2038 Option <literal>schema</literal> specifies SRU schema
2039 for retrieval. However, options <literal>elementSetName</literal> and
2040 <literal>preferredRecordSyntax</literal> are ignored.
2043 Options <literal>start</literal> and <literal>count</literal>
2044 are supported by SRU.
2045 The remaining options
2046 <literal>piggyback</literal>,
2047 <literal>smallSetUpperBound</literal>,
2048 <literal>largeSetLowerBound</literal>,
2049 <literal>mediumSetPresentNumber</literal>,
2050 <literal>mediumSetElementSetName</literal>,
2051 <literal>smallSetElementSetName</literal> are
2055 SRU supports CQL queries, <emphasis>not</emphasis> PQF.
2056 If PQF is used, however, the PQF query is transferred anyway
2057 using non-standard element <literal>pQuery</literal> in
2058 SRU SearchRetrieveRequest.
2061 Solr queries has to be done in Solr query format.
2064 Unfortunately, SRU or Solr does not define a database setting. Hence,
2065 <literal>databaseName</literal> is unsupported and ignored.
2066 However, the path part in host parameter for functions
2067 <function>ZOOM_connecton_new</function> and
2068 <function>ZOOM_connection_connect</function> acts as a
2069 database (at least for the &yaz; SRU server).
2073 <sect1 id="zoom.records">
2074 <title>Records</title>
2076 A record object is a retrieval record on the client side -
2077 created from result sets.
2080 void ZOOM_resultset_records(ZOOM_resultset r,
2082 size_t start, size_t count);
2083 ZOOM_record ZOOM_resultset_record(ZOOM_resultset s, size_t pos);
2085 const char *ZOOM_record_get(ZOOM_record rec, const char *type,
2088 int ZOOM_record_error(ZOOM_record rec, const char **msg,
2089 const char **addinfo, const char **diagset);
2091 ZOOM_record ZOOM_record_clone(ZOOM_record rec);
2093 void ZOOM_record_destroy(ZOOM_record rec);
2096 References to temporary records are returned by functions
2097 <function>ZOOM_resultset_records</function> or
2098 <function>ZOOM_resultset_record</function>.
2101 If a persistent reference to a record is desired
2102 <function>ZOOM_record_clone</function> should be used.
2103 It returns a record reference that should be destroyed
2104 by a call to <function>ZOOM_record_destroy</function>.
2107 A single record is returned by function
2108 <function>ZOOM_resultset_record</function> that takes a
2109 position as argument. First record has position zero.
2110 If no record could be obtained <literal>NULL</literal> is returned.
2113 Error information for a record can be checked with
2114 <function>ZOOM_record_error</function> which returns non-zero
2115 (error code) if record is in error, called <emphasis>Surrogate
2116 Diagnostics</emphasis> in Z39.50.
2119 Function <function>ZOOM_resultset_records</function> retrieves
2120 a number of records from a result set. Parameter <literal>start</literal>
2121 and <literal>count</literal> specifies the range of records to
2122 be returned. Upon completion array
2123 <literal>recs[0], ..recs[count-1]</literal>
2124 holds record objects for the records. The array of records
2125 <literal>recs</literal> should be allocated prior the call
2126 <function>ZOOM_resultset_records</function>. Note that for those
2127 records that couldn't be retrieved from the target
2128 <literal>recs[ ..]</literal> is set to <literal>NULL</literal>.
2130 <para id="zoom.record.get">
2131 In order to extract information about a single record,
2132 <function>ZOOM_record_get</function> is provided. The
2133 function returns a pointer to certain record information. The
2134 nature (type) of the pointer depends on the parameter,
2135 <parameter>type</parameter>.
2138 The <parameter>type</parameter> is a string of the format:
2141 <replaceable>format</replaceable>[;charset=<replaceable>from</replaceable>[/<replaceable>opacfrom</replaceable>][,<replaceable>to</replaceable>]][;format=<replaceable>v</replaceable>][;base64=<replaceable>xpath</replaceable>]
2144 If <literal>charset</literal> is given, then <replaceable>from</replaceable>
2145 specifies the character set of the record in its original form
2146 (as returned by the server), <replaceable>to</replaceable> specifies
2147 the output (returned) character set encoding.
2148 If <replaceable>to</replaceable> is omitted, then UTF-8 is assumed.
2149 If charset is not given, then no character set conversion takes place.
2150 OPAC records may be returned in a different
2151 set from the bibliographic MARC record. If this is this the case,
2152 <replaceable>opacfrom</replaceable> should be set to the character set
2153 of the OPAC record part.
2157 The <literal>format</literal> is generic but can only be used to
2158 specify XML indentation when the value <replaceable>v</replaceable>
2159 is 1 (<literal>format=1</literal>).
2162 The <literal>base64</literal> allows a full record to be extracted
2163 from base64-encoded string in an XML document.
2167 Specifying the OPAC record character set requires YAZ 4.1.5 or later.
2170 Specifying the base64 parameter requires YAZ 4.2.35 or later.
2174 The format argument controls whether record data should be XML
2175 pretty-printed (post process operation).
2176 It is enabled only if format value <replaceable>v</replaceable> is
2177 <literal>1</literal> and the record content is XML well-formed.
2180 In addition, for certain types, the length
2181 <literal>len</literal> passed will be set to the size in bytes of
2182 the returned information.
2185 The following are the supported values for <replaceable>form</replaceable>.
2187 <varlistentry><term><literal>database</literal></term>
2188 <listitem><para>Database of record is returned
2189 as a C null-terminated string. Return type
2190 <literal>const char *</literal>.
2193 <varlistentry><term><literal>syntax</literal></term>
2194 <listitem><para>The transfer syntax of the record is returned
2195 as a C null-terminated string containing the symbolic name of
2196 the record syntax, e.g. <literal>Usmarc</literal>. Return type
2198 <literal>const char *</literal>.
2201 <varlistentry><term><literal>schema</literal></term>
2202 <listitem><para>The schema of the record is returned
2203 as a C null-terminated string. Return type is
2204 <literal>const char *</literal>.
2207 <varlistentry><term><literal>render</literal></term>
2208 <listitem><para>The record is returned in a display friendly
2209 format. Upon completion buffer is returned
2210 (type <literal>const char *</literal>) and length is stored in
2211 <literal>*len</literal>.
2214 <varlistentry><term><literal>raw</literal></term>
2215 <listitem><para>The record is returned in the internal
2216 YAZ specific format. For GRS-1, Explain, and others, the
2217 raw data is returned as type
2218 <literal>Z_External *</literal> which is just the type for
2219 the member <literal>retrievalRecord</literal> in
2220 type <literal>NamePlusRecord</literal>.
2221 For SUTRS and octet aligned record (including all MARCs) the
2222 octet buffer is returned and the length of the buffer.
2225 <varlistentry><term><literal>xml</literal></term>
2226 <listitem><para>The record is returned in XML if possible.
2227 SRU, Solr and Z39.50 records with transfer syntax XML are
2228 returned verbatim. MARC records are returned in
2229 <ulink url="&url.marcxml;">
2232 (converted from ISO2709 to MARCXML by YAZ).
2233 OPAC records are also converted to XML and the
2234 bibliographic record is converted to MARCXML (when possible).
2235 GRS-1 records are not supported for this form.
2236 Upon completion, the XML buffer is returned
2237 (type <literal>const char *</literal>) and length is stored in
2238 <literal>*len</literal>.
2241 <varlistentry><term><literal>opac</literal></term>
2242 <listitem><para>OPAC information for record is returned in XML
2243 if an OPAC record is present at the position given. If no
2244 OPAC record is present, a NULL pointer is returned.
2247 <varlistentry><term><literal>txml</literal></term>
2248 <listitem><para>The record is returned in TurboMARC if possible.
2249 SRU and Z39.50 records with transfer syntax XML are
2250 returned verbatim. MARC records are returned in
2251 <link linkend="tools.turbomarc">
2254 (converted from ISO2709 to TurboMARC by YAZ).
2255 Upon completion, the XML buffer is returned
2256 (type <literal>const char *</literal>) and length is stored in
2257 <literal>*len</literal>.
2260 <varlistentry><term><literal>json</literal></term>
2261 <listitem><para>Like xml, but MARC records are converted to
2262 <ulink url="&url.marc_in_json;">MARC-in-JSON</ulink>.
2270 <ulink url="&url.marc21;">MARC21</ulink>
2272 <ulink url="&url.marc8;">MARC-8</ulink>
2273 character set encoding.
2274 An application that wishes to display in Latin-1 would use
2276 render; charset=marc8,iso-8859-1
2279 <sect2 id="zoom.z3950.record.behavior">
2280 <title>Z39.50 Protocol behavior</title>
2282 The functions <function>ZOOM_resultset_record</function> and
2283 <function>ZOOM_resultset_records</function> inspects the client-side
2284 record cache. Records not found in cache are fetched using
2286 The functions may block (and perform network I/O) - even though option
2287 <literal>async</literal> is 1, because they return records objects.
2288 (and there's no way to return records objects without retrieving them!).
2291 There is a trick, however, in the usage of function
2292 <function>ZOOM_resultset_records</function> that allows for
2293 delayed retrieval (and makes it non-blocking). By using
2294 a null pointer for <parameter>recs</parameter> you're indicating
2295 you're not interested in getting records objects
2296 <emphasis>now</emphasis>.
2299 <sect2 id="zoom.sru.record.behavior">
2300 <title>SRU/Solr Protocol behavior</title>
2302 The ZOOM driver for SRU/Solr treats records returned by a SRU/Solr server
2303 as if they where Z39.50 records with transfer syntax XML and
2304 no element set name or database name.
2308 <sect1 id="zoom.facets"><title>Facets</title>
2310 Facet operations is not part of the official ZOOM specification, but
2311 is an Index Data extension for YAZ-based Z39.50 targets,
2312 <ulink url="&url.solr;">Solr</ulink> and SRU 2.0 targets.
2314 Facets may be requestd by the
2315 <link linkend="zoom.facets.option">facets</link> option before a
2317 For inspection of the returned facets, the following functions are
2321 ZOOM_facet_field *ZOOM_resultset_facets(ZOOM_resultset r);
2323 ZOOM_facet_field ZOOM_resultset_get_facet_field(ZOOM_resultset r,
2324 const char *facet_name);
2326 ZOOM_facet_field ZOOM_resultset_get_facet_field_by_index(ZOOM_resultset r,
2329 size_t ZOOM_resultset_facets_size(ZOOM_resultset r);
2331 const char *ZOOM_facet_field_name(ZOOM_facet_field facet_field);
2333 size_t ZOOM_facet_field_term_count(ZOOM_facet_field facet_field);
2335 const char *ZOOM_facet_field_get_term(ZOOM_facet_field facet_field,
2336 size_t idx, int *freq);
2339 References to temporary structures are returned by all functions.
2340 They are only valid as long the Result set is valid.
2341 <function>ZOOM_resultset_get_facet_field</function> or
2342 <function>ZOOM_resultset_get_facet_field_by_index</function>.
2343 <function>ZOOM_resultset_facets</function>.
2344 <function>ZOOM_facet_field_name</function>.
2345 <function>ZOOM_facet_field_get_term</function>.
2347 <para id="zoom.resultset.get_facet_field">
2348 A single Facet field is returned by function
2349 <function>ZOOM_resultset_get_facet_field</function> or
2350 <function>ZOOM_resultset_get_facet_field_by_index</function> that takes
2351 a result set and facet name or positive index respectively. First
2352 facet has position zero. If no facet could be obtained (invalid name
2353 or index out of bounds) <literal>NULL</literal> is returned.
2355 <para id="zoom.resultset.facets">
2356 An array of facets field can be returned by
2357 <function>ZOOM_resultset_facets</function>. The length of the array is
2358 given by <function>ZOOM_resultset_facets_size</function>. The array is
2359 zero-based and last entry will be at
2360 <function>ZOOM_resultset_facets_size(result_set)</function>-1.
2362 <para id="zoom.resultset.facets_names">
2363 It is possible to interate over facets by name, by calling
2364 <function>ZOOM_resultset_facets_names</function>.
2365 This will return an const array of char * where each string can be used
2366 as parameter for <function>ZOOM_resultset_get_facet_field</function>.
2369 Function <function>ZOOM_facet_field_name</function> gets the request
2370 facet name from a returned facet field.
2373 Function <function>ZOOM_facet_field_get_term</function> returns the
2374 idx'th term and term count for a facet field.
2375 Idx must between 0 and
2376 <function>ZOOM_facet_field_term_count</function>-1, otherwise the
2377 returned reference will be <literal>NULL</literal>. On a valid idx, the
2378 value of the freq reference will be the term count.
2379 The <literal>freq</literal> parameter must be valid pointer to integer.
2382 <sect1 id="zoom.scan"><title>Scan</title>
2384 This section describes an interface for Scan. Scan is not an
2385 official part of the ZOOM model yet. The result of a scan operation
2386 is the <literal>ZOOM_scanset</literal> which is a set of terms
2387 returned by a target.
2391 The Scan interface is supported for both Z39.50, SRU and Solr.
2395 ZOOM_scanset ZOOM_connection_scan(ZOOM_connection c,
2396 const char *startpqf);
2398 ZOOM_scanset ZOOM_connection_scan1(ZOOM_connection c,
2401 size_t ZOOM_scanset_size(ZOOM_scanset scan);
2403 const char *ZOOM_scanset_term(ZOOM_scanset scan, size_t pos,
2404 size_t *occ, size_t *len);
2406 const char *ZOOM_scanset_display_term(ZOOM_scanset scan, size_t pos,
2407 size_t *occ, size_t *len);
2409 void ZOOM_scanset_destroy(ZOOM_scanset scan);
2411 const char *ZOOM_scanset_option_get(ZOOM_scanset scan,
2414 void ZOOM_scanset_option_set(ZOOM_scanset scan, const char *key,
2418 The scan set is created by function
2419 <function>ZOOM_connection_scan</function> which performs a scan
2420 operation on the connection using the specified
2421 <parameter>startpqf</parameter>.
2422 If the operation was successful, the size of the scan set can be
2423 retrieved by a call to <function>ZOOM_scanset_size</function>.
2424 Like result sets, the items are numbered 0,..size-1.
2425 To obtain information about a particular scan term, call function
2426 <function>ZOOM_scanset_term</function>. This function takes
2427 a scan set offset <literal>pos</literal> and returns a pointer
2428 to a <emphasis>raw term</emphasis> or <literal>NULL</literal> if
2430 If present, the <literal>occ</literal> and <literal>len</literal>
2431 are set to the number of occurrences and the length
2432 of the actual term respectively.
2433 <function>ZOOM_scanset_display_term</function> is similar to
2434 <function>ZOOM_scanset_term</function> except that it returns
2435 the <emphasis>display term</emphasis> rather than the raw term.
2436 In a few cases, the term is different from display term. Always
2437 use the display term for display and the raw term for subsequent
2438 scan operations (to get more terms, next scan result, etc).
2441 A scan set may be freed by a call to function
2442 <function>ZOOM_scanset_destroy</function>.
2443 Functions <function>ZOOM_scanset_option_get</function> and
2444 <function>ZOOM_scanset_option_set</function> retrieves and sets
2445 an option respectively.
2448 The <parameter>startpqf</parameter> is a subset of PQF, namely
2449 the Attributes+Term part. Multiple <literal>@attr</literal> can
2450 be used. For example to scan in title (complete) phrases:
2452 @attr 1=4 @attr 6=2 "science o"
2456 The <function>ZOOM_connecton_scan1</function> is a newer and
2457 more generic alternative to <function>ZOOM_connection_scan</function>
2458 which allows to use both CQL and PQF for Scan.
2460 <table frame="top" id="zoom.scanset.options">
2461 <title>ZOOM Scan Set Options</title>
2463 <colspec colwidth="4*" colname="name"></colspec>
2464 <colspec colwidth="7*" colname="description"></colspec>
2465 <colspec colwidth="2*" colname="default"></colspec>
2468 <entry>Option</entry>
2469 <entry>Description</entry>
2470 <entry>Default</entry>
2475 number</entry><entry>Number of Scan Terms requested in next scan.
2476 After scan it holds the actual number of terms returned.
2477 </entry><entry>20</entry></row>
2479 position</entry><entry>Preferred Position of term in response
2480 in next scan; actual position after completion of scan.
2481 </entry><entry>1</entry></row>
2483 stepSize</entry><entry>Step Size
2484 </entry><entry>0</entry></row>
2486 scanStatus</entry><entry>An integer indicating the Scan Status
2488 </entry><entry>0</entry></row>
2490 rpnCharset</entry><entry>Character set for RPN terms.
2491 If this is set, ZOOM C will assume that the ZOOM application is
2492 running UTF-8. Terms in RPN queries are then converted to the
2493 rpnCharset. If this is unset, ZOOM C will not assume any encoding
2494 of RPN terms and no conversion is performed.
2495 </entry><entry>none</entry></row>
2500 <sect1 id="zoom.extendedservices">
2501 <title>Extended Services</title>
2503 ZOOM offers an interface to a subset of the Z39.50 extended services
2504 as well as a few privately defined ones:
2509 Z39.50 Item Order (ILL).
2510 See <xref linkend="zoom.item.order"/>.
2515 Record Update. This allows a client to insert, modify or delete
2517 See <xref linkend="zoom.record.update"/>.
2522 Database Create. This a non-standard feature. Allows a client
2523 to create a database.
2524 See <xref linkend="zoom.database.create"/>.
2529 Database Drop. This a non-standard feature. Allows a client
2530 to delete/drop a database.
2531 See <xref linkend="zoom.database.drop"/>.
2536 Commit operation. This a non-standard feature. Allows a client
2537 to commit operations.
2538 See <xref linkend="zoom.commit"/>.
2541 <!-- all the ILL PDU options should go here too -->
2544 To create an extended service operation a <literal>ZOOM_package</literal>
2545 must be created. The operation is a five step operation. The
2546 package is created, package is configured by means of options,
2547 the package is send, result is inspected (by means of options),
2548 the package is destroyed.
2551 ZOOM_package ZOOM_connection_package(ZOOM_connection c,
2552 ZOOM_options options);
2554 const char *ZOOM_package_option_get(ZOOM_package p,
2556 void ZOOM_package_option_set(ZOOM_package p, const char *key,
2558 void ZOOM_package_send(ZOOM_package p, const char *type);
2560 void ZOOM_package_destroy(ZOOM_package p);
2563 The <function>ZOOM_connection_package</function> creates a
2564 package for the connection given using the options specified.
2567 Functions <function>ZOOM_package_option_get</function> and
2568 <function>ZOOM_package_option_set</function> gets and sets
2572 <function>ZOOM_package_send</function> sends
2573 the package the via connection specified in
2574 <function>ZOOM_connection_package</function>.
2575 The <parameter>type</parameter> specifies the actual extended service
2576 package type to be sent.
2578 <table frame="top" id="zoom.extendedservices.options">
2579 <title>Extended Service Common Options</title>
2581 <colspec colwidth="4*" colname="name"></colspec>
2582 <colspec colwidth="7*" colname="description"></colspec>
2583 <colspec colwidth="3*" colname="default"></colspec>
2586 <entry>Option</entry>
2587 <entry>Description</entry>
2588 <entry>Default</entry>
2593 <entry>package-name</entry>
2594 <entry>Extended Service Request package name. Must be specified
2595 as part of a request</entry>
2599 <entry>user-id</entry>
2600 <entry>User ID of Extended Service Package. Is a request option</entry>
2604 <entry>function</entry>
2606 Function of package - one of <literal>create</literal>,
2607 <literal>delete</literal>, <literal>modify</literal>. Is
2610 <entry><literal>create</literal></entry>
2613 <entry>waitAction</entry>
2615 Wait action for package. Possible values:
2616 <literal>wait</literal>, <literal>waitIfPossible</literal>,
2617 <literal>dontWait</literal> or <literal>dontReturnPackage</literal>.
2619 <entry><literal>waitIfPossible</literal></entry>
2622 <entry>targetReference</entry>
2624 Target Reference. This is part of the response as returned
2625 by the server. Read it after a successful operation.
2627 <entry><literal>none</literal></entry>
2632 <sect2 id="zoom.item.order">
2633 <title>Item Order</title>
2635 For Item Order, type must be set to <literal>itemorder</literal> in
2636 <function>ZOOM_package_send</function>.
2639 <table frame="top" id="zoom.item.order.options">
2640 <title>Item Order Options</title>
2642 <colspec colwidth="4*" colname="name"></colspec>
2643 <colspec colwidth="7*" colname="description"></colspec>
2644 <colspec colwidth="3*" colname="default"></colspec>
2647 <entry>Option</entry>
2648 <entry>Description</entry>
2649 <entry>Default</entry>
2654 <entry>contact-name</entry>
2655 <entry>ILL contact name</entry>
2659 <entry>contact-phone</entry>
2660 <entry>ILL contact phone</entry>
2664 <entry>contact-email</entry>
2665 <entry>ILL contact email</entry>
2669 <entry>itemorder-setname</entry>
2670 <entry>Name of result set for record</entry>
2671 <entry>default</entry>
2674 <entry>itemorder-item</entry>
2675 <entry>Position for item (record) requested. An integer</entry>
2682 There are two variants of item order: ILL-variant and
2683 XML document variant. In order to use the XML variant the setting
2684 <literal>doc</literal> must hold the XML item order document. If that
2685 setting is unset, the ILL-variant is used.
2688 <table frame="top" id="zoom.illrequest.options">
2689 <title>ILL Request Options</title>
2691 <colspec colwidth="4*" colname="name"></colspec>
2694 <entry>Option</entry>
2698 <row><entry>protocol-version-num</entry></row>
2699 <row><entry>transaction-id,initial-requester-id,person-or-institution-symbol,person</entry></row>
2700 <row><entry>transaction-id,initial-requester-id,person-or-institution-symbol,institution</entry></row>
2701 <row><entry>transaction-id,initial-requester-id,name-of-person-or-institution,name-of-person</entry></row>
2702 <row><entry>transaction-id,initial-requester-id,name-of-person-or-institution,name-of-institution</entry></row>
2703 <row><entry>transaction-id,transaction-group-qualifier</entry></row>
2704 <row><entry>transaction-id,transaction-qualifier</entry></row>
2705 <row><entry>transaction-id,sub-transaction-qualifier</entry></row>
2706 <row><entry>service-date-time,this,date</entry></row>
2707 <row><entry>service-date-time,this,time</entry></row>
2708 <row><entry>service-date-time,original,date</entry></row>
2709 <row><entry>service-date-time,original,time</entry></row>
2710 <row><entry>requester-id,person-or-institution-symbol,person</entry></row>
2711 <row><entry>requester-id,person-or-institution-symbol,institution</entry></row>
2712 <row><entry>requester-id,name-of-person-or-institution,name-of-person</entry></row>
2713 <row><entry>requester-id,name-of-person-or-institution,name-of-institution</entry></row>
2714 <row><entry>responder-id,person-or-institution-symbol,person</entry></row>
2715 <row><entry>responder-id,person-or-institution-symbol,institution</entry></row>
2716 <row><entry>responder-id,name-of-person-or-institution,name-of-person</entry></row>
2717 <row><entry>responder-id,name-of-person-or-institution,name-of-institution</entry></row>
2718 <row><entry>transaction-type</entry></row>
2719 <row><entry>delivery-address,postal-address,name-of-person-or-institution,name-of-person</entry></row>
2720 <row><entry>delivery-address,postal-address,name-of-person-or-institution,name-of-institution</entry></row>
2721 <row><entry>delivery-address,postal-address,extended-postal-delivery-address</entry></row>
2722 <row><entry>delivery-address,postal-address,street-and-number</entry></row>
2723 <row><entry>delivery-address,postal-address,post-office-box</entry></row>
2724 <row><entry>delivery-address,postal-address,city</entry></row>
2725 <row><entry>delivery-address,postal-address,region</entry></row>
2726 <row><entry>delivery-address,postal-address,country</entry></row>
2727 <row><entry>delivery-address,postal-address,postal-code</entry></row>
2728 <row><entry>delivery-address,electronic-address,telecom-service-identifier</entry></row>
2729 <row><entry>delivery-address,electronic-address,telecom-service-addreess</entry></row>
2730 <row><entry>billing-address,postal-address,name-of-person-or-institution,name-of-person</entry></row>
2731 <row><entry>billing-address,postal-address,name-of-person-or-institution,name-of-institution</entry></row>
2732 <row><entry>billing-address,postal-address,extended-postal-delivery-address</entry></row>
2733 <row><entry>billing-address,postal-address,street-and-number</entry></row>
2734 <row><entry>billing-address,postal-address,post-office-box</entry></row>
2735 <row><entry>billing-address,postal-address,city</entry></row>
2736 <row><entry>billing-address,postal-address,region</entry></row>
2737 <row><entry>billing-address,postal-address,country</entry></row>
2738 <row><entry>billing-address,postal-address,postal-code</entry></row>
2739 <row><entry>billing-address,electronic-address,telecom-service-identifier</entry></row>
2740 <row><entry>billing-address,electronic-address,telecom-service-addreess</entry></row>
2741 <row><entry>ill-service-type</entry></row>
2742 <row><entry>requester-optional-messages,can-send-RECEIVED</entry></row>
2743 <row><entry>requester-optional-messages,can-send-RETURNED</entry></row>
2744 <row><entry>requester-optional-messages,requester-SHIPPED</entry></row>
2745 <row><entry>requester-optional-messages,requester-CHECKED-IN</entry></row>
2746 <row><entry>search-type,level-of-service</entry></row>
2747 <row><entry>search-type,need-before-date</entry></row>
2748 <row><entry>search-type,expiry-date</entry></row>
2749 <row><entry>search-type,expiry-flag</entry></row>
2750 <row><entry>place-on-hold</entry></row>
2751 <row><entry>client-id,client-name</entry></row>
2752 <row><entry>client-id,client-status</entry></row>
2753 <row><entry>client-id,client-identifier</entry></row>
2754 <row><entry>item-id,item-type</entry></row>
2755 <row><entry>item-id,call-number</entry></row>
2756 <row><entry>item-id,author</entry></row>
2757 <row><entry>item-id,title</entry></row>
2758 <row><entry>item-id,sub-title</entry></row>
2759 <row><entry>item-id,sponsoring-body</entry></row>
2760 <row><entry>item-id,place-of-publication</entry></row>
2761 <row><entry>item-id,publisher</entry></row>
2762 <row><entry>item-id,series-title-number</entry></row>
2763 <row><entry>item-id,volume-issue</entry></row>
2764 <row><entry>item-id,edition</entry></row>
2765 <row><entry>item-id,publication-date</entry></row>
2766 <row><entry>item-id,publication-date-of-component</entry></row>
2767 <row><entry>item-id,author-of-article</entry></row>
2768 <row><entry>item-id,title-of-article</entry></row>
2769 <row><entry>item-id,pagination</entry></row>
2770 <row><entry>item-id,ISBN</entry></row>
2771 <row><entry>item-id,ISSN</entry></row>
2772 <row><entry>item-id,additional-no-letters</entry></row>
2773 <row><entry>item-id,verification-reference-source</entry></row>
2774 <row><entry>copyright-complicance</entry></row>
2775 <row><entry>retry-flag</entry></row>
2776 <row><entry>forward-flag</entry></row>
2777 <row><entry>requester-note</entry></row>
2778 <row><entry>forward-note</entry></row>
2783 <sect2 id="zoom.record.update">
2784 <title>Record Update</title>
2786 For Record Update, type must be set to <literal>update</literal> in
2787 <function>ZOOM_package_send</function>.
2789 <table frame="top" id="zoom.record.update.options">
2790 <title>Record Update Options</title>
2792 <colspec colwidth="4*" colname="name"></colspec>
2793 <colspec colwidth="7*" colname="description"></colspec>
2794 <colspec colwidth="3*" colname="default"></colspec>
2797 <entry>Option</entry>
2798 <entry>Description</entry>
2799 <entry>Default</entry>
2804 <entry>action</entry>
2806 The update action. One of
2807 <literal>specialUpdate</literal>,
2808 <literal>recordInsert</literal>,
2809 <literal>recordReplace</literal>,
2810 <literal>recordDelete</literal>,
2811 <literal>elementUpdate</literal>.
2813 <entry><literal>specialUpdate (recordInsert for updateVersion=1 which does not support specialUpdate)</literal></entry>
2816 <entry>recordIdOpaque</entry>
2817 <entry>Opaque Record ID</entry>
2821 <entry>recordIdNumber</entry>
2822 <entry>Record ID number</entry>
2826 <entry>record</entry>
2827 <entry>The record itself</entry>
2831 <entry>recordOpaque</entry>
2832 <entry>Specifies an opaque record which is
2833 encoded as an ASN.1 ANY type with the OID as tiven by option
2834 <literal>syntax</literal> (see below).
2835 Option <literal>recordOpaque</literal> is an alternative
2836 to record - and <literal>record</literal> option (above) is
2837 ignored if recordOpaque is set. This option is only available in
2838 YAZ 3.0.35 and later and is meant to facilitate Updates with
2844 <entry>syntax</entry>
2845 <entry>The record syntax (transfer syntax). Is a string that
2846 is a known record syntax.
2848 <entry>no syntax</entry>
2851 <entry>databaseName</entry>
2852 <entry>Database from connection object</entry>
2853 <entry>Default</entry>
2856 <entry>correlationInfo.note</entry>
2857 <entry>Correlation Info Note (string)</entry>
2861 <entry>correlationInfo.id</entry>
2862 <entry>Correlation Info ID (integer)</entry>
2866 <entry>elementSetName</entry>
2867 <entry>Element Set for Record</entry>
2871 <entry>updateVersion</entry>
2872 <entry>Record Update version which holds one of the values
2873 1, 2 or 3. Each version has a distinct OID:
2875 (<ulink url="&url.z39.50.extupdate1;">first version</ulink>) ,
2877 (second version) and
2878 1.2.840.10003.9.5.1.1
2879 (<ulink url="&url.z39.50.extupdate3;">third and
2880 newest version</ulink>).
2890 <sect2 id="zoom.database.create"><title>Database Create</title>
2892 For Database Create, type must be set to <literal>create</literal> in
2893 <function>ZOOM_package_send</function>.
2896 <table frame="top" id="zoom.database.create.options">
2897 <title>Database Create Options</title>
2899 <colspec colwidth="4*" colname="name"></colspec>
2900 <colspec colwidth="7*" colname="description"></colspec>
2901 <colspec colwidth="3*" colname="default"></colspec>
2904 <entry>Option</entry>
2905 <entry>Description</entry>
2906 <entry>Default</entry>
2911 <entry>databaseName</entry>
2912 <entry>Database from connection object</entry>
2913 <entry>Default</entry>
2919 <sect2 id="zoom.database.drop">
2920 <title>Database Drop</title>
2922 For Database Drop, type must be set to <literal>drop</literal> in
2923 <function>ZOOM_package_send</function>.
2925 <table frame="top" id="zoom.database.drop.options">
2926 <title>Database Drop Options</title>
2928 <colspec colwidth="4*" colname="name"></colspec>
2929 <colspec colwidth="7*" colname="description"></colspec>
2930 <colspec colwidth="3*" colname="default"></colspec>
2933 <entry>Option</entry>
2934 <entry>Description</entry>
2935 <entry>Default</entry>
2940 <entry>databaseName</entry>
2941 <entry>Database from connection object</entry>
2942 <entry>Default</entry>
2948 <sect2 id="zoom.commit">
2949 <title>Commit Operation</title>
2951 For Commit, type must be set to <literal>commit</literal> in
2952 <function>ZOOM_package_send</function>.
2955 <sect2 id="zoom.extended.services.behavior">
2956 <title>Protocol behavior</title>
2958 All the extended services are Z39.50-only.
2962 The database create, drop and commit services are privately defined
2964 Refer to <filename>esadmin.asn</filename> in YAZ for the ASN.1
2970 <sect1 id="zoom.options">
2971 <title>Options</title>
2973 Most &zoom; objects provide a way to specify options to change behavior.
2974 From an implementation point of view a set of options is just like
2975 an associative array / hash.
2978 ZOOM_options ZOOM_options_create(void);
2980 ZOOM_options ZOOM_options_create_with_parent(ZOOM_options parent);
2982 void ZOOM_options_destroy(ZOOM_options opt);
2985 const char *ZOOM_options_get(ZOOM_options opt, const char *name);
2987 void ZOOM_options_set(ZOOM_options opt, const char *name,
2991 typedef const char *(*ZOOM_options_callback)
2992 (void *handle, const char *name);
2994 ZOOM_options_callback
2995 ZOOM_options_set_callback(ZOOM_options opt,
2996 ZOOM_options_callback c,
3000 <sect1 id="zoom.queryconversions">
3001 <title>Query conversions</title>
3003 int ZOOM_query_cql2rpn(ZOOM_query s, const char *cql_str,
3004 ZOOM_connection conn);
3006 int ZOOM_query_ccl2rpn(ZOOM_query s, const char *ccl_str,
3008 int *ccl_error, const char **error_string,
3012 <function>ZOOM_query_cql2rpn</function> translates the CQL string,
3013 client-side, into RPN which may be passed to the server.
3014 This is useful for server's that don't themselves
3015 support CQL, for which <function>ZOOM_query_cql</function> is useless.
3016 `conn' is used only as a place to stash diagnostics if compilation
3017 fails; if this information is not needed, a null pointer may be used.
3018 The CQL conversion is driven by option <literal>cqlfile</literal> from
3019 connection conn. This specifies a conversion file (eg pqf.properties)
3020 which <emphasis>must</emphasis> be present.
3023 <function>ZOOM_query_ccl2rpn</function> translates the CCL string,
3024 client-side, into RPN which may be passed to the server.
3025 The conversion is driven by the specification given by
3026 <literal>config</literal>. Upon completion 0 is returned on success; -1
3027 is returned on on failure. Om failure <literal>error_string</literal> and
3028 <literal>error_pos</literal> holds error message and position of
3029 first error in original CCL string.
3032 <sect1 id="zoom.events"><title>Events</title>
3034 If you're developing non-blocking applications, you have to deal
3038 int ZOOM_event(int no, ZOOM_connection *cs);
3041 The <function>ZOOM_event</function> executes pending events for
3042 a number of connections. Supply the number of connections in
3043 <literal>no</literal> and an array of connections in
3044 <literal>cs</literal> (<literal>cs[0] ... cs[no-1]</literal>).
3045 A pending event could be a sending a search, receiving a response,
3047 When an event has occurred for one of the connections, this function
3048 returns a positive integer <literal>n</literal> denoting that an event
3049 occurred for connection <literal>cs[n-1]</literal>.
3050 When no events are pending for the connections, a value of zero is
3052 To ensure that all outstanding requests are performed call this function
3053 repeatedly until zero is returned.
3056 If <function>ZOOM_event</function> returns and returns non-zero, the
3057 last event that occurred can be expected.
3060 int ZOOM_connection_last_event(ZOOM_connection cs);
3063 <function>ZOOM_connection_last_event</function> returns an event type
3064 (integer) for the last event.
3067 <table frame="top" id="zoom.event.ids">
3068 <title>ZOOM Event IDs</title>
3070 <colspec colwidth="4*" colname="name"></colspec>
3071 <colspec colwidth="7*" colname="description"></colspec>
3074 <entry>Event</entry>
3075 <entry>Description</entry>
3080 <entry>ZOOM_EVENT_NONE</entry>
3081 <entry>No event has occurred</entry>
3084 <entry>ZOOM_EVENT_CONNECT</entry>
3085 <entry>TCP/IP connect has initiated</entry>
3088 <entry>ZOOM_EVENT_SEND_DATA</entry>
3089 <entry>Data has been transmitted (sending)</entry>
3092 <entry>ZOOM_EVENT_RECV_DATA</entry>
3093 <entry>Data has been received)</entry>
3096 <entry>ZOOM_EVENT_TIMEOUT</entry>
3097 <entry>Timeout</entry>
3100 <entry>ZOOM_EVENT_UNKNOWN</entry>
3101 <entry>Unknown event</entry>
3104 <entry>ZOOM_EVENT_SEND_APDU</entry>
3105 <entry>An APDU has been transmitted (sending)</entry>
3108 <entry>ZOOM_EVENT_RECV_APDU</entry>
3109 <entry>An APDU has been received</entry>
3112 <entry>ZOOM_EVENT_RECV_RECORD</entry>
3113 <entry>A result-set record has been received</entry>
3116 <entry>ZOOM_EVENT_RECV_SEARCH</entry>
3117 <entry>A search result been received</entry>
3124 <chapter id="server">
3125 <title>Generic server</title>
3126 <sect1 id="server.introduction"><title>Introduction</title>
3128 If you aren't into documentation, a good way to learn how the
3129 back end interface works is to look at the <filename>backend.h</filename>
3130 file. Then, look at the small dummy-server in
3131 <filename>ztest/ztest.c</filename>. The <filename>backend.h</filename>
3132 file also makes a good reference, once you've chewed your way through
3133 the prose of this file.
3136 If you have a database system that you would like to make available by
3137 means of Z39.50 or SRU, &yaz; basically offers your two options. You
3138 can use the APIs provided by the &asn;, &odr;, and &comstack;
3140 create and decode PDUs, and exchange them with a client.
3141 Using this low-level interface gives you access to all fields and
3142 options of the protocol, and you can construct your server as close
3143 to your existing database as you like.
3144 It is also a fairly involved process, requiring
3145 you to set up an event-handling mechanism, protocol state machine,
3146 etc. To simplify server implementation, we have implemented a compact
3147 and simple, but reasonably full-functioned server-frontend that will
3148 handle most of the protocol mechanics, while leaving you to
3149 concentrate on your database interface.
3153 The backend interface was designed in anticipation of a specific
3154 integration task, while still attempting to achieve some degree of
3155 generality. We realize fully that there are points where the
3156 interface can be improved significantly. If you have specific
3157 functions or parameters that you think could be useful, send us a
3158 mail (or better, sign on to the mailing list referred to in the
3159 top-level README file). We will try to fit good suggestions into future
3160 releases, to the extent that it can be done without requiring
3161 too many structural changes in existing applications.
3166 The &yaz; server does not support XCQL.
3170 <sect1 id="server.frontend">
3171 <title>The Database Frontend</title>
3173 We refer to this software as a generic database frontend. Your
3174 database system is the <emphasis>backend database</emphasis>, and the
3175 interface between the two is called the <emphasis>backend API</emphasis>.
3176 The backend API consists of a small number of function handlers and
3177 structure definitions. You are required to provide the
3178 <function>main()</function> routine for the server (which can be
3179 quite simple), as well as a set of handlers to match each of the
3181 The interface functions that you write can use any mechanism you like
3182 to communicate with your database system: You might link the whole
3183 thing together with your database application and access it by
3184 function calls; you might use IPC to talk to a database server
3185 somewhere; or you might link with third-party software that handles
3186 the communication for you (like a commercial database client library).
3187 At any rate, the handlers will perform the tasks of:
3200 Scanning the database index (optional - if you wish to implement SCAN).
3203 Extended Services (optional).
3206 Result-Set Delete (optional).
3209 Result-Set Sort (optional).
3212 Return Explain for SRU (optional).
3216 (more functions will be added in time to support as much of
3217 Z39.50-1995 as possible).
3220 <sect1 id="server.backend">
3221 <title>The Backend API</title>
3223 The header file that you need to use the interface are in the
3224 <filename>include/yaz</filename> directory. It's called
3225 <filename>backend.h</filename>. It will include other files from
3226 the <filename>include/yaz</filename> directory, so you'll
3227 probably want to use the -I option of your compiler to tell it
3228 where to find the files. When you run
3229 <literal>make</literal> in the top-level &yaz; directory,
3230 everything you need to create your server is to link with the
3231 <filename>lib/libyaz.la</filename> library.
3234 <sect1 id="server.main">
3235 <title>Your main() Routine</title>
3237 As mentioned, your <function>main()</function> routine can be quite brief.
3238 If you want to initialize global parameters, or read global configuration
3239 tables, this is the place to do it. At the end of the routine, you should
3243 int statserv_main(int argc, char **argv,
3244 bend_initresult *(*bend_init)(bend_initrequest *r),
3245 void (*bend_close)(void *handle));
3248 The third and fourth arguments are pointers to handlers. Handler
3249 <function>bend_init</function> is called whenever the server receives
3250 an Initialize Request, so it serves as a Z39.50 session initializer. The
3251 <function>bend_close</function> handler is called when the session is
3255 <function>statserv_main</function> will establish listening sockets
3256 according to the parameters given. When connection requests are received,
3257 the event handler will typically <function>fork()</function> and
3258 create a sub-process to handle a new connection.
3259 Alternatively the server may be setup to create threads for each
3261 If you do use global variables and forking, you should be aware, then,
3262 that these cannot be shared between associations, unless you explicitly
3263 disable forking by command line parameters.
3266 The server provides a mechanism for controlling some of its behavior
3267 without using command-line options. The function
3270 statserv_options_block *statserv_getcontrol(void);
3273 will return a pointer to a <literal>struct statserv_options_block</literal>
3274 describing the current default settings of the server. The structure
3275 contains these elements:
3278 <term><literal>int dynamic</literal></term>
3280 A boolean value, which determines whether the server
3281 will fork on each incoming request (TRUE), or not (FALSE). Default is
3282 TRUE. This flag is only read by UNIX-based servers (WIN32 based servers
3287 <term><literal>int threads</literal></term>
3289 A boolean value, which determines whether the server
3290 will create a thread on each incoming request (TRUE), or not (FALSE).
3291 Default is FALSE. This flag is only read by UNIX-based servers
3292 that offer POSIX Threads support.
3293 WIN32-based servers always operate in threaded mode.
3297 <term><literal>int inetd</literal></term>
3299 A boolean value, which determines whether the server
3300 will operates under a UNIX INET daemon (inetd). Default is FALSE.
3304 <term><literal>char logfile[ODR_MAXNAME+1]</literal></term>
3305 <listitem><para>File for diagnostic output ("": stderr).
3309 <term><literal>char apdufile[ODR_MAXNAME+1]</literal></term>
3311 Name of file for logging incoming and outgoing APDUs
3312 ("": don't log APDUs, "-":
3313 <literal>stderr</literal>).
3317 <term><literal>char default_listen[1024]</literal></term>
3318 <listitem><para>Same form as the command-line specification of
3319 listener address. "": no default listener address.
3320 Default is to listen at "tcp:@:9999". You can only
3321 specify one default listener address in this fashion.
3325 <term><literal>enum oid_proto default_proto;</literal></term>
3326 <listitem><para>Either <literal>PROTO_Z3950</literal> or
3327 <literal>PROTO_SR</literal>.
3328 Default is <literal>PROTO_Z39_50</literal>.
3332 <term><literal>int idle_timeout;</literal></term>
3333 <listitem><para>Maximum session idle-time, in minutes. Zero indicates
3334 no (infinite) timeout. Default is 15 minutes.
3338 <term><literal>int maxrecordsize;</literal></term>
3339 <listitem><para>Maximum permissible record (message) size. Default
3340 is 64 MB. This amount of memory will only be allocated if a
3341 client requests a very large amount of records in one operation
3343 Set it to a lower number if you are worried about resource
3344 consumption on your host system.
3348 <term><literal>char configname[ODR_MAXNAME+1]</literal></term>
3349 <listitem><para>Passed to the backend when a new connection is received.
3353 <term><literal>char setuid[ODR_MAXNAME+1]</literal></term>
3354 <listitem><para>Set user id to the user specified, after binding
3355 the listener addresses.
3360 <literal>void (*bend_start)(struct statserv_options_block *p)</literal>
3362 <listitem><para>Pointer to function which is called after the
3363 command line options have been parsed - but before the server
3365 For forked UNIX servers this handler is called in the mother
3366 process; for threaded servers this handler is called in the
3368 The default value of this pointer is NULL in which case it
3369 isn't invoked by the frontend server.
3370 When the server operates as an NT service this handler is called
3371 whenever the service is started.
3376 <literal>void (*bend_stop)(struct statserv_options_block *p)</literal>
3378 <listitem><para>Pointer to function which is called whenever the server
3379 has stopped listening for incoming connections. This function pointer
3380 has a default value of NULL in which case it isn't called.
3381 When the server operates as an NT service this handler is called
3382 whenever the service is stopped.
3386 <term><literal>void *handle</literal></term>
3387 <listitem><para>User defined pointer (default value NULL).
3388 This is a per-server handle that can be used to specify "user-data".
3389 Do not confuse this with the session-handle as returned by bend_init.
3395 The pointer returned by <literal>statserv_getcontrol</literal> points to
3396 a static area. You are allowed to change the contents of the structure,
3397 but the changes will not take effect before you call
3400 void statserv_setcontrol(statserv_options_block *block);
3404 that you should generally update this structure before calling
3405 <function>statserv_main()</function>.
3409 <sect1 id="server.backendfunctions">
3410 <title>The Backend Functions</title>
3412 For each service of the protocol, the backend interface declares one or
3413 two functions. You are required to provide implementations of the
3414 functions representing the services that you wish to implement.
3416 <sect2 id="server.init">
3419 bend_initresult (*bend_init)(bend_initrequest *r);
3422 This handler is called once for each new connection request, after
3423 a new process/thread has been created, and an Initialize Request has
3424 been received from the client. The pointer to the
3425 <function>bend_init</function> handler is passed in the call to
3426 <function>statserv_start</function>.
3429 This handler is also called when operating in SRU mode - when
3430 a connection has been made (even though SRU does not offer
3434 Unlike previous versions of YAZ, the <function>bend_init</function> also
3435 serves as a handler that defines the Z39.50 services that the backend
3436 wish to support. Pointers to <emphasis>all</emphasis> service handlers,
3437 including search - and fetch must be specified here in this handler.
3440 The request - and result structures are defined as
3443 typedef struct bend_initrequest
3445 /** \brief user/name/password to be read */
3446 Z_IdAuthentication *auth;
3447 /** \brief encoding stream (for results) */
3449 /** \brief printing stream */
3451 /** \brief decoding stream (use stream for results) */
3453 /** \brief reference ID */
3454 Z_ReferenceId *referenceId;
3455 /** \brief peer address of client */
3458 /** \brief character set and language negotiation
3460 see include/yaz/z-charneg.h
3462 Z_CharSetandLanguageNegotiation *charneg_request;
3464 /** \brief character negotiation response */
3465 Z_External *charneg_response;
3467 /** \brief character set (encoding) for query terms
3469 This is NULL by default. It should be set to the native character
3470 set that the backend assumes for query terms */
3471 char *query_charset;
3473 /** \brief whehter query_charset also applies to recors
3475 Is 0 (No) by default. Set to 1 (yes) if records is in the same
3476 character set as queries. If in doubt, use 0 (No).
3478 int records_in_same_charset;
3480 char *implementation_id;
3481 char *implementation_name;
3482 char *implementation_version;
3484 /** \brief Z39.50 sort handler */
3485 int (*bend_sort)(void *handle, bend_sort_rr *rr);
3486 /** \brief SRU/Z39.50 search handler */
3487 int (*bend_search)(void *handle, bend_search_rr *rr);
3488 /** \brief SRU/Z39.50 fetch handler */
3489 int (*bend_fetch)(void *handle, bend_fetch_rr *rr);
3490 /** \brief SRU/Z39.50 present handler */
3491 int (*bend_present)(void *handle, bend_present_rr *rr);
3492 /** \brief Z39.50 extended services handler */
3493 int (*bend_esrequest) (void *handle, bend_esrequest_rr *rr);
3494 /** \brief Z39.50 delete result set handler */
3495 int (*bend_delete)(void *handle, bend_delete_rr *rr);
3496 /** \brief Z39.50 scan handler */
3497 int (*bend_scan)(void *handle, bend_scan_rr *rr);
3498 /** \brief Z39.50 segment facility handler */
3499 int (*bend_segment)(void *handle, bend_segment_rr *rr);
3500 /** \brief SRU explain handler */
3501 int (*bend_explain)(void *handle, bend_explain_rr *rr);
3502 /** \brief SRU scan handler */
3503 int (*bend_srw_scan)(void *handle, bend_scan_rr *rr);
3504 /** \brief SRU record update handler */
3505 int (*bend_srw_update)(void *handle, bend_update_rr *rr);
3507 /** \brief whether named result sets are supported (0=disable, 1=enable) */
3508 int named_result_sets;
3511 typedef struct bend_initresult
3513 int errcode; /* 0==OK */
3514 char *errstring; /* system error string or NULL */
3515 void *handle; /* private handle to the backend module */
3519 In general, the server frontend expects that the
3520 <literal>bend_*result</literal> pointer that you return is valid at
3521 least until the next call to a <literal>bend_* function</literal>.
3522 This applies to all of the functions described herein. The parameter
3523 structure passed to you in the call belongs to the server frontend, and
3524 you should not make assumptions about its contents after the current
3525 function call has completed. In other words, if you want to retain any
3526 of the contents of a request structure, you should copy them.
3529 The <literal>errcode</literal> should be zero if the initialization of
3530 the backend went well. Any other value will be interpreted as an error.
3531 The <literal>errstring</literal> isn't used in the current version, but
3532 one option would be to stick it in the initResponse as a VisibleString.
3533 The <literal>handle</literal> is the most important parameter. It should
3534 be set to some value that uniquely identifies the current session to
3535 the backend implementation. It is used by the frontend server in any
3536 future calls to a backend function.
3537 The typical use is to set it to point to a dynamically allocated state
3538 structure that is private to your backend module.
3541 The <literal>auth</literal> member holds the authentication information
3542 part of the Z39.50 Initialize Request. Interpret this if your serves
3543 requires authentication.
3546 The members <literal>peer_name</literal>,
3547 <literal>implementation_id</literal>,
3548 <literal>implementation_name</literal> and
3549 <literal>implementation_version</literal> holds
3550 DNS of client, ID of implementor, name
3551 of client (Z39.50) implementation - and version.
3554 The <literal>bend_</literal> - members are set to NULL when
3555 <function>bend_init</function> is called. Modify the pointers by
3556 setting them to point to backend functions.
3559 <sect2 id="server.search.retrieve">
3560 <title>Search and Retrieve</title>
3562 We now describe the handlers that are required to support search -
3563 and retrieve. You must support two functions - one for search - and one
3564 for fetch (retrieval of one record). If desirable you can provide a
3565 third handler which is called when a present request is received which
3566 allows you to optimize retrieval of multiple-records.
3569 int (*bend_search) (void *handle, bend_search_rr *rr);
3572 char *setname; /* name to give to this set */
3573 int replace_set; /* replace set, if it already exists */
3574 int num_bases; /* number of databases in list */
3575 char **basenames; /* databases to search */
3576 Z_ReferenceId *referenceId;/* reference ID */
3577 Z_Query *query; /* query structure */
3578 ODR stream; /* encode stream */
3579 ODR decode; /* decode stream */
3580 ODR print; /* print stream */
3582 bend_request request;
3583 bend_association association;
3585 int hits; /* number of hits */
3586 int errcode; /* 0==OK */
3587 char *errstring; /* system error string or NULL */
3588 Z_OtherInformation *search_info; /* additional search info */
3589 char *srw_sortKeys; /* holds SRU/SRW sortKeys info */
3590 char *srw_setname; /* holds SRU/SRW generated resultsetID */
3591 int *srw_setnameIdleTime; /* holds SRU/SRW life-time */
3592 int estimated_hit_count; /* if hit count is estimated */
3593 int partial_resultset; /* if result set is partial */
3597 The <function>bend_search</function> handler is a fairly close
3598 approximation of a protocol Z39.50 Search Request - and Response PDUs
3599 The <literal>setname</literal> is the resultSetName from the protocol.
3600 You are required to establish a mapping between the set name and whatever
3601 your backend database likes to use.
3602 Similarly, the <literal>replace_set</literal> is a boolean value
3603 corresponding to the resultSetIndicator field in the protocol.
3604 <literal>num_bases/basenames</literal> is a length of/array of character
3605 pointers to the database names provided by the client.
3606 The <literal>query</literal> is the full query structure as defined in
3607 the protocol ASN.1 specification.
3608 It can be either of the possible query types, and it's up to you to
3609 determine if you can handle the provided query type.
3610 Rather than reproduce the C interface here, we'll refer you to the
3611 structure definitions in the file
3612 <filename>include/yaz/z-core.h</filename>. If you want to look at the
3613 attributeSetId OID of the RPN query, you can either match it against
3614 your own internal tables, or you can use the <link linkend="tools.oid">
3618 The structure contains a number of hits, and an
3619 <literal>errcode/errstring</literal> pair. If an error occurs
3620 during the search, or if you're unhappy with the request, you should
3621 set the errcode to a value from the BIB-1 diagnostic set. The value
3622 will then be returned to the user in a nonsurrogate diagnostic record
3623 in the response. The <literal>errstring</literal>, if provided, will
3624 go in the addinfo field. Look at the protocol definition for the
3625 defined error codes, and the suggested uses of the addinfo field.
3628 The <function>bend_search</function> handler is also called when
3629 the frontend server receives a SRU SearchRetrieveRequest.
3630 For SRU, a CQL query is usually provided by the client.
3631 The CQL query is available as part of <literal>Z_Query</literal>
3632 structure (note that CQL is now part of Z39.50 via an external).
3633 To support CQL in existing implementations that only do Type-1,
3634 we refer to the CQL-to-PQF tool described
3635 <link linkend="cql.to.pqf">here</link>.
3638 To maintain backwards compatibility, the frontend server
3639 of yaz always assume that error codes are BIB-1 diagnostics.
3640 For SRU operation, a Bib-1 diagnostic code is mapped to
3644 int (*bend_fetch) (void *handle, bend_fetch_rr *rr);
3646 typedef struct bend_fetch_rr {
3647 char *setname; /* set name */
3648 int number; /* record number */
3649 Z_ReferenceId *referenceId;/* reference ID */
3650 Odr_oid *request_format; /* format, transfer syntax (OID) */
3651 Z_RecordComposition *comp; /* Formatting instructions */
3652 ODR stream; /* encoding stream - memory source if req */
3653 ODR print; /* printing stream */
3655 char *basename; /* name of database that provided record */
3656 int len; /* length of record or -1 if structured */
3657 char *record; /* record */
3658 int last_in_set; /* is it? */
3659 Odr_oid *output_format; /* response format/syntax (OID) */
3660 int errcode; /* 0==success */
3661 char *errstring; /* system error string or NULL */
3662 int surrogate_flag; /* surrogate diagnostic */
3663 char *schema; /* string record schema input/output */
3667 The frontend server calls the <function>bend_fetch</function> handler
3668 when it needs database records to fulfill a Z39.50 Search Request, a
3669 Z39.50 Present Request or a SRU SearchRetrieveRequest.
3670 The <literal>setname</literal> is simply the name of the result set
3671 that holds the reference to the desired record.
3672 The <literal>number</literal> is the offset into the set (with 1
3673 being the first record in the set). The <literal>format</literal> field
3674 is the record format requested by the client (See
3675 <xref linkend="tools.oid"/>).
3676 A value of NULL for <literal>format</literal> indicates that the
3677 client did not request a specific format.
3678 The <literal>stream</literal> argument is an &odr; stream which
3679 should be used for allocating space for structured data records.
3680 The stream will be reset when all records have been assembled, and
3681 the response package has been transmitted.
3682 For unstructured data, the backend is responsible for maintaining a
3683 static or dynamic buffer for the record between calls.
3686 If a SRU SearchRetrieveRequest is received by the frontend server,
3687 the <literal>referenceId</literal> is NULL and the
3688 <literal>format</literal> (transfer syntax) is the OID for XML.
3689 The schema for SRU is stored in both the
3690 <literal>Z_RecordComposition</literal>
3691 structure and <literal>schema</literal> (simple string).
3694 In the structure, the <literal>basename</literal> is the name of the
3695 database that holds the
3696 record. <literal>len</literal> is the length of the record returned, in
3697 bytes, and <literal>record</literal> is a pointer to the record.
3698 <literal>last_in_set</literal> should be nonzero only if the record
3699 returned is the last one in the given result set.
3700 <literal>errcode</literal> and <literal>errstring</literal>, if
3701 given, will be interpreted as a global error pertaining to the
3702 set, and will be returned in a non-surrogate-diagnostic.
3703 If you wish to return the error as a surrogate-diagnostic
3704 (local error) you can do this by setting
3705 <literal>surrogate_flag</literal> to 1 also.
3708 If the <literal>len</literal> field has the value -1, then
3709 <literal>record</literal> is assumed to point to a constructed data
3710 type. The <literal>format</literal> field will be used to determine
3711 which encoder should be used to serialize the data.
3715 If your backend generates structured records, it should use
3716 <function>odr_malloc()</function> on the provided stream for allocating
3717 data: This allows the frontend server to keep track of the record sizes.
3721 The <literal>format</literal> field is mapped to an object identifier
3722 in the direct reference of the resulting EXTERNAL representation
3727 The current version of &yaz; only supports the direct reference mode.
3731 int (*bend_present) (void *handle, bend_present_rr *rr);
3734 char *setname; /* set name */
3736 int number; /* record number */
3737 Odr_oid *format; /* format, transfer syntax (OID) */
3738 Z_ReferenceId *referenceId;/* reference ID */
3739 Z_RecordComposition *comp; /* Formatting instructions */
3740 ODR stream; /* encoding stream - memory source if required */
3741 ODR print; /* printing stream */
3742 bend_request request;
3743 bend_association association;
3745 int hits; /* number of hits */
3746 int errcode; /* 0==OK */
3747 char *errstring; /* system error string or NULL */
3751 The <function>bend_present</function> handler is called when
3752 the server receives a Z39.50 Present Request.
3753 The <literal>setname</literal>,
3754 <literal>start</literal> and <literal>number</literal> is the
3755 name of the result set - start position - and number of records to
3756 be retrieved respectively. <literal>format</literal> and
3757 <literal>comp</literal> is the preferred transfer syntax and element
3758 specifications of the present request.
3761 Note that this is handler serves as a supplement for
3762 <function>bend_fetch</function> and need not to be defined in order to
3763 support search - and retrieve.
3766 <sect2 id="server.delete">
3767 <title>Delete</title>
3769 For back-ends that supports delete of a result set only one handler
3773 int (*bend_delete)(void *handle, bend_delete_rr *rr);
3775 typedef struct bend_delete_rr {
3779 Z_ReferenceId *referenceId;
3780 int delete_status; /* status for the whole operation */
3781 int *statuses; /* status each set - indexed as setnames */
3788 The delete set function definition is rather primitive, mostly because
3789 we have had no practical need for it as of yet. If someone wants
3790 to provide a full delete service, we'd be happy to add the
3791 extra parameters that are required. Are there clients out there
3792 that will actually delete sets they no longer need?
3796 <sect2 id="server.scan">
3799 For servers that wish to offer the scan service one handler
3803 int (*bend_scan)(void *handle, bend_scan_rr *rr);
3806 BEND_SCAN_SUCCESS, /* ok */
3807 BEND_SCAN_PARTIAL /* not all entries could be found */
3810 typedef struct bend_scan_rr {
3811 int num_bases; /* number of elements in databaselist */
3812 char **basenames; /* databases to search */
3813 Odr_oid *attributeset;
3814 Z_ReferenceId *referenceId; /* reference ID */
3815 Z_AttributesPlusTerm *term;
3816 ODR stream; /* encoding stream - memory source if required */
3817 ODR print; /* printing stream */
3819 int *step_size; /* step size */
3820 int term_position; /* desired index of term in result list/returned */
3821 int num_entries; /* number of entries requested/returned */
3823 /* scan term entries. The called handler does not have
3824 to allocate this. Size of entries is num_entries (see above) */
3825 struct scan_entry *entries;
3826 bend_scan_status status;
3829 char *scanClause; /* CQL scan clause */
3830 char *setname; /* Scan in result set (NULL if omitted) */
3834 This backend server handles both Z39.50 scan
3835 and SRU scan. In order for a handler to distinguish between SRU (CQL) scan
3836 Z39.50 Scan , it must check for a non-NULL value of
3837 <literal>scanClause</literal>.
3841 if designed today, it would be a choice using a union or similar,
3842 but that would break binary compatibility with existing servers.
3847 <sect1 id="server.invocation">
3848 <title>Application Invocation</title>
3850 The finished application has the following
3851 invocation syntax (by way of <function>statserv_main()</function>):
3859 A listener specification consists of a transport mode followed by a
3860 colon (:) followed by a listener address. The transport mode is
3861 either <literal>tcp</literal>, <literal>unix:</literal> or
3862 <literal>ssl</literal>.
3865 For TCP and SSL, an address has the form
3868 hostname | IP-number [: portnumber]
3871 The port number defaults to 210 (standard Z39.50 port).
3874 For UNIX, the address is the filename of socket.
3877 For TCP/IP and SSL, the special hostnames <literal>@</literal>,
3878 maps to <literal>IN6ADDR_ANY_INIT</literal> with
3879 IPV4 binding as well (bindv6only=0),
3880 The special hostname <literal>@4</literal> binds to
3881 <literal>INADDR_ANY</literal> (IPV4 only listener).
3882 The special hostname <literal>@6</literal> binds to
3883 <literal>IN6ADDR_ANY_INIT</literal> with bindv6only=1 (IPV6 only listener).
3885 <example id="server.example.running.unix">
3886 <title>Running the GFS on Unix</title>
3888 Assuming the server application <replaceable>appname</replaceable> is
3889 started as root, the following will make it listen on port 210.
3890 The server will change identity to <literal>nobody</literal>
3891 and write its log to <filename>/var/log/app.log</filename>.
3893 application -l /var/log/app.log -u nobody tcp:@:210
3897 The server will accept Z39.50 requests and offer SRU service on port 210.
3900 <example id="server.example.apache.sru">
3901 <title>Setting up Apache as SRU Frontend</title>
3903 If you use <ulink url="&url.apache;">Apache</ulink>
3904 as your public web server and want to offer HTTP port 80
3905 access to the YAZ server on 210, you can use the
3906 <ulink url="&url.apache.directive.proxypass;">
3907 <literal>ProxyPass</literal></ulink>
3909 If you have virtual host
3910 <literal>srw.mydomain</literal> you can use the following directives
3911 in Apache's httpd.conf:
3914 ErrorLog /home/srw/logs/error_log
3915 TransferLog /home/srw/logs/access_log
3916 ProxyPass / http://srw.mydomain:210/
3921 The above for the Apache 1.3 series.
3924 <example id="server.example.local.access">
3925 <title>Running a server with local access only</title>
3927 Servers that is only being accessed from the local host should listen
3928 on UNIX file socket rather than a Internet socket. To listen on
3929 <filename>/tmp/mysocket</filename> start the server as follows:
3931 application unix:/tmp/mysocket
3936 <sect1 id="server.vhosts">
3937 <title>GFS Configuration and Virtual Hosts</title>
3942 <title>The Z39.50 ASN.1 Module</title>
3943 <sect1 id="asn.introduction">
3944 <title>Introduction</title>
3946 The &asn; module provides you with a set of C struct definitions for the
3947 various PDUs of the Z39.50 protocol, as well as for the complex types
3948 appearing within the PDUs. For the primitive data types, the C
3949 representation often takes the form of an ordinary C language type,
3950 such as <literal>Odr_int</literal> which is equivalent to an integral
3951 C integer. For ASN.1 constructs that have no direct
3952 representation in C, such as general octet strings and bit strings,
3953 the &odr; module (see section <link linkend="odr">The ODR Module</link>)
3954 provides auxiliary definitions.
3957 The &asn; module is located in sub directory <filename>z39.50</filename>.
3958 There you'll find C files that implements encoders and decoders for the
3959 Z39.50 types. You'll also find the protocol definitions:
3960 <filename>z3950v3.asn</filename>, <filename>esupdate.asn</filename>,
3964 <sect1 id="asn.preparing">
3965 <title>Preparing PDUs</title>
3967 A structure representing a complex ASN.1 type doesn't in itself contain the
3968 members of that type. Instead, the structure contains
3969 <emphasis>pointers</emphasis> to the members of the type.
3970 This is necessary, in part, to allow a mechanism for specifying which
3971 of the optional structure (SEQUENCE) members are present, and which
3972 are not. It follows that you will need to somehow provide space for
3973 the individual members of the structure, and set the pointers to
3974 refer to the members.
3977 The conversion routines don't care how you allocate and maintain your
3978 C structures - they just follow the pointers that you provide.
3979 Depending on the complexity of your application, and your personal
3980 taste, there are at least three different approaches that you may take
3981 when you allocate the structures.
3984 You can use static or automatic local variables in the function that
3985 prepares the PDU. This is a simple approach, and it provides the most
3986 efficient form of memory management. While it works well for flat
3987 PDUs like the InitReqest, it will generally not be sufficient for say,
3988 the generation of an arbitrarily complex RPN query structure.
3991 You can individually create the structure and its members using the
3992 <function>malloc(2)</function> function. If you want to ensure that
3993 the data is freed when it is no longer needed, you will have to
3994 define a function that individually releases each member of a
3995 structure before freeing the structure itself.
3998 You can use the <function>odr_malloc()</function> function (see
3999 <xref linkend="odr.use"/> for details). When you use
4000 <function>odr_malloc()</function>, you can release all of the
4001 allocated data in a single operation, independent of any pointers and
4002 relations between the data. <function>odr_malloc()</function> is based on a
4003 "nibble-memory"
4004 scheme, in which large portions of memory are allocated, and then
4005 gradually handed out with each call to <function>odr_malloc()</function>.
4006 The next time you call <function>odr_reset()</function>, all of the
4007 memory allocated since the last call is recycled for future use (actually,
4008 it is placed on a free-list).
4011 You can combine all of the methods described here. This will often be
4012 the most practical approach. For instance, you might use
4013 <function>odr_malloc()</function> to allocate an entire structure and
4014 some of its elements, while you leave other elements pointing to global
4015 or per-session default variables.
4018 The &asn; module provides an important aid in creating new PDUs. For
4019 each of the PDU types (say, <function>Z_InitRequest</function>), a
4020 function is provided that allocates and initializes an instance of
4021 that PDU type for you. In the case of the InitRequest, the function is
4022 simply named <function>zget_InitRequest()</function>, and it sets up
4023 reasonable default value for all of the mandatory members. The optional
4024 members are generally initialized to null pointers. This last aspect
4025 is very important: it ensures that if the PDU definitions are
4026 extended after you finish your implementation (to accommodate
4027 new versions of the protocol, say), you won't get into trouble with
4028 uninitialized pointers in your structures. The functions use
4029 <function>odr_malloc()</function> to
4030 allocate the PDUs and its members, so you can free everything again with a
4031 single call to <function>odr_reset()</function>. We strongly recommend
4032 that you use the <literal>zget_*</literal>
4033 functions whenever you are preparing a PDU (in a C++ API, the
4034 <literal>zget_</literal>
4035 functions would probably be promoted to constructors for the
4039 The prototype for the individual PDU types generally look like this:
4042 Z_<type> *zget_<type>(ODR o);
4048 Z_InitRequest *zget_InitRequest(ODR o);
4051 The &odr; handle should generally be your encoding stream, but it
4055 As well as the individual PDU functions, a function
4056 <function>zget_APDU()</function> is provided, which allocates
4057 a top-level Z-APDU of the type requested:
4060 Z_APDU *zget_APDU(ODR o, int which);
4063 The <varname>which</varname> parameter is (of course) the discriminator
4064 belonging to the <varname>Z_APDU</varname> <literal>CHOICE</literal> type.
4065 All of the interface described here is provided by the &asn; module, and
4066 you access it through the <filename>proto.h</filename> header file.
4069 <sect1 id="asn.external">
4070 <title>EXTERNAL Data</title>
4072 In order to achieve extensibility and adaptability to different
4073 application domains, the new version of the protocol defines many
4074 structures outside of the main ASN.1 specification, referencing them
4075 through ASN.1 EXTERNAL constructs. To simplify the construction and
4076 access to the externally referenced data, the &asn; module defines a
4077 specialized version of the EXTERNAL construct, called
4078 <literal>Z_External</literal>.It is defined thus:
4081 typedef struct Z_External
4083 Odr_oid *direct_reference;
4084 int *indirect_reference;
4089 Z_External_single = 0,
4091 Z_External_arbitrary,
4093 /* Specific types */
4095 Z_External_explainRecord,
4096 Z_External_resourceReport1,
4097 Z_External_resourceReport2
4105 Odr_any *single_ASN1_type;
4106 Odr_oct *octet_aligned;
4107 Odr_bitmask *arbitrary;
4109 /* Specific types */
4111 Z_ExplainRecord *explainRecord;
4112 Z_ResourceReport1 *resourceReport1;
4113 Z_ResourceReport2 *resourceReport2;
4121 When decoding, the &asn; module will attempt to determine which
4122 syntax describes the data by looking at the reference fields
4123 (currently only the direct-reference). For ASN.1 structured data, you
4124 need only consult the <literal>which</literal> field to determine the
4125 type of data. You can the access the data directly through the union.
4126 When constructing data for encoding, you set the union pointer to point
4127 to the data, and set the <literal>which</literal> field accordingly.
4128 Remember also to set the direct (or indirect) reference to the correct
4129 OID for the data type.
4130 For non-ASN.1 data such as MARC records, use the
4131 <literal>octet_aligned</literal> arm of the union.
4134 Some servers return ASN.1 structured data values (eg. database
4135 records) as BER-encoded records placed in the
4136 <literal>octet-aligned</literal> branch of the EXTERNAL CHOICE.
4137 The ASN-module will <emphasis>not</emphasis> automatically decode
4138 these records. To help you decode the records in the application, the
4142 Z_ext_typeent *z_ext_gettypebyref(const oid *oid);
4145 Can be used to retrieve information about the known, external data
4146 types. The function return a pointer to a static area, or NULL, if no
4147 match for the given direct reference is found. The
4148 <literal>Z_ext_typeent</literal>
4152 typedef struct Z_ext_typeent
4154 int oid[OID_SIZE]; /* the direct-reference OID. */
4155 int what; /* discriminator value for the external CHOICE */
4156 Odr_fun fun; /* decoder function */
4160 The <literal>what</literal> member contains the
4161 <literal>Z_External</literal> union discriminator value for the
4162 given type: For the SUTRS record syntax, the value would be
4163 <literal>Z_External_sutrs</literal>.
4164 The <literal>fun</literal> member contains a pointer to the
4165 function which encodes/decodes the given type. Again, for the SUTRS
4166 record syntax, the value of <literal>fun</literal> would be
4167 <literal>z_SUTRS</literal> (a function pointer).
4170 If you receive an EXTERNAL which contains an octet-string value that
4171 you suspect of being an ASN.1-structured data value, you can use
4172 <literal>z_ext_gettypebyref</literal> to look for the provided
4174 If the return value is different from NULL, you can use the provided
4175 function to decode the BER string (see <xref linkend="odr.use"/>
4179 If you want to <emphasis>send</emphasis> EXTERNALs containing
4180 ASN.1-structured values in the occtet-aligned branch of the CHOICE, this
4181 is possible too. However, on the encoding phase, it requires a somewhat
4182 involved juggling around of the various buffers involved.
4185 If you need to add new, externally defined data types, you must update
4186 the struct above, in the source file <filename>prt-ext.h</filename>, as
4187 well as the encoder/decoder in the file <filename>prt-ext.c</filename>.
4188 When changing the latter, remember to update both the
4189 <literal>arm</literal> arrary and the list
4190 <literal>type_table</literal>, which drives the CHOICE biasing that
4191 is necessary to tell the different, structured types apart
4196 Eventually, the EXTERNAL processing will most likely
4197 automatically insert the correct OIDs or indirect-refs. First,
4198 however, we need to determine how application-context management
4199 (specifically the presentation-context-list) should fit into the
4204 <sect1 id="asn.pdu">
4205 <title>PDU Contents Table</title>
4207 We include, for reference, a listing of the fields of each top-level
4208 PDU, as well as their default settings.
4210 <table frame="top" id="asn.default.initialize.request">
4211 <title>Default settings for PDU Initialize Request</title>
4213 <colspec colwidth="7*" colname="field"></colspec>
4214 <colspec colwidth="5*" colname="type"></colspec>
4215 <colspec colwidth="7*" colname="value"></colspec>
4218 <entry>Field</entry>
4220 <entry>Default Value</entry>
4225 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4228 protocolVersion</entry><entry>Odr_bitmask</entry><entry>Empty bitmask
4231 options</entry><entry>Odr_bitmask</entry><entry>Empty bitmask
4234 preferredMessageSize</entry><entry>Odr_int</entry><entry>30*1024
4237 maximumRecordSize</entry><entry>Odr_int</entry><entry>30*1024
4240 idAuthentication</entry><entry>Z_IdAuthentication</entry><entry>NULL
4243 implementationId</entry><entry>char*</entry><entry>"81"
4246 implementationName</entry><entry>char*</entry><entry>"YAZ"
4249 implementationVersion</entry><entry>char*</entry><entry>YAZ_VERSION
4252 userInformationField</entry><entry>Z_UserInformation</entry><entry>NULL
4255 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4260 <table frame="top" id="asn.default.initialize.response">
4261 <title>Default settings for PDU Initialize Response</title>
4263 <colspec colwidth="7*" colname="field"></colspec>
4264 <colspec colwidth="5*" colname="type"></colspec>
4265 <colspec colwidth="7*" colname="value"></colspec>
4268 <entry>Field</entry>
4270 <entry>Default Value</entry>
4275 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4278 protocolVersion</entry><entry>Odr_bitmask</entry><entry>Empty bitmask
4281 options</entry><entry>Odr_bitmask</entry><entry>Empty bitmask
4284 preferredMessageSize</entry><entry>Odr_int</entry><entry>30*1024
4287 maximumRecordSize</entry><entry>Odr_int</entry><entry>30*1024
4290 result</entry><entry>Odr_bool</entry><entry>TRUE
4293 implementationId</entry><entry>char*</entry><entry>"id)"
4296 implementationName</entry><entry>char*</entry><entry>"YAZ"
4299 implementationVersion</entry><entry>char*</entry><entry>YAZ_VERSION
4302 userInformationField</entry><entry>Z_UserInformation</entry><entry>NULL
4305 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4310 <table frame="top" id="asn.default.search.request">
4311 <title>Default settings for PDU Search Request</title>
4313 <colspec colwidth="7*" colname="field"></colspec>
4314 <colspec colwidth="5*" colname="type"></colspec>
4315 <colspec colwidth="7*" colname="value"></colspec>
4318 <entry>Field</entry>
4320 <entry>Default Value</entry>
4325 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4328 smallSetUpperBound</entry><entry>Odr_int</entry><entry>0
4331 largeSetLowerBound</entry><entry>Odr_int</entry><entry>1
4334 mediumSetPresentNumber</entry><entry>Odr_int</entry><entry>0
4337 replaceIndicator</entry><entry>Odr_bool</entry><entry>TRUE
4340 resultSetName</entry><entry>char *</entry><entry>"default"
4343 num_databaseNames</entry><entry>Odr_int</entry><entry>0
4346 databaseNames</entry><entry>char **</entry><entry>NULL
4349 smallSetElementSetNames</entry><entry>Z_ElementSetNames
4353 mediumSetElementSetNames</entry><entry>Z_ElementSetNames
4357 preferredRecordSyntax</entry><entry>Odr_oid</entry><entry>NULL
4360 query</entry><entry>Z_Query</entry><entry>NULL
4363 additionalSearchInfo</entry><entry>Z_OtherInformation
4367 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4372 <table frame="top" id="asn.default.search.response">
4373 <title>Default settings for PDU Search Response</title>
4375 <colspec colwidth="7*" colname="field"></colspec>
4376 <colspec colwidth="5*" colname="type"></colspec>
4377 <colspec colwidth="7*" colname="value"></colspec>
4380 <entry>Field</entry>
4382 <entry>Default Value</entry>
4387 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4390 resultCount</entry><entry>Odr_int</entry><entry>0
4393 numberOfRecordsReturned</entry><entry>Odr_int</entry><entry>0
4396 nextResultSetPosition</entry><entry>Odr_int</entry><entry>0
4399 searchStatus</entry><entry>Odr_bool</entry><entry>TRUE
4402 resultSetStatus</entry><entry>Odr_int</entry><entry>NULL
4405 presentStatus</entry><entry>Odr_int</entry><entry>NULL
4408 records</entry><entry>Z_Records</entry><entry>NULL
4411 additionalSearchInfo</entry>
4412 <entry>Z_OtherInformation</entry><entry>NULL
4415 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4420 <table frame="top" id="asn.default.present.request">
4421 <title>Default settings for PDU Present Request</title>
4423 <colspec colwidth="7*" colname="field"></colspec>
4424 <colspec colwidth="5*" colname="type"></colspec>
4425 <colspec colwidth="7*" colname="value"></colspec>
4428 <entry>Field</entry>
4430 <entry>Default Value</entry>
4435 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4438 resultSetId</entry><entry>char*</entry><entry>"default"
4441 resultSetStartPoint</entry><entry>Odr_int</entry><entry>1
4444 numberOfRecordsRequested</entry><entry>Odr_int</entry><entry>10
4447 num_ranges</entry><entry>Odr_int</entry><entry>0
4450 additionalRanges</entry><entry>Z_Range</entry><entry>NULL
4453 recordComposition</entry><entry>Z_RecordComposition</entry><entry>NULL
4456 preferredRecordSyntax</entry><entry>Odr_oid</entry><entry>NULL
4459 maxSegmentCount</entry><entry>Odr_int</entry><entry>NULL
4462 maxRecordSize</entry><entry>Odr_int</entry><entry>NULL
4465 maxSegmentSize</entry><entry>Odr_int</entry><entry>NULL
4468 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4473 <table frame="top" id="asn.default.present.response">
4474 <title>Default settings for PDU Present Response</title>
4476 <colspec colwidth="7*" colname="field"></colspec>
4477 <colspec colwidth="5*" colname="type"></colspec>
4478 <colspec colwidth="7*" colname="value"></colspec>
4481 <entry>Field</entry>
4483 <entry>Default Value</entry>
4488 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4491 numberOfRecordsReturned</entry><entry>Odr_int</entry><entry>0
4494 nextResultSetPosition</entry><entry>Odr_int</entry><entry>0
4497 presentStatus</entry><entry>Odr_int</entry><entry>Z_PresentStatus_success
4500 records</entry><entry>Z_Records</entry><entry>NULL
4503 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4508 <table frame="top" id="asn.default.delete.result.set.request">
4509 <title>Default settings for Delete Result Set Request</title>
4511 <colspec colwidth="7*" colname="field"></colspec>
4512 <colspec colwidth="5*" colname="type"></colspec>
4513 <colspec colwidth="7*" colname="value"></colspec>
4516 <entry>Field</entry>
4518 <entry>Default Value</entry>
4522 <row><entry>referenceId
4523 </entry><entry>Z_ReferenceId</entry><entry>NULL
4526 deleteFunction</entry><entry>Odr_int</entry><entry>Z_DeleteResultSetRequest_list
4529 num_ids</entry><entry>Odr_int</entry><entry>0
4532 resultSetList</entry><entry>char**</entry><entry>NULL
4535 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4540 <table frame="top" id="asn.default.delete.result.set.response">
4541 <title>Default settings for Delete Result Set Response</title>
4543 <colspec colwidth="7*" colname="field"></colspec>
4544 <colspec colwidth="5*" colname="type"></colspec>
4545 <colspec colwidth="7*" colname="value"></colspec>
4548 <entry>Field</entry>
4550 <entry>Default Value</entry>
4555 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4558 deleteOperationStatus</entry><entry>Odr_int</entry>
4559 <entry>Z_DeleteStatus_success</entry></row>
4561 num_statuses</entry><entry>Odr_int</entry><entry>0
4564 deleteListStatuses</entry><entry>Z_ListStatus**</entry><entry>NULL
4567 numberNotDeleted</entry><entry>Odr_int</entry><entry>NULL
4570 num_bulkStatuses</entry><entry>Odr_int</entry><entry>0
4573 bulkStatuses</entry><entry>Z_ListStatus</entry><entry>NUL
4576 deleteMessage</entry><entry>char*</entry><entry>NULL
4579 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4584 <table frame="top" id="asn.default.scan.request">
4585 <title>Default settings for Scan Request</title>
4587 <colspec colwidth="7*" colname="field"></colspec>
4588 <colspec colwidth="5*" colname="type"></colspec>
4589 <colspec colwidth="7*" colname="value"></colspec>
4592 <entry>Field</entry>
4594 <entry>Default Value</entry>
4599 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4602 num_databaseNames</entry><entry>Odr_int</entry><entry>0
4605 databaseNames</entry><entry>char**</entry><entry>NULL
4608 attributeSet</entry><entry>Odr_oid</entry><entry>NULL
4611 termListAndStartPoint</entry><entry>Z_AttributesPlus...
4612 </entry><entry>NULL</entry></row>
4614 stepSize</entry><entry>Odr_int</entry><entry>NULL
4617 numberOfTermsRequested</entry><entry>Odr_int</entry><entry>20
4620 preferredPositionInResponse</entry><entry>Odr_int</entry><entry>NULL
4623 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4628 <table frame="top" id="asn.default.scan.response">
4629 <title>Default settings for Scan Response</title>
4631 <colspec colwidth="7*" colname="field"></colspec>
4632 <colspec colwidth="5*" colname="type"></colspec>
4633 <colspec colwidth="7*" colname="value"></colspec>
4636 <entry>Field</entry>
4638 <entry>Default Value</entry>
4643 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4646 stepSize</entry><entry>Odr_int</entry><entry>NULL
4649 scanStatus</entry><entry>Odr_int</entry><entry>Z_Scan_success
4652 numberOfEntriesReturned</entry><entry>Odr_int</entry><entry>0
4655 positionOfTerm</entry><entry>Odr_int</entry><entry>NULL
4658 entries</entry><entry>Z_ListEntris</entry><entry>NULL
4661 attributeSet</entry><entry>Odr_oid</entry><entry>NULL
4664 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4669 <table frame="top" id="asn.default.trigger.resource.control.request">
4670 <title>Default settings for Trigger Resource Control Request</title>
4672 <colspec colwidth="7*" colname="field"></colspec>
4673 <colspec colwidth="5*" colname="type"></colspec>
4674 <colspec colwidth="7*" colname="value"></colspec>
4677 <entry>Field</entry>
4679 <entry>Default Value</entry>
4684 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4687 requestedAction</entry><entry>Odr_int</entry><entry>
4688 Z_TriggerResourceCtrl_resou..
4691 prefResourceReportFormat</entry><entry>Odr_oid</entry><entry>NULL
4694 resultSetWanted</entry><entry>Odr_bool</entry><entry>NULL
4697 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4702 <table frame="top" id="asn.default.resource.control.request">
4703 <title>Default settings for Resource Control Request</title>
4705 <colspec colwidth="7*" colname="field"></colspec>
4706 <colspec colwidth="5*" colname="type"></colspec>
4707 <colspec colwidth="7*" colname="value"></colspec>
4710 <entry>Field</entry>
4712 <entry>Default Value</entry>
4717 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4720 suspendedFlag</entry><entry>Odr_bool</entry><entry>NULL
4723 resourceReport</entry><entry>Z_External</entry><entry>NULL
4726 partialResultsAvailable</entry><entry>Odr_int</entry><entry>NULL
4729 responseRequired</entry><entry>Odr_bool</entry><entry>FALSE
4732 triggeredRequestFlag</entry><entry>Odr_bool</entry><entry>NULL
4735 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4740 <table frame="top" id="asn.default.resource.control.response">
4741 <title>Default settings for Resource Control Response</title>
4743 <colspec colwidth="7*" colname="field"></colspec>
4744 <colspec colwidth="5*" colname="type"></colspec>
4745 <colspec colwidth="7*" colname="value"></colspec>
4748 <entry>Field</entry>
4750 <entry>Default Value</entry>
4755 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4758 continueFlag</entry><entry>bool_t</entry><entry>TRUE
4761 resultSetWanted</entry><entry>bool_t</entry><entry>NULL
4764 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4769 <table frame="top" id="asn.default.access.control.request">
4770 <title>Default settings for Access Control Request</title>
4772 <colspec colwidth="7*" colname="field"></colspec>
4773 <colspec colwidth="5*" colname="type"></colspec>
4774 <colspec colwidth="7*" colname="value"></colspec>
4777 <entry>Field</entry>
4779 <entry>Default Value</entry>
4784 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4787 which</entry><entry>enum</entry><entry>Z_AccessRequest_simpleForm;
4790 u</entry><entry>union</entry><entry>NULL
4793 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4798 <table frame="top" id="asn.default.access.control.response">
4799 <title>Default settings for Access Control Response</title>
4801 <colspec colwidth="7*" colname="field"></colspec>
4802 <colspec colwidth="5*" colname="type"></colspec>
4803 <colspec colwidth="7*" colname="value"></colspec>
4806 <entry>Field</entry>
4808 <entry>Default Value</entry>
4813 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4816 which</entry><entry>enum</entry><entry>Z_AccessResponse_simpleForm
4819 u</entry><entry>union</entry><entry>NULL
4822 diagnostic</entry><entry>Z_DiagRec</entry><entry>NULL
4825 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4830 <table frame="top" id="asn.default.segment">
4831 <title>Default settings for Segment</title>
4833 <colspec colwidth="7*" colname="field"></colspec>
4834 <colspec colwidth="5*" colname="type"></colspec>
4835 <colspec colwidth="7*" colname="value"></colspec>
4838 <entry>Field</entry>
4840 <entry>Default Value</entry>
4845 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4848 numberOfRecordsReturned</entry><entry>Odr_int</entry><entry>value=0
4851 num_segmentRecords</entry><entry>Odr_int</entry><entry>0
4854 segmentRecords</entry><entry>Z_NamePlusRecord</entry><entry>NULL
4856 <row><entry>otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4861 <table frame="top" id="asn.default.close">
4862 <title>Default settings for Close</title>
4864 <colspec colwidth="7*" colname="field"></colspec>
4865 <colspec colwidth="5*" colname="type"></colspec>
4866 <colspec colwidth="7*" colname="value"></colspec>
4869 <entry>Field</entry>
4871 <entry>Default Value</entry>
4876 referenceId</entry><entry>Z_ReferenceId</entry><entry>NULL
4879 closeReason</entry><entry>Odr_int</entry><entry>Z_Close_finished
4882 diagnosticInformation</entry><entry>char*</entry><entry>NULL
4885 resourceReportFormat</entry><entry>Odr_oid</entry><entry>NULL
4888 resourceFormat</entry><entry>Z_External</entry><entry>NULL
4891 otherInfo</entry><entry>Z_OtherInformation</entry><entry>NULL
4899 <title>SOAP and SRU</title>
4900 <sect1 id="soap.introduction">
4901 <title>Introduction</title>
4903 &yaz; uses a very simple implementation of
4904 <ulink url="&url.soap;">SOAP</ulink> that only,
4905 currenly, supports what is sufficient to offer SRU SOAP functionality.
4906 The implementation uses the
4907 <ulink url="&url.libxml2.api.tree;">tree API</ulink> of
4908 libxml2 to encode and decode SOAP packages.
4911 Like the Z39.50 ASN.1 module, the &yaz; SRU implementation uses
4912 simple C structs to represent SOAP packages as well as
4916 <sect1 id="soap.http">
4919 &yaz; only offers HTTP as transport carrier for SOAP, but it is
4920 relatively easy to change that.
4923 The following definition of <literal>Z_GDU</literal> (Generic Data
4924 Unit) allows for both HTTP and Z39.50 in one packet.
4927 #include <yaz/zgdu.h>
4929 #define Z_GDU_Z3950 1
4930 #define Z_GDU_HTTP_Request 2
4931 #define Z_GDU_HTTP_Response 3
4936 Z_HTTP_Request *HTTP_Request;
4937 Z_HTTP_Response *HTTP_Response;
4942 The corresponding Z_GDU encoder/decoder is <function>z_GDU</function>.
4943 The <literal>z3950</literal> is any of the known BER encoded Z39.50
4945 <literal>HTTP_Request</literal> and <literal>HTTP_Response</literal>
4946 is the HTTP Request and Response respectively.
4949 <sect1 id="soap.xml">
4950 <title>SOAP Packages</title>
4952 Every SOAP package in &yaz; is represented as follows:
4954 #include <yaz/soap.h>
4968 #define Z_SOAP_fault 1
4969 #define Z_SOAP_generic 2
4970 #define Z_SOAP_error 3
4974 Z_SOAP_Fault *fault;
4975 Z_SOAP_Generic *generic;
4976 Z_SOAP_Fault *soap_error;
4983 The <literal>fault</literal> and <literal>soap_error</literal>
4984 arms represent both a SOAP fault - struct
4985 <literal>Z_SOAP_Fault</literal>. Any other generic
4986 (valid) package is represented by <literal>Z_SOAP_Generic</literal>.
4989 The <literal>ns</literal> as part of <literal>Z_SOAP</literal>
4990 is the namespace for SOAP itself and reflects the SOAP
4991 version. For version 1.1 it is
4992 <literal>http://schemas.xmlsoap.org/soap/envelope/</literal>,
4993 for version 1.2 it is
4994 <literal>http://www.w3.org/2001/06/soap-envelope</literal>.
4997 int z_soap_codec(ODR o, Z_SOAP **pp,
4998 char **content_buf, int *content_len,
4999 Z_SOAP_Handler *handlers);
5002 The <literal>content_buf</literal> and <literal>content_len</literal>
5003 is XML buffer and length of buffer respectively.
5006 The <literal>handlers</literal> is a list of SOAP codec
5007 handlers - one handler for each service namespace. For SRU SOAP, the
5008 namespace would be <literal>http://www.loc.gov/zing/srw/v1.0/</literal>.
5011 When decoding, the <function>z_soap_codec</function>
5012 inspects the XML content
5013 and tries to match one of the services namespaces of the
5014 supplied handlers. If there is a match a handler function
5015 is invoked which decodes that particular SOAP package.
5016 If successful, the returned <literal>Z_SOAP</literal> package will be
5017 of type <literal>Z_SOAP_Generic</literal>.
5018 Member <literal>no</literal> is
5019 set the offset of handler that matched; <literal>ns</literal>
5020 is set to namespace of matching handler; the void pointer
5021 <literal>p</literal> is set to the C data structure assocatiated
5025 When a NULL namespace is met (member <literal>ns</literal> bwlow),
5026 that specifies end-of-list.
5029 Each handler is defined as follows:
5037 The <literal>ns</literal> is namespace of service associated with
5038 handler <literal>f</literal>. <literal>client_data</literal>
5039 is user-defined data which is passed to handler.
5042 The prototype for a SOAP service handler is:
5044 int handler(ODR o, void * ptr, void **handler_data,
5045 void *client_data, const char *ns);
5047 The <parameter>o</parameter> specifies the mode (decode/encode)
5048 as usual. The second argument, <parameter>ptr</parameter>,
5049 is a libxml2 tree node pointer (<literal>xmlNodePtr</literal>)
5050 and is a pointer to the <literal>Body</literal> element
5051 of the SOAP package. The <parameter>handler_data</parameter>
5052 is an opaque pointer to a C definitions associated with the
5053 SOAP service. <parameter>client_data</parameter> is the pointer
5054 which was set as part of the <literal>Z_SOAP_handler</literal>.
5055 Finally, <parameter>ns</parameter> the service namespace.
5058 <sect1 id="soap.srw">
5061 SRU SOAP is just one implementation of a SOAP handler as described
5062 in the previous section.
5063 The encoder/decoder handler for SRU is defined as
5066 #include <yaz/srw.h>
5068 int yaz_srw_codec(ODR o, void * pptr,
5069 Z_SRW_GDU **handler_data,
5070 void *client_data, const char *ns);
5072 Here, <literal>Z_SRW_GDU</literal> is either
5073 searchRetrieveRequest or a searchRetrieveResponse.
5077 The xQuery and xSortKeys are not handled yet by
5078 the SRW implementation of &yaz;. Explain is also missing.
5079 Future versions of &yaz; will include these features.
5083 The definition of searchRetrieveRequest is:
5087 #define Z_SRW_query_type_cql 1
5088 #define Z_SRW_query_type_xcql 2
5089 #define Z_SRW_query_type_pqf 3
5097 #define Z_SRW_sort_type_none 1
5098 #define Z_SRW_sort_type_sort 2
5099 #define Z_SRW_sort_type_xSort 3
5107 int *maximumRecords;
5109 char *recordPacking;
5111 } Z_SRW_searchRetrieveRequest;
5113 Please observe that data of type xsd:string is represented
5114 as a char pointer (<literal>char *</literal>). A null pointer
5115 means that the element is absent.
5116 Data of type xsd:integer is representd as a pointer to
5117 an int (<literal>int *</literal>). Again, a null pointer
5118 us used for absent elements.
5121 The SearchRetrieveResponse has the following definition.
5124 int * numberOfRecords;
5126 int * resultSetIdleTime;
5128 Z_SRW_record *records;
5131 Z_SRW_diagnostic *diagnostics;
5132 int num_diagnostics;
5133 int *nextRecordPosition;
5134 } Z_SRW_searchRetrieveResponse;
5136 The <literal>num_records</literal> and <literal>num_diagnostics</literal>
5137 is number of returned records and diagnostics respectively and also
5138 correspond to the "size of" arrays <literal>records</literal>
5139 and <literal>diagnostics</literal>.
5142 A retrieval record is defined as follows:
5146 char *recordData_buf;
5148 int *recordPosition;
5151 The record data is defined as a buffer of some length so that
5152 data can be of any type. SRW 1.0 currenly doesn't allow for this
5153 (only XML), but future versions might do.
5156 And, a diagnostic as:
5166 <chapter id="tools">
5167 <title>Supporting Tools</title>
5169 In support of the service API - primarily the ASN module, which
5170 provides the pro-grammatic interface to the Z39.50 APDUs, &yaz; contains
5171 a collection of tools that support the development of applications.
5173 <sect1 id="tools.query">
5174 <title>Query Syntax Parsers</title>
5176 Since the type-1 (RPN) query structure has no direct, useful string
5177 representation, every origin application needs to provide some form of
5178 mapping from a local query notation or representation to a
5179 <token>Z_RPNQuery</token> structure. Some programmers will prefer to
5180 construct the query manually, perhaps using
5181 <function>odr_malloc()</function> to simplify memory management.
5182 The &yaz; distribution includes three separate, query-generating tools
5183 that may be of use to you.
5186 <title>Prefix Query Format</title>
5188 Since RPN or reverse polish notation is really just a fancy way of
5189 describing a suffix notation format (operator follows operands), it
5190 would seem that the confusion is total when we now introduce a prefix
5191 notation for RPN. The reason is one of simple laziness - it's somewhat
5192 simpler to interpret a prefix format, and this utility was designed
5193 for maximum simplicity, to provide a baseline representation for use
5194 in simple test applications and scripting environments (like Tcl). The
5195 demonstration client included with YAZ uses the PQF.
5199 The PQF have been adopted by other parties developing Z39.50
5200 software. It is often referred to as Prefix Query Notation
5205 The PQF is defined by the pquery module in the YAZ library.
5206 There are two sets of function that have similar behavior. First
5207 set operates on a PQF parser handle, second set doesn't. First set
5208 set of functions are more flexible than the second set. Second set
5209 is obsolete and is only provided to ensure backwards compatibility.
5212 First set of functions all operate on a PQF parser handle:
5215 #include <yaz/pquery.h>
5217 YAZ_PQF_Parser yaz_pqf_create(void);
5219 void yaz_pqf_destroy(YAZ_PQF_Parser p);
5221 Z_RPNQuery *yaz_pqf_parse(YAZ_PQF_Parser p, ODR o, const char *qbuf);
5223 Z_AttributesPlusTerm *yaz_pqf_scan(YAZ_PQF_Parser p, ODR o,
5224 Odr_oid **attributeSetId, const char *qbuf);
5226 int yaz_pqf_error(YAZ_PQF_Parser p, const char **msg, size_t *off);
5229 A PQF parser is created and destructed by functions
5230 <function>yaz_pqf_create</function> and
5231 <function>yaz_pqf_destroy</function> respectively.
5232 Function <function>yaz_pqf_parse</function> parses query given
5233 by string <literal>qbuf</literal>. If parsing was successful,
5234 a Z39.50 RPN Query is returned which is created using ODR stream
5235 <literal>o</literal>. If parsing failed, a NULL pointer is
5237 Function <function>yaz_pqf_scan</function> takes a scan query in
5238 <literal>qbuf</literal>. If parsing was successful, the function
5239 returns attributes plus term pointer and modifies
5240 <literal>attributeSetId</literal> to hold attribute set for the
5241 scan request - both allocated using ODR stream <literal>o</literal>.
5242 If parsing failed, yaz_pqf_scan returns a NULL pointer.
5243 Error information for bad queries can be obtained by a call to
5244 <function>yaz_pqf_error</function> which returns an error code and
5245 modifies <literal>*msg</literal> to point to an error description,
5246 and modifies <literal>*off</literal> to the offset within last
5247 query were parsing failed.
5250 The second set of functions are declared as follows:
5253 #include <yaz/pquery.h>
5255 Z_RPNQuery *p_query_rpn(ODR o, oid_proto proto, const char *qbuf);
5257 Z_AttributesPlusTerm *p_query_scan(ODR o, oid_proto proto,
5258 Odr_oid **attributeSetP, const char *qbuf);
5260 int p_query_attset(const char *arg);
5263 The function <function>p_query_rpn()</function> takes as arguments an
5264 &odr; stream (see section <link linkend="odr">The ODR Module</link>)
5265 to provide a memory source (the structure created is released on
5266 the next call to <function>odr_reset()</function> on the stream), a
5267 protocol identifier (one of the constants <token>PROTO_Z3950</token> and
5268 <token>PROTO_SR</token>), an attribute set reference, and
5269 finally a null-terminated string holding the query string.
5272 If the parse went well, <function>p_query_rpn()</function> returns a
5273 pointer to a <literal>Z_RPNQuery</literal> structure which can be
5274 placed directly into a <literal>Z_SearchRequest</literal>.
5275 If parsing failed, due to syntax error, a NULL pointer is returned.
5278 The <literal>p_query_attset</literal> specifies which attribute set
5279 to use if the query doesn't specify one by the
5280 <literal>@attrset</literal> operator.
5281 The <literal>p_query_attset</literal> returns 0 if the argument is a
5282 valid attribute set specifier; otherwise the function returns -1.
5285 The grammar of the PQF is as follows:
5288 query ::= top-set query-struct.
5290 top-set ::= [ '@attrset' string ]
5292 query-struct ::= attr-spec | simple | complex | '@term' term-type query
5294 attr-spec ::= '@attr' [ string ] string query-struct
5296 complex ::= operator query-struct query-struct.
5298 operator ::= '@and' | '@or' | '@not' | '@prox' proximity.
5300 simple ::= result-set | term.
5302 result-set ::= '@set' string.
5306 proximity ::= exclusion distance ordered relation which-code unit-code.
5308 exclusion ::= '1' | '0' | 'void'.
5310 distance ::= integer.
5312 ordered ::= '1' | '0'.
5314 relation ::= integer.
5316 which-code ::= 'known' | 'private' | integer.
5318 unit-code ::= integer.
5320 term-type ::= 'general' | 'numeric' | 'string' | 'oid' | 'datetime' | 'null'.
5323 You will note that the syntax above is a fairly faithful
5324 representation of RPN, except for the Attribute, which has been
5325 moved a step away from the term, allowing you to associate one or more
5326 attributes with an entire query structure. The parser will
5327 automatically apply the given attributes to each term as required.
5330 The @attr operator is followed by an attribute specification
5331 (<literal>attr-spec</literal> above). The specification consists
5332 of an optional attribute set, an attribute type-value pair and
5333 a sub-query. The attribute type-value pair is packed in one string:
5334 an attribute type, an equals sign, and an attribute value, like this:
5335 <literal>@attr 1=1003</literal>.
5336 The type is always an integer but the value may be either an
5337 integer or a string (if it doesn't start with a digit character).
5338 A string attribute-value is encoded as a Type-1 ``complex''
5339 attribute with the list of values containing the single string
5340 specified, and including no semantic indicators.
5343 Version 3 of the Z39.50 specification defines various encoding of terms.
5344 Use <literal>@term </literal> <replaceable>type</replaceable>
5345 <replaceable>string</replaceable>,
5346 where type is one of: <literal>general</literal>,
5347 <literal>numeric</literal> or <literal>string</literal>
5348 (for InternationalString).
5349 If no term type has been given, the <literal>general</literal> form
5350 is used. This is the only encoding allowed in both versions 2 and 3
5351 of the Z39.50 standard.
5353 <sect3 id="PQF-prox">
5354 <title>Using Proximity Operators with PQF</title>
5357 This is an advanced topic, describing how to construct
5358 queries that make very specific requirements on the
5359 relative location of their operands.
5360 You may wish to skip this section and go straight to
5361 <link linkend="pqf-examples">the example PQF queries</link>.
5366 Most Z39.50 servers do not support proximity searching, or
5367 support only a small subset of the full functionality that
5368 can be expressed using the PQF proximity operator. Be
5369 aware that the ability to <emphasis>express</emphasis> a
5370 query in PQF is no guarantee that any given server will
5371 be able to <emphasis>execute</emphasis> it.
5377 The proximity operator <literal>@prox</literal> is a special
5378 and more restrictive version of the conjunction operator
5379 <literal>@and</literal>. Its semantics are described in
5380 section 3.7.2 (Proximity) of Z39.50 the standard itself, which
5381 can be read on-line at
5382 <ulink url="&url.z39.50.proximity;"/>
5385 In PQF, the proximity operation is represented by a sequence
5388 @prox <replaceable>exclusion</replaceable> <replaceable>distance</replaceable> <replaceable>ordered</replaceable> <replaceable>relation</replaceable> <replaceable>which-code</replaceable> <replaceable>unit-code</replaceable>
5390 in which the meanings of the parameters are as described in in
5391 the standard, and they can take the following values:
5394 <formalpara><title>exclusion</title>
5396 0 = false (i.e. the proximity condition specified by the
5397 remaining parameters must be satisfied) or
5398 1 = true (the proximity condition specified by the
5399 remaining parameters must <emphasis>not</emphasis> be
5405 <formalpara><title>distance</title><para>
5406 An integer specifying the difference between the locations
5407 of the operands: e.g. two adjacent words would have
5408 distance=1 since their locations differ by one unit.
5410 </formalpara></listitem>
5412 <formalpara><title>ordered</title><para>
5413 1 = ordered (the operands must occur in the order the
5414 query specifies them) or
5415 0 = unordered (they may appear in either order).
5420 <formalpara><title>relation</title><para>
5421 Recognised values are
5423 2 (lessThanOrEqual),
5425 4 (greaterThanOrEqual),
5432 <formalpara><title>which-code</title><para>
5433 <literal>known</literal>
5435 <literal>k</literal>
5436 (the unit-code parameter is taken from the well-known list
5437 of alternatives described in below) or
5438 <literal>private</literal>
5440 <literal>p</literal>
5441 (the unit-code paramater has semantics specific to an
5442 out-of-band agreement such as a profile).
5447 <formalpara><title>unit-code</title><para>
5448 If the which-code parameter is <literal>known</literal>
5449 then the recognised values are
5459 10 (elementType) and
5461 If which-code is <literal>private</literal> then the
5462 acceptable values are determined by the profile.
5467 (The numeric values of the relation and well-known unit-code
5468 parameters are taken straight from
5469 <ulink url="&url.z39.50.proximity.asn1;"
5470 >the ASN.1</ulink> of the proximity structure in the standard.)
5473 <sect3 id="pqf-examples">
5474 <title>PQF queries</title>
5475 <example id="example.pqf.simple.terms">
5476 <title>PQF queries using simple terms</title>
5485 <example id="pqf.example.pqf.boolean.operators">
5486 <title>PQF boolean operators</title>
5489 @or "dylan" "zimmerman"
5491 @and @or dylan zimmerman when
5493 @and when @or dylan zimmerman
5497 <example id="example.pqf.result.sets">
5498 <title>PQF references to result sets</title>
5503 @and @set seta @set setb
5507 <example id="example.pqf.attributes">
5508 <title>Attributes for terms</title>
5513 @attr 1=4 @attr 4=1 "self portrait"
5515 @attrset exp1 @attr 1=1 CategoryList
5517 @attr gils 1=2008 Copenhagen
5519 @attr 1=/book/title computer
5523 <example id="example.pqf.proximity">
5524 <title>PQF Proximity queries</title>
5527 @prox 0 3 1 2 k 2 dylan zimmerman
5529 Here the parameters 0, 3, 1, 2, k and 2 represent exclusion,
5530 distance, ordered, relation, which-code and unit-code, in that
5534 <para>exclusion = 0: the proximity condition must hold</para>
5537 <para>distance = 3: the terms must be three units apart</para>
5541 ordered = 1: they must occur in the order they are specified
5546 relation = 2: lessThanOrEqual (to the distance of 3 units)
5551 which-code is ``known'', so the standard unit-codes are used
5555 <para>unit-code = 2: word.</para>
5558 So the whole proximity query means that the words
5559 <literal>dylan</literal> and <literal>zimmerman</literal> must
5560 both occur in the record, in that order, differing in position
5561 by three or fewer words (i.e. with two or fewer words between
5562 them.) The query would find ``Bob Dylan, aka. Robert
5563 Zimmerman'', but not ``Bob Dylan, born as Robert Zimmerman''
5564 since the distance in this case is four.
5567 <example id="example.pqf.search.term.type">
5568 <title>PQF specification of search term type</title>
5571 @term string "a UTF-8 string, maybe?"
5575 <example id="example.pqf.mixed.queries">
5576 <title>PQF mixed queries</title>
5579 @or @and bob dylan @set Result-1
5581 @attr 4=1 @and @attr 1=1 "bob dylan" @attr 1=4 "slow train coming"
5583 @and @attr 2=4 @attr gils 1=2038 -114 @attr 2=2 @attr gils 1=2039 -109
5585 The last of these examples is a spatial search: in
5586 <ulink url="http://www.gils.net/prof_v2.html#sec_7_4"
5587 >the GILS attribute set</ulink>,
5589 2038 indicates West Bounding Coordinate and
5590 2030 indicates East Bounding Coordinate,
5591 so the query is for areas extending from -114 degrees
5592 to no more than -109 degrees.
5597 <sect2 id="CCL"><title>CCL</title>
5599 Not all users enjoy typing in prefix query structures and numerical
5600 attribute values, even in a minimalistic test client. In the library
5601 world, the more intuitive Common Command Language - CCL (ISO 8777)
5602 has enjoyed some popularity - especially before the widespread
5603 availability of graphical interfaces. It is still useful in
5604 applications where you for some reason or other need to provide a
5605 symbolic language for expressing boolean query structures.
5607 <sect3 id="ccl.syntax">
5608 <title>CCL Syntax</title>
5610 The CCL parser obeys the following grammar for the FIND argument.
5611 The syntax is annotated by in the lines prefixed by
5612 <literal>--</literal>.
5615 CCL-Find ::= CCL-Find Op Elements
5618 Op ::= "and" | "or" | "not"
5619 -- The above means that Elements are separated by boolean operators.
5621 Elements ::= '(' CCL-Find ')'
5624 | Qualifiers Relation Terms
5625 | Qualifiers Relation '(' CCL-Find ')'
5626 | Qualifiers '=' string '-' string
5627 -- Elements is either a recursive definition, a result set reference, a
5628 -- list of terms, qualifiers followed by terms, qualifiers followed
5629 -- by a recursive definition or qualifiers in a range (lower - upper).
5631 Set ::= 'set' = string
5632 -- Reference to a result set
5634 Terms ::= Terms Prox Term
5636 -- Proximity of terms.
5638 Term ::= Term string
5640 -- This basically means that a term may include a blank
5642 Qualifiers ::= Qualifiers ',' string
5644 -- Qualifiers is a list of strings separated by comma
5646 Relation ::= '=' | '>=' | '<=' | '<>' | '>' | '<'
5647 -- Relational operators. This really doesn't follow the ISO8777
5651 -- Proximity operator
5654 <example id="example.ccl.queries">
5655 <title>CCL queries</title>
5657 The following queries are all valid:
5668 (dylan and bob) or set=1
5677 Assuming that the qualifiers <literal>ti</literal>,
5678 <literal>au</literal>
5679 and <literal>date</literal> are defined we may use:
5684 au=(bob dylan and slow train coming)
5686 date>1980 and (ti=((self portrait)))
5690 <sect3 id="ccl.qualifiers">
5691 <title>CCL Qualifiers</title>
5693 Qualifiers are used to direct the search to a particular searchable
5694 index, such as title (ti) and author indexes (au). The CCL standard
5695 itself doesn't specify a particular set of qualifiers, but it does
5696 suggest a few short-hand notations. You can customize the CCL parser
5697 to support a particular set of qualifiers to reflect the current target
5698 profile. Traditionally, a qualifier would map to a particular
5699 use-attribute within the BIB-1 attribute set. It is also
5700 possible to set other attributes, such as the structure
5704 A CCL profile is a set of predefined CCL qualifiers that may be
5705 read from a file or set in the CCL API.
5706 The YAZ client reads its CCL qualifiers from a file named
5707 <filename>default.bib</filename>. There are four types of
5708 lines in a CCL profile: qualifier specification,
5709 qualifier alias, comments and directives.
5711 <sect4 id="ccl.qualifier.specification">
5712 <title>Qualifier specification</title>
5714 A qualifier specification is of the form:
5717 <replaceable>qualifier-name</replaceable>
5718 [<replaceable>attributeset</replaceable><literal>,</literal>]<replaceable>type</replaceable><literal>=</literal><replaceable>val</replaceable>
5719 [<replaceable>attributeset</replaceable><literal>,</literal>]<replaceable>type</replaceable><literal>=</literal><replaceable>val</replaceable> ...
5722 where <replaceable>qualifier-name</replaceable> is the name of the
5723 qualifier to be used (eg. <literal>ti</literal>),
5724 <replaceable>type</replaceable> is attribute type in the attribute
5725 set (Bib-1 is used if no attribute set is given) and
5726 <replaceable>val</replaceable> is attribute value.
5727 The <replaceable>type</replaceable> can be specified as an
5728 integer or as it be specified either as a single-letter:
5729 <literal>u</literal> for use,
5730 <literal>r</literal> for relation,<literal>p</literal> for position,
5731 <literal>s</literal> for structure,<literal>t</literal> for truncation
5732 or <literal>c</literal> for completeness.
5733 The attributes for the special qualifier name <literal>term</literal>
5734 are used when no CCL qualifier is given in a query.
5735 <table id="ccl.common.bib1.attributes">
5736 <title>Common Bib-1 attributes</title>
5738 <colspec colwidth="2*" colname="type"></colspec>
5739 <colspec colwidth="9*" colname="description"></colspec>
5743 <entry>Description</entry>
5748 <entry><literal>u=</literal><replaceable>value</replaceable></entry>
5750 Use attribute (1). Common use attributes are
5751 1 Personal-name, 4 Title, 7 ISBN, 8 ISSN, 30 Date,
5752 62 Subject, 1003 Author), 1016 Any. Specify value
5757 <entry><literal>r=</literal><replaceable>value</replaceable></entry>
5759 Relation attribute (2). Common values are
5760 1 <, 2 <=, 3 =, 4 >=, 5 >, 6 <>,
5761 100 phonetic, 101 stem, 102 relevance, 103 always matches.
5765 <entry><literal>p=</literal><replaceable>value</replaceable></entry>
5767 Position attribute (3). Values: 1 first in field, 2
5768 first in any subfield, 3 any position in field.
5772 <entry><literal>s=</literal><replaceable>value</replaceable></entry>
5774 Structure attribute (4). Values: 1 phrase, 2 word,
5775 3 key, 4 year, 5 date, 6 word list, 100 date (un),
5776 101 name (norm), 102 name (un), 103 structure, 104 urx,
5777 105 free-form-text, 106 document-text, 107 local-number,
5778 108 string, 109 numeric string.
5782 <entry><literal>t=</literal><replaceable>value</replaceable></entry>
5784 Truncation attribute (5). Values: 1 right, 2 left,
5785 3 left& right, 100 none, 101 process #, 102 regular-1,
5786 103 regular-2, 104 CCL.
5790 <entry><literal>c=</literal><replaceable>value</replaceable></entry>
5792 Completeness attribute (6). Values: 1 incomplete subfield,
5793 2 complete subfield, 3 complete field.
5801 Refer to <xref linkend="bib1"/> or the complete
5802 <ulink url="&url.z39.50.attset.bib1;">list of Bib-1 attributes</ulink>
5805 It is also possible to specify non-numeric attribute values,
5806 which are used in combination with certain types.
5807 The special combinations are:
5808 <table id="ccl.special.attribute.combos">
5809 <title>Special attribute combos</title>
5811 <colspec colwidth="2*" colname="name"></colspec>
5812 <colspec colwidth="9*" colname="description"></colspec>
5816 <entry>Description</entry>
5821 <entry><literal>s=pw</literal></entry>
5823 The structure is set to either word or phrase depending
5824 on the number of tokens in a term (phrase-word).
5828 <entry><literal>s=al</literal></entry>
5830 Each token in the term is ANDed. (and-list).
5831 This does not set the structure at all.
5834 <row><entry><literal>s=ol</literal></entry>
5836 Each token in the term is ORed. (or-list).
5837 This does not set the structure at all.
5840 <row><entry><literal>s=ag</literal></entry>
5842 Tokens that appears as phrases (with blank in them) gets
5843 structure phrase attached (4=1). Tokens that appear to be words
5844 gets structure word attached (4=2). Phrases and words are
5845 ANDed. This is a variant of s=al and s=pw, with the main
5846 difference that words are not split (with operator AND)
5847 but instead kept in one RPN token. This facility appeared
5851 <row><entry><literal>s=sl</literal></entry>
5853 Tokens are split into sub-phrases of all combinations - in order.
5854 This facility appeared in YAZ 5.14.0.
5857 <row><entry><literal>r=o</literal></entry>
5859 Allows ranges and the operators greather-than, less-than, ...
5861 This sets Bib-1 relation attribute accordingly (relation
5862 ordered). A query construct is only treated as a range if
5863 dash is used and that is surrounded by white-space. So
5864 <literal>-1980</literal> is treated as term
5865 <literal>"-1980"</literal> not <literal><= 1980</literal>.
5866 If <literal>- 1980</literal> is used, however, that is
5870 <row><entry><literal>r=r</literal></entry>
5872 Similar to <literal>r=o</literal> but assumes that terms
5873 are non-negative (not prefixed with <literal>-</literal>).
5874 Thus, a dash will always be treated as a range.
5875 The construct <literal>1980-1990</literal> is
5876 treated as a range with <literal>r=r</literal> but as a
5877 single term <literal>"1980-1990"</literal> with
5878 <literal>r=o</literal>. The special attribute
5879 <literal>r=r</literal> is available in YAZ 2.0.24 or later.
5882 <row><entry><literal>r=omiteq</literal></entry>
5884 This will omit relation=equals (@attr 2=3) when r=o / r=r
5885 is used. This is useful for servers that somehow breaks
5886 when an explicit relation=equals is used. Omitting the
5887 relation is usually safe because "equals" is the default
5888 behavior. This tweak was added in YAZ version 5.1.2.
5891 <row><entry><literal>t=l</literal></entry>
5893 Allows term to be left-truncated.
5894 If term is of the form <literal>?x</literal>, the resulting
5895 Type-1 term is <literal>x</literal> and truncation is left.
5898 <row><entry><literal>t=r</literal></entry>
5900 Allows term to be right-truncated.
5901 If term is of the form <literal>x?</literal>, the resulting
5902 Type-1 term is <literal>x</literal> and truncation is right.
5905 <row><entry><literal>t=n</literal></entry>
5907 If term is does not include <literal>?</literal>, the
5908 truncation attribute is set to none (100).
5911 <row><entry><literal>t=b</literal></entry>
5913 Allows term to be both left&right truncated.
5914 If term is of the form <literal>?x?</literal>, the
5915 resulting term is <literal>x</literal> and trunctation is
5916 set to both left&right.
5919 <row><entry><literal>t=x</literal></entry>
5921 Allows masking anywhere in a term, thus fully supporting
5922 # (mask one character) and ? (zero or more of any).
5923 If masking is used, trunction is set to 102 (regexp-1 in term)
5924 and the term is converted accordingly to a regular expression.
5927 <row><entry><literal>t=z</literal></entry>
5929 Allows masking anywhere in a term, thus fully supporting
5930 # (mask one character) and ? (zero or more of any).
5931 If masking is used, trunction is set to 104 (Z39.58 in term)
5932 and the term is converted accordingly to Z39.58 masking term -
5933 actually the same truncation as CCL itself.
5940 <example id="example.ccl.profile">
5941 <title>CCL profile</title>
5943 Consider the following definition:
5953 <literal>ti</literal> and <literal>au</literal> both set
5954 structure attribute to phrase (s=1).
5955 <literal>ti</literal>
5956 sets the use-attribute to 4. <literal>au</literal> sets the
5958 When no qualifiers are used in the query the structure-attribute is
5959 set to free-form-text (105) (rule for <literal>term</literal>).
5960 The <literal>date</literal> sets the relation attribute to
5961 the relation used in the CCL query and sets the use attribute
5965 You can combine attributes. To Search for "ranked title" you
5968 ti,ranked=knuth computer
5970 which will set relation=ranked, use=title, structure=phrase.
5977 is a valid query. But
5985 <sect4 id="ccl.qualifier.alias">
5986 <title>Qualifier alias</title>
5988 A qualifier alias is of the form:
5991 <replaceable>q</replaceable>
5992 <replaceable>q1</replaceable> <replaceable>q2</replaceable> ..
5995 which declares <replaceable>q</replaceable> to
5996 be an alias for <replaceable>q1</replaceable>,
5997 <replaceable>q2</replaceable>... such that the CCL
5998 query <replaceable>q=x</replaceable> is equivalent to
5999 <replaceable>q1=x or q2=x or ...</replaceable>.
6002 <sect4 id="ccl.comments">
6003 <title>Comments</title>
6005 Lines with white space or lines that begin with
6006 character <literal>#</literal> are treated as comments.
6009 <sect4 id="ccl.directives">
6010 <title>Directives</title>
6012 Directive specifications takes the form
6014 <para><literal>@</literal><replaceable>directive</replaceable> <replaceable>value</replaceable>
6016 <table id="ccl.directives.table">
6017 <title>CCL directives</title>
6019 <colspec colwidth="2*" colname="name"></colspec>
6020 <colspec colwidth="8*" colname="description"></colspec>
6021 <colspec colwidth="1*" colname="default"></colspec>
6025 <entry>Description</entry>
6026 <entry>Default</entry>
6031 <entry>truncation</entry>
6032 <entry>Truncation character</entry>
6033 <entry><literal>?</literal></entry>
6037 <entry>Masking character. Requires YAZ 4.2.58 or later</entry>
6038 <entry><literal>#</literal></entry>
6041 <entry>field</entry>
6042 <entry>Specifies how multiple fields are to be
6043 combined. There are two modes: <literal>or</literal>:
6044 multiple qualifier fields are ORed,
6045 <literal>merge</literal>: attributes for the qualifier
6046 fields are merged and assigned to one term.
6048 <entry><literal>merge</literal></entry>
6052 <entry>Specifies if CCL operators and qualifiers should be
6053 compared with case sensitivity or not. Specify 1 for
6054 case sensitive; 0 for case insensitive.</entry>
6055 <entry><literal>1</literal></entry>
6059 <entry>Specifies token for CCL operator AND.</entry>
6060 <entry><literal>and</literal></entry>
6064 <entry>Specifies token for CCL operator OR.</entry>
6065 <entry><literal>or</literal></entry>
6069 <entry>Specifies token for CCL operator NOT.</entry>
6070 <entry><literal>not</literal></entry>
6074 <entry>Specifies token for CCL operator SET.</entry>
6075 <entry><literal>set</literal></entry>
6082 <sect3 id="ccl.api">
6083 <title>CCL API</title>
6085 All public definitions can be found in the header file
6086 <filename>ccl.h</filename>. A profile identifier is of type
6087 <literal>CCL_bibset</literal>. A profile must be created with the call
6088 to the function <function>ccl_qual_mk</function> which returns a profile
6089 handle of type <literal>CCL_bibset</literal>.
6092 To read a file containing qualifier definitions the function
6093 <function>ccl_qual_file</function> may be convenient. This function
6094 takes an already opened <literal>FILE</literal> handle pointer as
6095 argument along with a <literal>CCL_bibset</literal> handle.
6098 To parse a simple string with a FIND query use the function
6101 struct ccl_rpn_node *ccl_find_str(CCL_bibset bibset, const char *str,
6102 int *error, int *pos);
6105 which takes the CCL profile (<literal>bibset</literal>) and query
6106 (<literal>str</literal>) as input. Upon successful completion the RPN
6107 tree is returned. If an error occur, such as a syntax error, the integer
6108 pointed to by <literal>error</literal> holds the error code and
6109 <literal>pos</literal> holds the offset inside query string in which
6113 An English representation of the error may be obtained by calling
6114 the <literal>ccl_err_msg</literal> function. The error codes are
6115 listed in <filename>ccl.h</filename>.
6118 To convert the CCL RPN tree (type
6119 <literal>struct ccl_rpn_node *</literal>)
6120 to the Z_RPNQuery of YAZ the function <function>ccl_rpn_query</function>
6121 must be used. This function which is part of YAZ is implemented in
6122 <filename>yaz-ccl.c</filename>.
6123 After calling this function the CCL RPN tree is probably no longer
6124 needed. The <literal>ccl_rpn_delete</literal> destroys the CCL RPN tree.
6127 A CCL profile may be destroyed by calling the
6128 <function>ccl_qual_rm</function> function.
6131 The token names for the CCL operators may be changed by setting the
6132 globals (all type <literal>char *</literal>)
6133 <literal>ccl_token_and</literal>, <literal>ccl_token_or</literal>,
6134 <literal>ccl_token_not</literal> and <literal>ccl_token_set</literal>.
6135 An operator may have aliases, i.e. there may be more than one name for
6136 the operator. To do this, separate each alias with a space character.
6143 <ulink url="&url.cql;">CQL</ulink>
6144 - Common Query Language - was defined for the
6145 <ulink url="&url.sru;">SRU</ulink> protocol.
6146 In many ways CQL has a similar syntax to CCL.
6147 The objective of CQL is different. Where CCL aims to be
6148 an end-user language, CQL is <emphasis>the</emphasis> protocol
6149 query language for SRU.
6153 If you are new to CQL, read the
6154 <ulink url="&url.cql.intro;">Gentle Introduction</ulink>.
6158 The CQL parser in &yaz; provides the following:
6162 It parses and validates a CQL query.
6167 It generates a C structure that allows you to convert
6168 a CQL query to some other query language, such as SQL.
6173 The parser converts a valid CQL query to PQF, thus providing a
6174 way to use CQL for both SRU servers and Z39.50 targets at the
6180 The parser converts CQL to XCQL.
6181 XCQL is an XML representation of CQL.
6182 XCQL is part of the SRU specification. However, since SRU
6183 supports CQL only, we don't expect XCQL to be widely used.
6184 Furthermore, CQL has the advantage over XCQL that it is
6190 <sect3 id="cql.parsing">
6191 <title>CQL parsing</title>
6193 A CQL parser is represented by the <literal>CQL_parser</literal>
6194 handle. Its contents should be considered &yaz; internal (private).
6196 #include <yaz/cql.h>
6198 typedef struct cql_parser *CQL_parser;
6200 CQL_parser cql_parser_create(void);
6201 void cql_parser_destroy(CQL_parser cp);
6203 A parser is created by <function>cql_parser_create</function> and
6204 is destroyed by <function>cql_parser_destroy</function>.
6207 To parse a CQL query string, the following function
6210 int cql_parser_string(CQL_parser cp, const char *str);
6212 A CQL query is parsed by the <function>cql_parser_string</function>
6213 which takes a query <parameter>str</parameter>.
6214 If the query was valid (no syntax errors), then zero is returned;
6215 otherwise -1 is returned to indicate a syntax error.
6219 int cql_parser_stream(CQL_parser cp,
6220 int (*getbyte)(void *client_data),
6221 void (*ungetbyte)(int b, void *client_data),
6224 int cql_parser_stdio(CQL_parser cp, FILE *f);
6226 The functions <function>cql_parser_stream</function> and
6227 <function>cql_parser_stdio</function> parses a CQL query
6228 - just like <function>cql_parser_string</function>.
6229 The only difference is that the CQL query can be
6230 fed to the parser in different ways.
6231 The <function>cql_parser_stream</function> uses a generic
6232 byte stream as input. The <function>cql_parser_stdio</function>
6233 uses a <literal>FILE</literal> handle which is opened for reading.
6236 <sect3 id="cql.tree">
6237 <title>CQL tree</title>
6239 The the query string is valid, the CQL parser
6240 generates a tree representing the structure of the
6245 struct cql_node *cql_parser_result(CQL_parser cp);
6247 <function>cql_parser_result</function> returns the
6248 a pointer to the root node of the resulting tree.
6251 Each node in a CQL tree is represented by a
6252 <literal>struct cql_node</literal>.
6253 It is defined as follows:
6255 #define CQL_NODE_ST 1
6256 #define CQL_NODE_BOOL 2
6257 #define CQL_NODE_SORT 3
6267 struct cql_node *modifiers;
6271 struct cql_node *left;
6272 struct cql_node *right;
6273 struct cql_node *modifiers;
6277 struct cql_node *next;
6278 struct cql_node *modifiers;
6279 struct cql_node *search;
6284 There are three node types: search term (ST), boolean (BOOL)
6286 A modifier is treated as a search term too.
6289 The search term node has five members:
6293 <literal>index</literal>: index for search term.
6294 If an index is unspecified for a search term,
6295 <literal>index</literal> will be NULL.
6300 <literal>index_uri</literal>: index URi for search term
6301 or NULL if none could be resolved for the index.
6306 <literal>term</literal>: the search term itself.
6311 <literal>relation</literal>: relation for search term.
6316 <literal>relation_uri</literal>: relation URI for search term.
6321 <literal>modifiers</literal>: relation modifiers for search
6322 term. The <literal>modifiers</literal> list itself of cql_nodes
6323 each of type <literal>ST</literal>.
6329 The boolean node represents <literal>and</literal>,
6330 <literal>or</literal>, <literal>not</literal> +
6335 <literal>left</literal> and <literal>right</literal>: left
6336 - and right operand respectively.
6341 <literal>modifiers</literal>: proximity arguments.
6347 The sort node represents both the SORTBY clause.
6350 <sect3 id="cql.to.pqf">
6351 <title>CQL to PQF conversion</title>
6353 Conversion to PQF (and Z39.50 RPN) is tricky by the fact
6354 that the resulting RPN depends on the Z39.50 target
6355 capabilities (combinations of supported attributes).
6356 In addition, the CQL and SRU operates on index prefixes
6357 (URI or strings), whereas the RPN uses Object Identifiers
6361 The CQL library of &yaz; defines a <literal>cql_transform_t</literal>
6362 type. It represents a particular mapping between CQL and RPN.
6363 This handle is created and destroyed by the functions:
6365 cql_transform_t cql_transform_open_FILE (FILE *f);
6366 cql_transform_t cql_transform_open_fname(const char *fname);
6367 void cql_transform_close(cql_transform_t ct);
6369 The first two functions create a tranformation handle from
6370 either an already open FILE or from a filename respectively.
6373 The handle is destroyed by <function>cql_transform_close</function>
6374 in which case no further reference of the handle is allowed.
6377 When a <literal>cql_transform_t</literal> handle has been created
6378 you can convert to RPN.
6380 int cql_transform_buf(cql_transform_t ct,
6381 struct cql_node *cn, char *out, int max);
6383 This function converts the CQL tree <literal>cn</literal>
6384 using handle <literal>ct</literal>.
6385 For the resulting PQF, you supply a buffer <literal>out</literal>
6386 which must be able to hold at at least <literal>max</literal>
6390 If conversion failed, <function>cql_transform_buf</function>
6391 returns a non-zero SRU error code; otherwise zero is returned
6392 (conversion successful). The meanings of the numeric error
6393 codes are listed in the SRU specification somewhere (no
6394 direct link anymore).
6397 If conversion fails, more information can be obtained by calling
6399 int cql_transform_error(cql_transform_t ct, char **addinfop);
6401 This function returns the most recently returned numeric
6402 error-code and sets the string-pointer at
6403 <literal>*addinfop</literal> to point to a string containing
6404 additional information about the error that occurred: for
6405 example, if the error code is 15 (``Illegal or unsupported context
6406 set''), the additional information is the name of the requested
6407 context set that was not recognised.
6410 The SRU error-codes may be translated into brief human-readable
6411 error messages using
6413 const char *cql_strerror(int code);
6417 If you wish to be able to produce a PQF result in a different
6418 way, there are two alternatives.
6420 void cql_transform_pr(cql_transform_t ct,
6421 struct cql_node *cn,
6422 void (*pr)(const char *buf, void *client_data),
6425 int cql_transform_FILE(cql_transform_t ct,
6426 struct cql_node *cn, FILE *f);
6428 The former function produces output to a user-defined
6429 output stream. The latter writes the result to an already
6430 open <literal>FILE</literal>.
6433 <sect3 id="cql.to.rpn">
6434 <title>Specification of CQL to RPN mappings</title>
6436 The file supplied to functions
6437 <function>cql_transform_open_FILE</function>,
6438 <function>cql_transform_open_fname</function> follows
6439 a structure found in many Unix utilities.
6440 It consists of mapping specifications - one per line.
6441 Lines starting with <literal>#</literal> are ignored (comments).
6444 Each line is of the form
6446 <replaceable>CQL pattern</replaceable><literal> = </literal> <replaceable> RPN equivalent</replaceable>
6450 An RPN pattern is a simple attribute list. Each attribute pair
6453 [<replaceable>set</replaceable>] <replaceable>type</replaceable><literal>=</literal><replaceable>value</replaceable>
6455 The attribute <replaceable>set</replaceable> is optional.
6456 The <replaceable>type</replaceable> is the attribute type,
6457 <replaceable>value</replaceable> the attribute value.
6460 The character <literal>*</literal> (asterisk) has special meaning
6461 when used in the RPN pattern.
6462 Each occurrence of <literal>*</literal> is substituted with the
6463 CQL matching name (index, relation, qualifier etc).
6464 This facility can be used to copy a CQL name verbatim to the RPN result.
6467 The following CQL patterns are recognized:
6471 <literal>index.</literal><replaceable>set</replaceable><literal>.</literal><replaceable>name</replaceable>
6475 This pattern is invoked when a CQL index, such as
6476 dc.title is converted. <replaceable>set</replaceable>
6477 and <replaceable>name</replaceable> are the context set and index
6479 Typically, the RPN specifies an equivalent use attribute.
6482 For terms not bound by an index the pattern
6483 <literal>index.cql.serverChoice</literal> is used.
6484 Here, the prefix <literal>cql</literal> is defined as
6485 <literal>http://www.loc.gov/zing/cql/cql-indexes/v1.0/</literal>.
6486 If this pattern is not defined, the mapping will fail.
6490 <literal>index.</literal><replaceable>set</replaceable><literal>.*</literal>
6491 is used when no other index pattern is matched.
6497 <literal>qualifier.</literal><replaceable>set</replaceable><literal>.</literal><replaceable>name</replaceable>
6502 For backwards compatibility, this is recognised as a synonym of
6503 <literal>index.</literal><replaceable>set</replaceable><literal>.</literal><replaceable>name</replaceable>
6509 <literal>relation.</literal><replaceable>relation</replaceable>
6513 This pattern specifies how a CQL relation is mapped to RPN.
6514 <replaceable>pattern</replaceable> is name of relation
6515 operator. Since <literal>=</literal> is used as
6516 separator between CQL pattern and RPN, CQL relations
6517 including <literal>=</literal> cannot be
6518 used directly. To avoid a conflict, the names
6519 <literal>ge</literal>,
6520 <literal>eq</literal>,
6521 <literal>le</literal>,
6522 must be used for CQL operators, greater-than-or-equal,
6523 equal, less-than-or-equal respectively.
6524 The RPN pattern is supposed to include a relation attribute.
6527 For terms not bound by a relation, the pattern
6528 <literal>relation.scr</literal> is used. If the pattern
6529 is not defined, the mapping will fail.
6532 The special pattern, <literal>relation.*</literal> is used
6533 when no other relation pattern is matched.
6539 <literal>relationModifier.</literal><replaceable>mod</replaceable>
6543 This pattern specifies how a CQL relation modifier is mapped to RPN.
6544 The RPN pattern is usually a relation attribute.
6550 <literal>structure.</literal><replaceable>type</replaceable>
6554 This pattern specifies how a CQL structure is mapped to RPN.
6555 Note that this CQL pattern is somewhat to similar to
6556 CQL pattern <literal>relation</literal>.
6557 The <replaceable>type</replaceable> is a CQL relation.
6560 The pattern, <literal>structure.*</literal> is used
6561 when no other structure pattern is matched.
6562 Usually, the RPN equivalent specifies a structure attribute.
6568 <literal>position.</literal><replaceable>type</replaceable>
6572 This pattern specifies how the anchor (position) of
6573 CQL is mapped to RPN.
6574 The <replaceable>type</replaceable> is one
6575 of <literal>first</literal>, <literal>any</literal>,
6576 <literal>last</literal>, <literal>firstAndLast</literal>.
6579 The pattern, <literal>position.*</literal> is used
6580 when no other position pattern is matched.
6586 <literal>set.</literal><replaceable>prefix</replaceable>
6590 This specification defines a CQL context set for a given prefix.
6591 The value on the right hand side is the URI for the set -
6592 <emphasis>not</emphasis> RPN. All prefixes used in
6593 index patterns must be defined this way.
6599 <literal>set</literal>
6603 This specification defines a default CQL context set for index names.
6604 The value on the right hand side is the URI for the set.
6610 <example id="example.cql.to.rpn.mapping">
6611 <title>CQL to RPN mapping file</title>
6613 This simple file defines two context sets, three indexes and three
6614 relations, a position pattern and a default structure.
6616 <programlisting><![CDATA[
6617 set.cql = http://www.loc.gov/zing/cql/context-sets/cql/v1.1/
6618 set.dc = http://www.loc.gov/zing/cql/dc-indexes/v1.0/
6620 index.cql.serverChoice = 1=1016
6621 index.dc.title = 1=4
6622 index.dc.subject = 1=21
6628 position.any = 3=3 6=1
6634 With the mappings above, the CQL query
6638 is converted to the PQF:
6640 @attr 1=1016 @attr 2=3 @attr 4=1 @attr 3=3 @attr 6=1 "computer"
6642 by rules <literal>index.cql.serverChoice</literal>,
6643 <literal>relation.scr</literal>, <literal>structure.*</literal>,
6644 <literal>position.any</literal>.
6651 is rejected, since <literal>position.right</literal> is
6657 >my = "http://www.loc.gov/zing/cql/dc-indexes/v1.0/" my.title = x
6661 @attr 1=4 @attr 2=3 @attr 4=1 @attr 3=3 @attr 6=1 "x"
6665 <example id="example.cql.to.rpn.string">
6666 <title>CQL to RPN string attributes</title>
6668 In this example we allow any index to be passed to RPN as
6671 <programlisting><![CDATA[
6672 # Identifiers for prefixes used in this file. (index.*)
6673 set.cql = info:srw/cql-context-set/1/cql-v1.1
6674 set.rpn = http://bogus/rpn
6675 set = http://bogus/rpn
6677 # The default index when none is specified by the query
6678 index.cql.serverChoice = 1=any
6687 The <literal>http://bogus/rpn</literal> context set is also the default
6688 so we can make queries such as
6692 which is converted to
6694 @attr 2=3 @attr 4=1 @attr 3=3 @attr 1=title "a"
6698 <example id="example.cql.to.rpn.bathprofile">
6699 <title>CQL to RPN using Bath Profile</title>
6701 The file <filename>etc/pqf.properties</filename> has mappings from
6702 the Bath Profile and Dublin Core to RPN.
6703 If YAZ is installed as a package it's usually located
6704 in <filename>/usr/share/yaz/etc</filename> and part of the
6705 development package, such as <literal>libyaz-dev</literal>.
6709 <sect3 id="cql.xcql">
6710 <title>CQL to XCQL conversion</title>
6712 Conversion from CQL to XCQL is trivial and does not
6713 require a mapping to be defined.
6714 There three functions to choose from depending on the
6715 way you wish to store the resulting output (XML buffer
6718 int cql_to_xml_buf(struct cql_node *cn, char *out, int max);
6719 void cql_to_xml(struct cql_node *cn,
6720 void (*pr)(const char *buf, void *client_data),
6722 void cql_to_xml_stdio(struct cql_node *cn, FILE *f);
6724 Function <function>cql_to_xml_buf</function> converts
6725 to XCQL and stores result in a user supplied buffer of a given
6729 <function>cql_to_xml</function> writes the result in
6730 a user defined output stream.
6731 <function>cql_to_xml_stdio</function> writes to a
6735 <sect3 id="rpn.to.cql">
6736 <title>PQF to CQL conversion</title>
6738 Conversion from PQF to CQL is offered by the two functions shown
6739 below. The former uses a generic stream for result. The latter
6740 puts result in a WRBUF (string container).
6742 #include <yaz/rpn2cql.h>
6744 int cql_transform_rpn2cql_stream(cql_transform_t ct,
6745 void (*pr)(const char *buf, void *client_data),
6749 int cql_transform_rpn2cql_wrbuf(cql_transform_t ct,
6753 The configuration is the same as used in CQL to PQF conversions.
6758 <sect1 id="tools.oid">
6759 <title>Object Identifiers</title>
6761 The basic YAZ representation of an OID is an array of integers,
6762 terminated with the value -1. This integer is of type
6763 <literal>Odr_oid</literal>.
6766 Fundamental OID operations and the type <literal>Odr_oid</literal>
6767 are defined in <filename>yaz/oid_util.h</filename>.
6770 An OID can either be declared as a automatic variable or it can
6771 allocated using the memory utilities or ODR/NMEM. It's
6772 guaranteed that an OID can fit in <literal>OID_SIZE</literal> integers.
6774 <example id="tools.oid.bib1.1"><title>Create OID on stack</title>
6776 We can create an OID for the Bib-1 attribute set with:
6778 Odr_oid bib1[OID_SIZE];
6790 And OID may also be filled from a string-based representation using
6791 dots (.). This is achieved by function
6793 int oid_dotstring_to_oid(const char *name, Odr_oid *oid);
6795 This functions returns 0 if name could be converted; -1 otherwise.
6797 <example id="tools.oid.bib1.2"><title>Using oid_oiddotstring_to_oid</title>
6799 We can fill the Bib-1 attribute set OID easier with:
6801 Odr_oid bib1[OID_SIZE];
6802 oid_oiddotstring_to_oid("1.2.840.10003.3.1", bib1);
6807 We can also allocate an OID dynamically on a ODR stream with:
6809 Odr_oid *odr_getoidbystr(ODR o, const char *str);
6811 This creates an OID from string-based representation using dots.
6812 This function take an &odr; stream as parameter. This stream is used to
6813 allocate memory for the data elements, which is released on a
6814 subsequent call to <function>odr_reset()</function> on that stream.
6816 <example id="tools.oid.bib1.3">
6817 <title>Using odr_getoidbystr</title>
6819 We can create a OID for the Bib-1 attribute set with:
6821 Odr_oid *bib1 = odr_getoidbystr(odr, "1.2.840.10003.3.1");
6828 char *oid_oid_to_dotstring(const Odr_oid *oid, char *oidbuf)
6830 does the reverse of <function>oid_oiddotstring_to_oid</function>. It
6831 converts an OID to the string-based representation using dots.
6832 The supplied char buffer <literal>oidbuf</literal> holds the resulting
6833 string and must be at least <literal>OID_STR_MAX</literal> in size.
6836 OIDs can be copied with <function>oid_oidcpy</function> which takes
6837 two OID lists as arguments. Alternativly, an OID copy can be allocated
6838 on a ODR stream with:
6840 Odr_oid *odr_oiddup(ODR odr, const Odr_oid *o);
6844 OIDs can be compared with <function>oid_oidcmp</function> which returns
6845 zero if the two OIDs provided are identical; non-zero otherwise.
6847 <sect2 id="tools.oid.database">
6848 <title>OID database</title>
6850 From YAZ version 3 and later, the oident system has been replaced
6851 by an OID database. OID database is a misnomer .. the old odient
6852 system was also a database.
6855 The OID database is really just a map between named Object Identifiers
6856 (string) and their OID raw equivalents. Most operations either
6857 convert from string to OID or other way around.
6860 Unfortunately, whenever we supply a string we must also specify the
6861 <emphasis>OID class</emphasis>. The class is necessary because some
6862 strings correspond to multiple OIDs. An example of such a string is
6863 <literal>Bib-1</literal> which may either be an attribute-set
6864 or a diagnostic-set.
6867 Applications using the YAZ database should include
6868 <filename>yaz/oid_db.h</filename>.
6871 A YAZ database handle is of type <literal>yaz_oid_db_t</literal>.
6872 Actually that's a pointer. You need not think deal with that.
6873 YAZ has a built-in database which can be considered "constant" for
6875 We can get hold that by using function <function>yaz_oid_std</function>.
6878 All functions with prefix <function>yaz_string_to_oid</function>
6879 converts from class + string to OID. We have variants of this
6880 operation due to different memory allocation strategies.
6883 All functions with prefix
6884 <function>yaz_oid_to_string</function> converts from OID to string
6887 <example id="tools.oid.bib1.4">
6888 <title>Create OID with YAZ DB</title>
6890 We can create an OID for the Bib-1 attribute set on the ODR stream
6894 yaz_string_to_oid_odr(yaz_oid_std(), CLASS_ATTSET, "Bib-1", odr);
6896 This is more complex than using <function>odr_getoidbystr</function>.
6897 You would only use <function>yaz_string_to_oid_odr</function> when the
6898 string (here Bib-1) is supplied by a user or configuration.
6902 <sect2 id="tools.oid.std">
6903 <title>Standard OIDs</title>
6905 All the object identifers in the standard OID database as returned
6906 by <function>yaz_oid_std</function> can referenced directly in a
6907 program as a constant OID.
6908 Each constant OID is prefixed with <literal>yaz_oid_</literal> -
6909 followed by OID class (lowercase) - then by OID name (normalized and
6913 See <xref linkend="list-oids"/> for list of all object identifiers
6915 These are declared in <filename>yaz/oid_std.h</filename> but are
6916 included by <filename>yaz/oid_db.h</filename> as well.
6918 <example id="tools.oid.bib1.5">
6919 <title>Use a built-in OID</title>
6921 We can allocate our own OID filled with the constant OID for
6924 Odr_oid *bib1 = odr_oiddup(o, yaz_oid_attset_bib1);
6930 <sect1 id="tools.nmem">
6931 <title>Nibble Memory</title>
6933 Sometimes when you need to allocate and construct a large,
6934 interconnected complex of structures, it can be a bit of a pain to
6935 release the associated memory again. For the structures describing the
6936 Z39.50 PDUs and related structures, it is convenient to use the
6937 memory-management system of the &odr; subsystem (see
6938 <xref linkend="odr.use"/>). However, in some circumstances
6939 where you might otherwise benefit from using a simple nibble memory
6940 management system, it may be impractical to use
6941 <function>odr_malloc()</function> and <function>odr_reset()</function>.
6942 For this purpose, the memory manager which also supports the &odr;
6943 streams is made available in the NMEM module. The external interface
6944 to this module is given in the <filename>nmem.h</filename> file.
6947 The following prototypes are given:
6950 NMEM nmem_create(void);
6951 void nmem_destroy(NMEM n);
6952 void *nmem_malloc(NMEM n, size_t size);
6953 void nmem_reset(NMEM n);
6954 size_t nmem_total(NMEM n);
6955 void nmem_init(void);
6956 void nmem_exit(void);
6959 The <function>nmem_create()</function> function returns a pointer to a
6960 memory control handle, which can be released again by
6961 <function>nmem_destroy()</function> when no longer needed.
6962 The function <function>nmem_malloc()</function> allocates a block of
6963 memory of the requested size. A call to <function>nmem_reset()</function>
6964 or <function>nmem_destroy()</function> will release all memory allocated
6965 on the handle since it was created (or since the last call to
6966 <function>nmem_reset()</function>. The function
6967 <function>nmem_total()</function> returns the number of bytes currently
6968 allocated on the handle.
6971 The nibble memory pool is shared amongst threads. POSIX
6972 mutex'es and WIN32 Critical sections are introduced to keep the
6973 module thread safe. Function <function>nmem_init()</function>
6974 initializes the nibble memory library and it is called automatically
6975 the first time the <literal>YAZ.DLL</literal> is loaded. &yaz; uses
6976 function <function>DllMain</function> to achieve this. You should
6977 <emphasis>not</emphasis> call <function>nmem_init</function> or
6978 <function>nmem_exit</function> unless you're absolute sure what
6979 you're doing. Note that in previous &yaz; versions you'd have to call
6980 <function>nmem_init</function> yourself.
6983 <sect1 id="tools.log">
6986 &yaz; has evolved a fairly complex log system which should be useful both
6987 for debugging &yaz; itself, debugging applications that use &yaz;, and for
6988 production use of those applications.
6991 The log functions are declared in header <filename>yaz/log.h</filename>
6992 and implemented in <filename>src/log.c</filename>.
6993 Due to name clash with syslog and some math utilities the logging
6994 interface has been modified as of YAZ 2.0.29. The obsolete interface
6995 is still available if in header file <filename>yaz/log.h</filename>.
6996 The key points of the interface are:
6999 void yaz_log(int level, const char *fmt, ...)
7000 void yaz_log_init(int level, const char *prefix, const char *name);
7001 void yaz_log_init_file(const char *fname);
7002 void yaz_log_init_level(int level);
7003 void yaz_log_init_prefix(const char *prefix);
7004 void yaz_log_time_format(const char *fmt);
7005 void yaz_log_init_max_size(int mx);
7007 int yaz_log_mask_str(const char *str);
7008 int yaz_log_module_level(const char *name);
7011 The reason for the whole log module is the <function>yaz_log</function>
7012 function. It takes a bitmask indicating the log levels, a
7013 <literal>printf</literal>-like format string, and a variable number of
7017 The <literal>log level</literal> is a bit mask, that says on which level(s)
7018 the log entry should be made, and optionally set some behaviour of the
7019 logging. In the most simple cases, it can be one of <literal>YLOG_FATAL,
7020 YLOG_DEBUG, YLOG_WARN, YLOG_LOG</literal>. Those can be combined with bits
7021 that modify the way the log entry is written:<literal>YLOG_ERRNO,
7022 YLOG_NOTIME, YLOG_FLUSH</literal>.
7023 Most of the rest of the bits are deprecated, and should not be used. Use
7024 the dynamic log levels instead.
7027 Applications that use &yaz;, should not use the LOG_LOG for ordinary
7028 messages, but should make use of the dynamic loglevel system. This consists
7029 of two parts, defining the loglevel and checking it.
7032 To define the log levels, the (main) program should pass a string to
7033 <function>yaz_log_mask_str</function> to define which log levels are to be
7034 logged. This string should be a comma-separated list of log level names,
7035 and can contain both hard-coded names and dynamic ones. The log level
7036 calculation starts with <literal>YLOG_DEFAULT_LEVEL</literal> and adds a bit
7037 for each word it meets, unless the word starts with a '-', in which case it
7038 clears the bit. If the string <literal>'none'</literal> is found,
7039 all bits are cleared. Typically this string comes from the command-line,
7040 often identified by <literal>-v</literal>. The
7041 <function>yaz_log_mask_str</function> returns a log level that should be
7042 passed to <function>yaz_log_init_level</function> for it to take effect.
7045 Each module should check what log bits it should be used, by calling
7046 <function>yaz_log_module_level</function> with a suitable name for the
7047 module. The name is cleared from a preceding path and an extension, if any,
7048 so it is quite possible to use <literal>__FILE__</literal> for it. If the
7049 name has been passed to <function>yaz_log_mask_str</function>, the routine
7050 returns a non-zero bitmask, which should then be used in consequent calls
7051 to yaz_log. (It can also be tested, so as to avoid unnecessary calls to
7052 yaz_log, in time-critical places, or when the log entry would take time
7056 Yaz uses the following dynamic log levels:
7057 <literal>server, session, request, requestdetail</literal> for the server
7059 <literal>zoom</literal> for the zoom client api.
7060 <literal>ztest</literal> for the simple test server.
7061 <literal>malloc, nmem, odr, eventl</literal> for internal
7062 debugging of yaz itself.
7063 Of course, any program using yaz is welcome to define as many new
7067 By default the log is written to stderr, but this can be changed by a call
7068 to <function>yaz_log_init_file</function> or
7069 <function>yaz_log_init</function>. If the log is directed to a file, the
7070 file size is checked at every write, and if it exceeds the limit given in
7071 <function>yaz_log_init_max_size</function>, the log is rotated. The
7072 rotation keeps one old version (with a <literal>.1</literal> appended to
7073 the name). The size defaults to 1GB. Setting it to zero will disable the
7077 A typical yaz-log looks like this
7078 13:23:14-23/11 yaz-ztest(1) [session] Starting session from tcp:127.0.0.1 (pid=30968)
7079 13:23:14-23/11 yaz-ztest(1) [request] Init from 'YAZ' (81) (ver 2.0.28) OK
7080 13:23:17-23/11 yaz-ztest(1) [request] Search Z: @attrset Bib-1 foo OK:7 hits
7081 13:23:22-23/11 yaz-ztest(1) [request] Present: [1] 2+2 OK 2 records returned
7082 13:24:13-23/11 yaz-ztest(1) [request] Close OK
7085 The log entries start with a time stamp. This can be omitted by setting the
7086 <literal>YLOG_NOTIME</literal> bit in the loglevel. This way automatic tests
7087 can be hoped to produce identical log files, that are easy to diff. The
7088 format of the time stamp can be set with
7089 <function>yaz_log_time_format</function>, which takes a format string just
7090 like <function>strftime</function>.
7093 Next in a log line comes the prefix, often the name of the program. For
7094 yaz-based servers, it can also contain the session number. Then
7095 comes one or more logbits in square brackets, depending on the logging
7096 level set by <function>yaz_log_init_level</function> and the loglevel
7097 passed to <function>yaz_log_init_level</function>. Finally comes the format
7098 string and additional values passed to <function>yaz_log</function>
7101 The log level <literal>YLOG_LOGLVL</literal>, enabled by the string
7102 <literal>loglevel</literal>, will log all the log-level affecting
7103 operations. This can come in handy if you need to know what other log
7104 levels would be useful. Grep the logfile for <literal>[loglevel]</literal>.
7107 The log system is almost independent of the rest of &yaz;, the only
7108 important dependence is of <filename>nmem</filename>, and that only for
7109 using the semaphore definition there.
7112 The dynamic log levels and log rotation were introduced in &yaz; 2.0.28. At
7113 the same time, the log bit names were changed from
7114 <literal>LOG_something</literal> to <literal>YLOG_something</literal>,
7115 to avoid collision with <filename>syslog.h</filename>.
7121 YAZ provides a fast utility for working with MARC records.
7122 Early versions of the MARC utility only allowed decoding of ISO2709.
7123 Today the utility may both encode - and decode to a varity of formats.
7126 #include <yaz/marcdisp.h>
7128 /* create handler */
7129 yaz_marc_t yaz_marc_create(void);
7131 void yaz_marc_destroy(yaz_marc_t mt);
7133 /* set XML mode YAZ_MARC_LINE, YAZ_MARC_SIMPLEXML, ... */
7134 void yaz_marc_xml(yaz_marc_t mt, int xmlmode);
7135 #define YAZ_MARC_LINE 0
7136 #define YAZ_MARC_SIMPLEXML 1
7137 #define YAZ_MARC_OAIMARC 2
7138 #define YAZ_MARC_MARCXML 3
7139 #define YAZ_MARC_ISO2709 4
7140 #define YAZ_MARC_XCHANGE 5
7141 #define YAZ_MARC_CHECK 6
7142 #define YAZ_MARC_TURBOMARC 7
7143 #define YAZ_MARC_JSON 8
7145 /* supply iconv handle for character set conversion .. */
7146 void yaz_marc_iconv(yaz_marc_t mt, yaz_iconv_t cd);
7148 /* set debug level, 0=none, 1=more, 2=even more, .. */
7149 void yaz_marc_debug(yaz_marc_t mt, int level);
7151 /* decode MARC in buf of size bsize. Returns >0 on success; <=0 on failure.
7152 On success, result in *result with size *rsize. */
7153 int yaz_marc_decode_buf(yaz_marc_t mt, const char *buf, int bsize,
7154 const char **result, size_t *rsize);
7156 /* decode MARC in buf of size bsize. Returns >0 on success; <=0 on failure.
7157 On success, result in WRBUF */
7158 int yaz_marc_decode_wrbuf(yaz_marc_t mt, const char *buf,
7159 int bsize, WRBUF wrbuf);
7164 The synopsis is just a basic subset of all functionality. Refer
7165 to the actual header file <filename>marcdisp.h</filename> for
7170 A MARC conversion handle must be created by using
7171 <function>yaz_marc_create</function> and destroyed
7172 by calling <function>yaz_marc_destroy</function>.
7175 All other function operate on a <literal>yaz_marc_t</literal> handle.
7176 The output is specified by a call to <function>yaz_marc_xml</function>.
7177 The <literal>xmlmode</literal> must be one of
7180 <term>YAZ_MARC_LINE</term>
7183 A simple line-by-line format suitable for display but not
7184 recommend for further (machine) processing.
7189 <term>YAZ_MARC_MARCXML</term>
7192 <ulink url="&url.marcxml;">MARCXML</ulink>.
7197 <term>YAZ_MARC_ISO2709</term>
7200 ISO2709 (sometimes just referred to as "MARC").
7205 <term>YAZ_MARC_XCHANGE</term>
7208 <ulink url="&url.marcxchange;">MarcXchange</ulink>.
7213 <term>YAZ_MARC_CHECK</term>
7216 Pseudo format for validation only. Does not generate
7217 any real output except diagnostics.
7222 <term>YAZ_MARC_TURBOMARC</term>
7225 XML format with same semantics as MARCXML but more compact
7226 and geared towards fast processing with XSLT. Refer to
7227 <xref linkend="tools.turbomarc"/> for more information.
7232 <term>YAZ_MARC_JSON</term>
7235 <ulink url="&url.marc_in_json;">MARC-in_JSON</ulink> format.
7242 The actual conversion functions are
7243 <function>yaz_marc_decode_buf</function> and
7244 <function>yaz_marc_decode_wrbuf</function> which decodes and encodes
7245 a MARC record. The former function operates on simple buffers, the
7246 stores the resulting record in a WRBUF handle (WRBUF is a simple string
7249 <example id="example.marc.display">
7250 <title>Display of MARC record</title>
7252 The following program snippet illustrates how the MARC API may
7253 be used to convert a MARC record to the line-by-line format:
7254 <programlisting><![CDATA[
7255 void print_marc(const char *marc_buf, int marc_buf_size)
7257 char *result; /* for result buf */
7258 size_t result_len; /* for size of result */
7259 yaz_marc_t mt = yaz_marc_create();
7260 yaz_marc_xml(mt, YAZ_MARC_LINE);
7261 yaz_marc_decode_buf(mt, marc_buf, marc_buf_size,
7262 &result, &result_len);
7263 fwrite(result, result_len, 1, stdout);
7264 yaz_marc_destroy(mt); /* note that result is now freed... */
7270 <sect2 id="tools.turbomarc">
7271 <title>TurboMARC</title>
7273 TurboMARC is yet another XML encoding of a MARC record. The format
7274 was designed for fast processing with XSLT.
7278 Pazpar2 uses XSLT to convert an XML encoded MARC record to an internal
7279 representation. This conversion mostly check the tag of a MARC field
7280 to determine the basic rules in the conversion. This check is
7281 costly when that is tag is encoded as an attribute in MARCXML.
7282 By having the tag value as the element instead, makes processing
7283 many times faster (at least for Libxslt).
7286 TurboMARC is encoded as follows:
7290 Record elements is part of namespace
7291 "<literal>http://www.indexdata.com/turbomarc</literal>".
7296 A record is enclosed in element <literal>r</literal>.
7301 A collection of records is enclosed in element
7302 <literal>collection</literal>.
7307 The leader is encoded as element <literal>l</literal> with the
7308 leader content as its (text) value.
7313 A control field is encoded as element <literal>c</literal> concatenated
7314 with the tag value of the control field if the tag value
7315 matches the regular expression <literal>[a-zA-Z0-9]*</literal>.
7316 If the tag value do not match the regular expression
7317 <literal>[a-zA-Z0-9]*</literal> the control field is encoded
7318 as element <literal>c</literal> and attribute <literal>code</literal>
7319 will hold the tag value.
7320 This rule ensure that in the rare cases where a tag value might
7321 result in a non-wellformed XML YAZ encode it as a coded attribute
7325 The control field content is the the text value of this element.
7326 Indicators are encoded as attribute names
7327 <literal>i1</literal>, <literal>i2</literal>, etc.. and
7328 corresponding values for each indicator.
7333 A data field is encoded as element <literal>d</literal> concatenated
7334 with the tag value of the data field or using the attribute
7335 <literal>code</literal> as described in the rules for control fields.
7336 The children of the data field element is subfield elements.
7337 Each subfield element is encoded as <literal>s</literal>
7338 concatenated with the sub field code.
7339 The text of the subfield element is the contents of the subfield.
7340 Indicators are encoded as attributes for the data field element similar
7341 to the encoding for control fields.
7348 <sect1 id="tools.retrieval">
7349 <title>Retrieval Facility</title>
7351 YAZ version 2.1.20 or later includes a Retrieval facility tool
7352 which allows a SRU/Z39.50 to describe itself and perform record
7353 conversions. The idea is the following:
7357 An SRU/Z39.50 client sends a retrieval request which includes
7358 a combination of the following parameters: syntax (format),
7359 schema (or element set name).
7364 The retrieval facility is invoked with parameters in a
7365 server/proxy. The retrieval facility matches the parameters a set of
7366 "supported" retrieval types.
7367 If there is no match, the retrieval signals an error
7368 (syntax and / or schema not supported).
7373 For a successful match, the backend is invoked with the same
7374 or altered retrieval parameters (syntax, schema). If
7375 a record is received from the backend, it is converted to the
7376 frontend name / syntax.
7381 The resulting record is sent back the client and tagged with
7382 the frontend syntax / schema.
7388 The Retrieval facility is driven by an XML configuration. The
7389 configuration is neither Z39.50 ZeeRex or SRU ZeeRex. But it
7390 should be easy to generate both of them from the XML configuration.
7391 (unfortunately the two versions
7392 of ZeeRex differ substantially in this regard).
7394 <sect2 id="tools.retrieval.format">
7395 <title>Retrieval XML format</title>
7397 All elements should be covered by namespace
7398 <literal>http://indexdata.com/yaz</literal> .
7399 The root element node must be <literal>retrievalinfo</literal>.
7402 The <literal>retrievalinfo</literal> must include one or
7403 more <literal>retrieval</literal> elements. Each
7404 <literal>retrieval</literal> defines specific combination of
7405 syntax, name and identifier supported by this retrieval service.
7408 The <literal>retrieval</literal> element may include any of the
7409 following attributes:
7411 <varlistentry><term><literal>syntax</literal> (REQUIRED)</term>
7414 Defines the record syntax. Possible values is any
7415 of the names defined in YAZ' OID database or a raw
7420 <varlistentry><term><literal>name</literal> (OPTIONAL)</term>
7423 Defines the name of the retrieval format. This can be
7424 any string. For SRU, the value, is equivalent to schema (short-hand);
7425 for Z39.50 it's equivalent to simple element set name.
7426 For YAZ 3.0.24 and later this name may be specified as a glob
7427 expression with operators
7428 <literal>*</literal> and <literal>?</literal>.
7432 <varlistentry><term><literal>identifier</literal> (OPTIONAL)</term>
7435 Defines the URI schema name of the retrieval format. This can be
7436 any string. For SRU, the value, is equivalent to URI schema.
7437 For Z39.50, there is no equivalent.
7444 The <literal>retrieval</literal> may include one
7445 <literal>backend</literal> element. If a <literal>backend</literal>
7446 element is given, it specifies how the records are retrieved by
7447 some backend and how the records are converted from the backend to
7451 The attributes, <literal>name</literal> and <literal>syntax</literal>
7452 may be specified for the <literal>backend</literal> element. These
7453 semantics of these attributes is equivalent to those for the
7454 <literal>retrieval</literal>. However, these values are passed to
7458 The <literal>backend</literal> element may includes one or more
7459 conversion instructions (as children elements). The supported
7462 <varlistentry><term><literal>marc</literal></term>
7465 The <literal>marc</literal> element specifies a conversion
7466 to - and from ISO2709 encoded MARC and
7467 <ulink url="&url.marcxml;">&acro.marcxml;</ulink>/MarcXchange.
7468 The following attributes may be specified:
7471 <term><literal>inputformat</literal> (REQUIRED)</term>
7474 Format of input. Supported values are
7475 <literal>marc</literal> (for ISO2709), <literal>xml</literal>
7476 (MARCXML/MarcXchange) and <literal>json</literal>
7477 (<ulink url="&url.marc_in_json;">MARC-in_JSON</ulink>).
7482 <term><literal>outputformat</literal> (REQUIRED)</term>
7485 Format of output. Supported values are
7486 <literal>line</literal> (MARC line format);
7487 <literal>marcxml</literal> (for MARCXML),
7488 <literal>marc</literal> (ISO2709),
7489 <literal>marcxhcange</literal> (for MarcXchange),
7490 or <literal>json</literal>
7491 (<ulink url="&url.marc_in_json;">MARC-in_JSON </ulink>).
7496 <term><literal>inputcharset</literal> (OPTIONAL)</term>
7499 Encoding of input. For XML input formats, this need not
7500 be given, but for ISO2709 based inputformats, this should
7501 be set to the encoding used. For MARC21 records, a common
7502 inputcharset value would be <literal>marc-8</literal>.
7507 <term><literal>outputcharset</literal> (OPTIONAL)</term>
7510 Encoding of output. If outputformat is XML based, it is
7511 strongly recommened to use <literal>utf-8</literal>.
7520 <term><literal>select</literal></term>
7523 The <literal>select</literal> selects one or more text nodes
7524 and decodes them as XML.
7525 The following attributes may be specified:
7527 <varlistentry><term><literal>path</literal> (REQUIRED)</term>
7530 X-Path expression for selecting text nodes.
7537 This conversion is available in YAZ 5.8.0 and later.
7542 <term><literal>solrmarc</literal></term>
7545 The <literal>solrmarc</literal> decodes solrmarc records.
7546 It assumes that the input is pure solrmarc text (no escaping)
7547 and will convert all sequences of the form #XX; to a single
7548 character of the hexadecimal value as given by XX. The output,
7549 presumably, is a valid ISO2709 buffer.
7552 This conversion is available in YAZ 5.0.21 and later.
7557 <term><literal>xslt</literal></term>
7560 The <literal>xslt</literal> element specifies a conversion
7561 via &acro.xslt;. The following attributes may be specified:
7563 <varlistentry><term><literal>stylesheet</literal> (REQUIRED)</term>
7577 <sect2 id="tools.retrieval.examples">
7578 <title>Retrieval Facility Examples</title>
7579 <example id="tools.retrieval.marc21">
7580 <title>MARC21 backend</title>
7582 A typical way to use the retrieval facility is to enable XML
7583 for servers that only supports ISO2709 encoded MARC21 records.
7585 <programlisting><![CDATA[
7587 <retrieval syntax="usmarc" name="F"/>
7588 <retrieval syntax="usmarc" name="B"/>
7589 <retrieval syntax="xml" name="marcxml"
7590 identifier="info:srw/schema/1/marcxml-v1.1">
7591 <backend syntax="usmarc" name="F">
7592 <marc inputformat="marc" outputformat="marcxml"
7593 inputcharset="marc-8"/>
7596 <retrieval syntax="xml" name="dc">
7597 <backend syntax="usmarc" name="F">
7598 <marc inputformat="marc" outputformat="marcxml"
7599 inputcharset="marc-8"/>
7600 <xslt stylesheet="MARC21slim2DC.xsl"/>
7607 This means that our frontend supports:
7611 MARC21 F(ull) records.
7616 MARC21 B(rief) records.
7626 Dublin core records.
7632 <example id="tools.retrieval.marcxml">
7633 <title>MARCXML backend</title>
7635 SRW/SRU and Solr backends returns records in XML.
7636 If they return MARCXML or MarcXchange, the retrieval module
7637 can convert those into ISO2709 formats, most commonly USMARC
7639 In this example, the backend returns MARCXML for schema="marcxml".
7641 <programlisting><![CDATA[
7643 <retrieval syntax="usmarc">
7644 <backend syntax="xml" name="marcxml">
7645 <marc inputformat="xml" outputformat="marc"
7646 outputcharset="marc-8"/>
7649 <retrieval syntax="xml" name="marcxml"
7650 identifier="info:srw/schema/1/marcxml-v1.1"/>
7651 <retrieval syntax="xml" name="dc">
7652 <backend syntax="xml" name="marcxml">
7653 <xslt stylesheet="MARC21slim2DC.xsl"/>
7660 This means that our frontend supports:
7664 MARC21 records (any element set name) in MARC-8 encoding.
7669 MARCXML records for element-set=marcxml
7674 Dublin core records for element-set=dc.
7681 <sect2 id="tools.retrieval.api">
7684 It should be easy to use the retrieval systems from applications. Refer
7686 <filename>yaz/retrieval.h</filename> and
7687 <filename>yaz/record_conv.h</filename>.
7691 <sect1 id="sorting">
7692 <title>Sorting</title>
7694 This chapter describes sorting and how it is supported in YAZ.
7695 Sorting applies to a result-set.
7697 <ulink url="http://www.loc.gov/z3950/agency/markup/05.html#3.2.7">
7698 Z39.50 sorting facility
7700 takes one or more input result-sets
7701 and one result-set as output. The most simple case is that
7702 the input-set is the same as the output-set.
7705 Z39.50 sorting has a separate APDU (service) that is, thus, performed
7706 following a search (two phases).
7709 In SRU/Solr, however, the model is different. Here, sorting is specified
7710 during the the search operation. Note, however, that SRU might
7711 perform sort as separate search, by referring to an existing result-set
7712 in the query (result-set reference).
7715 <title>Using the Z39.50 sort service</title>
7717 yaz-client and the ZOOM API supports the Z39.50 sort facility. In any
7718 case the sort sequence or sort critiera is using a string notation.
7719 This notation is a one-line notation suitable for being manually
7720 entered or generated and allows for easy logging (one liner).
7721 For the ZOOM API, the sort is specified in the call to ZOOM_query_sortby
7722 function. For yaz-client the sort is performed and specified using
7723 the sort and sort+ commands. For description of the sort criteria notation
7724 refer to the <link linkend="sortspec">sort command</link> in the
7728 The ZOOM API might choose one of several sort strategies for
7729 sorting. Refer to <xref linkend="zoom-sort-strategy"/>.
7733 <title>Type-7 sort</title>
7735 Type-7 sort is an extension to the Bib-1 based RPN query where the
7736 sort specification is embedded as an Attribute-Plus-Term.
7739 The objectives for introducing Type-7 sorting is that it allows
7740 a client to perform sorting even if it does not implement/support
7741 Z39.50 sort. Virtually all Z39.50 client software supports
7742 RPN queries. It also may improve performance because the sort
7743 critieria is specified along with the search query.
7746 The sort is triggered by the presence of type 7 and the value of type 7
7748 <ulink url="http://www.loc.gov/z3950/agency/asn1.html#SortKeySpec">
7751 The value for type 7 is 1 for ascending and 2 for descending.
7753 <ulink url="http://www.loc.gov/z3950/agency/asn1.html#SortElement">
7756 only the generic part is handled. If generic sortKey is of type
7757 sortField, then attribute type 1 is present and the value is
7758 sortField (InternationalString). If generic sortKey is of type
7759 sortAttributes, then the attributes in list is used . generic sortKey
7760 of type elementSpec is not supported.
7763 The term in the sorting Attribute-Plus-Term combo should hold
7764 an integer. The value is 0 for primary sorting criteria, 1 for second
7770 <title>Facets</title>
7772 YAZ supports facets for in Solr, SRU 2.0 and Z39.50 protocols.
7775 Like Type-1/RPN, YAZ supports a string notation for specifying
7776 facets. For the API this is performed by
7777 <function>yaz_pqf_parse_facet_list</function>.
7780 For ZOOM C the facets are given by option "facets"
7781 For yaz-client it is used for the facets command.
7784 The grammar of this specification is as follows:
7786 facet-spec ::= facet-list
7788 facet-list ::= facet-list ',' attr-spec | attr-spec
7790 attr-spec ::= attr-spec '@attr' string | '@attr' string
7793 The notation is inspired by PQF. The string following '@attr'
7794 may not include blanks and is of the form
7795 <replaceable>type</replaceable><literal>=</literal><replaceable>value</replaceable>,
7796 where <replaceable>type</replaceable> is an integer and
7797 <replaceable>value</replaceable> is a string or an integer.
7800 The Facets specification is not Bib-1. The following types apply:
7802 <table id="facet.attributes">
7803 <title>Facet attributes</title>
7805 <colspec colwidth="2*" colname="type"></colspec>
7806 <colspec colwidth="9*" colname="description"></colspec>
7810 <entry>Description</entry>
7817 Field-name. This is often a string, eg "Author", "Year", etc.
7823 Sort order. Value should be an integer.
7824 Value 0: count descending (frequency). Value 1: alpha ascending.
7830 Number of terms requested.
7845 <title>The ODR Module</title>
7846 <sect1 id="odr.introduction">
7847 <title>Introduction</title>
7849 &odr; is the BER-encoding/decoding subsystem of &yaz;. Care as been taken
7850 to isolate &odr; from the rest of the package - specifically from the
7851 transport interface. &odr; may be used in any context where basic
7852 ASN.1/BER representations are used.
7855 If you are only interested in writing a Z39.50 implementation based on
7856 the PDUs that are already provided with &yaz;, you only need to concern
7857 yourself with the section on managing ODR streams
7858 (<xref linkend="odr.use"/>). Only if you need to
7859 implement ASN.1 beyond that which has been provided, should you
7860 worry about the second half of the documentation
7861 (<xref linkend="odr.programming"/>).
7862 If you use one of the higher-level interfaces, you can skip this
7866 This is important, so we'll repeat it for emphasis: <emphasis>You do
7867 not need to read <xref linkend="odr.programming"/>
7868 to implement Z39.50 with &yaz;.</emphasis>
7871 If you need a part of the protocol that isn't already in &yaz;, you
7872 should contact the authors before going to work on it yourself: We
7873 might already be working on it. Conversely, if you implement a useful
7874 part of the protocol before us, we'd be happy to include it in a
7878 <sect1 id="odr.use">
7879 <title>Using ODR</title>
7880 <sect2 id="odr.streams">
7881 <title>ODR Streams</title>
7883 Conceptually, the ODR stream is the source of encoded data in the
7884 decoding mode; when encoding, it is the receptacle for the encoded
7885 data. Before you can use an ODR stream it must be allocated. This is
7886 done with the function
7889 ODR odr_createmem(int direction);
7892 The <function>odr_createmem()</function> function takes as argument one
7893 of three manifest constants: <literal>ODR_ENCODE</literal>,
7894 <literal>ODR_DECODE</literal>, or <literal>ODR_PRINT</literal>.
7895 An &odr; stream can be in only one mode - it is not possible to change
7896 its mode once it's selected. Typically, your program will allocate
7897 at least two ODR streams - one for decoding, and one for encoding.
7900 When you're done with the stream, you can use
7903 void odr_destroy(ODR o);
7906 to release the resources allocated for the stream.
7909 <sect2 id="odr.memory.management">
7910 <title id="memory">Memory Management</title>
7912 Two forms of memory management take place in the &odr; system. The first
7913 one, which has to do with allocating little bits of memory (sometimes
7914 quite large bits of memory, actually) when a protocol package is
7915 decoded, and turned into a complex of interlinked structures. This
7916 section deals with this system, and how you can use it for your own
7917 purposes. The next section deals with the memory management which is
7918 required when encoding data - to make sure that a large enough buffer is
7919 available to hold the fully encoded PDU.
7922 The &odr; module has its own memory management system, which is
7923 used whenever memory is required. Specifically, it is used to allocate
7924 space for data when decoding incoming PDUs. You can use the memory
7925 system for your own purposes, by using the function
7928 void *odr_malloc(ODR o, size_t size);
7931 You can't use the normal <function>free(2)</function> routine to free
7932 memory allocated by this function, and &odr; doesn't provide a parallel
7933 function. Instead, you can call
7936 void odr_reset(ODR o);
7939 when you are done with the
7940 memory: Everything allocated since the last call to
7941 <function>odr_reset()</function> is released.
7942 The <function>odr_reset()</function> call is also required to clear
7943 up an error condition on a stream.
7949 size_t odr_total(ODR o);
7952 returns the number of bytes allocated on the stream since the last call to
7953 <function>odr_reset()</function>.
7956 The memory subsystem of &odr; is fairly efficient at allocating and
7957 releasing little bits of memory. Rather than managing the individual,
7958 small bits of space, the system maintains a free-list of larger chunks
7959 of memory, which are handed out in small bits. This scheme is
7960 generally known as a <emphasis>nibble memory</emphasis> system.
7961 It is very useful for maintaining short-lived constructions such
7965 If you want to retain a bit of memory beyond the next call to
7966 <function>odr_reset()</function>, you can use the function
7969 ODR_MEM odr_extract_mem(ODR o);
7972 This function will give you control of the memory recently allocated
7973 on the ODR stream. The memory will live (past calls to
7974 <function>odr_reset()</function>), until you call the function
7977 void odr_release_mem(ODR_MEM p);
7980 The opaque <literal>ODR_MEM</literal> handle has no other purpose than
7981 referencing the memory block for you until you want to release it.
7984 You can use <function>odr_extract_mem()</function> repeatedly between
7985 allocating data, to retain individual control of separate chunks of data.
7988 <sect2 id="odr.encoding.and.decoding">
7989 <title>Encoding and Decoding Data</title>
7991 When encoding data, the ODR stream will write the encoded octet string
7992 in an internal buffer. To retrieve the data, use the function
7995 char *odr_getbuf(ODR o, int *len, int *size);
7998 The integer pointed to by len is set to the length of the encoded
7999 data, and a pointer to that data is returned. <literal>*size</literal>
8000 is set to the size of the buffer (unless <literal>size</literal> is null,
8001 signaling that you are not interested in the size). The next call to
8002 a primitive function using the same &odr; stream will overwrite the
8003 data, unless a different buffer has been supplied using the call
8006 void odr_setbuf(ODR o, char *buf, int len, int can_grow);
8009 which sets the encoding (or decoding) buffer used by
8010 <literal>o</literal> to <literal>buf</literal>, using the length
8011 <literal>len</literal>.
8012 Before a call to an encoding function, you can use
8013 <function>odr_setbuf()</function> to provide the stream with an encoding
8014 buffer of sufficient size (length). The <literal>can_grow</literal>
8015 parameter tells the encoding &odr; stream whether it is allowed to use
8016 <function>realloc(2)</function> to increase the size of the buffer when
8017 necessary. The default condition of a new encoding stream is equivalent
8018 to the results of calling
8021 odr_setbuf(stream, 0, 0, 1);
8024 In this case, the stream will allocate and reallocate memory as
8025 necessary. The stream reallocates memory by repeatedly doubling the
8026 size of the buffer - the result is that the buffer will typically
8027 reach its maximum, working size with only a small number of reallocation
8028 operations. The memory is freed by the stream when the latter is destroyed,
8029 unless it was assigned by the user with the <literal>can_grow</literal>
8030 parameter set to zero (in this case, you are expected to retain
8031 control of the memory yourself).
8034 To assume full control of an encoded buffer, you must first call
8035 <function>odr_getbuf()</function> to fetch the buffer and its length.
8036 Next, you should call <function>odr_setbuf()</function> to provide a
8037 different buffer (or a null pointer) to the stream. In the simplest
8038 case, you will reuse the same buffer over and over again, and you
8039 will just need to call <function>odr_getbuf()</function> after each
8040 encoding operation to get the length and address of the buffer.
8041 Note that the stream may reallocate the buffer during an encoding
8042 operation, so it is necessary to retrieve the correct address after
8043 each encoding operation.
8046 It is important to realize that the ODR stream will not release this
8047 memory when you call <function>odr_reset()</function>: It will
8048 merely update its internal pointers to prepare for the encoding of a
8050 When the stream is released by the <function>odr_destroy()</function>
8051 function, the memory given to it by <function>odr_setbuf</function> will
8052 be released <emphasis>only</emphasis> if the <literal>can_grow</literal>
8053 parameter to <function>odr_setbuf()</function> was nonzero. The
8054 <literal>can_grow</literal> parameter, in other words, is a way of
8055 signaling who is to own the buffer, you or the ODR stream. If you never call
8056 <function>odr_setbuf()</function> on your encoding stream, which is
8057 typically the case, the buffer allocated by the stream will belong to
8058 the stream by default.
8061 When you wish to decode data, you should first call
8062 <function>odr_setbuf()</function>, to tell the decoding stream
8063 where to find the encoded data, and how long the buffer is
8064 (the <literal>can_grow</literal> parameter is ignored by a decoding
8065 stream). After this, you can call the function corresponding to the
8066 data you wish to decode (eg, <function>odr_integer()</function> odr
8067 <function>z_APDU()</function>).
8069 <example id="example.odr.encoding.and.decoding.functions">
8070 <title>Encoding and decoding functions</title>
8072 int odr_integer(ODR o, Odr_int **p, int optional, const char *name);
8074 int z_APDU(ODR o, Z_APDU **p, int optional, const char *name);
8078 If the data is absent (or doesn't match the tag corresponding to
8079 the type), the return value will be either 0 or 1 depending on the
8080 <literal>optional</literal> flag. If <literal>optional</literal>
8081 is 0 and the data is absent, an error flag will be raised in the
8082 stream, and you'll need to call <function>odr_reset()</function> before
8083 you can use the stream again. If <literal>optional</literal> is
8084 nonzero, the pointer <emphasis>pointed</emphasis> to/ by
8085 <literal>p</literal> will be set to the null value, and the function
8087 The <literal>name</literal> argument is used to pretty-print the
8088 tag in question. It may be set to <literal>NULL</literal> if
8089 pretty-printing is not desired.
8092 If the data value is found where it's expected, the pointer
8093 <emphasis>pointed to</emphasis> by the <literal>p</literal> argument
8094 will be set to point to the decoded type.
8095 The space for the type will be allocated and owned by the &odr;
8096 stream, and it will live until you call
8097 <function>odr_reset()</function> on the stream. You cannot use
8098 <function>free(2)</function> to release the memory.
8099 You can decode several data elements (by repeated calls to
8100 <function>odr_setbuf()</function> and your decoding function), and
8101 new memory will be allocated each time. When you do call
8102 <function>odr_reset()</function>, everything decoded since the
8103 last call to <function>odr_reset()</function> will be released.
8105 <example id="example.odr.encoding.of.integer">
8106 <title>Encoding and decoding of an integer</title>
8108 The use of the double indirection can be a little confusing at first
8109 (its purpose will become clear later on, hopefully),
8110 so an example is in order. We'll encode an integer value, and
8111 immediately decode it again using a different stream. A useless, but
8112 informative operation.
8114 <programlisting><![CDATA[
8115 void do_nothing_useful(Odr_int value)
8118 Odr_int *valp, *resvalp;
8122 /* allocate streams */
8123 if (!(encode = odr_createmem(ODR_ENCODE)))
8125 if (!(decode = odr_createmem(ODR_DECODE)))
8129 if (odr_integer(encode, &valp, 0, 0) == 0)
8131 printf("encoding went bad\n");
8134 bufferp = odr_getbuf(encode, &len, 0);
8135 printf("length of encoded data is %d\n", len);
8137 /* now let's decode the thing again */
8138 odr_setbuf(decode, bufferp, len, 0);
8139 if (odr_integer(decode, &resvalp, 0, 0) == 0)
8141 printf("decoding went bad\n");
8144 /* ODR_INT_PRINTF format for printf (such as %d) */
8145 printf("the value is " ODR_INT_PRINTF "\n", *resvalp);
8148 odr_destroy(encode);
8149 odr_destroy(decode);
8154 This looks like a lot of work, offhand. In practice, the &odr; streams
8155 will typically be allocated once, in the beginning of your program
8156 (or at the beginning of a new network session), and the encoding
8157 and decoding will only take place in a few, isolated places in your
8158 program, so the overhead is quite manageable.
8162 <sect2 id="odr.printing">
8163 <title>Printing</title>
8165 When an ODR stream is created of type <literal>ODR_PRINT</literal>
8166 the ODR module will print the contents of a PDU in a readable format.
8167 By default output is written to the <literal>stderr</literal> stream.
8168 This behavior can be changed, however, by calling the function
8170 odr_setprint(ODR o, FILE *file);
8172 before encoders or decoders are being invoked.
8173 It is also possible to direct the output to a buffer (of indeed
8174 another file), by using the more generic mechanism:
8176 void odr_set_stream(ODR o, void *handle,
8177 void (*stream_write)(ODR o, void *handle, int type,
8178 const char *buf, int len),
8179 void (*stream_close)(void *handle));
8181 Here the user provides an opaque handle and two handlers,
8182 <replaceable>stream_write</replaceable> for writing,
8183 and <replaceable>stream_close</replaceable> which is supposed
8184 to close/free resources associated with handle.
8185 The <replaceable>stream_close</replaceable> handler is optional and
8186 if NULL for the function is provided, it will not be invoked.
8187 The <replaceable>stream_write</replaceable> takes the ODR handle
8188 as parameter, the user defined handle, a type
8189 <literal>ODR_OCTETSTRING</literal>, <literal>ODR_VISIBLESTRING</literal>
8190 which indicates the type of contents is being written.
8193 Another utility useful for diagnostics (error handling) or as
8194 part of the printing facilities is:
8196 const char **odr_get_element_path(ODR o);
8198 which returns a list of current elements that ODR deals with at the
8199 moment. For the returned array, say <literal>ar</literal>,
8200 <literal>ar[0]</literal> is the top level element,
8201 <literal>ar[n]</literal> is the last. The last element has the
8202 property that <literal>ar[n+1] == NULL</literal>.
8204 <example id="example.odr.element.path.record">
8205 <title>Element Path for record</title>
8207 For a database record part of a PresentResponse the
8208 array returned by <function>odr_get_element</function>
8209 is <literal>presentResponse</literal>, <literal>databaseOrSurDiagnostics</literal>, <literal>?</literal>, <literal>record</literal>, <literal>?</literal>, <literal>databaseRecord</literal> . The question mark appears due to
8210 unnamed constructions.
8214 <sect2 id="odr.diagnostics">
8215 <title>Diagnostics</title>
8217 The encoding/decoding functions all return 0 when an error occurs.
8218 Until you call <function>odr_reset()</function>, you cannot use the
8219 stream again, and any function called will immediately return 0.
8222 To provide information to the programmer or administrator, the function
8225 void odr_perror(ODR o, char *message);
8228 is provided, which prints the <literal>message</literal> argument to
8229 <literal>stderr</literal> along with an error message from the stream.
8232 You can also use the function
8235 int odr_geterror(ODR o);
8238 to get the current error number from the screen. The number will be
8239 one of these constants:
8241 <table frame="top" id="odr.error.codes">
8242 <title>ODR Error codes</title>
8247 <entry>Description</entry>
8252 <entry>OMEMORY</entry><entry>Memory allocation failed.</entry>
8255 <entry>OSYSERR</entry><entry>A system- or library call has failed.
8256 The standard diagnostic variable <literal>errno</literal> should be
8257 examined to determine the actual error.</entry>
8260 <entry>OSPACE</entry><entry>No more space for encoding.
8261 This will only occur when the user has explicitly provided a
8262 buffer for an encoding stream without allowing the system to
8263 allocate more space.</entry>
8266 <entry>OREQUIRED</entry><entry>This is a common protocol error; A
8267 required data element was missing during encoding or decoding.</entry>
8270 <entry>OUNEXPECTED</entry><entry>An unexpected data element was
8271 found during decoding.</entry>
8274 <entry>OOTHER</entry><entry>Other error. This is typically an
8275 indication of misuse of the &odr; system by the programmer, and also
8276 that the diagnostic system isn't as good as it should be, yet.</entry>
8282 The character string array
8288 can be indexed by the error code to obtain a human-readable
8289 representation of the problem.
8292 <sect2 id="odr.summary.and.synopsis">
8293 <title>Summary and Synopsis</title>
8295 #include <yaz/odr.h>
8297 ODR odr_createmem(int direction);
8299 void odr_destroy(ODR o);
8301 void odr_reset(ODR o);
8303 char *odr_getbuf(ODR o, int *len, int *size);
8305 void odr_setbuf(ODR o, char *buf, int len, int can_grow);
8307 void *odr_malloc(ODR o, int size);
8309 NMEM odr_extract_mem(ODR o);
8311 int odr_geterror(ODR o);
8313 void odr_perror(ODR o, const char *message);
8315 extern char *odr_errlist[];
8319 <sect1 id="odr.programming">
8320 <title>Programming with ODR</title>
8322 The API of &odr; is designed to reflect the structure of ASN.1, rather
8323 than BER itself. Future releases may be able to represent data in
8324 other external forms.
8328 There is an ASN.1 tutorial available at
8329 <ulink url="&url.asn.1.tutorial;">this site</ulink>.
8330 This site also has standards for ASN.1 (X.680) and BER (X.690)
8331 <ulink url="&url.asn.1.standards;">online</ulink>.
8335 The ODR interface is based loosely on that of the Sun Microsystems
8337 Specifically, each function which corresponds to an ASN.1 primitive
8338 type has a dual function. Depending on the settings of the ODR
8339 stream which is supplied as a parameter, the function may be used
8340 either to encode or decode data. The functions that can be built
8341 using these primitive functions, to represent more complex data types,
8342 share this quality. The result is that you only have to enter the
8343 definition for a type once - and you have the functionality of encoding,
8344 decoding (and pretty-printing) all in one unit.
8345 The resulting C source code is quite compact, and is a pretty
8346 straightforward representation of the source ASN.1 specification.
8349 In many cases, the model of the XDR functions works quite well in this
8351 In others, it is less elegant. Most of the hassle comes from the optional
8352 SEQUENCE members which don't exist in XDR.
8354 <sect2 id="odr.primitive.asn1.types">
8355 <title>The Primitive ASN.1 Types</title>
8357 ASN.1 defines a number of primitive types (many of which correspond
8358 roughly to primitive types in structured programming languages, such as C).
8360 <sect3 id="odr.integer">
8361 <title>INTEGER</title>
8363 The &odr; function for encoding or decoding (or printing) the ASN.1
8364 INTEGER type looks like this:
8367 int odr_integer(ODR o, Odr_int **p, int optional, const char *name);
8370 The <literal>Odr_int</literal> is just a simple integer.
8373 This form is typical of the primitive &odr; functions. They are named
8374 after the type of data that they encode or decode. They take an &odr;
8375 stream, an indirect reference to the type in question, and an
8376 <literal>optional</literal> flag (corresponding to the OPTIONAL keyword
8377 of ASN.1) as parameters. They all return an integer value of either one
8379 When you use the primitive functions to construct encoders for complex
8380 types of your own, you should follow this model as well. This
8381 ensures that your new types can be reused as elements in yet more
8385 The <literal>o</literal> parameter should obviously refer to a properly
8386 initialized &odr; stream of the right type (encoding/decoding/printing)
8387 for the operation that you wish to perform.
8390 When encoding or printing, the function first looks at
8391 <literal>* p</literal>. If <literal>* p</literal> (the pointer pointed
8392 to by <literal>p</literal>) is a null pointer, this is taken to mean that
8393 the data element is absent. If the <literal>optional</literal> parameter
8394 is nonzero, the function will return one (signifying success) without
8395 any further processing. If the <literal>optional</literal> is zero, an
8396 internal error flag is set in the &odr; stream, and the function will
8397 return 0. No further operations can be carried out on the stream without
8398 a call to the function <function>odr_reset()</function>.
8401 If <literal>*p</literal> is not a null pointer, it is expected to
8402 point to an instance of the data type. The data will be subjected to
8403 the encoding rules, and the result will be placed in the buffer held
8404 by the &odr; stream.
8407 The other ASN.1 primitives have similar functions that operate in
8411 <sect3 id="odr.boolean">
8412 <title>BOOLEAN</title>
8414 int odr_bool(ODR o, Odr_bool **p, int optional, const char *name);
8417 <sect3 id="odr.real">
8423 <sect3 id="odr.null">
8426 int odr_null(ODR o, Odr_null **p, int optional, const char *name);
8429 In this case, the value of **p is not important. If <literal>*p</literal>
8430 is different from the null pointer, the null value is present, otherwise
8434 <sect3 id="odr.octet.string">
8435 <title>OCTET STRING</title>
8437 typedef struct odr_oct
8443 int odr_octetstring(ODR o, Odr_oct **p, int optional,
8447 The <literal>buf</literal> field should point to the character array
8448 that holds the octetstring. The <literal>len</literal> field holds the
8450 The character array need not be null terminated.
8453 To make things a little easier, an alternative is given for string
8454 types that are not expected to contain embedded NULL characters (eg.
8458 int odr_cstring(ODR o, char **p, int optional, const char *name);
8461 Which encoded or decodes between OCTETSTRING representations and
8462 null-terminates C strings.
8465 Functions are provided for the derived string types, eg:
8468 int odr_visiblestring(ODR o, char **p, int optional,
8472 <sect3 id="odr.bit.string">
8473 <title>BIT STRING</title>
8475 int odr_bitstring(ODR o, Odr_bitmask **p, int optional,
8479 The opaque type <literal>Odr_bitmask</literal> is only suitable for
8480 holding relatively brief bit strings, eg. for options fields, etc.
8481 The constant <literal>ODR_BITMASK_SIZE</literal> multiplied by 8
8482 gives the maximum possible number of bits.
8485 A set of macros are provided for manipulating the
8486 <literal>Odr_bitmask</literal> type:
8489 void ODR_MASK_ZERO(Odr_bitmask *b);
8491 void ODR_MASK_SET(Odr_bitmask *b, int bitno);
8493 void ODR_MASK_CLEAR(Odr_bitmask *b, int bitno);
8495 int ODR_MASK_GET(Odr_bitmask *b, int bitno);
8498 The functions are modeled after the manipulation functions that
8499 accompany the <literal>fd_set</literal> type used by the
8500 <function>select(2)</function> call.
8501 <literal>ODR_MASK_ZERO</literal> should always be called first on a
8502 new bitmask, to initialize the bits to zero.
8505 <sect3 id="odr.object.identifier">
8506 <title>OBJECT IDENTIFIER</title>
8508 int odr_oid(ODR o, Odr_oid **p, int optional, const char *name);
8511 The C OID representation is simply an array of integers, terminated by
8512 the value -1 (the <literal>Odr_oid</literal> type is synonymous with
8513 the <literal>short</literal> type).
8514 We suggest that you use the OID database module (see
8515 <xref linkend="tools.oid.database"/>) to handle object identifiers
8516 in your application.
8520 <sect2 id="odr.tagging.primitive.types">
8521 <title>Tagging Primitive Types</title>
8523 The simplest way of tagging a type is to use the
8524 <function>odr_implicit_tag()</function> or
8525 <function>odr_explicit_tag()</function> macros:
8528 int odr_implicit_tag(ODR o, Odr_fun fun, int class, int tag,
8529 int optional, const char *name);
8531 int odr_explicit_tag(ODR o, Odr_fun fun, int class, int tag,
8532 int optional, const char *name);
8535 To create a type derived from the integer type by implicit tagging, you
8539 MyInt ::= [210] IMPLICIT INTEGER
8542 In the &odr; system, this would be written like:
8545 int myInt(ODR o, Odr_int **p, int optional, const char *name)
8547 return odr_implicit_tag(o, odr_integer, p,
8548 ODR_CONTEXT, 210, optional, name);
8552 The function <function>myInt()</function> can then be used like any of
8553 the primitive functions provided by &odr;. Note that the behavior of
8554 <function>odr_explicit_tag()</function>
8555 and <function>odr_implicit_tag()</function> macros
8556 act exactly the same as the functions they are applied to - they
8557 respond to error conditions, etc, in the same manner - they
8558 simply have three extra parameters. The class parameter may
8559 take one of the values: <literal>ODR_CONTEXT</literal>,
8560 <literal>ODR_PRIVATE</literal>, <literal>ODR_UNIVERSAL</literal>, or
8561 <literal>/ODR_APPLICATION</literal>.
8564 <sect2 id="odr.constructed.types">
8565 <title>Constructed Types</title>
8567 Constructed types are created by combining primitive types. The
8568 &odr; system only implements the SEQUENCE and SEQUENCE OF constructions
8569 (although adding the rest of the container types should be simple
8570 enough, if the need arises).
8573 For implementing SEQUENCEs, the functions
8576 int odr_sequence_begin(ODR o, void *p, int size, const char *name);
8577 int odr_sequence_end(ODR o);
8583 The <function>odr_sequence_begin()</function> function should be
8584 called in the beginning of a function that implements a SEQUENCE type.
8585 Its parameters are the &odr; stream, a pointer (to a pointer to the type
8586 you're implementing), and the <literal>size</literal> of the type
8587 (typically a C structure). On encoding, it returns 1 if
8588 <literal>* p</literal> is a null pointer. The <literal>size</literal>
8589 parameter is ignored. On decoding, it returns 1 if the type is found in
8590 the data stream. <literal>size</literal> bytes of memory are allocated,
8591 and <literal>*p</literal> is set to point to this space.
8592 <function>odr_sequence_end()</function> is called at the end of the
8593 complex function. Assume that a type is defined like this:
8596 MySequence ::= SEQUENCE {
8598 boolval BOOLEAN OPTIONAL
8602 The corresponding &odr; encoder/decoder function and the associated data
8603 structures could be written like this:
8606 typedef struct MySequence
8612 int mySequence(ODR o, MySequence **p, int optional, const char *name)
8614 if (odr_sequence_begin(o, p, sizeof(**p), name) == 0)
8615 return optional && odr_ok(o);
8617 odr_integer(o, &(*p)->intval, 0, "intval") &&
8618 odr_bool(o, &(*p)->boolval, 1, "boolval") &&
8619 odr_sequence_end(o);
8623 Note the 1 in the call to <function>odr_bool()</function>, to mark
8624 that the sequence member is optional.
8625 If either of the member types had been tagged, the macros
8626 <function>odr_implicit_tag()</function> or
8627 <function>odr_explicit_tag()</function>
8628 could have been used.
8629 The new function can be used exactly like the standard functions provided
8630 with &odr;. It will encode, decode or pretty-print a data value of the
8631 <literal>MySequence</literal> type. We like to name types with an
8632 initial capital, as done in ASN.1 definitions, and to name the
8633 corresponding function with the first character of the name in lower case.
8634 You could, of course, name your structures, types, and functions any way
8635 you please - as long as you're consistent, and your code is easily readable.
8636 <literal>odr_ok</literal> is just that - a predicate that returns the
8637 state of the stream. It is used to ensure that the behavior of the new
8638 type is compatible with the interface of the primitive types.
8641 <sect2 id="odr.tagging.constructed.types">
8642 <title>Tagging Constructed Types</title>
8645 See <xref linkend="odr.tagging.primitive.types"/> for information
8646 on how to tag the primitive types, as well as types that are
8650 <sect3 id="odr.implicit.tagging">
8651 <title>Implicit Tagging</title>
8653 Assume the type above had been defined as
8656 MySequence ::= [10] IMPLICIT SEQUENCE {
8658 boolval BOOLEAN OPTIONAL
8662 You would implement this in &odr; by calling the function
8665 int odr_implicit_settag(ODR o, int class, int tag);
8668 which overrides the tag of the type immediately following it. The
8669 macro <function>odr_implicit_tag()</function> works by calling
8670 <function>odr_implicit_settag()</function> immediately
8671 before calling the function pointer argument.
8672 Your type function could look like this:
8675 int mySequence(ODR o, MySequence **p, int optional, const char *name)
8677 if (odr_implicit_settag(o, ODR_CONTEXT, 10) == 0 ||
8678 odr_sequence_begin(o, p, sizeof(**p), name) == 0)
8679 return optional && odr_ok(o);
8681 odr_integer(o, &(*p)->intval, 0, "intval") &&
8682 odr_bool(o, &(*p)->boolval, 1, "boolval") &&
8683 odr_sequence_end(o);
8687 The definition of the structure <literal>MySequence</literal> would be
8691 <sect3 id="odr.explicit.tagging">
8692 <title>Explicit Tagging</title>
8694 Explicit tagging of constructed types is a little more complicated,
8695 since you are in effect adding a level of construction to the data.
8698 Assume the definition:
8701 MySequence ::= [10] IMPLICIT SEQUENCE {
8703 boolval BOOLEAN OPTIONAL
8707 Since the new type has an extra level of construction, two new functions
8708 are needed to encapsulate the base type:
8711 int odr_constructed_begin(ODR o, void *p, int class, int tag,
8714 int odr_constructed_end(ODR o);
8717 Assume that the IMPLICIT in the type definition above were replaced
8718 with EXPLICIT (or that the IMPLICIT keyword were simply deleted, which
8719 would be equivalent). The structure definition would look the same,
8720 but the function would look like this:
8723 int mySequence(ODR o, MySequence **p, int optional, const char *name)
8725 if (odr_constructed_begin(o, p, ODR_CONTEXT, 10, name) == 0)
8726 return optional && odr_ok(o);
8727 if (o->direction == ODR_DECODE)
8728 *p = odr_malloc(o, sizeof(**p));
8729 if (odr_sequence_begin(o, p, sizeof(**p), 0) == 0)
8731 *p = 0; /* this is almost certainly a protocol error */
8735 odr_integer(o, &(*p)->intval, 0, "intval") &&
8736 odr_bool(o, &(*p)->boolval, 1, "boolval") &&
8737 odr_sequence_end(o) &&
8738 odr_constructed_end(o);
8742 Notice that the interface here gets kind of nasty. The reason is
8743 simple: Explicitly tagged, constructed types are fairly rare in
8744 the protocols that we care about, so the
8745 esthetic annoyance (not to mention the dangers of a cluttered
8746 interface) is less than the time that would be required to develop a
8747 better interface. Nevertheless, it is far from satisfying, and it's a
8748 point that will be worked on in the future. One option for you would
8749 be to simply apply the <function>odr_explicit_tag()</function> macro to
8750 the first function, and not
8751 have to worry about <function>odr_constructed_*</function> yourself.
8752 Incidentally, as you might have guessed, the
8753 <function>odr_sequence_</function> functions are themselves
8754 implemented using the <function>/odr_constructed_</function> functions.
8758 <sect2 id="odr.sequence.of">
8759 <title>SEQUENCE OF</title>
8761 To handle sequences (arrays) of a specific type, the function
8764 int odr_sequence_of(ODR o, int (*fun)(ODR o, void *p, int optional),
8765 void *p, int *num, const char *name);
8768 The <literal>fun</literal> parameter is a pointer to the decoder/encoder
8769 function of the type. <literal>p</literal> is a pointer to an array of
8770 pointers to your type. <literal>num</literal> is the number of elements
8777 MyArray ::= SEQUENCE OF INTEGER
8780 The C representation might be
8783 typedef struct MyArray
8790 And the function might look like
8793 int myArray(ODR o, MyArray **p, int optional, const char *name)
8795 if (o->direction == ODR_DECODE)
8796 *p = odr_malloc(o, sizeof(**p));
8797 if (odr_sequence_of(o, odr_integer, &(*p)->elements,
8798 &(*p)->num_elements, name))
8801 return optional && odr_ok(o);
8805 <sect2 id="odr.choice.types">
8806 <title>CHOICE Types</title>
8808 The choice type is used fairly often in some ASN.1 definitions, so
8809 some work has gone into streamlining its interface.
8812 CHOICE types are handled by the function:
8815 int odr_choice(ODR o, Odr_arm arm[], void *p, void *whichp,
8819 The <literal>arm</literal> array is used to describe each of the possible
8820 types that the CHOICE type may assume. Internally in your application,
8821 the CHOICE type is represented as a discriminated union. That is, a
8822 C union accompanied by an integer (or enum) identifying the active
8824 <literal>whichp</literal> is a pointer to the union discriminator.
8825 When encoding, it is examined to determine the current type.
8826 When decoding, it is set to reference the type that was found in
8830 The Odr_arm type is defined thus:
8833 typedef struct odr_arm
8844 The interpretation of the fields are:
8848 <term>tagmode</term>
8849 <listitem><para>Either <literal>ODR_IMPLICIT</literal>,
8850 <literal>ODR_EXPLICIT</literal>, or <literal>ODR_NONE</literal> (-1)
8851 to mark no tagging.</para></listitem>
8855 <listitem><para>The value of the discriminator that corresponds to
8856 this CHOICE element. Typically, it will be a #defined constant, or
8857 an enum member.</para></listitem>
8861 <listitem><para>A pointer to a function that implements the type of
8862 the CHOICE member. It may be either a standard &odr; type or a type
8863 defined by yourself.</para></listitem>
8867 <listitem><para>Name of tag.</para></listitem>
8871 A handy way to prepare the array for use by the
8872 <function>odr_choice()</function> function is to
8873 define it as a static, initialized array in the beginning of your
8874 decoding/encoding function. Assume the type definition:
8877 MyChoice ::= CHOICE {
8879 tagged [99] IMPLICIT INTEGER,
8884 Your C type might look like
8887 typedef struct MyChoice
8904 And your function could look like this:
8907 int myChoice(ODR o, MyChoice **p, int optional, const char *name)
8909 static Odr_arm arm[] =
8911 {-1, -1, -1, MyChoice_untagged, odr_integer, "untagged"},
8912 {ODR_IMPLICIT, ODR_CONTEXT, 99, MyChoice_tagged, odr_integer,
8914 {-1, -1, -1, MyChoice_other, odr_boolean, "other"},
8918 if (o->direction == ODR_DECODE)
8919 *p = odr_malloc(o, sizeof(**p);
8921 return optional && odr_ok(o);
8923 if (odr_choice(o, arm, &(*p)->u, &(*p)->which), name)
8926 return optional && odr_ok(o);
8930 In some cases (say, a non-optional choice which is a member of a
8931 sequence), you can "embed" the union and its discriminator in the
8932 structure belonging to the enclosing type, and you won't need to
8933 fiddle with memory allocation to create a separate structure to
8934 wrap the discriminator and union.
8937 The corresponding function is somewhat nicer in the Sun XDR interface.
8938 Most of the complexity of this interface comes from the possibility of
8939 declaring sequence elements (including CHOICEs) optional.
8942 The ASN.1 specifications naturally requires that each member of a
8943 CHOICE have a distinct tag, so they can be told apart on decoding.
8944 Sometimes it can be useful to define a CHOICE that has multiple types
8945 that share the same tag. You'll need some other mechanism, perhaps
8946 keyed to the context of the CHOICE type. In effect, we would like to
8947 introduce a level of context-sensitiveness to our ASN.1 specification.
8948 When encoding an internal representation, we have no problem, as long
8949 as each CHOICE member has a distinct discriminator value. For
8950 decoding, we need a way to tell the choice function to look for a
8951 specific arm of the table. The function
8954 void odr_choice_bias(ODR o, int what);
8957 provides this functionality. When called, it leaves a notice for the next
8958 call to <function>odr_choice()</function> to be called on the decoding
8959 stream <literal>o</literal> that only the <literal>arm</literal> entry with
8960 a <literal>which</literal> field equal to <literal>what</literal>
8964 The most important application (perhaps the only one, really) is in
8965 the definition of application-specific EXTERNAL encoders/decoders
8966 which will automatically decode an ANY member given the direct or
8971 <sect1 id="odr.debugging">
8972 <title>Debugging</title>
8974 The protocol modules are suffering somewhat from a lack of diagnostic
8975 tools at the moment. Specifically ways to pretty-print PDUs that
8976 aren't recognized by the system. We'll include something to this end
8977 in a not-too-distant release. In the meantime, what we do when we get
8978 packages we don't understand is to compile the ODR module with
8979 <literal>ODR_DEBUG</literal> defined. This causes the module to dump tracing
8980 information as it processes data units. With this output and the
8981 protocol specification (Z39.50), it is generally fairly easy to see
8986 <chapter id="comstack">
8987 <title>The COMSTACK Module</title>
8988 <sect1 id="comstack.synopsis">
8989 <title>Synopsis (blocking mode)</title>
8990 <programlisting><![CDATA[
8993 int size = 0, length_incoming;
8994 char server_address_str[] = "localhost:9999";
8995 void *server_address_ip;
8998 char *protocol_package = "GET / HTTP/1.0\r\n\r\n";
8999 int protocol_package_length = strlen(protocol_package);
9001 stack = cs_create(tcpip_type, 1, PROTO_HTTP);
9003 perror("cs_create"); /* use perror() here since we have no stack yet */
9007 server_address_ip = cs_straddr(stack, server_address_str);
9008 if (!server_address_ip) {
9009 fprintf(stderr, "cs_straddr: address could not be resolved\n");
9013 status = cs_connect(stack, server_address_ip);
9015 fprintf(stderr, "cs_connect: %s\n", cs_strerror(stack));
9019 status = cs_rcvconnect(stack);
9021 fprintf(stderr, "cs_rcvconnect: %s\n", cs_strerror(stack));
9025 status = cs_put(stack, protocol_package, protocol_package_length);
9027 fprintf(stderr, "cs_put: %s\n", cs_strerror(stack));
9031 /* Now get a response */
9032 length_incoming = cs_get(stack, &buf, &size);
9033 if (!length_incoming) {
9034 fprintf(stderr, "Connection closed\n");
9036 } else if (length_incoming < 0) {
9037 fprintf(stderr, "cs_get: %s\n", cs_strerror(stack));
9042 fwrite(buf, length_incoming, 1, stdout);
9053 <sect1 id="comstack.introduction">
9054 <title>Introduction</title>
9057 subsystem provides a transparent interface to different types of transport
9058 stacks for the exchange of BER-encoded data and HTTP packets.
9059 At present, the RFC1729 method (BER over TCP/IP), local UNIX socket and an
9060 experimental SSL stack are supported, but others may be added in time.
9061 The philosophy of the
9062 module is to provide a simple interface by hiding unused options and
9063 facilities of the underlying libraries. This is always done at the risk
9064 of losing generality, and it may prove that the interface will need
9069 There hasn't been interest in the XTImOSI stack for some years.
9070 Therefore, it is no longer supported.
9074 The interface is implemented in such a fashion that only the
9075 sub-layers constructed to the transport methods that you wish to
9076 use in your application are linked in.
9079 You will note that even though simplicity was a goal in the design,
9080 the interface is still orders of magnitudes more complex than the
9081 transport systems found in many other packages. One reason is that
9082 the interface needs to support the somewhat different requirements of
9083 the different lower-layer communications stacks; another important
9084 reason is that the interface seeks to provide a more or less
9085 industrial-strength approach to asynchronous event-handling.
9086 When no function is allowed to block, things get more complex -
9087 particularly on the server side.
9088 We urge you to have a look at the demonstration client and server
9089 provided with the package. They are meant to be easily readable and
9090 instructive, while still being at least moderately useful.
9093 <sect1 id="comstack.common">
9094 <title>Common Functions</title>
9095 <sect2 id="comstack.managing.endpoints">
9096 <title>Managing Endpoints</title>
9098 COMSTACK cs_create(CS_TYPE type, int blocking, int protocol);
9101 Creates an instance of the protocol stack - a communications endpoint.
9102 The <literal>type</literal> parameter determines the mode
9103 of communication. At present the following values are supported:
9107 <term><literal>tcpip_type</literal></term>
9108 <listitem><para>TCP/IP (BER over TCP/IP or HTTP over TCP/IP)
9112 <term><literal>ssl_type</literal></term>
9113 <listitem><para>Secure Socket Layer (SSL). This COMSTACK
9114 is experimental and is not fully implemented. If
9115 HTTP is used, this effectively is HTTPS.
9119 <term><literal>unix_type</literal></term>
9120 <listitem><para>Unix socket (unix only). Local Transfer via
9121 file socket. See <citerefentry><refentrytitle>unix</refentrytitle>
9122 <manvolnum>7</manvolnum></citerefentry>.
9127 The <function>cs_create</function> function returns a null-pointer
9128 if a system error occurs.
9129 The <literal>blocking</literal> parameter should be one if
9130 you wish the association to operate in blocking mode, zero otherwise.
9131 The <literal>protocol</literal> field should be
9132 <literal>PROTO_Z3950</literal> or <literal>PROTO_HTTP</literal>.
9133 Protocol <literal>PROTO_SR</literal> is no longer supported.
9136 void cs_close(COMSTACK handle);
9139 Closes the connection (as elegantly as the lower layers will permit),
9140 and releases the resources pointed to by the
9141 <literal>handle</literal>
9143 <literal>handle</literal>
9144 should not be referenced again after this call.
9148 We really need a soft disconnect, don't we?
9152 <sect2 id="comstack.data.exchange">
9153 <title>Data Exchange</title>
9155 int cs_put(COMSTACK handle, char *buf, int len);
9158 Sends <literal>buf</literal> down the wire.
9159 In blocking mode, this function will return only when a full buffer has
9160 been written, or an error has occurred. In nonblocking mode, it's
9161 possible that the function will be unable to send the full buffer
9162 at once, which will be indicated by a return value of 1.
9163 The function will keep track of the number of octets already written; you
9164 should call it repeatedly with the same values of <literal>buf</literal>
9165 and <literal>len</literal>, until the buffer has been transmitted.
9166 When a full buffer has been sent, the function will return 0 for
9167 success. -1 indicates an error condition (see below).
9170 int cs_get(COMSTACK handle, char **buf, int *size);
9173 Receives a PDU or HTTP Response from the peer. Returns the number of
9175 In nonblocking mode, it is possible that not all of the packet can be
9176 read at once. In this case, the function returns 1. To simplify the
9177 interface, the function is
9178 responsible for managing the size of the buffer. It will be reallocated
9179 if necessary to contain large packages, and will sometimes be moved
9180 around internally by the subsystem when partial packages are read. Before
9182 <function>cs_get</function>
9183 for the fist time, the buffer can be initialized to the null pointer,
9184 and the length should also be set to 0 - cs_get will perform a
9185 <function>malloc(2)</function>
9186 on the buffer for you. When a full buffer has been read, the size of
9187 the package is returned (which will always be greater than 1). -1
9188 indicates an error condition.
9191 See also the <function>cs_more()</function> function below.
9194 int cs_more(COMSTACK handle);
9197 The <function>cs_more()</function> function should be used in conjunction
9198 with <function>cs_get</function> and
9199 <function>select(2)</function>.
9200 The <function>cs_get()</function> function will sometimes
9201 (notably in the TCP/IP mode) read more than a single protocol package
9202 off the network. When this happens, the extra package is stored
9203 by the subsystem. After calling <function>cs_get()</function>, and before
9204 waiting for more input, You should always call
9205 <function>cs_more()</function>
9206 to check if there's a full protocol package already read. If
9207 <function>cs_more()</function>
9209 <function>cs_get()</function>
9210 can be used to immediately fetch the new package. For the
9212 subsystem, the function should always return 0, but if you want your
9213 stuff to be protocol independent, you should use it.
9217 The <function>cs_more()</function>
9218 function is required because the RFC1729-method
9219 does not provide a way of separating individual PDUs, short of
9220 partially decoding the BER. Some other implementations will carefully
9221 nibble at the packet by calling
9222 <function>read(2)</function>
9223 several times. This was felt to be too inefficient (or at least
9224 clumsy) - hence the call for this extra function.
9228 int cs_look(COMSTACK handle);
9231 This function is useful when you're operating in nonblocking
9233 <function>select(2)</function>
9234 tells you there's something happening on the line. It returns one of
9235 the following values:
9239 <term>CS_NONE</term>
9241 No event is pending. The data found on the line was not a
9246 <term>CS_CONNECT</term>
9248 A response to your connect request has been received. Call
9249 <function>cs_rcvconnect</function>
9250 to process the event and to finalize the connection establishment.
9254 <term>CS_DISCON</term>
9256 The other side has closed the connection (or maybe sent a disconnect
9257 request - but do we care? Maybe later). Call
9258 <function>cs_close</function> to close your end of the association
9263 <term>CS_LISTEN</term>
9265 A connect request has been received.
9266 Call <function>cs_listen</function> to process the event.
9270 <term>CS_DATA</term>
9272 There's data to be found on the line.
9273 Call <function>cs_get</function> to get it.
9279 You should be aware that even if
9280 <function>cs_look()</function>
9281 tells you that there's an event event pending, the corresponding
9282 function may still return and tell you there was nothing to be found.
9283 This means that only part of a package was available for reading. The
9284 same event will show up again, when more data has arrived.
9288 int cs_fileno(COMSTACK h);
9291 Returns the file descriptor of the association. Use this when
9292 file-level operations on the endpoint are required
9293 (<function>select(2)</function> operations, specifically).
9297 <sect1 id="comstack.client">
9298 <title>Client Side</title>
9300 int cs_connect(COMSTACK handle, void *address);
9303 Initiate a connection with the target at <literal>address</literal>
9304 (more on addresses below). The function will return 0 on success, and 1 if
9305 the operation does not complete immediately (this will only
9306 happen on a nonblocking endpoint). In this case, use
9307 <function>cs_rcvconnect</function> to complete the operation,
9308 when <function>select(2)</function> or <function>poll(2)</function>
9309 reports input pending on the association.
9312 int cs_rcvconnect(COMSTACK handle);
9315 Complete a connect operation initiated by <function>cs_connect()</function>.
9316 It will return 0 on success; 1 if the operation has not yet completed (in
9317 this case, call the function again later); -1 if an error has occurred.
9320 <sect1 id="comstack.server">
9321 <title>Server Side</title>
9323 To establish a server under the <application>inetd</application>
9327 COMSTACK cs_createbysocket(int socket, CS_TYPE type, int blocking,
9331 The <literal>socket</literal> parameter is an established socket (when
9332 your application is invoked from <application>inetd</application>, the
9333 socket will typically be 0.
9334 The following parameters are identical to the ones for
9335 <function>cs_create</function>.
9338 int cs_bind(COMSTACK handle, void *address, int mode)
9341 Binds a local address to the endpoint. Read about addresses below. The
9342 <literal>mode</literal> parameter should be either
9343 <literal>CS_CLIENT</literal> or <literal>CS_SERVER</literal>.
9346 int cs_listen(COMSTACK handle, char *addr, int *addrlen);
9349 Call this to process incoming events on an endpoint that has been
9350 bound in listening mode. It will return 0 to indicate that the connect
9351 request has been received, 1 to signal a partial reception, and -1 to
9352 indicate an error condition.
9355 COMSTACK cs_accept(COMSTACK handle);
9358 This finalizes the server-side association establishment, after
9359 cs_listen has completed successfully. It returns a new connection
9360 endpoint, which represents the new association. The application will
9361 typically wish to fork off a process to handle the association at this
9362 point, and continue listen for new connections on the old
9363 <literal>handle</literal>.
9366 You can use the call
9369 const char *cs_addrstr(COMSTACK);
9372 on an established connection to retrieve the host-name of the remote host.
9376 You may need to use this function with some care if your
9377 name server service is slow or unreliable
9381 <sect1 id="comstack.addresses">
9382 <title>Addresses</title>
9384 The low-level format of the addresses are different depending on the
9385 mode of communication you have chosen. A function is provided by each
9386 of the lower layers to map a user-friendly string-form address to the
9387 binary form required by the lower layers.
9390 void *cs_straddr(COMSTACK handle, const char *str);
9393 The format for TCP/IP and SSL addresses is:
9396 <host> [ ':' <portnum> ]
9399 The <literal>hostname</literal> can be either a domain name or an
9400 IP address. The port number, if omitted, defaults to 210.
9403 For TCP/IP and SSL, the special hostnames <literal>@</literal>,
9404 maps to <literal>IN6ADDR_ANY_INIT</literal> with
9405 IPV4 binding as well (bindv6only=0),
9406 The special hostname <literal>@4</literal> binds to
9407 <literal>INADDR_ANY</literal> (IPV4 only listener).
9408 The special hostname <literal>@6</literal> binds to
9409 <literal>IN6ADDR_ANY_INIT</literal> with bindv6only=1 (IPV6 only listener).
9412 For UNIX sockets, the format of an address is the socket filename.
9415 When a connection has been established, you can use
9418 const char *cs_addrstr(COMSTACK h);
9421 to retrieve the host name of the peer system. The function returns
9422 a pointer to a static area, which is overwritten on the next call
9426 A fairly recent addition to the &comstack; module is the utility
9430 COMSTACK cs_create_host (const char *str, int blocking, void **vp);
9433 which is just a wrapper for <function>cs_create</function> and
9434 <function>cs_straddr</function>. The <parameter>str</parameter>
9435 is similar to that described for <function>cs_straddr</function>
9436 but with a prefix denoting the &comstack; type. Prefixes supported
9437 are <literal>tcp:</literal>, <literal>unix:</literal> and
9438 <literal>ssl:</literal> for TCP/IP, UNIX and SSL respectively.
9439 If no prefix is given, then TCP/IP is used.
9440 The <parameter>blocking</parameter> is passed to
9441 function <function>cs_create</function>. The third parameter
9442 <parameter>vp</parameter> is a pointer to &comstack; stack type
9444 Parameter <parameter>vp</parameter> is reserved for future use.
9445 Set it to <literal>NULL</literal>.
9448 <sect1 id="comstack.ssl">
9452 void *cs_get_ssl(COMSTACK cs);
9454 Returns the SSL handle, <literal>SSL *</literal> for comstack. If comstack
9455 is not of type SSL, NULL is returned.
9459 int cs_set_ssl_ctx(COMSTACK cs, void *ctx);
9461 Sets SSL context for comstack. The parameter is expected to be of type
9462 <literal>SSL_CTX *</literal>. This function should be called just
9463 after comstack has been created (before connect, bind, etc).
9464 This function returns 1 for success; 0 for failure.
9468 int cs_set_ssl_certificate_file(COMSTACK cs, const char *fname);
9470 Sets SSL certificate for comstack as a PEM file. This function
9471 returns 1 for success; 0 for failure.
9475 int cs_get_ssl_peer_certificate_x509(COMSTACK cs, char **buf, int *len);
9477 This function returns the peer certificate. If successful,
9478 <literal>*buf</literal> and <literal>*len</literal> holds
9479 X509 buffer and length respectively. Buffer should be freed
9480 with <literal>xfree</literal>. This function returns 1 for success;
9484 <sect1 id="comstack.diagnostics">
9485 <title>Diagnostics</title>
9487 All functions return -1 if an error occurs. Typically, the functions
9488 will return 0 on success, but the data exchange functions
9489 (<function>cs_get</function>, <function>cs_put</function>,
9490 <function>cs_more</function>) follow special rules. Consult their
9494 The error code for the COMSTACK can be retrieved using C macro
9495 <function>cs_errno</function> which will return one
9496 of the error codes <literal>CSYSERR</literal>,
9497 <literal>CSOUTSTATE</literal>,
9498 <literal>CSNODATA</literal>, ...
9501 int cs_errno(COMSTACK handle);
9504 You can the textual representation of the error code
9505 by using <function>cs_errmsg</function> - which
9506 works like <function>strerror(3)</function>
9509 const char *cs_errmsg(int n);
9512 It is also possible to get straight to the textual represenataion
9513 without the error code by using
9514 <function>cs_strerror</function>.
9517 const char *cs_strerror(COMSTACK h);
9520 <sect1 id="comstack.summary">
9521 <title>Summary and Synopsis</title>
9523 #include <yaz/comstack.h>
9525 #include <yaz/tcpip.h> /* this is for TCP/IP and SSL support */
9526 #include <yaz/unix.h> /* this is for UNIX socket support */
9528 COMSTACK cs_create(CS_TYPE type, int blocking, int protocol);
9530 COMSTACK cs_createbysocket(int s, CS_TYPE type, int blocking,
9532 COMSTACK cs_create_host(const char *str, int blocking,
9535 int cs_bind(COMSTACK handle, int mode);
9537 int cs_connect(COMSTACK handle, void *address);
9539 int cs_rcvconnect(COMSTACK handle);
9541 int cs_listen(COMSTACK handle);
9543 COMSTACK cs_accept(COMSTACK handle);
9545 int cs_put(COMSTACK handle, char *buf, int len);
9547 int cs_get(COMSTACK handle, char **buf, int *size);
9549 int cs_more(COMSTACK handle);
9551 void cs_close(COMSTACK handle);
9553 int cs_look(COMSTACK handle);
9555 void *cs_straddr(COMSTACK handle, const char *str);
9557 const char *cs_addrstr(COMSTACK h);
9562 <chapter id="future">
9563 <title>Future Directions</title>
9565 We have a new and better version of the front-end server on the drawing
9566 board. Resources and external commitments will govern when we'll be
9567 able to do something real with it. Features should include greater
9568 flexibility, greater support for access/resource control, and easy
9569 support for Explain (possibly with Zebra as an extra database engine).
9572 &yaz; is a BER toolkit and as such should support all protocols
9573 out there based on that. We'd like to see running ILL applications.
9574 It shouldn't be that hard. Another thing that would be interesting is
9575 LDAP. Maybe a generic framework for doing IR using both LDAP and
9576 Z39.50 transparently.
9579 The SOAP implementation is incomplete. In the future we hope
9580 to add more features to it. Perhaps make a WSDL/XML Schema compiler.
9581 The authors of libxml2 are already working on XML Schema / RelaxNG
9582 compilers so this may not be too hard.
9585 It would be neat to have a proper module mechanism for the Generic
9586 Frontend Server so that backend would be dynamically
9587 loaded (as shared objects / DLLs).
9590 Other than that, &yaz; generally moves in the directions which appear to
9591 make the most people happy (including ourselves, as prime users of the
9592 software). If there's something you'd like to see in here, then drop
9593 us a note and let's see what we can come up with.
9596 <reference id="reference">
9597 <title>Reference</title>
9598 <partintro id="reference-introduction">
9600 The material in this chapter is drawn directly from the individual
9606 <appendix id="list-oids">
9607 <title>List of Object Identifiers</title>
9609 These is a list of object identifiers that are built into YAZ.
9613 <appendix id="bib1-diagnostics">
9614 <title>Bib-1 diagnostics</title>
9616 List of Bib-1 diagnostics that are known to YAZ.
9620 <appendix id="sru-diagnostics">
9621 <title>SRU diagnostics</title>
9623 List of SRU diagnostics that are known to YAZ.
9627 <appendix id="license">
9628 <title>License</title>
9629 <sect1 id="license.indexdata">
9630 <title>Index Data Copyright</title>
9632 Copyright © ©right-year; Index Data.
9635 All rights reserved.
9638 Redistribution and use in source and binary forms, with or without
9639 modification, are permitted provided that the following conditions are met:
9644 Redistributions of source code must retain the above copyright
9645 notice, this list of conditions and the following disclaimer.
9650 Redistributions in binary form must reproduce the above copyright
9651 notice, this list of conditions and the following disclaimer in the
9652 documentation and/or other materials provided with the distribution.
9657 Neither the name of Index Data nor the names of its contributors
9658 may be used to endorse or promote products derived from this
9659 software without specific prior written permission.
9664 THIS SOFTWARE IS PROVIDED BY INDEX DATA ``AS IS'' AND ANY
9665 EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
9666 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
9667 DISCLAIMED. IN NO EVENT SHALL INDEX DATA BE LIABLE FOR
9668 ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
9669 DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
9670 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
9671 CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
9672 LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
9673 OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
9678 <appendix id="indexdata">
9679 <title>About Index Data</title>
9681 Index Data is a consulting and software-development enterprise that
9682 specializes in library and information management systems. Our
9683 interests and expertise span a broad range of related fields, and one
9684 of our primary, long-term objectives is the development of a powerful
9685 information management
9686 system with open network interfaces and hyper-media capabilities.
9688 We make this software available free of charge, on a fairly unrestrictive
9689 license; as a service to the networking community, and to further the
9690 development of quality software for open network communication.
9692 We'll be happy to answer questions about the software, and about ourselves
9698 <street>Amagerfælledvej 56</street>
9699 <postcode>2300 Copenhagen S</postcode>
9700 <country>Denmark</country>
9701 Email <email>info@indexdata.dk</email>
9705 The Hacker's Jargon File has the following to say about the
9707 prefix "YA" in the name of a software product.
9711 Yet Another. adj. 1. Of your own work: A
9712 humorous allusion often used in titles to acknowledge that the
9713 topic is not original, though the content is. As in "Yet Another
9714 AI Group" or "Yet Another Simulated Annealing Algorithm".
9716 others' work: Describes something of which there are already far
9721 <appendix id="credits">
9722 <title>Credits</title>
9724 This appendix lists individuals that have contributed in the development
9725 of &yaz;. Some have contributed with code, while others have provided bug
9726 fixes or suggestions. If we're missing somebody, of if you, for
9727 whatever reason, don't like to be listed here, let us know.
9737 Morten Bøgeskov
9758 Mads Bondo Dydensborg
9767 Morten Garkier Hendriksen
9824 Tom André Øverland
9830 <!-- Keep this comment at the end of the file
9833 nxml-child-indent: 1