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.5 1996/01/03 08:58:12 adam
51 * Updated to use new version of Yaz (some names changed to avoid C++ conflict).
53 * Revision 1.4 1995/07/28 10:51:34 adam
54 * Bug fix: multiple databases weren't specified correctly.
56 * Revision 1.3 1995/07/20 08:18:15 adam
57 * Bug fix: Multiple databases are separated by commas and NOT by space.
59 * Revision 1.2 1995/07/05 11:08:33 adam
60 * Bug fix in init request.
62 * Revision 1.1 1995/07/03 08:21:31 adam
63 * Yaz layer moved to new sub directory. zaccess aligned with new
66 * Revision 1.10 1995/05/16 09:41:46 adam
67 * LICENSE. Uses new versions of odr_{set,get}buf.
69 * Revision 1.9 1995/05/03 10:15:43 quinn
70 * Fixed bug in the get_record loop - crashed when diagrec was received.
72 * Revision 1.8 1995/04/28 14:18:38 quinn
73 * *** empty log message ***
75 * Revision 1.7 1995/04/21 16:29:32 quinn
78 * Revision 1.6 1995/04/21 12:58:36 adam
81 * Revision 1.5 1995/04/20 15:25:32 quinn
84 * Revision 1.4 1995/04/19 16:02:28 adam
87 * Revision 1.3 1995/04/19 12:55:15 quinn
90 * Revision 1.2 1995/04/19 09:24:02 quinn
91 * Fixed bug in zass_open - variable initialized after use
93 * Revision 1.1 1995/04/17 11:26:53 quinn
94 * Added YAZ version of zaccess
99 * Interface to the YAZ Z39.50 toolkit.
108 #include <comstack.h>
118 struct zass /* Z-assoc */
120 COMSTACK ass; /* comstack association handle */
123 int fd; /* low-level socket (for select only) */
126 int preferredmessagesize;
131 static Z_APDU *get_apdu(struct zass *z, int *complete)
136 if ((res = cs_get(z->ass, &z->inbuf, &z->inbuflen)) <= 0)
138 gw_log(GW_LOG_WARN, ZASS_TYPE, "cs_get failed");
149 odr_reset(z->decode);
150 odr_setbuf(z->decode, z->inbuf, res, 0);
151 if (!z_APDU(z->decode, &ap, 0))
153 gw_log(GW_LOG_WARN, ZASS_TYPE, "decode: %s",
154 odr_errlist[odr_geterror(z->decode)]);
164 static int send_apdu(struct zass *z, Z_APDU *a)
169 if (!z_APDU(z->encode, &a, 0))
171 gw_log(GW_LOG_FATAL, ZASS_TYPE, "encoding initreq");
174 buf = odr_getbuf(z->encode, &len, NULL);
175 if (cs_put(z->ass, buf, len) < 0)
177 gw_log(GW_LOG_FATAL, ZASS_TYPE, "cs_put");
180 odr_reset(z->encode); /* release odr_allocated structures */
184 static int send_initreq(struct zass *p, char *auth)
189 Z_IdAuthentication idauth;
191 apdu = zget_APDU (p->encode, Z_APDU_initRequest);
192 req = apdu->u.initRequest;
193 req->preferredMessageSize = &p->preferredmessagesize;
194 req->maximumRecordSize = &p->maxrecordsize;
196 ODR_MASK_SET(req->options, Z_Options_search);
197 ODR_MASK_SET(req->options, Z_Options_present);
198 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
200 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
201 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
205 req->idAuthentication = &idauth;
206 idauth.which = Z_IdAuthentication_open;
207 idauth.u.open = auth;
210 req->idAuthentication = 0;
211 sprintf(name, "%s (YAZ protocol layer)", ZASS_NAME);
212 req->implementationName = name;
213 req->implementationVersion = ZASS_VERSION;
214 if (send_apdu(p, apdu) < 0)
219 int zass_fileno(ZASS a)
224 int zass_openresult(ZASS p, int *complete)
229 if (!(ap = get_apdu(p, complete)))
231 if (ap->which != Z_APDU_initResponse)
233 gw_log(GW_LOG_WARN, ZASS_TYPE, "bad APDU");
236 res = ap->u.initResponse;
239 gw_log(GW_LOG_WARN, ZASS_TYPE, "Negative result on initres");
242 p->preferredmessagesize = *res->preferredMessageSize;
243 p->maxrecordsize = *res->maximumRecordSize;
244 if (res->implementationId)
245 gw_log(GW_LOG_NOTICE, ZASS_TYPE, "imp. ID : %s",
246 res->implementationId);
247 if (res->implementationName)
248 gw_log(GW_LOG_NOTICE, ZASS_TYPE, "imp. ID : %s",
249 res->implementationName);
250 if (res->implementationVersion)
251 gw_log(GW_LOG_NOTICE, ZASS_TYPE, "imp. ID : %s",
252 res->implementationVersion);
253 gw_log(ZASS_DEBUG, ZASS_TYPE, "Initialized ok");
257 ZASS zass_open(char *host, int port, int *complete, char *auth)
263 if (!(p = malloc(sizeof(*p))))
265 gw_log(GW_LOG_FATAL|GW_LOG_ERRNO, ZASS_TYPE, "malloc");
275 if (!(p->encode = odr_createmem(ODR_ENCODE)) ||
276 !(p->decode = odr_createmem(ODR_DECODE)))
278 gw_log(GW_LOG_FATAL|GW_LOG_ERRNO, ZASS_TYPE, "odr_createmem");
281 p->maxrecordsize = ZASS_MAXRECORDSIZE;
282 p->preferredmessagesize = ZASS_PREFERREDMESSAGESIZE;
283 if (!(p->ass = cs_create(tcpip_type, 1, CS_Z3950)))
285 gw_log(GW_LOG_FATAL|GW_LOG_ERRNO, ZASS_TYPE, "cs_create");
290 sprintf(addstr, "%s:%d", host, port);
291 if (!(address = tcpip_strtoaddr(addstr)))
293 gw_log(GW_LOG_FATAL, ZASS_TYPE, "failed to resolve %s", addstr);
296 p->fd = cs_fileno(p->ass);
297 gw_log(ZASS_DEBUG, ZASS_TYPE, "Connecting to %s", addstr);
298 if (cs_connect(p->ass, address) < 0)
300 gw_log(GW_LOG_FATAL, ZASS_TYPE, "Failed to connect to %s", addstr);
303 gw_log(ZASS_DEBUG, ZASS_TYPE, "connected ok... initializing");
304 if (send_initreq(p, auth) < 0)
306 gw_log(GW_LOG_FATAL, ZASS_TYPE, "Failed to send init");
314 if (zass_openresult(p, complete) < 0)
316 return p; /* all done */
320 * Convert the egate (ccl2rpn) version of RPN to YAZ RPN.
322 static Z_RPNStructure *rpn2rpn(ODR o, struct ccl_rpn_node *q)
324 Z_RPNStructure *r = odr_malloc(o, sizeof(*r));
325 Z_AttributesPlusTerm *t;
326 struct ccl_rpn_attr *i;
328 static int op[] = { Z_Operator_and, Z_Operator_or, Z_Operator_and_not };
333 r->which = Z_RPNStructure_simple;
334 r->u.simple = odr_malloc(o, sizeof(Z_Operand));
335 r->u.simple->which = Z_Operand_APT;
336 r->u.simple->u.attributesPlusTerm = t = odr_malloc(o, sizeof(*t));
337 t->term = odr_malloc(o, sizeof(Z_Term));
338 t->term->which = Z_Term_general;
339 t->term->u.general = odr_malloc(o, sizeof(Odr_oct));
340 t->term->u.general->len = t->term->u.general->size =
342 t->term->u.general->buf = odr_malloc(o, t->term->u.general->size);
343 memcpy(t->term->u.general->buf, q->u.t.term,
344 t->term->u.general->len);
345 t->num_attributes = 0;
346 t->attributeList = odr_malloc(o, sizeof(Z_AttributeElement*) * 100);
347 for (i = q->u.t.attr_list; i && t->num_attributes < 100;
350 Z_AttributeElement *a;
352 t->attributeList[t->num_attributes++] = a =
353 odr_malloc(o, sizeof(*a));
354 a->attributeType = odr_malloc(o, sizeof(int));
355 *a->attributeType = i->type;
358 a->which = Z_AttributeValue_numeric;
359 a->value.numeric = odr_malloc(o, sizeof(*a->value.numeric));
360 *a->value.numeric = i->value;
362 a->attributeValue = odr_malloc(o, sizeof(*a->attributeValue));
363 *a->attributeValue = i->value;
368 r->which = Z_RPNStructure_simple;
369 r->u.simple = odr_malloc(o, sizeof(Z_Operand));
370 r->u.simple->which = Z_Operand_resultSetId;
371 r->u.simple->u.resultSetId = odr_malloc(o, len =
372 strlen(q->u.setname) + 1);
373 memcpy(r->u.simple->u.resultSetId, q->u.setname, len);
375 case CCL_RPN_AND: case CCL_RPN_OR: case CCL_RPN_NOT:
376 r->which = Z_RPNStructure_complex;
377 r->u.complex = odr_malloc(o, sizeof(Z_Complex));
378 if (!(r->u.complex->s1 = rpn2rpn(o, q->u.p[0])) ||
379 !(r->u.complex->s2 = rpn2rpn(o, q->u.p[1])))
381 r->u.complex->roperator = odr_malloc(o, sizeof(Z_Operator));
382 r->u.complex->roperator->which = op[q->kind];
383 r->u.complex->roperator->u.and = "";
386 gw_log(GW_LOG_FATAL, ZASS_TYPE, "Bad operator in RPN");
391 const struct zass_searchent *zass_searchresult(ZASS a, int *complete)
393 static struct zass_searchent r;
395 Z_SearchResponse *res;
397 if (!(apdu = get_apdu(a, complete)))
399 if (apdu->which != Z_APDU_searchResponse)
401 gw_log(GW_LOG_FATAL, ZASS_TYPE, "Expected searchresponse, got #%d",
405 res = apdu->u.searchResponse;
406 r.status = *res->searchStatus;
407 r.num = *res->resultCount;
408 r.status = res->resultSetStatus ? *res->resultSetStatus : 0;
413 if (res->records->which != Z_Records_NSD)
414 gw_log(GW_LOG_WARN, ZASS_TYPE, "Unexpected record types in SchR");
418 Z_DiagRec *dr = res->records->u.nonSurrogateDiagnostic;
421 if (dr->which != Z_DiagRec_defaultFormat ||
422 !(id = oid_getentbyoid
423 (dr->u.defaultFormat->diagnosticSetId)) ||
424 id->oclass != CLASS_DIAGSET ||
425 id->value != VAL_BIB1)
426 gw_log(GW_LOG_WARN, ZASS_TYPE,
427 "Missing or unknown diagset - ignoring error!");
430 r.errcode = *dr->u.defaultFormat->condition;
431 if (dr->u.defaultFormat->addinfo)
433 strncpy(r.errstring, dr->u.defaultFormat->addinfo, 512);
434 r.errstring[511] = '\0';
438 if (!(id = oid_getentbyoid(dr->diagnosticSetId)) ||
439 id->class != CLASS_DIAGSET || id->value != VAL_BIB1)
440 gw_log(GW_LOG_WARN, ZASS_TYPE,
441 "Missing or unknown diagset - ignoring error!");
444 r.errcode = *dr->condition;
447 strncpy(r.errstring, dr->addinfo, 512);
448 r.errstring[511] = '\0';
457 const struct zass_searchent *zass_search(ZASS a, struct ccl_rpn_node *query,
458 char *resname, char *databases, int *complete)
463 Z_SearchRequest *req;
465 int smallSetUpperBound = 0;
466 int largeSetLowerBound = 1;
467 int mediumSetPresentNumber = 0;
468 int replaceIndicator = 1;
471 apdu = zget_APDU (a->encode, Z_APDU_searchRequest);
472 req = apdu->u.searchRequest;
474 req->smallSetUpperBound = &smallSetUpperBound;
475 req->largeSetLowerBound = &largeSetLowerBound;
476 req->mediumSetPresentNumber = &mediumSetPresentNumber;
477 req->replaceIndicator = &replaceIndicator;
478 req->resultSetName = resname;
479 req->num_databaseNames = 0;
480 req->databaseNames = datab;
481 while (*databases && req->num_databaseNames < 100)
486 while (*p && !isspace(*p) && *p != ',')
494 req->databaseNames[req->num_databaseNames] = odr_malloc(a->encode,
495 (p - databases) + 1);
496 memcpy(req->databaseNames[req->num_databaseNames], databases,
498 req->databaseNames[req->num_databaseNames++][p-databases] = '\0';
500 databases = p + more;
503 q.which = Z_Query_type_1;
505 bib1.proto = PROTO_Z3950;
506 bib1.oclass = CLASS_ATTSET;
507 bib1.value = VAL_BIB1;
508 rpnq.attributeSetId = oid_getoidbyent(&bib1);
512 if (!(rpnq.RPNStructure = rpn2rpn(a->encode, query)))
514 if (send_apdu(a, apdu) < 0)
522 return zass_searchresult(a, complete);
526 * Triple indirection - that's kinda heavy. We'll fix it later.
527 * There are worse things around, though. Like ZDist.
529 void get_diagrec(zass_record ***p, Z_DiagRec *r)
531 **p = malloc(sizeof(***p));
534 (**p)->errstring[0] = '\0';
535 if (r->which == Z_DiagRec_defaultFormat)
537 (**p)->errcode = *r->u.defaultFormat->condition;
538 if (r->u.defaultFormat->addinfo)
540 strncpy((**p)->errstring, r->u.defaultFormat->addinfo, 200);
541 (**p)->errstring[200] = 0;
547 (**p)->errcode = *r->condition;
550 strncpy((**p)->errstring, r->addinfo, 200);
551 (**p)->errstring[200] = 0;
554 (**p)->errstring[0] = '\0';
556 (**p)->which = ZASS_REC_DIAG;
560 void get_responserecords(zass_record ***p, Z_NamePlusRecordList *recs)
564 for (i = 0; i < recs->num_records; i++)
566 Z_NamePlusRecord *record;
568 record = recs->records[i];
569 if (record->which == Z_NamePlusRecord_surrogateDiagnostic)
570 get_diagrec(p, record->u.surrogateDiagnostic);
573 Z_DatabaseRecord *r = record->u.databaseRecord;
576 **p = malloc(sizeof(***p));
579 if (!(recform = oid_getentbyoid(r->direct_reference)) ||
580 recform->oclass != CLASS_RECSYN)
582 gw_log(GW_LOG_WARN, ZASS_TYPE, "Unknown or bad record syntax");
583 (**p)->which = ZASS_REC_UNKNOWN;
586 switch (recform->value)
588 case VAL_USMARC: (**p)->which = ZASS_REC_USMARC; break;
590 gw_log(GW_LOG_WARN, ZASS_TYPE, "Unknown recsyn");
591 (**p)->which = ZASS_REC_UNKNOWN;
593 if (r->which != ODR_EXTERNAL_octet)
595 gw_log(GW_LOG_WARN, ZASS_TYPE, "Record wasn't octet-aligned");
600 if (!((**p)->record = malloc(r->u.octet_aligned->len + 1)))
602 gw_log(GW_LOG_FATAL, ZASS_TYPE, "malloc");
605 memcpy((**p)->record, r->u.octet_aligned->buf,
606 r->u.octet_aligned->len);
607 (**p)->record[r->u.octet_aligned->len] = '\0';
608 gw_log(ZASS_DEBUG, ZASS_TYPE, "Got a record of %d bytes",
609 r->u.octet_aligned->len);
616 static void zass_records_free(zass_record *p)
620 static int send_present(ZASS a, char *name, int start, int num,
624 Z_PresentRequest *req;
629 apdu = zget_APDU (a->encode, Z_APDU_presentRequest);
630 req = apdu->u.presentRequest;
632 req->resultSetId = name;
633 req->resultSetStartPoint = &start;
634 req->numberOfRecordsRequested = #
636 recsyn.proto = PROTO_Z3950;
637 recsyn.class = CLASS_RECSYN;
639 req->preferredRecordSyntax = oid_getoidbyent(&recsyn);
641 req->preferredRecordSyntax = 0;
643 return send_apdu(a, apdu);
647 * Note that 1== first record.
648 * TODO: make this baby operate in nonblocking mode, too.
650 const struct zass_presentent *zass_present(ZASS a, char *resname, int start,
651 int num, int *complete)
653 static struct zass_presentent r;
654 zass_record **rec = &r.records;
661 zass_records_free(r.records);
667 Z_PresentResponse *res;
669 gw_log(ZASS_DEBUG, ZASS_TYPE,
670 "Fetching %d records from # %d", num - r.num, start);
671 if (send_present(a, resname, start, num - r.num, VAL_USMARC) < 0)
673 if (!(apdu = get_apdu(a, complete)))
679 if (apdu->which != Z_APDU_presentResponse)
681 gw_log(GW_LOG_FATAL, ZASS_TYPE, "Expected presentresponse, got #%d",
685 res = apdu->u.presentResponse;
686 r.presentstatus = *res->presentStatus;
687 r.num += *res->numberOfRecordsReturned;
688 if (*res->numberOfRecordsReturned == 0)
690 gw_log(GW_LOG_WARN, ZASS_TYPE, "Got 0 records from target");
693 r.nextpos = *res->nextResultSetPosition;
695 switch (res->records->which)
697 case Z_Records_DBOSD:
698 get_responserecords(&rec,
699 res->records->u.databaseOrSurDiagnostics);
702 get_diagrec(&rec, res->records->u.nonSurrogateDiagnostic);
705 gw_log(GW_LOG_WARN, ZASS_TYPE, "Bad tag in response rec.");
709 while (num - r.num && start);
713 const struct zass_presentent *zass_presentresult(ZASS a, int *complete)