2 * Copyright (c) 1995, Index Data.
3 * See the file LICENSE for details.
4 * Sebastian Hammer, Adam Dickmeiss
7 * Revision 1.25 1995-11-13 09:27:22 quinn
8 * Fiddling with the variant stuff.
10 * Revision 1.24 1995/10/30 12:41:13 quinn
11 * Added hostname lookup for server.
13 * Revision 1.23 1995/10/18 16:12:30 quinn
16 * Revision 1.22 1995/10/11 14:49:12 quinn
19 * Revision 1.21 1995/09/29 17:01:47 quinn
22 * Revision 1.20 1995/08/29 14:24:13 quinn
23 * Added second half of close-handshake
25 * Revision 1.19 1995/08/29 11:17:28 quinn
26 * Added code to receive close
28 * Revision 1.18 1995/08/28 12:21:27 quinn
29 * Client can now ask for simple element set names.
31 * Revision 1.17 1995/08/17 12:45:02 quinn
32 * Fixed minor problems with GRS-1. Added support in c&s.
34 * Revision 1.16 1995/08/15 12:00:04 quinn
37 * Revision 1.15 1995/06/22 09:28:03 quinn
38 * Fixed bug in SUTRS processing.
40 * Revision 1.14 1995/06/19 12:37:41 quinn
43 * Revision 1.13 1995/06/16 10:29:11 quinn
44 * *** empty log message ***
46 * Revision 1.12 1995/06/15 07:44:57 quinn
49 * Revision 1.11 1995/06/14 15:26:40 quinn
50 * *** empty log message ***
52 * Revision 1.10 1995/06/06 14:56:58 quinn
55 * Revision 1.9 1995/06/06 08:15:19 quinn
58 * Revision 1.8 1995/06/05 10:52:22 quinn
61 * Revision 1.7 1995/06/02 09:50:09 quinn
64 * Revision 1.6 1995/05/31 08:29:21 quinn
65 * Nothing significant.
67 * Revision 1.5 1995/05/29 08:10:47 quinn
68 * Moved oid.c to util.
70 * Revision 1.4 1995/05/22 15:30:13 adam
71 * Client uses prefix query notation.
73 * Revision 1.3 1995/05/22 15:06:53 quinn
74 * *** empty log message ***
76 * Revision 1.2 1995/05/22 14:56:40 quinn
77 * *** empty log message ***
79 * Revision 1.1 1995/05/22 11:30:31 quinn
80 * Added prettier client.
86 * This is the obligatory little toy client, whose primary purpose is
87 * to illustrate the use of the YAZ service-level API.
99 #include <sys/select.h>
102 #include <comstack.h>
109 #include <marcdisp.h>
110 #include <diagbib1.h>
120 #define C_PROMPT "Z> "
122 static ODR out, in, print; /* encoding and decoding streams */
123 static COMSTACK conn = 0; /* our z-association */
124 static Z_IdAuthentication *auth = 0; /* our current auth definition */
125 static char database[512] = "Default"; /* Database name */
126 static int setnumber = 0; /* current result set number */
127 static int smallSetUpperBound = 0;
128 static int largeSetLowerBound = 1;
129 static int mediumSetPresentNumber = 0;
130 static Z_ElementSetNames *elementSetNames = 0;
131 static int setno = 1; /* current set offset */
132 static int protocol = PROTO_Z3950; /* current app protocol */
133 static int recordsyntax = VAL_USMARC;
134 static int sent_close = 0;
135 static ODR_MEM session_mem; /* memory handle for init-response */
136 static Z_InitResponse *session = 0; /* session parameters */
137 static char last_scan[512] = "0";
138 static char last_cmd[100] = "?";
141 static CCL_bibset bibset; /* CCL bibset handle */
145 static void send_apdu(Z_APDU *a)
150 if (!z_APDU(out, &a, 0))
152 odr_perror(out, "Encoding APDU");
155 buf = odr_getbuf(out, &len, 0);
156 odr_reset(out); /* release the APDU */
157 if (cs_put(conn, buf, len) < 0)
159 fprintf(stderr, "cs_put: %s", cs_errmsg(cs_errno(conn)));
164 /* INIT SERVICE ------------------------------- */
166 static void send_initRequest()
168 Z_APDU *apdu = zget_APDU(out, Z_APDU_initRequest);
169 Z_InitRequest *req = apdu->u.initRequest;
171 ODR_MASK_SET(req->options, Z_Options_search);
172 ODR_MASK_SET(req->options, Z_Options_present);
173 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
174 ODR_MASK_SET(req->options, Z_Options_triggerResourceCtrl);
175 ODR_MASK_SET(req->options, Z_Options_scan);
177 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
178 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
179 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
181 req->idAuthentication = auth;
184 printf("Sent initrequest.\n");
187 static int process_initResponse(Z_InitResponse *res)
189 /* save session parameters for later use */
190 session_mem = odr_extract_mem(in);
194 printf("Connection rejected by target.\n");
196 printf("Connection accepted by target.\n");
197 if (res->implementationId)
198 printf("ID : %s\n", res->implementationId);
199 if (res->implementationName)
200 printf("Name : %s\n", res->implementationName);
201 if (res->implementationVersion)
202 printf("Version: %s\n", res->implementationVersion);
203 if (res->userInformationField)
205 printf("UserInformationfield:\n");
206 if (!z_External(print, (Z_External**)&res-> userInformationField,
209 odr_perror(print, "Printing userinfo\n");
212 if (res->userInformationField->which == Z_External_octet)
214 printf("Guessing visiblestring:\n");
215 printf("'%s'\n", res->userInformationField->u. octet_aligned->buf);
221 int cmd_open(char *arg)
224 char type[100], addr[100];
229 printf("Already connected.\n");
232 if (!*arg || sscanf(arg, "%[^:]:%s", type, addr) < 2)
234 fprintf(stderr, "Usage: open (osi|tcp) ':' [tsel '/']host[':'port]\n");
238 if (!strcmp(type, "osi"))
240 if (!(add = mosi_strtoaddr(addr)))
250 if (!strcmp(type, "tcp"))
252 if (!(add = tcpip_strtoaddr(addr)))
258 protocol = PROTO_Z3950;
262 fprintf(stderr, "Bad type: %s\n", type);
265 if (!(conn = cs_create(t, 1, protocol)))
270 printf("Connecting...");
272 if (cs_connect(conn, add) < 0)
284 int cmd_authentication(char *arg)
286 static Z_IdAuthentication au;
287 static char open[256];
291 printf("Auth field set to null\n");
296 au.which = Z_IdAuthentication_open;
302 /* SEARCH SERVICE ------------------------------ */
304 static void display_variant(Z_Variant *v, int level)
308 for (i = 0; i < v->num_triples; i++)
310 printf("%*sclass=%d,type=%d", level * 4, "", *v->triples[i]->class,
311 *v->triples[i]->type);
312 if (v->triples[i]->which == Z_Triple_internationalString)
313 printf(",value=%s\n", v->triples[i]->value.internationalString);
319 static void display_grs1(Z_GenericRecord *r, int level)
325 for (i = 0; i < r->num_elements; i++)
329 printf("%*s", level * 4, "");
333 printf("%d,", *t->tagType);
336 if (t->tagValue->which == Z_StringOrNumeric_numeric)
337 printf("%d) ", *t->tagValue->u.numeric);
339 printf("%s) ", t->tagValue->u.string);
340 if (t->content->which == Z_ElementData_subtree)
343 display_grs1(t->content->u.subtree, level+1);
345 else if (t->content->which == Z_ElementData_string)
346 printf("%s\n", t->content->u.string);
347 else if (t->content->which == Z_ElementData_numeric)
348 printf("%d\n", *t->content->u.numeric);
349 else if (t->content->which == Z_ElementData_noDataRequested)
350 printf("[No data requested]\n");
351 else if (t->content->which == Z_ElementData_elementEmpty)
352 printf("[Element empty]\n");
353 else if (t->content->which == Z_ElementData_elementNotThere)
354 printf("[Element not there]\n");
357 if (t->appliedVariant)
358 display_variant(t->appliedVariant, level+1);
359 if (t->metaData && t->metaData->supportedVariants)
363 printf("%*s---- variant list\n", (level+1)*4, "");
364 for (c = 0; c < t->metaData->num_supportedVariants; c++)
366 printf("%*svariant #%d\n", (level+1)*4, "", c);
367 display_variant(t->metaData->supportedVariants[c], level + 2);
373 static void display_record(Z_DatabaseRecord *p)
375 Z_External *r = (Z_External*) p;
376 oident *ent = oid_getentbyoid(r->direct_reference);
378 if (r->direct_reference)
380 printf("Record type: ");
382 printf("%s\n", ent->desc);
383 else if (!odr_oid(print, &r->direct_reference, 0))
385 odr_perror(print, "print oid");
389 if (r->which == Z_External_octet && p->u.octet_aligned->len)
390 marc_display ((char*)p->u.octet_aligned->buf, stdout);
391 else if (ent->value == VAL_SUTRS)
393 if (r->which != Z_External_sutrs)
395 printf("Expecting single SUTRS type for SUTRS.\n");
398 printf("%.*s", r->u.sutrs->len, r->u.sutrs->buf);
400 else if (ent->value == VAL_GRS1)
402 if (r->which != Z_External_grs1)
404 printf("Expecting single GRS type for GRS.\n");
407 display_grs1(r->u.grs1, 0);
411 printf("Unknown record representation.\n");
412 if (!z_External(print, &r, 0))
414 odr_perror(print, "Printing external");
420 static void display_diagrec(Z_DiagRec *p)
424 Z_DefaultDiagFormat *r;
429 printf("Diagnostic message from database:\n");
431 if (p->which != Z_DiagRec_defaultFormat)
433 printf("Diagnostic record not in default format.\n");
437 r = p->u.defaultFormat;
439 if (!(ent = oid_getentbyoid(r->diagnosticSetId)) ||
440 ent->class != CLASS_DIAGSET || ent->value != VAL_BIB1)
441 printf("Missing or unknown diagset\n");
442 printf(" [%d] %s", *r->condition, diagbib1_str(*r->condition));
443 if (r->addinfo && *r->addinfo)
444 printf(" -- %s\n", r->addinfo);
449 static void display_nameplusrecord(Z_NamePlusRecord *p)
452 printf("[%s]", p->databaseName);
453 if (p->which == Z_NamePlusRecord_surrogateDiagnostic)
454 display_diagrec(p->u.surrogateDiagnostic);
456 display_record(p->u.databaseRecord);
459 static void display_records(Z_Records *p)
463 if (p->which == Z_Records_NSD)
464 display_diagrec(p->u.nonSurrogateDiagnostic);
467 printf("Records: %d\n", p->u.databaseOrSurDiagnostics->num_records);
468 for (i = 0; i < p->u.databaseOrSurDiagnostics->num_records; i++)
469 display_nameplusrecord(p->u.databaseOrSurDiagnostics->records[i]);
473 static int send_searchRequest(char *arg)
475 Z_APDU *apdu = zget_APDU(out, Z_APDU_searchRequest);
476 Z_SearchRequest *req = apdu->u.searchRequest;
477 char *databaseNames = database;
481 struct ccl_rpn_node *rpn;
487 Z_RPNQuery *RPNquery;
495 rpn = ccl_find_str(bibset, arg, &error, &pos);
498 printf("CCL ERROR: %s\n", ccl_err_msg(error));
504 if (!strcmp(arg, "@big")) /* strictly for troublemaking */
506 static unsigned char big[2100];
509 /* send a very big referenceid to test transport stack etc. */
510 memset(big, 'A', 2100);
511 bigo.len = bigo.size = 2100;
513 req->referenceId = &bigo;
518 sprintf(setstring, "%d", ++setnumber);
519 req->resultSetName = setstring;
521 *req->smallSetUpperBound = smallSetUpperBound;
522 *req->largeSetLowerBound = largeSetLowerBound;
523 *req->mediumSetPresentNumber = mediumSetPresentNumber;
524 if (smallSetUpperBound > 0 || (largeSetLowerBound > 1 &&
525 mediumSetPresentNumber > 0))
529 prefsyn.proto = protocol;
530 prefsyn.class = CLASS_RECSYN;
531 prefsyn.value = recordsyntax;
532 req->preferredRecordSyntax = odr_oiddup(out, oid_getoidbyent(&prefsyn));
533 req->smallSetElementSetNames =
534 req->mediumSetElementSetNames = elementSetNames;
536 req->num_databaseNames = 1;
537 req->databaseNames = &databaseNames;
542 query.which = Z_Query_type_1;
545 assert((RPNquery = ccl_rpn_query(rpn)));
547 RPNquery = p_query_rpn (out, arg);
550 printf("Prefix query error\n");
554 bib1.proto = protocol;
555 bib1.class = CLASS_ATTSET;
556 bib1.value = VAL_BIB1;
557 RPNquery->attributeSetId = oid_getoidbyent(&bib1);
558 query.u.type_1 = RPNquery;
560 query.which = Z_Query_type_2;
561 query.u.type_2 = &ccl_query;
562 ccl_query.buf = (unsigned char*) arg;
563 ccl_query.len = strlen(arg);
568 printf("Sent searchRequest.\n");
572 static int process_searchResponse(Z_SearchResponse *res)
574 if (*res->searchStatus)
575 printf("Search was a success.\n");
577 printf("Search was a bloomin' failure.\n");
578 printf("Number of hits: %d, setno %d\n",
579 *res->resultCount, setnumber);
580 printf("records returned: %d\n",
581 *res->numberOfRecordsReturned);
582 setno += *res->numberOfRecordsReturned;
584 display_records(res->records);
588 static int cmd_find(char *arg)
592 printf("Find what?\n");
597 printf("Not connected yet\n");
600 if (!send_searchRequest(arg))
605 static int cmd_ssub(char *arg)
607 if (!(smallSetUpperBound = atoi(arg)))
612 static int cmd_lslb(char *arg)
614 if (!(largeSetLowerBound = atoi(arg)))
619 static int cmd_mspn(char *arg)
621 if (!(mediumSetPresentNumber = atoi(arg)))
626 static int cmd_status(char *arg)
628 printf("smallSetUpperBound: %d\n", smallSetUpperBound);
629 printf("largeSetLowerBound: %d\n", largeSetLowerBound);
630 printf("mediumSetPresentNumber: %d\n", mediumSetPresentNumber);
634 static int cmd_base(char *arg)
638 printf("Usage: base <database>\n");
641 strcpy(database, arg);
645 static int cmd_setnames(char *arg)
649 printf("Set numbering enabled.\n");
654 printf("Set numbering disabled.\n");
660 /* PRESENT SERVICE ----------------------------- */
662 static int send_presentRequest(char *arg)
664 Z_APDU *apdu = zget_APDU(out, Z_APDU_presentRequest);
665 Z_PresentRequest *req = apdu->u.presentRequest;
666 Z_RecordComposition compo;
672 if ((p = strchr(arg, '+')))
682 sprintf(setstring, "%d", setnumber);
683 req->resultSetId = setstring;
685 req->resultSetStartPoint = &setno;
686 req->numberOfRecordsRequested = &nos;
687 prefsyn.proto = protocol;
688 prefsyn.class = CLASS_RECSYN;
689 prefsyn.value = recordsyntax;
690 req->preferredRecordSyntax = oid_getoidbyent(&prefsyn);
693 req->recordComposition = &compo;
694 compo.which = Z_RecordComp_simple;
695 compo.u.simple = elementSetNames;
698 printf("Sent presentRequest (%d+%d).\n", setno, nos);
702 void process_close(Z_Close *req)
704 Z_APDU *apdu = zget_APDU(out, Z_APDU_close);
705 Z_Close *res = apdu->u.close;
707 static char *reasons[] =
712 "cost limit reached",
714 "security violation",
721 printf("Reason: %s, message: %s\n", reasons[*req->closeReason],
722 req->diagnosticInformation ? req->diagnosticInformation : "NULL");
725 printf("Goodbye.\n");
728 *res->closeReason = Z_Close_finished;
730 printf("Sent response.\n");
734 static int cmd_show(char *arg)
736 if (!send_presentRequest(arg))
741 int cmd_quit(char *arg)
743 printf("See you later, alligator.\n");
747 int cmd_cancel(char *arg)
749 Z_APDU *apdu = zget_APDU(out, Z_APDU_triggerResourceControlRequest);
750 Z_TriggerResourceControlRequest *req =
751 apdu->u.triggerResourceControlRequest;
756 printf("Session not initialized yet\n");
759 if (!ODR_MASK_GET(session->options, Z_Options_triggerResourceCtrl))
761 printf("Target doesn't support cancel (trigger resource ctrl)\n");
764 *req->requestedAction = Z_TriggerResourceCtrl_cancel;
765 req->resultSetWanted = &false;
768 printf("Sent cancel request\n");
772 int send_scanrequest(char *string, int pp, int num)
774 Z_APDU *apdu = zget_APDU(out, Z_APDU_scanRequest);
775 Z_ScanRequest *req = apdu->u.scanRequest;
779 req->num_databaseNames = 1;
780 req->databaseNames = &db;
781 attset.proto = protocol;
782 attset.class = CLASS_ATTSET;
783 attset.value = VAL_BIB1;
784 req->attributeSet = oid_getoidbyent(&attset);
785 req->termListAndStartPoint = p_query_scan(out, string);
786 req->numberOfTermsRequested = #
787 req->preferredPositionInResponse = &pp;
792 void display_term(Z_TermInfo *t)
794 if (t->term->which == Z_Term_general)
796 printf("%.*s (%d)\n", t->term->u.general->len, t->term->u.general->buf,
797 t->globalOccurrences ? *t->globalOccurrences : -1);
798 sprintf(last_scan, "%.*s", t->term->u.general->len,
799 t->term->u.general->buf);
802 printf("Term type not general.\n");
805 void process_scanResponse(Z_ScanResponse *res)
809 printf("SCAN: %d entries, position=%d\n", *res->numberOfEntriesReturned,
810 *res->positionOfTerm);
811 if (*res->scanStatus != Z_Scan_success)
812 printf("Scan returned code %d\n", *res->scanStatus);
815 if (res->entries->which == Z_ListEntries_entries)
817 Z_Entries *ent = res->entries->u.entries;
819 for (i = 0; i < ent->num_entries; i++)
820 if (ent->entries[i]->which == Z_Entry_termInfo)
822 printf("%c ", i + 1 == *res->positionOfTerm ? '*' : ' ');
823 display_term(ent->entries[i]->u.termInfo);
826 display_diagrec(ent->entries[i]->u.surrogateDiagnostic);
829 display_diagrec(res->entries->u.nonSurrogateDiagnostics->diagRecs[0]);
832 int cmd_scan(char *arg)
836 printf("Session not initialized yet\n");
839 if (!ODR_MASK_GET(session->options, Z_Options_scan))
841 printf("Target doesn't support scan\n");
846 if (send_scanrequest(arg, 5, 20) < 0)
850 if (send_scanrequest(last_scan, 1, 20) < 0)
855 int cmd_format(char *arg)
859 printf("Usage: format <recordsyntax>\n");
862 if (!strcmp(arg, "sutrs"))
864 printf("Preferred format is SUTRS.\n");
865 recordsyntax = VAL_SUTRS;
868 else if (!strcmp(arg, "usmarc"))
870 printf("Preferred format is USMARC\n");
871 recordsyntax = VAL_USMARC;
874 else if (!strcmp(arg, "danmarc"))
876 printf("Preferred format is DANMARC\n");
877 recordsyntax = VAL_DANMARC;
880 else if (!strcmp(arg, "grs1"))
882 printf("Preferred format is GRS1\n");
883 recordsyntax = VAL_GRS1;
888 printf("Specify one of {sutrs,usmarc,danmarc,grs1}.\n");
893 int cmd_elements(char *arg)
895 static Z_ElementSetNames esn;
896 static char what[100];
900 printf("Usage: elements <esn>\n");
904 esn.which = Z_ElementSetNames_generic;
905 esn.u.generic = what;
906 elementSetNames = &esn;
910 int cmd_close(char *arg)
912 Z_APDU *apdu = zget_APDU(out, Z_APDU_close);
913 Z_Close *req = apdu->u.close;
915 *req->closeReason = Z_Close_finished;
917 printf("Sent close request.\n");
922 static void initialize(void)
930 if (!(out = odr_createmem(ODR_ENCODE)) ||
931 !(in = odr_createmem(ODR_DECODE)) ||
932 !(print = odr_createmem(ODR_PRINT)))
934 fprintf(stderr, "failed to allocate ODR streams\n");
937 setvbuf(stdout, 0, _IONBF, 0);
941 bibset = ccl_qual_mk ();
942 inf = fopen ("default.bib", "r");
945 ccl_qual_file (bibset, inf);
952 static int client(void)
956 int (*fun)(char *arg);
959 {"open", cmd_open, "('tcp'|'osi')':'[<TSEL>'/']<HOST>[':'<PORT>]"},
960 {"quit", cmd_quit, ""},
961 {"find", cmd_find, "<CCL-QUERY>"},
962 {"base", cmd_base, "<BASE-NAME>"},
963 {"show", cmd_show, "<REC#>['+'<#RECS>]"},
964 {"scan", cmd_scan, "<TERM>"},
965 {"authentication", cmd_authentication, "<ACCTSTRING>"},
966 {"lslb", cmd_lslb, "<largeSetLowerBound>"},
967 {"ssub", cmd_ssub, "<smallSetUpperBound>"},
968 {"mspn", cmd_mspn, "<mediumSetPresentNumber>"},
969 {"status", cmd_status, ""},
970 {"setnames", cmd_setnames, ""},
971 {"cancel", cmd_cancel, ""},
972 {"format", cmd_format, "<recordsyntax>"},
973 {"elements", cmd_elements, "<elementSetName>"},
974 {"close", cmd_close, ""},
978 int netbufferlen = 0;
986 char line[1024], word[1024], arg[1024];
991 FD_SET(cs_fileno(conn), &input);
992 if ((res = select(20, &input, 0, 0, 0)) < 0)
999 if (FD_ISSET(0, &input))
1001 /* quick & dirty way to get a command line. */
1004 if ((res = sscanf(line, "%s %[^;]", word, arg)) <= 0)
1006 strcpy(word, last_cmd);
1011 strcpy(last_cmd, word);
1012 for (i = 0; cmd[i].cmd; i++)
1013 if (!strncmp(cmd[i].cmd, word, strlen(word)))
1015 res = (*cmd[i].fun)(arg);
1018 if (!cmd[i].cmd) /* dump our help-screen */
1020 printf("Unknown command: %s.\n", word);
1021 printf("Currently recognized commands:\n");
1022 for (i = 0; cmd[i].cmd; i++)
1023 printf(" %s %s\n", cmd[i].cmd, cmd[i].ad);
1029 if (conn && FD_ISSET(cs_fileno(conn), &input))
1033 if ((res = cs_get(conn, &netbuffer, &netbufferlen)) < 0)
1040 printf("Target closed connection.\n");
1043 odr_reset(in); /* release APDU from last round */
1044 odr_setbuf(in, netbuffer, res, 0);
1045 if (!z_APDU(in, &apdu, 0))
1047 odr_perror(in, "Decoding incoming APDU");
1048 fprintf(stderr, "[Near %d]\n", odr_offset(in));
1049 fprintf(stderr, "Packet dump:\n---------\n");
1050 odr_dumpBER(stderr, netbuffer, res);
1051 fprintf(stderr, "---------\n");
1055 if (!z_APDU(print, &apdu, 0))
1057 odr_perror(print, "Failed to print incoming APDU");
1064 case Z_APDU_initResponse:
1065 process_initResponse(apdu->u.initResponse);
1067 case Z_APDU_searchResponse:
1068 process_searchResponse(apdu->u.searchResponse);
1070 case Z_APDU_scanResponse:
1071 process_scanResponse(apdu->u.scanResponse);
1073 case Z_APDU_presentResponse:
1074 printf("Received presentResponse.\n");
1076 *apdu->u.presentResponse->numberOfRecordsReturned;
1077 if (apdu->u.presentResponse->records)
1078 display_records(apdu->u.presentResponse->records);
1080 printf("No records.\n");
1083 printf("Target has closed the association.\n");
1084 process_close(apdu->u.close);
1087 printf("Received unknown APDU type (%d).\n",
1094 while (cs_more(conn));
1100 int main(int argc, char **argv)