2 * Copyright (c) 1995, the EUROPAGATE consortium (see below).
4 * The EUROPAGATE consortium members are:
6 * University College Dublin
7 * Danmarks Teknologiske Videnscenter
8 * An Chomhairle Leabharlanna
9 * Consejo Superior de Investigaciones Cientificas
11 * Permission to use, copy, modify, distribute, and sell this software and
12 * its documentation, in whole or in part, for any purpose, is hereby granted,
15 * 1. This copyright and permission notice appear in all copies of the
16 * software and its documentation. Notices of copyright or attribution
17 * which appear at the beginning of any file must remain unchanged.
19 * 2. The names of EUROPAGATE or the project partners may not be used to
20 * endorse or promote products derived from this software without specific
21 * prior written permission.
23 * 3. Users of this software (implementors and gateway operators) agree to
24 * inform the EUROPAGATE consortium of their use of the software. This
25 * information will be used to evaluate the EUROPAGATE project and the
26 * software, and to plan further developments. The consortium may use
27 * the information in later publications.
29 * 4. Users of this software agree to make their best efforts, when
30 * documenting their use of the software, to acknowledge the EUROPAGATE
31 * consortium, and the role played by the software in their work.
33 * THIS SOFTWARE IS PROVIDED "AS IS" AND WITHOUT WARRANTY OF ANY KIND,
34 * EXPRESS, IMPLIED, OR OTHERWISE, INCLUDING WITHOUT LIMITATION, ANY
35 * WARRANTY OF MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE.
36 * IN NO EVENT SHALL THE EUROPAGATE CONSORTIUM OR ITS MEMBERS BE LIABLE
37 * FOR ANY SPECIAL, INCIDENTAL, INDIRECT OR CONSEQUENTIAL DAMAGES OF
38 * ANY KIND, OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA
39 * OR PROFITS, WHETHER OR NOT ADVISED OF THE POSSIBILITY OF DAMAGE, AND
40 * ON ANY THEORY OF LIABILITY, ARISING OUT OF OR IN CONNECTION WITH THE
41 * USE OR PERFORMANCE OF THIS SOFTWARE.
47 * Z39.50 API for the Email gateway - YAZ version
50 * Revision 1.4 1995/07/28 10:51:34 adam
51 * Bug fix: multiple databases weren't specified correctly.
53 * Revision 1.3 1995/07/20 08:18:15 adam
54 * Bug fix: Multiple databases are separated by commas and NOT by space.
56 * Revision 1.2 1995/07/05 11:08:33 adam
57 * Bug fix in init request.
59 * Revision 1.1 1995/07/03 08:21:31 adam
60 * Yaz layer moved to new sub directory. zaccess aligned with new
63 * Revision 1.10 1995/05/16 09:41:46 adam
64 * LICENSE. Uses new versions of odr_{set,get}buf.
66 * Revision 1.9 1995/05/03 10:15:43 quinn
67 * Fixed bug in the get_record loop - crashed when diagrec was received.
69 * Revision 1.8 1995/04/28 14:18:38 quinn
70 * *** empty log message ***
72 * Revision 1.7 1995/04/21 16:29:32 quinn
75 * Revision 1.6 1995/04/21 12:58:36 adam
78 * Revision 1.5 1995/04/20 15:25:32 quinn
81 * Revision 1.4 1995/04/19 16:02:28 adam
84 * Revision 1.3 1995/04/19 12:55:15 quinn
87 * Revision 1.2 1995/04/19 09:24:02 quinn
88 * Fixed bug in zass_open - variable initialized after use
90 * Revision 1.1 1995/04/17 11:26:53 quinn
91 * Added YAZ version of zaccess
96 * Interface to the YAZ Z39.50 toolkit.
105 #include <comstack.h>
115 struct zass /* Z-assoc */
117 COMSTACK ass; /* comstack association handle */
120 int fd; /* low-level socket (for select only) */
123 int preferredmessagesize;
128 static Z_APDU *get_apdu(struct zass *z, int *complete)
133 if ((res = cs_get(z->ass, &z->inbuf, &z->inbuflen)) <= 0)
135 gw_log(GW_LOG_WARN, ZASS_TYPE, "cs_get failed");
146 odr_reset(z->decode);
147 odr_setbuf(z->decode, z->inbuf, res, 0);
148 if (!z_APDU(z->decode, &ap, 0))
150 gw_log(GW_LOG_WARN, ZASS_TYPE, "decode: %s",
151 odr_errlist[odr_geterror(z->decode)]);
161 static int send_apdu(struct zass *z, Z_APDU *a)
166 if (!z_APDU(z->encode, &a, 0))
168 gw_log(GW_LOG_FATAL, ZASS_TYPE, "encoding initreq");
171 buf = odr_getbuf(z->encode, &len, NULL);
172 if (cs_put(z->ass, buf, len) < 0)
174 gw_log(GW_LOG_FATAL, ZASS_TYPE, "cs_put");
177 odr_reset(z->encode); /* release odr_allocated structures */
181 static int send_initreq(struct zass *p, char *auth)
186 Z_IdAuthentication idauth;
188 apdu = zget_APDU (p->encode, Z_APDU_initRequest);
189 req = apdu->u.initRequest;
190 req->preferredMessageSize = &p->preferredmessagesize;
191 req->maximumRecordSize = &p->maxrecordsize;
193 ODR_MASK_SET(req->options, Z_Options_search);
194 ODR_MASK_SET(req->options, Z_Options_present);
195 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
197 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
198 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
202 req->idAuthentication = &idauth;
203 idauth.which = Z_IdAuthentication_open;
204 idauth.u.open = auth;
207 req->idAuthentication = 0;
208 sprintf(name, "%s (YAZ protocol layer)", ZASS_NAME);
209 req->implementationName = name;
210 req->implementationVersion = ZASS_VERSION;
211 if (send_apdu(p, apdu) < 0)
216 int zass_fileno(ZASS a)
221 int zass_openresult(ZASS p, int *complete)
226 if (!(ap = get_apdu(p, complete)))
228 if (ap->which != Z_APDU_initResponse)
230 gw_log(GW_LOG_WARN, ZASS_TYPE, "bad APDU");
233 res = ap->u.initResponse;
236 gw_log(GW_LOG_WARN, ZASS_TYPE, "Negative result on initres");
239 p->preferredmessagesize = *res->preferredMessageSize;
240 p->maxrecordsize = *res->maximumRecordSize;
241 if (res->implementationId)
242 gw_log(GW_LOG_NOTICE, ZASS_TYPE, "imp. ID : %s",
243 res->implementationId);
244 if (res->implementationName)
245 gw_log(GW_LOG_NOTICE, ZASS_TYPE, "imp. ID : %s",
246 res->implementationName);
247 if (res->implementationVersion)
248 gw_log(GW_LOG_NOTICE, ZASS_TYPE, "imp. ID : %s",
249 res->implementationVersion);
250 gw_log(ZASS_DEBUG, ZASS_TYPE, "Initialized ok");
254 ZASS zass_open(char *host, int port, int *complete, char *auth)
260 if (!(p = malloc(sizeof(*p))))
262 gw_log(GW_LOG_FATAL|GW_LOG_ERRNO, ZASS_TYPE, "malloc");
272 if (!(p->encode = odr_createmem(ODR_ENCODE)) ||
273 !(p->decode = odr_createmem(ODR_DECODE)))
275 gw_log(GW_LOG_FATAL|GW_LOG_ERRNO, ZASS_TYPE, "odr_createmem");
278 p->maxrecordsize = ZASS_MAXRECORDSIZE;
279 p->preferredmessagesize = ZASS_PREFERREDMESSAGESIZE;
280 if (!(p->ass = cs_create(tcpip_type, 1, CS_Z3950)))
282 gw_log(GW_LOG_FATAL|GW_LOG_ERRNO, ZASS_TYPE, "cs_create");
287 sprintf(addstr, "%s:%d", host, port);
288 if (!(address = tcpip_strtoaddr(addstr)))
290 gw_log(GW_LOG_FATAL, ZASS_TYPE, "failed to resolve %s", addstr);
293 p->fd = cs_fileno(p->ass);
294 gw_log(ZASS_DEBUG, ZASS_TYPE, "Connecting to %s", addstr);
295 if (cs_connect(p->ass, address) < 0)
297 gw_log(GW_LOG_FATAL, ZASS_TYPE, "Failed to connect to %s", addstr);
300 gw_log(ZASS_DEBUG, ZASS_TYPE, "connected ok... initializing");
301 if (send_initreq(p, auth) < 0)
303 gw_log(GW_LOG_FATAL, ZASS_TYPE, "Failed to send init");
311 if (zass_openresult(p, complete) < 0)
313 return p; /* all done */
317 * Convert the egate (ccl2rpn) version of RPN to YAZ RPN.
319 static Z_RPNStructure *rpn2rpn(ODR o, struct ccl_rpn_node *q)
321 Z_RPNStructure *r = odr_malloc(o, sizeof(*r));
322 Z_AttributesPlusTerm *t;
323 struct ccl_rpn_attr *i;
325 static int op[] = { Z_Operator_and, Z_Operator_or, Z_Operator_and_not };
330 r->which = Z_RPNStructure_simple;
331 r->u.simple = odr_malloc(o, sizeof(Z_Operand));
332 r->u.simple->which = Z_Operand_APT;
333 r->u.simple->u.attributesPlusTerm = t = odr_malloc(o, sizeof(*t));
334 t->term = odr_malloc(o, sizeof(Z_Term));
335 t->term->which = Z_Term_general;
336 t->term->u.general = odr_malloc(o, sizeof(Odr_oct));
337 t->term->u.general->len = t->term->u.general->size =
339 t->term->u.general->buf = odr_malloc(o, t->term->u.general->size);
340 memcpy(t->term->u.general->buf, q->u.t.term,
341 t->term->u.general->len);
342 t->num_attributes = 0;
343 t->attributeList = odr_malloc(o, sizeof(Z_AttributeElement*) * 100);
344 for (i = q->u.t.attr_list; i && t->num_attributes < 100;
347 Z_AttributeElement *a;
349 t->attributeList[t->num_attributes++] = a =
350 odr_malloc(o, sizeof(*a));
351 a->attributeType = odr_malloc(o, sizeof(int));
352 *a->attributeType = i->type;
355 a->which = Z_AttributeValue_numeric;
356 a->value.numeric = odr_malloc(o, sizeof(*a->value.numeric));
357 *a->value.numeric = i->value;
359 a->attributeValue = odr_malloc(o, sizeof(*a->attributeValue));
360 *a->attributeValue = i->value;
365 r->which = Z_RPNStructure_simple;
366 r->u.simple = odr_malloc(o, sizeof(Z_Operand));
367 r->u.simple->which = Z_Operand_resultSetId;
368 r->u.simple->u.resultSetId = odr_malloc(o, len =
369 strlen(q->u.setname) + 1);
370 memcpy(r->u.simple->u.resultSetId, q->u.setname, len);
372 case CCL_RPN_AND: case CCL_RPN_OR: case CCL_RPN_NOT:
373 r->which = Z_RPNStructure_complex;
374 r->u.complex = odr_malloc(o, sizeof(Z_Complex));
375 if (!(r->u.complex->s1 = rpn2rpn(o, q->u.p[0])) ||
376 !(r->u.complex->s2 = rpn2rpn(o, q->u.p[1])))
378 r->u.complex->operator = odr_malloc(o, sizeof(Z_Operator));
379 r->u.complex->operator->which = op[q->kind];
380 r->u.complex->operator->u.and = "";
383 gw_log(GW_LOG_FATAL, ZASS_TYPE, "Bad operator in RPN");
388 const struct zass_searchent *zass_searchresult(ZASS a, int *complete)
390 static struct zass_searchent r;
392 Z_SearchResponse *res;
394 if (!(apdu = get_apdu(a, complete)))
396 if (apdu->which != Z_APDU_searchResponse)
398 gw_log(GW_LOG_FATAL, ZASS_TYPE, "Expected searchresponse, got #%d",
402 res = apdu->u.searchResponse;
403 r.status = *res->searchStatus;
404 r.num = *res->resultCount;
405 r.status = res->resultSetStatus ? *res->resultSetStatus : 0;
410 if (res->records->which != Z_Records_NSD)
411 gw_log(GW_LOG_WARN, ZASS_TYPE, "Unexpected record types in SchR");
415 Z_DiagRec *dr = res->records->u.nonSurrogateDiagnostic;
418 if (dr->which != Z_DiagRec_defaultFormat ||
419 !(id = oid_getentbyoid
420 (dr->u.defaultFormat->diagnosticSetId)) ||
421 id->class != CLASS_DIAGSET ||
422 id->value != VAL_BIB1)
423 gw_log(GW_LOG_WARN, ZASS_TYPE,
424 "Missing or unknown diagset - ignoring error!");
427 r.errcode = *dr->u.defaultFormat->condition;
428 if (dr->u.defaultFormat->addinfo)
430 strncpy(r.errstring, dr->u.defaultFormat->addinfo, 512);
431 r.errstring[511] = '\0';
435 if (!(id = oid_getentbyoid(dr->diagnosticSetId)) ||
436 id->class != CLASS_DIAGSET || id->value != VAL_BIB1)
437 gw_log(GW_LOG_WARN, ZASS_TYPE,
438 "Missing or unknown diagset - ignoring error!");
441 r.errcode = *dr->condition;
444 strncpy(r.errstring, dr->addinfo, 512);
445 r.errstring[511] = '\0';
454 const struct zass_searchent *zass_search(ZASS a, struct ccl_rpn_node *query,
455 char *resname, char *databases, int *complete)
460 Z_SearchRequest *req;
462 int smallSetUpperBound = 0;
463 int largeSetLowerBound = 1;
464 int mediumSetPresentNumber = 0;
465 int replaceIndicator = 1;
468 apdu = zget_APDU (a->encode, Z_APDU_searchRequest);
469 req = apdu->u.searchRequest;
471 req->smallSetUpperBound = &smallSetUpperBound;
472 req->largeSetLowerBound = &largeSetLowerBound;
473 req->mediumSetPresentNumber = &mediumSetPresentNumber;
474 req->replaceIndicator = &replaceIndicator;
475 req->resultSetName = resname;
476 req->num_databaseNames = 0;
477 req->databaseNames = datab;
478 while (*databases && req->num_databaseNames < 100)
483 while (*p && !isspace(*p) && *p != ',')
491 req->databaseNames[req->num_databaseNames] = odr_malloc(a->encode,
492 (p - databases) + 1);
493 memcpy(req->databaseNames[req->num_databaseNames], databases,
495 req->databaseNames[req->num_databaseNames++][p-databases] = '\0';
497 databases = p + more;
500 q.which = Z_Query_type_1;
502 bib1.proto = PROTO_Z3950;
503 bib1.class = CLASS_ATTSET;
504 bib1.value = VAL_BIB1;
505 rpnq.attributeSetId = oid_getoidbyent(&bib1);
509 if (!(rpnq.RPNStructure = rpn2rpn(a->encode, query)))
511 if (send_apdu(a, apdu) < 0)
519 return zass_searchresult(a, complete);
523 * Triple indirection - that's kinda heavy. We'll fix it later.
524 * There are worse things around, though. Like ZDist.
526 void get_diagrec(zass_record ***p, Z_DiagRec *r)
528 **p = malloc(sizeof(***p));
531 (**p)->errstring[0] = '\0';
532 if (r->which == Z_DiagRec_defaultFormat)
534 (**p)->errcode = *r->u.defaultFormat->condition;
535 if (r->u.defaultFormat->addinfo)
537 strncpy((**p)->errstring, r->u.defaultFormat->addinfo, 200);
538 (**p)->errstring[200] = 0;
544 (**p)->errcode = *r->condition;
547 strncpy((**p)->errstring, r->addinfo, 200);
548 (**p)->errstring[200] = 0;
551 (**p)->errstring[0] = '\0';
553 (**p)->which = ZASS_REC_DIAG;
557 void get_responserecords(zass_record ***p, Z_NamePlusRecordList *recs)
561 for (i = 0; i < recs->num_records; i++)
563 Z_NamePlusRecord *record;
565 record = recs->records[i];
566 if (record->which == Z_NamePlusRecord_surrogateDiagnostic)
567 get_diagrec(p, record->u.surrogateDiagnostic);
570 Z_DatabaseRecord *r = record->u.databaseRecord;
573 **p = malloc(sizeof(***p));
576 if (!(recform = oid_getentbyoid(r->direct_reference)) ||
577 recform->class != CLASS_RECSYN)
579 gw_log(GW_LOG_WARN, ZASS_TYPE, "Unknown or bad record syntax");
580 (**p)->which = ZASS_REC_UNKNOWN;
583 switch (recform->value)
585 case VAL_USMARC: (**p)->which = ZASS_REC_USMARC; break;
587 gw_log(GW_LOG_WARN, ZASS_TYPE, "Unknown recsyn");
588 (**p)->which = ZASS_REC_UNKNOWN;
590 if (r->which != ODR_EXTERNAL_octet)
592 gw_log(GW_LOG_WARN, ZASS_TYPE, "Record wasn't octet-aligned");
597 if (!((**p)->record = malloc(r->u.octet_aligned->len + 1)))
599 gw_log(GW_LOG_FATAL, ZASS_TYPE, "malloc");
602 memcpy((**p)->record, r->u.octet_aligned->buf,
603 r->u.octet_aligned->len);
604 (**p)->record[r->u.octet_aligned->len] = '\0';
605 gw_log(ZASS_DEBUG, ZASS_TYPE, "Got a record of %d bytes",
606 r->u.octet_aligned->len);
613 static void zass_records_free(zass_record *p)
617 static int send_present(ZASS a, char *name, int start, int num,
621 Z_PresentRequest *req;
626 apdu = zget_APDU (a->encode, Z_APDU_presentRequest);
627 req = apdu->u.presentRequest;
629 req->resultSetId = name;
630 req->resultSetStartPoint = &start;
631 req->numberOfRecordsRequested = #
633 recsyn.proto = PROTO_Z3950;
634 recsyn.class = CLASS_RECSYN;
636 req->preferredRecordSyntax = oid_getoidbyent(&recsyn);
638 req->preferredRecordSyntax = 0;
640 return send_apdu(a, apdu);
644 * Note that 1== first record.
645 * TODO: make this baby operate in nonblocking mode, too.
647 const struct zass_presentent *zass_present(ZASS a, char *resname, int start,
648 int num, int *complete)
650 static struct zass_presentent r;
651 zass_record **rec = &r.records;
658 zass_records_free(r.records);
664 Z_PresentResponse *res;
666 gw_log(ZASS_DEBUG, ZASS_TYPE,
667 "Fetching %d records from # %d", num - r.num, start);
668 if (send_present(a, resname, start, num - r.num, VAL_USMARC) < 0)
670 if (!(apdu = get_apdu(a, complete)))
676 if (apdu->which != Z_APDU_presentResponse)
678 gw_log(GW_LOG_FATAL, ZASS_TYPE, "Expected presentresponse, got #%d",
682 res = apdu->u.presentResponse;
683 r.presentstatus = *res->presentStatus;
684 r.num += *res->numberOfRecordsReturned;
685 if (*res->numberOfRecordsReturned == 0)
687 gw_log(GW_LOG_WARN, ZASS_TYPE, "Got 0 records from target");
690 r.nextpos = *res->nextResultSetPosition;
692 switch (res->records->which)
694 case Z_Records_DBOSD:
695 get_responserecords(&rec,
696 res->records->u.databaseOrSurDiagnostics);
699 get_diagrec(&rec, res->records->u.nonSurrogateDiagnostic);
702 gw_log(GW_LOG_WARN, ZASS_TYPE, "Bad tag in response rec.");
706 while (num - r.num && start);
710 const struct zass_presentent *zass_presentresult(ZASS a, int *complete)