2 * Copyright (c) 1995, Index Data.
3 * See the file LICENSE for details.
4 * Sebastian Hammer, Adam Dickmeiss
7 * Revision 1.22 1995-10-11 14:49:12 quinn
10 * Revision 1.21 1995/09/29 17:01:47 quinn
13 * Revision 1.20 1995/08/29 14:24:13 quinn
14 * Added second half of close-handshake
16 * Revision 1.19 1995/08/29 11:17:28 quinn
17 * Added code to receive close
19 * Revision 1.18 1995/08/28 12:21:27 quinn
20 * Client can now ask for simple element set names.
22 * Revision 1.17 1995/08/17 12:45:02 quinn
23 * Fixed minor problems with GRS-1. Added support in c&s.
25 * Revision 1.16 1995/08/15 12:00:04 quinn
28 * Revision 1.15 1995/06/22 09:28:03 quinn
29 * Fixed bug in SUTRS processing.
31 * Revision 1.14 1995/06/19 12:37:41 quinn
34 * Revision 1.13 1995/06/16 10:29:11 quinn
35 * *** empty log message ***
37 * Revision 1.12 1995/06/15 07:44:57 quinn
40 * Revision 1.11 1995/06/14 15:26:40 quinn
41 * *** empty log message ***
43 * Revision 1.10 1995/06/06 14:56:58 quinn
46 * Revision 1.9 1995/06/06 08:15:19 quinn
49 * Revision 1.8 1995/06/05 10:52:22 quinn
52 * Revision 1.7 1995/06/02 09:50:09 quinn
55 * Revision 1.6 1995/05/31 08:29:21 quinn
56 * Nothing significant.
58 * Revision 1.5 1995/05/29 08:10:47 quinn
59 * Moved oid.c to util.
61 * Revision 1.4 1995/05/22 15:30:13 adam
62 * Client uses prefix query notation.
64 * Revision 1.3 1995/05/22 15:06:53 quinn
65 * *** empty log message ***
67 * Revision 1.2 1995/05/22 14:56:40 quinn
68 * *** empty log message ***
70 * Revision 1.1 1995/05/22 11:30:31 quinn
71 * Added prettier client.
77 * This is the obligatory little toy client, whose primary purpose is
78 * to illustrate the use of the YAZ service-level API.
90 #include <sys/select.h>
100 #include <marcdisp.h>
101 #include <diagbib1.h>
111 #define C_PROMPT "Z> "
113 static ODR out, in, print; /* encoding and decoding streams */
114 static COMSTACK conn = 0; /* our z-association */
115 static Z_IdAuthentication *auth = 0; /* our current auth definition */
116 static char database[512] = "Default"; /* Database name */
117 static int setnumber = 0; /* current result set number */
118 static int smallSetUpperBound = 0;
119 static int largeSetLowerBound = 1;
120 static int mediumSetPresentNumber = 0;
121 static Z_ElementSetNames *elementSetNames = 0;
122 static int setno = 1; /* current set offset */
123 static int protocol = PROTO_Z3950; /* current app protocol */
124 static int recordsyntax = VAL_USMARC;
125 static int sent_close = 0;
126 static ODR_MEM session_mem; /* memory handle for init-response */
127 static Z_InitResponse *session = 0; /* session parameters */
128 static char last_scan[512] = "0";
129 static char last_cmd[100] = "?";
132 static CCL_bibset bibset; /* CCL bibset handle */
136 static void send_apdu(Z_APDU *a)
141 if (!z_APDU(out, &a, 0))
143 odr_perror(out, "Encoding APDU");
146 buf = odr_getbuf(out, &len, 0);
147 odr_reset(out); /* release the APDU */
148 if (cs_put(conn, buf, len) < 0)
150 fprintf(stderr, "cs_put: %s", cs_errmsg(cs_errno(conn)));
155 /* INIT SERVICE ------------------------------- */
157 static void send_initRequest()
159 Z_APDU *apdu = zget_APDU(out, Z_APDU_initRequest);
160 Z_InitRequest *req = apdu->u.initRequest;
162 ODR_MASK_SET(req->options, Z_Options_search);
163 ODR_MASK_SET(req->options, Z_Options_present);
164 ODR_MASK_SET(req->options, Z_Options_namedResultSets);
165 ODR_MASK_SET(req->options, Z_Options_triggerResourceCtrl);
166 ODR_MASK_SET(req->options, Z_Options_scan);
168 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_1);
169 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_2);
170 ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
172 req->idAuthentication = auth;
175 printf("Sent initrequest.\n");
178 static int process_initResponse(Z_InitResponse *res)
180 /* save session parameters for later use */
181 session_mem = odr_extract_mem(in);
185 printf("Connection rejected by target.\n");
187 printf("Connection accepted by target.\n");
188 if (res->implementationId)
189 printf("ID : %s\n", res->implementationId);
190 if (res->implementationName)
191 printf("Name : %s\n", res->implementationName);
192 if (res->implementationVersion)
193 printf("Version: %s\n", res->implementationVersion);
194 if (res->userInformationField)
196 printf("UserInformationfield:\n");
197 if (!z_External(print, (Z_External**)&res-> userInformationField,
200 odr_perror(print, "Printing userinfo\n");
203 if (res->userInformationField->which == Z_External_octet)
205 printf("Guessing visiblestring:\n");
206 printf("'%s'\n", res->userInformationField->u. octet_aligned->buf);
212 int cmd_open(char *arg)
215 char type[100], addr[100];
220 printf("Already connected.\n");
223 if (!*arg || sscanf(arg, "%[^:]:%s", type, addr) < 2)
225 fprintf(stderr, "Usage: open (osi|tcp) ':' [tsel '/']host[':'port]\n");
229 if (!strcmp(type, "osi"))
231 if (!(add = mosi_strtoaddr(addr)))
241 if (!strcmp(type, "tcp"))
243 if (!(add = tcpip_strtoaddr(addr)))
249 protocol = PROTO_Z3950;
253 fprintf(stderr, "Bad type: %s\n", type);
256 if (!(conn = cs_create(t, 1, protocol)))
261 printf("Connecting...");
263 if (cs_connect(conn, add) < 0)
275 int cmd_authentication(char *arg)
277 static Z_IdAuthentication au;
278 static char open[256];
282 printf("Auth field set to null\n");
287 au.which = Z_IdAuthentication_open;
293 /* SEARCH SERVICE ------------------------------ */
295 void display_grs1(Z_GenericRecord *r, int level)
301 for (i = 0; i < r->num_elements; i++)
305 printf("%*s", level * 4, "");
309 printf("%d,", *t->tagType);
312 if (t->tagValue->which == Z_StringOrNumeric_numeric)
313 printf("%d) ", *t->tagValue->u.numeric);
315 printf("%s) ", t->tagValue->u.string);
316 if (t->content->which == Z_ElementData_subtree)
319 display_grs1(t->content->u.subtree, level+1);
321 else if (t->content->which == Z_ElementData_string)
322 printf("%s\n", t->content->u.string);
323 else if (t->content->which == Z_ElementData_numeric)
324 printf("%d\n", *t->content->u.numeric);
330 void display_record(Z_DatabaseRecord *p)
332 Z_External *r = (Z_External*) p;
333 oident *ent = oid_getentbyoid(r->direct_reference);
335 if (r->direct_reference)
337 printf("Record type: ");
339 printf("%s\n", ent->desc);
340 else if (!odr_oid(print, &r->direct_reference, 0))
342 odr_perror(print, "print oid");
346 if (r->which == Z_External_octet && p->u.octet_aligned->len)
347 marc_display ((char*)p->u.octet_aligned->buf, stdout);
348 else if (ent->value == VAL_SUTRS)
350 if (r->which != Z_External_sutrs)
352 printf("Expecting single SUTRS type for SUTRS.\n");
355 printf("%.*s", r->u.sutrs->len, r->u.sutrs->buf);
357 else if (ent->value == VAL_GRS1)
359 if (r->which != Z_External_grs1)
361 printf("Expecting single GRS type for GRS.\n");
364 display_grs1(r->u.grs1, 0);
368 printf("Unknown record representation.\n");
369 if (!z_External(print, &r, 0))
371 odr_perror(print, "Printing external");
377 static void display_diagrec(Z_DiagRec *p)
381 Z_DefaultDiagFormat *r;
386 printf("Diagnostic message from database:\n");
388 if (p->which != Z_DiagRec_defaultFormat)
390 printf("Diagnostic record not in default format.\n");
394 r = p->u.defaultFormat;
396 if (!(ent = oid_getentbyoid(r->diagnosticSetId)) ||
397 ent->class != CLASS_DIAGSET || ent->value != VAL_BIB1)
398 printf("Missing or unknown diagset\n");
399 printf(" [%d] %s", *r->condition, diagbib1_str(*r->condition));
400 if (r->addinfo && *r->addinfo)
401 printf(" -- %s\n", r->addinfo);
406 static void display_nameplusrecord(Z_NamePlusRecord *p)
409 printf("[%s]", p->databaseName);
410 if (p->which == Z_NamePlusRecord_surrogateDiagnostic)
411 display_diagrec(p->u.surrogateDiagnostic);
413 display_record(p->u.databaseRecord);
416 static void display_records(Z_Records *p)
420 if (p->which == Z_Records_NSD)
421 display_diagrec(p->u.nonSurrogateDiagnostic);
424 printf("Records: %d\n", p->u.databaseOrSurDiagnostics->num_records);
425 for (i = 0; i < p->u.databaseOrSurDiagnostics->num_records; i++)
426 display_nameplusrecord(p->u.databaseOrSurDiagnostics->records[i]);
430 static int send_searchRequest(char *arg)
432 Z_APDU *apdu = zget_APDU(out, Z_APDU_searchRequest);
433 Z_SearchRequest *req = apdu->u.searchRequest;
434 char *databaseNames = database;
438 struct ccl_rpn_node *rpn;
444 Z_RPNQuery *RPNquery;
452 rpn = ccl_find_str(bibset, arg, &error, &pos);
455 printf("CCL ERROR: %s\n", ccl_err_msg(error));
461 if (!strcmp(arg, "@big")) /* strictly for troublemaking */
463 static unsigned char big[2100];
466 /* send a very big referenceid to test transport stack etc. */
467 memset(big, 'A', 2100);
468 bigo.len = bigo.size = 2100;
470 req->referenceId = &bigo;
475 sprintf(setstring, "%d", ++setnumber);
476 req->resultSetName = setstring;
478 *req->smallSetUpperBound = smallSetUpperBound;
479 *req->largeSetLowerBound = largeSetLowerBound;
480 *req->mediumSetPresentNumber = mediumSetPresentNumber;
481 if (smallSetUpperBound > 0 || (largeSetLowerBound > 1 &&
482 mediumSetPresentNumber > 0))
486 prefsyn.proto = protocol;
487 prefsyn.class = CLASS_RECSYN;
488 prefsyn.value = recordsyntax;
489 req->preferredRecordSyntax = odr_oiddup(out, oid_getoidbyent(&prefsyn));
490 req->smallSetElementSetNames =
491 req->mediumSetElementSetNames = elementSetNames;
493 req->num_databaseNames = 1;
494 req->databaseNames = &databaseNames;
499 query.which = Z_Query_type_1;
502 assert((RPNquery = ccl_rpn_query(rpn)));
504 RPNquery = p_query_rpn (out, arg);
507 printf("Prefix query error\n");
511 bib1.proto = protocol;
512 bib1.class = CLASS_ATTSET;
513 bib1.value = VAL_BIB1;
514 RPNquery->attributeSetId = oid_getoidbyent(&bib1);
515 query.u.type_1 = RPNquery;
517 query.which = Z_Query_type_2;
518 query.u.type_2 = &ccl_query;
519 ccl_query.buf = (unsigned char*) arg;
520 ccl_query.len = strlen(arg);
525 printf("Sent searchRequest.\n");
529 static int process_searchResponse(Z_SearchResponse *res)
531 if (*res->searchStatus)
532 printf("Search was a success.\n");
534 printf("Search was a bloomin' failure.\n");
535 printf("Number of hits: %d, setno %d\n",
536 *res->resultCount, setnumber);
537 printf("records returned: %d\n",
538 *res->numberOfRecordsReturned);
539 setno += *res->numberOfRecordsReturned;
541 display_records(res->records);
545 static int cmd_find(char *arg)
549 printf("Find what?\n");
554 printf("Not connected yet\n");
557 if (!send_searchRequest(arg))
562 static int cmd_ssub(char *arg)
564 if (!(smallSetUpperBound = atoi(arg)))
569 static int cmd_lslb(char *arg)
571 if (!(largeSetLowerBound = atoi(arg)))
576 static int cmd_mspn(char *arg)
578 if (!(mediumSetPresentNumber = atoi(arg)))
583 static int cmd_status(char *arg)
585 printf("smallSetUpperBound: %d\n", smallSetUpperBound);
586 printf("largeSetLowerBound: %d\n", largeSetLowerBound);
587 printf("mediumSetPresentNumber: %d\n", mediumSetPresentNumber);
591 static int cmd_base(char *arg)
595 printf("Usage: base <database>\n");
598 strcpy(database, arg);
602 static int cmd_setnames(char *arg)
606 printf("Set numbering enabled.\n");
611 printf("Set numbering disabled.\n");
617 /* PRESENT SERVICE ----------------------------- */
619 static int send_presentRequest(char *arg)
621 Z_APDU *apdu = zget_APDU(out, Z_APDU_presentRequest);
622 Z_PresentRequest *req = apdu->u.presentRequest;
623 Z_RecordComposition compo;
629 if ((p = strchr(arg, '+')))
639 sprintf(setstring, "%d", setnumber);
640 req->resultSetId = setstring;
642 req->resultSetStartPoint = &setno;
643 req->numberOfRecordsRequested = &nos;
644 prefsyn.proto = protocol;
645 prefsyn.class = CLASS_RECSYN;
646 prefsyn.value = recordsyntax;
647 req->preferredRecordSyntax = oid_getoidbyent(&prefsyn);
650 req->recordComposition = &compo;
651 compo.which = Z_RecordComp_simple;
652 compo.u.simple = elementSetNames;
655 printf("Sent presentRequest (%d+%d).\n", setno, nos);
659 void process_close(Z_Close *req)
661 Z_APDU *apdu = zget_APDU(out, Z_APDU_close);
662 Z_Close *res = apdu->u.close;
664 static char *reasons[] =
678 printf("Reason: %s, message: %s\n", reasons[*req->closeReason],
679 req->diagnosticInformation ? req->diagnosticInformation : "NULL");
682 printf("Goodbye.\n");
685 *res->closeReason = Z_Close_finished;
687 printf("Sent response.\n");
691 static int cmd_show(char *arg)
693 if (!send_presentRequest(arg))
698 int cmd_quit(char *arg)
700 printf("See you later, alligator.\n");
704 int cmd_cancel(char *arg)
706 Z_APDU *apdu = zget_APDU(out, Z_APDU_triggerResourceControlRequest);
707 Z_TriggerResourceControlRequest *req =
708 apdu->u.triggerResourceControlRequest;
713 printf("Session not initialized yet\n");
716 if (!ODR_MASK_GET(session->options, Z_Options_triggerResourceCtrl))
718 printf("Target doesn't support cancel (trigger resource ctrl)\n");
721 *req->requestedAction = Z_TriggerResourceCtrl_cancel;
722 req->resultSetWanted = &false;
725 printf("Sent cancel request\n");
729 int send_scanrequest(char *string, int pp, int num)
731 Z_APDU *apdu = zget_APDU(out, Z_APDU_scanRequest);
732 Z_ScanRequest *req = apdu->u.scanRequest;
736 req->num_databaseNames = 1;
737 req->databaseNames = &db;
738 attset.proto = protocol;
739 attset.class = CLASS_ATTSET;
740 attset.value = VAL_BIB1;
741 req->attributeSet = oid_getoidbyent(&attset);
742 req->termListAndStartPoint = p_query_scan(out, string);
743 req->numberOfTermsRequested = #
744 req->preferredPositionInResponse = &pp;
749 void display_term(Z_TermInfo *t)
751 if (t->term->which == Z_Term_general)
753 printf("%.*s (%d)\n", t->term->u.general->len, t->term->u.general->buf,
754 t->globalOccurrences ? *t->globalOccurrences : -1);
755 sprintf(last_scan, "%.*s", t->term->u.general->len,
756 t->term->u.general->buf);
759 printf("Term type not general.\n");
762 void process_scanResponse(Z_ScanResponse *res)
766 printf("SCAN: %d entries, position=%d\n", *res->numberOfEntriesReturned,
767 *res->positionOfTerm);
768 if (*res->scanStatus != Z_Scan_success)
769 printf("Scan returned code %d\n", *res->scanStatus);
772 if (res->entries->which == Z_ListEntries_entries)
774 Z_Entries *ent = res->entries->u.entries;
776 for (i = 0; i < ent->num_entries; i++)
777 if (ent->entries[i]->which == Z_Entry_termInfo)
779 printf("%c ", i + 1 == *res->positionOfTerm ? '*' : ' ');
780 display_term(ent->entries[i]->u.termInfo);
783 display_diagrec(ent->entries[i]->u.surrogateDiagnostic);
786 display_diagrec(res->entries->u.nonSurrogateDiagnostics->diagRecs[0]);
789 int cmd_scan(char *arg)
793 printf("Session not initialized yet\n");
796 if (!ODR_MASK_GET(session->options, Z_Options_scan))
798 printf("Target doesn't support scan\n");
803 if (send_scanrequest(arg, 5, 20) < 0)
807 if (send_scanrequest(last_scan, 1, 20) < 0)
812 int cmd_format(char *arg)
816 printf("Usage: format <recordsyntax>\n");
819 if (!strcmp(arg, "sutrs"))
821 printf("Preferred format is SUTRS.\n");
822 recordsyntax = VAL_SUTRS;
825 else if (!strcmp(arg, "usmarc"))
827 printf("Preferred format is USMARC\n");
828 recordsyntax = VAL_USMARC;
831 else if (!strcmp(arg, "danmarc"))
833 printf("Preferred format is DANMARC\n");
834 recordsyntax = VAL_DANMARC;
837 else if (!strcmp(arg, "grs1"))
839 printf("Preferred format is GRS1\n");
840 recordsyntax = VAL_GRS1;
845 printf("Specify one of {sutrs,usmarc,danmarc,grs1}.\n");
850 int cmd_elements(char *arg)
852 static Z_ElementSetNames esn;
853 static char what[100];
857 printf("Usage: elements <esn>\n");
861 esn.which = Z_ElementSetNames_generic;
862 esn.u.generic = what;
863 elementSetNames = &esn;
867 int cmd_close(char *arg)
869 Z_APDU *apdu = zget_APDU(out, Z_APDU_close);
870 Z_Close *req = apdu->u.close;
872 *req->closeReason = Z_Close_finished;
874 printf("Sent close request.\n");
879 static void initialize(void)
887 if (!(out = odr_createmem(ODR_ENCODE)) ||
888 !(in = odr_createmem(ODR_DECODE)) ||
889 !(print = odr_createmem(ODR_PRINT)))
891 fprintf(stderr, "failed to allocate ODR streams\n");
894 setvbuf(stdout, 0, _IONBF, 0);
898 bibset = ccl_qual_mk ();
899 inf = fopen ("default.bib", "r");
902 ccl_qual_file (bibset, inf);
909 static int client(void)
913 int (*fun)(char *arg);
916 {"open", cmd_open, "('tcp'|'osi')':'[<TSEL>'/']<HOST>[':'<PORT>]"},
917 {"quit", cmd_quit, ""},
918 {"find", cmd_find, "<CCL-QUERY>"},
919 {"base", cmd_base, "<BASE-NAME>"},
920 {"show", cmd_show, "<REC#>['+'<#RECS>]"},
921 {"scan", cmd_scan, "<TERM>"},
922 {"authentication", cmd_authentication, "<ACCTSTRING>"},
923 {"lslb", cmd_lslb, "<largeSetLowerBound>"},
924 {"ssub", cmd_ssub, "<smallSetUpperBound>"},
925 {"mspn", cmd_mspn, "<mediumSetPresentNumber>"},
926 {"status", cmd_status, ""},
927 {"setnames", cmd_setnames, ""},
928 {"cancel", cmd_cancel, ""},
929 {"format", cmd_format, "<recordsyntax>"},
930 {"elements", cmd_elements, "<elementSetName>"},
931 {"close", cmd_close, ""},
935 int netbufferlen = 0;
943 char line[1024], word[1024], arg[1024];
948 FD_SET(cs_fileno(conn), &input);
949 if ((res = select(20, &input, 0, 0, 0)) < 0)
956 if (FD_ISSET(0, &input))
958 /* quick & dirty way to get a command line. */
961 if ((res = sscanf(line, "%s %[^;]", word, arg)) <= 0)
963 strcpy(word, last_cmd);
968 strcpy(last_cmd, word);
969 for (i = 0; cmd[i].cmd; i++)
970 if (!strncmp(cmd[i].cmd, word, strlen(word)))
972 res = (*cmd[i].fun)(arg);
975 if (!cmd[i].cmd) /* dump our help-screen */
977 printf("Unknown command: %s.\n", word);
978 printf("Currently recognized commands:\n");
979 for (i = 0; cmd[i].cmd; i++)
980 printf(" %s %s\n", cmd[i].cmd, cmd[i].ad);
986 if (conn && FD_ISSET(cs_fileno(conn), &input))
990 if ((res = cs_get(conn, &netbuffer, &netbufferlen)) < 0)
997 printf("Target closed connection.\n");
1000 odr_reset(in); /* release APDU from last round */
1001 odr_setbuf(in, netbuffer, res, 0);
1002 if (!z_APDU(in, &apdu, 0))
1004 odr_perror(in, "Decoding incoming APDU");
1005 fprintf(stderr, "Packet dump:\n---------\n");
1006 odr_dumpBER(stderr, netbuffer, res);
1007 fprintf(stderr, "---------\n");
1011 if (!z_APDU(print, &apdu, 0))
1013 odr_perror(print, "Failed to print incoming APDU");
1020 case Z_APDU_initResponse:
1021 process_initResponse(apdu->u.initResponse);
1023 case Z_APDU_searchResponse:
1024 process_searchResponse(apdu->u.searchResponse);
1026 case Z_APDU_scanResponse:
1027 process_scanResponse(apdu->u.scanResponse);
1029 case Z_APDU_presentResponse:
1030 printf("Received presentResponse.\n");
1032 *apdu->u.presentResponse->numberOfRecordsReturned;
1033 if (apdu->u.presentResponse->records)
1034 display_records(apdu->u.presentResponse->records);
1036 printf("No records.\n");
1039 printf("Target has closed the association.\n");
1040 process_close(apdu->u.close);
1043 printf("Received unknown APDU type (%d).\n",
1050 while (cs_more(conn));
1056 int main(int argc, char **argv)