2 * Copyright (c) 1995, Index Data.
3 * See the file LICENSE for details.
4 * Sebastian Hammer, Adam Dickmeiss
7 * Revision 1.26 1995-12-12 14:11:00 quinn
10 * Revision 1.25 1995/11/13 09:27:22 quinn
11 * Fiddling with the variant stuff.
13 * Revision 1.24 1995/10/30 12:41:13 quinn
14 * Added hostname lookup for server.
16 * Revision 1.23 1995/10/18 16:12:30 quinn
19 * Revision 1.22 1995/10/11 14:49:12 quinn
22 * Revision 1.21 1995/09/29 17:01:47 quinn
25 * Revision 1.20 1995/08/29 14:24:13 quinn
26 * Added second half of close-handshake
28 * Revision 1.19 1995/08/29 11:17:28 quinn
29 * Added code to receive close
31 * Revision 1.18 1995/08/28 12:21:27 quinn
32 * Client can now ask for simple element set names.
34 * Revision 1.17 1995/08/17 12:45:02 quinn
35 * Fixed minor problems with GRS-1. Added support in c&s.
37 * Revision 1.16 1995/08/15 12:00:04 quinn
40 * Revision 1.15 1995/06/22 09:28:03 quinn
41 * Fixed bug in SUTRS processing.
43 * Revision 1.14 1995/06/19 12:37:41 quinn
46 * Revision 1.13 1995/06/16 10:29:11 quinn
47 * *** empty log message ***
49 * Revision 1.12 1995/06/15 07:44:57 quinn
52 * Revision 1.11 1995/06/14 15:26:40 quinn
53 * *** empty log message ***
55 * Revision 1.10 1995/06/06 14:56:58 quinn
58 * Revision 1.9 1995/06/06 08:15:19 quinn
61 * Revision 1.8 1995/06/05 10:52:22 quinn
64 * Revision 1.7 1995/06/02 09:50:09 quinn
67 * Revision 1.6 1995/05/31 08:29:21 quinn
68 * Nothing significant.
70 * Revision 1.5 1995/05/29 08:10:47 quinn
71 * Moved oid.c to util.
73 * Revision 1.4 1995/05/22 15:30:13 adam
74 * Client uses prefix query notation.
76 * Revision 1.3 1995/05/22 15:06:53 quinn
77 * *** empty log message ***
79 * Revision 1.2 1995/05/22 14:56:40 quinn
80 * *** empty log message ***
82 * Revision 1.1 1995/05/22 11:30:31 quinn
83 * Added prettier client.
89 * This is the obligatory little toy client, whose primary purpose is
90 * to illustrate the use of the YAZ service-level API.
102 #include <sys/select.h>
105 #include <comstack.h>
112 #include <marcdisp.h>
113 #include <diagbib1.h>
123 #define C_PROMPT "Z> "
125 static ODR out, in, print; /* encoding and decoding streams */
126 static COMSTACK conn = 0; /* our z-association */
127 static Z_IdAuthentication *auth = 0; /* our current auth definition */
128 static char database[512] = "Default"; /* Database name */
129 static int setnumber = 0; /* current result set number */
130 static int smallSetUpperBound = 0;
131 static int largeSetLowerBound = 1;
132 static int mediumSetPresentNumber = 0;
133 static Z_ElementSetNames *elementSetNames = 0;
134 static int setno = 1; /* current set offset */
135 static int protocol = PROTO_Z3950; /* current app protocol */
136 static int recordsyntax = VAL_USMARC;
137 static int sent_close = 0;
138 static ODR_MEM session_mem; /* memory handle for init-response */
139 static Z_InitResponse *session = 0; /* session parameters */
140 static char last_scan[512] = "0";
141 static char last_cmd[100] = "?";
144 static CCL_bibset bibset; /* CCL bibset handle */
148 static void send_apdu(Z_APDU *a)
153 if (!z_APDU(out, &a, 0))
155 odr_perror(out, "Encoding APDU");
158 buf = odr_getbuf(out, &len, 0);
159 odr_reset(out); /* release the APDU */
160 if (cs_put(conn, buf, len) < 0)
162 fprintf(stderr, "cs_put: %s", cs_errmsg(cs_errno(conn)));
167 /* INIT SERVICE ------------------------------- */
169 static void send_initRequest()
171 Z_APDU *apdu = zget_APDU(out, Z_APDU_initRequest);
172 Z_InitRequest *req = apdu->u.initRequest;
174 ODR_MASK_SET(req->options, Z_Options_search);
175 ODR_MASK_SET(req->options, Z_Options_present);
176 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
177 ODR_MASK_SET(req->options, Z_Options_triggerResourceCtrl);
178 ODR_MASK_SET(req->options, Z_Options_scan);
180 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
181 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
182 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
184 req->idAuthentication = auth;
187 printf("Sent initrequest.\n");
190 static int process_initResponse(Z_InitResponse *res)
192 /* save session parameters for later use */
193 session_mem = odr_extract_mem(in);
197 printf("Connection rejected by target.\n");
199 printf("Connection accepted by target.\n");
200 if (res->implementationId)
201 printf("ID : %s\n", res->implementationId);
202 if (res->implementationName)
203 printf("Name : %s\n", res->implementationName);
204 if (res->implementationVersion)
205 printf("Version: %s\n", res->implementationVersion);
206 if (res->userInformationField)
208 printf("UserInformationfield:\n");
209 if (!z_External(print, (Z_External**)&res-> userInformationField,
212 odr_perror(print, "Printing userinfo\n");
215 if (res->userInformationField->which == Z_External_octet)
217 printf("Guessing visiblestring:\n");
218 printf("'%s'\n", res->userInformationField->u. octet_aligned->buf);
224 int cmd_open(char *arg)
227 char type[100], addr[100];
232 printf("Already connected.\n");
235 if (!*arg || sscanf(arg, "%[^:]:%s", type, addr) < 2)
237 fprintf(stderr, "Usage: open (osi|tcp) ':' [tsel '/']host[':'port]\n");
241 if (!strcmp(type, "osi"))
243 if (!(add = mosi_strtoaddr(addr)))
253 if (!strcmp(type, "tcp"))
255 if (!(add = tcpip_strtoaddr(addr)))
261 protocol = PROTO_Z3950;
265 fprintf(stderr, "Bad type: %s\n", type);
268 if (!(conn = cs_create(t, 1, protocol)))
273 printf("Connecting...");
275 if (cs_connect(conn, add) < 0)
287 int cmd_authentication(char *arg)
289 static Z_IdAuthentication au;
290 static char open[256];
294 printf("Auth field set to null\n");
299 au.which = Z_IdAuthentication_open;
305 /* SEARCH SERVICE ------------------------------ */
307 static void display_variant(Z_Variant *v, int level)
311 for (i = 0; i < v->num_triples; i++)
313 printf("%*sclass=%d,type=%d", level * 4, "", *v->triples[i]->class,
314 *v->triples[i]->type);
315 if (v->triples[i]->which == Z_Triple_internationalString)
316 printf(",value=%s\n", v->triples[i]->value.internationalString);
322 static void display_grs1(Z_GenericRecord *r, int level)
328 for (i = 0; i < r->num_elements; i++)
332 printf("%*s", level * 4, "");
336 printf("%d,", *t->tagType);
339 if (t->tagValue->which == Z_StringOrNumeric_numeric)
340 printf("%d) ", *t->tagValue->u.numeric);
342 printf("%s) ", t->tagValue->u.string);
343 if (t->content->which == Z_ElementData_subtree)
346 display_grs1(t->content->u.subtree, level+1);
348 else if (t->content->which == Z_ElementData_string)
349 printf("%s\n", t->content->u.string);
350 else if (t->content->which == Z_ElementData_numeric)
351 printf("%d\n", *t->content->u.numeric);
352 else if (t->content->which == Z_ElementData_noDataRequested)
353 printf("[No data requested]\n");
354 else if (t->content->which == Z_ElementData_elementEmpty)
355 printf("[Element empty]\n");
356 else if (t->content->which == Z_ElementData_elementNotThere)
357 printf("[Element not there]\n");
360 if (t->appliedVariant)
361 display_variant(t->appliedVariant, level+1);
362 if (t->metaData && t->metaData->supportedVariants)
366 printf("%*s---- variant list\n", (level+1)*4, "");
367 for (c = 0; c < t->metaData->num_supportedVariants; c++)
369 printf("%*svariant #%d\n", (level+1)*4, "", c);
370 display_variant(t->metaData->supportedVariants[c], level + 2);
376 static void display_record(Z_DatabaseRecord *p)
378 Z_External *r = (Z_External*) p;
379 oident *ent = oid_getentbyoid(r->direct_reference);
381 if (r->direct_reference)
383 printf("Record type: ");
385 printf("%s\n", ent->desc);
386 else if (!odr_oid(print, &r->direct_reference, 0))
388 odr_perror(print, "print oid");
392 if (r->which == Z_External_octet && p->u.octet_aligned->len)
393 marc_display ((char*)p->u.octet_aligned->buf, stdout);
394 else if (ent->value == VAL_SUTRS)
396 if (r->which != Z_External_sutrs)
398 printf("Expecting single SUTRS type for SUTRS.\n");
401 printf("%.*s", r->u.sutrs->len, r->u.sutrs->buf);
403 else if (ent->value == VAL_GRS1)
405 if (r->which != Z_External_grs1)
407 printf("Expecting single GRS type for GRS.\n");
410 display_grs1(r->u.grs1, 0);
414 printf("Unknown record representation.\n");
415 if (!z_External(print, &r, 0))
417 odr_perror(print, "Printing external");
423 static void display_diagrec(Z_DiagRec *p)
427 Z_DefaultDiagFormat *r;
432 printf("Diagnostic message from database:\n");
434 if (p->which != Z_DiagRec_defaultFormat)
436 printf("Diagnostic record not in default format.\n");
440 r = p->u.defaultFormat;
442 if (!(ent = oid_getentbyoid(r->diagnosticSetId)) ||
443 ent->class != CLASS_DIAGSET || ent->value != VAL_BIB1)
444 printf("Missing or unknown diagset\n");
445 printf(" [%d] %s", *r->condition, diagbib1_str(*r->condition));
446 if (r->addinfo && *r->addinfo)
447 printf(" -- %s\n", r->addinfo);
452 static void display_nameplusrecord(Z_NamePlusRecord *p)
455 printf("[%s]", p->databaseName);
456 if (p->which == Z_NamePlusRecord_surrogateDiagnostic)
457 display_diagrec(p->u.surrogateDiagnostic);
459 display_record(p->u.databaseRecord);
462 static void display_records(Z_Records *p)
466 if (p->which == Z_Records_NSD)
467 display_diagrec(p->u.nonSurrogateDiagnostic);
470 printf("Records: %d\n", p->u.databaseOrSurDiagnostics->num_records);
471 for (i = 0; i < p->u.databaseOrSurDiagnostics->num_records; i++)
472 display_nameplusrecord(p->u.databaseOrSurDiagnostics->records[i]);
476 static int send_searchRequest(char *arg)
478 Z_APDU *apdu = zget_APDU(out, Z_APDU_searchRequest);
479 Z_SearchRequest *req = apdu->u.searchRequest;
480 char *databaseNames = database;
484 struct ccl_rpn_node *rpn;
490 Z_RPNQuery *RPNquery;
498 rpn = ccl_find_str(bibset, arg, &error, &pos);
501 printf("CCL ERROR: %s\n", ccl_err_msg(error));
507 if (!strcmp(arg, "@big")) /* strictly for troublemaking */
509 static unsigned char big[2100];
512 /* send a very big referenceid to test transport stack etc. */
513 memset(big, 'A', 2100);
514 bigo.len = bigo.size = 2100;
516 req->referenceId = &bigo;
521 sprintf(setstring, "%d", ++setnumber);
522 req->resultSetName = setstring;
524 *req->smallSetUpperBound = smallSetUpperBound;
525 *req->largeSetLowerBound = largeSetLowerBound;
526 *req->mediumSetPresentNumber = mediumSetPresentNumber;
527 if (smallSetUpperBound > 0 || (largeSetLowerBound > 1 &&
528 mediumSetPresentNumber > 0))
532 prefsyn.proto = protocol;
533 prefsyn.class = CLASS_RECSYN;
534 prefsyn.value = recordsyntax;
535 req->preferredRecordSyntax = odr_oiddup(out, oid_getoidbyent(&prefsyn));
536 req->smallSetElementSetNames =
537 req->mediumSetElementSetNames = elementSetNames;
539 req->num_databaseNames = 1;
540 req->databaseNames = &databaseNames;
545 query.which = Z_Query_type_1;
548 assert((RPNquery = ccl_rpn_query(rpn)));
550 RPNquery = p_query_rpn (out, arg);
553 printf("Prefix query error\n");
557 bib1.proto = protocol;
558 bib1.class = CLASS_ATTSET;
559 bib1.value = VAL_BIB1;
560 RPNquery->attributeSetId = oid_getoidbyent(&bib1);
561 query.u.type_1 = RPNquery;
563 query.which = Z_Query_type_2;
564 query.u.type_2 = &ccl_query;
565 ccl_query.buf = (unsigned char*) arg;
566 ccl_query.len = strlen(arg);
571 printf("Sent searchRequest.\n");
575 static int process_searchResponse(Z_SearchResponse *res)
577 if (*res->searchStatus)
578 printf("Search was a success.\n");
580 printf("Search was a bloomin' failure.\n");
581 printf("Number of hits: %d, setno %d\n",
582 *res->resultCount, setnumber);
583 printf("records returned: %d\n",
584 *res->numberOfRecordsReturned);
585 setno += *res->numberOfRecordsReturned;
587 display_records(res->records);
591 static int cmd_find(char *arg)
595 printf("Find what?\n");
600 printf("Not connected yet\n");
603 if (!send_searchRequest(arg))
608 static int cmd_ssub(char *arg)
610 if (!(smallSetUpperBound = atoi(arg)))
615 static int cmd_lslb(char *arg)
617 if (!(largeSetLowerBound = atoi(arg)))
622 static int cmd_mspn(char *arg)
624 if (!(mediumSetPresentNumber = atoi(arg)))
629 static int cmd_status(char *arg)
631 printf("smallSetUpperBound: %d\n", smallSetUpperBound);
632 printf("largeSetLowerBound: %d\n", largeSetLowerBound);
633 printf("mediumSetPresentNumber: %d\n", mediumSetPresentNumber);
637 static int cmd_base(char *arg)
641 printf("Usage: base <database>\n");
644 strcpy(database, arg);
648 static int cmd_setnames(char *arg)
652 printf("Set numbering enabled.\n");
657 printf("Set numbering disabled.\n");
663 /* PRESENT SERVICE ----------------------------- */
665 static int send_presentRequest(char *arg)
667 Z_APDU *apdu = zget_APDU(out, Z_APDU_presentRequest);
668 Z_PresentRequest *req = apdu->u.presentRequest;
669 Z_RecordComposition compo;
675 if ((p = strchr(arg, '+')))
685 sprintf(setstring, "%d", setnumber);
686 req->resultSetId = setstring;
688 req->resultSetStartPoint = &setno;
689 req->numberOfRecordsRequested = &nos;
690 prefsyn.proto = protocol;
691 prefsyn.class = CLASS_RECSYN;
692 prefsyn.value = recordsyntax;
693 req->preferredRecordSyntax = oid_getoidbyent(&prefsyn);
696 req->recordComposition = &compo;
697 compo.which = Z_RecordComp_simple;
698 compo.u.simple = elementSetNames;
701 printf("Sent presentRequest (%d+%d).\n", setno, nos);
705 void process_close(Z_Close *req)
707 Z_APDU *apdu = zget_APDU(out, Z_APDU_close);
708 Z_Close *res = apdu->u.close;
710 static char *reasons[] =
715 "cost limit reached",
717 "security violation",
724 printf("Reason: %s, message: %s\n", reasons[*req->closeReason],
725 req->diagnosticInformation ? req->diagnosticInformation : "NULL");
728 printf("Goodbye.\n");
731 *res->closeReason = Z_Close_finished;
733 printf("Sent response.\n");
737 static int cmd_show(char *arg)
739 if (!send_presentRequest(arg))
744 int cmd_quit(char *arg)
746 printf("See you later, alligator.\n");
750 int cmd_cancel(char *arg)
752 Z_APDU *apdu = zget_APDU(out, Z_APDU_triggerResourceControlRequest);
753 Z_TriggerResourceControlRequest *req =
754 apdu->u.triggerResourceControlRequest;
759 printf("Session not initialized yet\n");
762 if (!ODR_MASK_GET(session->options, Z_Options_triggerResourceCtrl))
764 printf("Target doesn't support cancel (trigger resource ctrl)\n");
767 *req->requestedAction = Z_TriggerResourceCtrl_cancel;
768 req->resultSetWanted = &false;
771 printf("Sent cancel request\n");
775 int send_scanrequest(char *string, int pp, int num)
777 Z_APDU *apdu = zget_APDU(out, Z_APDU_scanRequest);
778 Z_ScanRequest *req = apdu->u.scanRequest;
782 req->num_databaseNames = 1;
783 req->databaseNames = &db;
784 attset.proto = protocol;
785 attset.class = CLASS_ATTSET;
786 attset.value = VAL_BIB1;
787 req->attributeSet = oid_getoidbyent(&attset);
788 req->termListAndStartPoint = p_query_scan(out, string);
789 req->numberOfTermsRequested = #
790 req->preferredPositionInResponse = &pp;
795 void display_term(Z_TermInfo *t)
797 if (t->term->which == Z_Term_general)
799 printf("%.*s (%d)\n", t->term->u.general->len, t->term->u.general->buf,
800 t->globalOccurrences ? *t->globalOccurrences : -1);
801 sprintf(last_scan, "%.*s", t->term->u.general->len,
802 t->term->u.general->buf);
805 printf("Term type not general.\n");
808 void process_scanResponse(Z_ScanResponse *res)
812 printf("SCAN: %d entries, position=%d\n", *res->numberOfEntriesReturned,
813 *res->positionOfTerm);
814 if (*res->scanStatus != Z_Scan_success)
815 printf("Scan returned code %d\n", *res->scanStatus);
818 if (res->entries->which == Z_ListEntries_entries)
820 Z_Entries *ent = res->entries->u.entries;
822 for (i = 0; i < ent->num_entries; i++)
823 if (ent->entries[i]->which == Z_Entry_termInfo)
825 printf("%c ", i + 1 == *res->positionOfTerm ? '*' : ' ');
826 display_term(ent->entries[i]->u.termInfo);
829 display_diagrec(ent->entries[i]->u.surrogateDiagnostic);
832 display_diagrec(res->entries->u.nonSurrogateDiagnostics->diagRecs[0]);
835 int cmd_scan(char *arg)
839 printf("Session not initialized yet\n");
842 if (!ODR_MASK_GET(session->options, Z_Options_scan))
844 printf("Target doesn't support scan\n");
849 if (send_scanrequest(arg, 5, 20) < 0)
853 if (send_scanrequest(last_scan, 1, 20) < 0)
858 int cmd_format(char *arg)
862 printf("Usage: format <recordsyntax>\n");
865 if (!strcmp(arg, "sutrs"))
867 printf("Preferred format is SUTRS.\n");
868 recordsyntax = VAL_SUTRS;
871 else if (!strcmp(arg, "usmarc"))
873 printf("Preferred format is USMARC\n");
874 recordsyntax = VAL_USMARC;
877 else if (!strcmp(arg, "danmarc"))
879 printf("Preferred format is DANMARC\n");
880 recordsyntax = VAL_DANMARC;
883 else if (!strcmp(arg, "grs1"))
885 printf("Preferred format is GRS1\n");
886 recordsyntax = VAL_GRS1;
891 printf("Specify one of {sutrs,usmarc,danmarc,grs1}.\n");
896 int cmd_elements(char *arg)
898 static Z_ElementSetNames esn;
899 static char what[100];
903 printf("Usage: elements <esn>\n");
907 esn.which = Z_ElementSetNames_generic;
908 esn.u.generic = what;
909 elementSetNames = &esn;
913 int cmd_close(char *arg)
915 Z_APDU *apdu = zget_APDU(out, Z_APDU_close);
916 Z_Close *req = apdu->u.close;
918 *req->closeReason = Z_Close_finished;
920 printf("Sent close request.\n");
925 static void initialize(void)
933 if (!(out = odr_createmem(ODR_ENCODE)) ||
934 !(in = odr_createmem(ODR_DECODE)) ||
935 !(print = odr_createmem(ODR_PRINT)))
937 fprintf(stderr, "failed to allocate ODR streams\n");
940 setvbuf(stdout, 0, _IONBF, 0);
944 bibset = ccl_qual_mk ();
945 inf = fopen ("default.bib", "r");
948 ccl_qual_file (bibset, inf);
955 static int client(void)
959 int (*fun)(char *arg);
962 {"open", cmd_open, "('tcp'|'osi')':'[<TSEL>'/']<HOST>[':'<PORT>]"},
963 {"quit", cmd_quit, ""},
964 {"find", cmd_find, "<CCL-QUERY>"},
965 {"base", cmd_base, "<BASE-NAME>"},
966 {"show", cmd_show, "<REC#>['+'<#RECS>]"},
967 {"scan", cmd_scan, "<TERM>"},
968 {"authentication", cmd_authentication, "<ACCTSTRING>"},
969 {"lslb", cmd_lslb, "<largeSetLowerBound>"},
970 {"ssub", cmd_ssub, "<smallSetUpperBound>"},
971 {"mspn", cmd_mspn, "<mediumSetPresentNumber>"},
972 {"status", cmd_status, ""},
973 {"setnames", cmd_setnames, ""},
974 {"cancel", cmd_cancel, ""},
975 {"format", cmd_format, "<recordsyntax>"},
976 {"elements", cmd_elements, "<elementSetName>"},
977 {"close", cmd_close, ""},
981 int netbufferlen = 0;
989 char line[1024], word[1024], arg[1024];
994 FD_SET(cs_fileno(conn), &input);
995 if ((res = select(20, &input, 0, 0, 0)) < 0)
1002 if (FD_ISSET(0, &input))
1004 /* quick & dirty way to get a command line. */
1007 if ((res = sscanf(line, "%s %[^;]", word, arg)) <= 0)
1009 strcpy(word, last_cmd);
1014 strcpy(last_cmd, word);
1015 for (i = 0; cmd[i].cmd; i++)
1016 if (!strncmp(cmd[i].cmd, word, strlen(word)))
1018 res = (*cmd[i].fun)(arg);
1021 if (!cmd[i].cmd) /* dump our help-screen */
1023 printf("Unknown command: %s.\n", word);
1024 printf("Currently recognized commands:\n");
1025 for (i = 0; cmd[i].cmd; i++)
1026 printf(" %s %s\n", cmd[i].cmd, cmd[i].ad);
1032 if (conn && FD_ISSET(cs_fileno(conn), &input))
1036 if ((res = cs_get(conn, &netbuffer, &netbufferlen)) < 0)
1043 printf("Target closed connection.\n");
1046 odr_reset(in); /* release APDU from last round */
1047 odr_setbuf(in, netbuffer, res, 0);
1048 if (!z_APDU(in, &apdu, 0))
1050 odr_perror(in, "Decoding incoming APDU");
1051 fprintf(stderr, "[Near %d]\n", odr_offset(in));
1052 fprintf(stderr, "Packet dump:\n---------\n");
1053 odr_dumpBER(stderr, netbuffer, res);
1054 fprintf(stderr, "---------\n");
1058 if (!z_APDU(print, &apdu, 0))
1060 odr_perror(print, "Failed to print incoming APDU");
1067 case Z_APDU_initResponse:
1068 process_initResponse(apdu->u.initResponse);
1070 case Z_APDU_searchResponse:
1071 process_searchResponse(apdu->u.searchResponse);
1073 case Z_APDU_scanResponse:
1074 process_scanResponse(apdu->u.scanResponse);
1076 case Z_APDU_presentResponse:
1077 printf("Received presentResponse.\n");
1079 *apdu->u.presentResponse->numberOfRecordsReturned;
1080 if (apdu->u.presentResponse->records)
1081 display_records(apdu->u.presentResponse->records);
1083 printf("No records.\n");
1086 printf("Target has closed the association.\n");
1087 process_close(apdu->u.close);
1090 printf("Received unknown APDU type (%d).\n",
1097 while (cs_more(conn));
1103 int main(int argc, char **argv)