2 * IR toolkit for tcl/tk
6 * Revision 1.5 1995-03-10 18:00:15 adam
7 * Actual presentation in line-by-line format. RPN query support.
9 * Revision 1.4 1995/03/09 16:15:08 adam
10 * First presentRequest attempts. Hot-target list.
35 int preferredMessageSize;
36 int maximumMessageSize;
38 Odr_bitmask protocolVersion;
39 char *idAuthentication;
40 char *implementationName;
41 char *implementationId;
56 int smallSetUpperBound;
57 int largeSetLowerBound;
58 int mediumSetPresentNumber;
61 int num_databaseNames;
66 struct IRSetObj_ *child;
69 typedef struct IRRecordList_ {
73 struct IRRecordList_ *next;
76 typedef struct IRSetObj_ {
81 int numberOfRecordsReturned;
83 IRRecordList *record_list;
88 int (*method) (void * obj, Tcl_Interp *interp, int argc, char **argv);
91 static int do_disconnect (void *obj,Tcl_Interp *interp, int argc, char **argv);
94 * get_parent_info: Returns information about parent object.
96 static int get_parent_info (Tcl_Interp *interp, const char *name,
97 Tcl_CmdInfo *parent_info)
99 char parent_name[128];
100 const char *csep = strrchr (name, '.');
105 interp->result = "missing .";
111 memcpy (parent_name, name, pos);
112 parent_name[pos] = '\0';
113 if (!Tcl_GetCommandInfo (interp, parent_name, parent_info))
115 interp->result = "No parent";
122 * ir_method: Search for method in table and invoke method handler
124 int ir_method (void *obj, Tcl_Interp *interp, int argc, char **argv,
129 if (!strcmp (tab->name, argv[1]))
130 return (*tab->method)(obj, interp, argc, argv);
133 Tcl_AppendResult (interp, "unknown method: ", argv[1], NULL);
138 * ir_asc2bitmask: Ascii to ODR bitmask conversion
140 int ir_asc2bitmask (const char *asc, Odr_bitmask *ob)
142 const char *cp = asc + strlen(asc);
149 ODR_MASK_SET (ob, bitno);
156 * ir_strdup: Duplicate string
158 int ir_strdup (Tcl_Interp *interp, char** p, char *s)
160 *p = malloc (strlen(s)+1);
163 interp->result = "malloc fail";
170 /* ------------------------------------------------------- */
173 * do_init_request: init method on IR object
175 static int do_init_request (void *obj, Tcl_Interp *interp,
176 int argc, char **argv)
185 req.options = &p->options;
186 req.protocolVersion = &p->protocolVersion;
187 req.preferredMessageSize = &p->preferredMessageSize;
188 req.maximumRecordSize = &p->maximumMessageSize;
190 req.idAuthentication = p->idAuthentication;
191 req.implementationId = p->implementationId;
192 req.implementationName = p->implementationName;
193 req.implementationVersion = "0.1";
194 req.userInformationField = 0;
196 apdu.u.initRequest = &req;
197 apdu.which = Z_APDU_initRequest;
200 if (!z_APDU (p->odr_out, &apdup, 0))
202 interp->result = odr_errlist [odr_geterror (p->odr_out)];
203 odr_reset (p->odr_out);
206 sbuf = odr_getbuf (p->odr_out, &slen);
207 if (cs_put (p->cs_link, sbuf, slen) < 0)
209 interp->result = "cs_put failed in init";
212 printf("Sent initializeRequest (%d bytes).\n", slen);
217 * do_protocolVersion: Set protocol Version
219 static int do_protocolVersion (void *obj, Tcl_Interp *interp,
220 int argc, char **argv)
223 ir_asc2bitmask (argv[2], &((IRObj *) obj)->protocolVersion);
228 * do_options: Set options
230 static int do_options (void *obj, Tcl_Interp *interp,
231 int argc, char **argv)
234 ir_asc2bitmask (argv[2], &((IRObj *) obj)->options);
239 * do_preferredMessageSize: Set preferred message size
241 static int do_preferredMessageSize (void *obj, Tcl_Interp *interp,
242 int argc, char **argv)
246 if (Tcl_GetInt (interp, argv[2],
247 &((IRObj *)obj)->preferredMessageSize)==TCL_ERROR)
250 sprintf (interp->result, "%d", ((IRObj *)obj)->preferredMessageSize);
255 * do_maximumMessageSize: Set maximum message size
257 static int do_maximumMessageSize (void *obj, Tcl_Interp *interp,
258 int argc, char **argv)
262 if (Tcl_GetInt (interp, argv[2],
263 &((IRObj *)obj)->maximumMessageSize)==TCL_ERROR)
266 sprintf (interp->result, "%d", ((IRObj *)obj)->maximumMessageSize);
272 * do_implementationName: Set Implementation Name.
274 static int do_implementationName (void *obj, Tcl_Interp *interp,
275 int argc, char **argv)
279 free (((IRObj*)obj)->implementationName);
280 if (ir_strdup (interp, &((IRObj*) obj)->implementationName, argv[2])
284 Tcl_AppendResult (interp, ((IRObj*)obj)->implementationName,
290 * do_implementationId: Set Implementation Name.
292 static int do_implementationId (void *obj, Tcl_Interp *interp,
293 int argc, char **argv)
297 free (((IRObj*)obj)->implementationId);
298 if (ir_strdup (interp, &((IRObj*) obj)->implementationId, argv[2])
302 Tcl_AppendResult (interp, ((IRObj*)obj)->implementationId,
308 * do_idAuthentication: Set id Authentication
310 static int do_idAuthentication (void *obj, Tcl_Interp *interp,
311 int argc, char **argv)
315 free (((IRObj*)obj)->idAuthentication);
316 if (ir_strdup (interp, &((IRObj*) obj)->idAuthentication, argv[2])
320 Tcl_AppendResult (interp, ((IRObj*)obj)->idAuthentication,
326 * do_connect: connect method on IR object
328 static int do_connect (void *obj, Tcl_Interp *interp,
329 int argc, char **argv)
336 interp->result = "missing hostname";
339 if (cs_type(p->cs_link) == tcpip_type)
341 addr = tcpip_strtoaddr (argv[2]);
344 interp->result = "tcpip_strtoaddr fail";
347 printf ("tcp/ip connect %s\n", argv[2]);
349 else if (cs_type (p->cs_link) == mosi_type)
351 addr = mosi_strtoaddr (argv[2]);
354 interp->result = "mosi_strtoaddr fail";
357 printf ("mosi connect %s\n", argv[2]);
359 if (cs_connect (p->cs_link, addr) < 0)
361 interp->result = "cs_connect fail";
362 do_disconnect (p, interp, argc, argv);
365 ir_select_add (cs_fileno (p->cs_link), p);
370 * do_disconnect: disconnect method on IR object
372 static int do_disconnect (void *obj, Tcl_Interp *interp,
373 int argc, char **argv)
377 ir_select_remove (cs_fileno (p->cs_link), p);
378 if (cs_type (p->cs_link) == tcpip_type)
380 cs_close (p->cs_link);
381 p->cs_link = cs_create (tcpip_type);
383 else if (cs_type (p->cs_link) == mosi_type)
385 cs_close (p->cs_link);
386 p->cs_link = cs_create (mosi_type);
390 interp->result = "unknown comstack type";
397 * do_comstack: comstack method on IR object
399 static int do_comstack (void *obj, Tcl_Interp *interp,
400 int argc, char **argv)
404 if (!strcmp (argv[2], "tcpip"))
405 ((IRObj *)obj)->cs_link = cs_create (tcpip_type);
406 else if (!strcmp (argv[2], "mosi"))
407 ((IRObj *)obj)->cs_link = cs_create (mosi_type);
410 interp->result = "wrong comstack type";
414 if (cs_type(((IRObj *)obj)->cs_link) == tcpip_type)
415 interp->result = "tcpip";
416 else if (cs_type(((IRObj *)obj)->cs_link) == mosi_type)
417 interp->result = "comstack";
422 * do_callback: add callback
424 static int do_callback (void *obj, Tcl_Interp *interp,
425 int argc, char **argv)
432 if (ir_strdup (interp, &p->callback, argv[2]) == TCL_ERROR)
440 * do_databaseNames: specify database names
442 static int do_databaseNames (void *obj, Tcl_Interp *interp,
443 int argc, char **argv)
450 interp->result = "wrong # args";
453 if (p->databaseNames)
455 for (i=0; i<p->num_databaseNames; i++)
456 free (p->databaseNames[i]);
457 free (p->databaseNames);
459 p->num_databaseNames = argc - 2;
460 if (!(p->databaseNames = malloc (sizeof(*p->databaseNames) *
461 p->num_databaseNames)))
463 interp->result = "malloc fail";
466 for (i=0; i<p->num_databaseNames; i++)
468 if (ir_strdup (interp, &p->databaseNames[i], argv[2+i])
476 * do_query: Set/Get query mothod
478 static int do_query (void *obj, Tcl_Interp *interp,
479 int argc, char **argv)
484 free (p->query_method);
485 if (ir_strdup (interp, &p->query_method, argv[2]) == TCL_ERROR)
488 Tcl_AppendResult (interp, p->query_method, NULL);
493 * ir_obj_method: IR Object methods
495 static int ir_obj_method (ClientData clientData, Tcl_Interp *interp,
496 int argc, char **argv)
498 static IRMethod tab[] = {
499 { "comstack", do_comstack },
500 { "connect", do_connect },
501 { "protocolVersion", do_protocolVersion },
502 { "options", do_options },
503 { "preferredMessageSize", do_preferredMessageSize },
504 { "maximumMessageSize", do_maximumMessageSize },
505 { "implementationName", do_implementationName },
506 { "implementationId", do_implementationId },
507 { "idAuthentication", do_idAuthentication },
508 { "init", do_init_request },
509 { "disconnect", do_disconnect },
510 { "callback", do_callback },
511 { "databaseNames", do_databaseNames},
512 { "query", do_query },
517 interp->result = "wrong # args";
520 return ir_method (clientData, interp, argc, argv, tab);
524 * ir_obj_delete: IR Object disposal
526 static void ir_obj_delete (ClientData clientData)
528 free ( (void*) clientData);
532 * ir_obj_mk: IR Object creation
534 static int ir_obj_mk (ClientData clientData, Tcl_Interp *interp,
535 int argc, char **argv)
542 interp->result = "wrong # args";
545 obj = malloc (sizeof(*obj));
548 interp->result = "malloc fail";
551 obj->cs_link = cs_create (tcpip_type);
553 obj->maximumMessageSize = 32768;
554 obj->preferredMessageSize = 4096;
556 obj->idAuthentication = NULL;
558 if (ir_strdup (interp, &obj->implementationName, "TCL/TK on YAZ")
562 if (ir_strdup (interp, &obj->implementationId, "TCL/TK/YAZ")
566 obj->smallSetUpperBound = 0;
567 obj->largeSetLowerBound = 2;
568 obj->mediumSetPresentNumber = 0;
569 obj->replaceIndicator = 1;
570 obj->databaseNames = NULL;
571 obj->num_databaseNames = 0;
572 if (ir_strdup (interp, &obj->query_method, "rpn") == TCL_ERROR)
574 obj->bibset = ccl_qual_mk ();
575 if ((inf = fopen ("default.bib", "r")))
577 ccl_qual_file (obj->bibset, inf);
580 ODR_MASK_ZERO (&obj->protocolVersion);
581 ODR_MASK_SET (&obj->protocolVersion, 0);
582 ODR_MASK_SET (&obj->protocolVersion, 1);
584 ODR_MASK_ZERO (&obj->options);
585 ODR_MASK_SET (&obj->options, 0);
587 obj->odr_in = odr_createmem (ODR_DECODE);
588 obj->odr_out = odr_createmem (ODR_ENCODE);
589 obj->odr_pr = odr_createmem (ODR_PRINT);
591 obj->len_out = 10000;
592 obj->buf_out = malloc (obj->len_out);
595 interp->result = "malloc fail";
598 odr_setbuf (obj->odr_out, obj->buf_out, obj->len_out);
603 obj->callback = NULL;
604 Tcl_CreateCommand (interp, argv[1], ir_obj_method,
605 (ClientData) obj, ir_obj_delete);
609 /* ------------------------------------------------------- */
611 * do_search: Do search request
613 static int do_search (void *o, Tcl_Interp *interp,
614 int argc, char **argv)
619 static Odr_oid bib1[] = {1, 2, 840, 10003, 3, 1, -1};
622 IRObj *p = obj->parent;
629 interp->result = "wrong # args";
632 if (!p->num_databaseNames)
634 interp->result = "no databaseNames";
637 apdu.which = Z_APDU_searchRequest;
638 apdu.u.searchRequest = &req;
642 req.smallSetUpperBound = &p->smallSetUpperBound;
643 req.largeSetLowerBound = &p->largeSetLowerBound;
644 req.mediumSetPresentNumber = &p->mediumSetPresentNumber;
645 req.replaceIndicator = &p->replaceIndicator;
646 req.resultSetName = "Default";
647 req.num_databaseNames = p->num_databaseNames;
648 req.databaseNames = p->databaseNames;
649 req.smallSetElementSetNames = 0;
650 req.mediumSetElementSetNames = 0;
651 req.preferredRecordSyntax = 0;
654 if (!strcmp (p->query_method, "rpn"))
658 struct ccl_rpn_node *rpn;
659 Z_RPNQuery *RPNquery;
661 rpn = ccl_find_str(p->bibset, argv[2], &error, &pos);
664 Tcl_AppendResult (interp, "CCL error: ", ccl_err_msg(error),NULL);
667 query.which = Z_Query_type_1;
668 assert((RPNquery = ccl_rpn_query(rpn)));
669 RPNquery->attributeSetId = bib1;
670 query.u.type_1 = RPNquery;
672 else if (!strcmp (p->query_method, "ccl"))
674 query.which = Z_Query_type_2;
675 query.u.type_2 = &ccl_query;
676 ccl_query.buf = argv[2];
677 ccl_query.len = strlen (argv[2]);
681 interp->result = "unknown query method";
684 if (!z_APDU (p->odr_out, &apdup, 0))
686 interp->result = odr_errlist [odr_geterror (p->odr_out)];
687 odr_reset (p->odr_out);
690 sbuf = odr_getbuf (p->odr_out, &slen);
691 if (cs_put (p->cs_link, sbuf, slen) < 0)
693 interp->result = "cs_put failed in init";
696 printf ("Search request\n");
701 * do_resultCount: Get number of hits
703 static int do_resultCount (void *o, Tcl_Interp *interp,
704 int argc, char **argv)
708 sprintf (interp->result, "%d", obj->resultCount);
713 * do_numberOfRecordsReturned: Get number of records returned
715 static int do_numberOfRecordsReturned (void *o, Tcl_Interp *interp,
716 int argc, char **argv)
720 sprintf (interp->result, "%d", obj->numberOfRecordsReturned);
724 static int get_marc_record(Tcl_Interp *interp, Iso2709Rec rec,
725 int argc, char **argv)
727 struct iso2709_dir *dir;
728 struct iso2709_field *field;
730 for (dir = rec->directory; dir; dir = dir->next)
732 if (strcmp (dir->tag, argv[3]))
734 for (field = dir->fields; field; field = field->next)
736 if (argc > 4 && strcmp (field->identifier, argv[4]))
738 Tcl_AppendElement (interp, field->data);
745 * do_getRecord: Get an ISO2709 Record
747 static int do_getRecord (void *o, Tcl_Interp *interp,
748 int argc, char **argv)
756 sprintf (interp->result, "wrong # args");
759 if (Tcl_GetInt (interp, argv[2], &offset)==TCL_ERROR)
761 for (rl = obj->record_list; rl; rl = rl->next)
763 if (rl->no == offset)
768 Tcl_AppendResult (interp, "No record at #", argv[2], NULL);
773 Tcl_AppendResult (interp, "Not a MARC record at #", argv[2], NULL);
776 return get_marc_record (interp, rl->rec, argc, argv);
780 * do_present: Perform Present Request
783 static int do_present (void *o, Tcl_Interp *interp,
784 int argc, char **argv)
787 IRObj *p = obj->parent;
789 Z_PresentRequest req;
797 if (Tcl_GetInt (interp, argv[2], &start) == TCL_ERROR)
804 if (Tcl_GetInt (interp, argv[3], &number) == TCL_ERROR)
810 obj->number = number;
813 apdu.which = Z_APDU_presentRequest;
814 apdu.u.presentRequest = &req;
816 /* sprintf(setstring, "%d", setnumber); */
817 req.resultSetId = "Default";
818 req.resultSetStartPoint = &start;
819 req.numberOfRecordsRequested = &number;
820 req.elementSetNames = 0;
821 req.preferredRecordSyntax = 0;
823 if (!z_APDU (p->odr_out, &apdup, 0))
825 interp->result = odr_errlist [odr_geterror (p->odr_out)];
826 odr_reset (p->odr_out);
829 sbuf = odr_getbuf (p->odr_out, &slen);
830 if (cs_put (p->cs_link, sbuf, slen) < 0)
832 interp->result = "cs_put failed in init";
835 printf ("Present request, start=%d, num=%d\n", start, number);
840 * ir_set_obj_method: IR Set Object methods
842 static int ir_set_obj_method (ClientData clientData, Tcl_Interp *interp,
843 int argc, char **argv)
845 static IRMethod tab[] = {
846 { "search", do_search },
847 { "resultCount", do_resultCount },
848 { "numberOfRecordsReturned", do_numberOfRecordsReturned },
849 { "present", do_present },
850 { "getRecord", do_getRecord },
856 interp->result = "wrong # args";
859 return ir_method (clientData, interp, argc, argv, tab);
863 * ir_set_obj_delete: IR Set Object disposal
865 static void ir_set_obj_delete (ClientData clientData)
867 free ( (void*) clientData);
871 * ir_set_obj_mk: IR Set Object creation
873 static int ir_set_obj_mk (ClientData clientData, Tcl_Interp *interp,
874 int argc, char **argv)
876 Tcl_CmdInfo parent_info;
881 interp->result = "wrong # args";
884 if (get_parent_info (interp, argv[1], &parent_info) == TCL_ERROR)
886 obj = malloc (sizeof(*obj));
889 interp->result = "malloc fail";
892 obj->z_records = NULL;
893 obj->record_list = NULL;
894 obj->parent = (IRObj *) parent_info.clientData;
895 Tcl_CreateCommand (interp, argv[1], ir_set_obj_method,
896 (ClientData) obj, ir_set_obj_delete);
900 /* ------------------------------------------------------- */
902 static void ir_searchResponse (void *o, Z_SearchResponse *searchrs)
905 IRSetObj *obj = p->child;
908 obj->resultCount = *searchrs->resultCount;
909 if (searchrs->searchStatus)
910 printf("Search was a success.\n");
912 printf("Search was a bloomin' failure.\n");
913 printf("Number of hits: %d\n", *searchrs->resultCount);
915 if (searchrs->records)
916 display_records(searchrs->records);
920 static void ir_initResponse (void *obj, Z_InitResponse *initrs)
924 if (!*initrs->result)
925 printf("Connection rejected by target.\n");
927 printf("Connection accepted by target.\n");
928 if (initrs->implementationId)
929 printf("ID : %s\n", initrs->implementationId);
930 if (initrs->implementationName)
931 printf("Name : %s\n", initrs->implementationName);
932 if (initrs->implementationVersion)
933 printf("Version: %s\n", initrs->implementationVersion);
935 if (initrs->userInformationField)
937 printf("UserInformationfield:\n");
938 odr_external(&print, (Odr_external**)&initrs->
939 userInformationField, 0);
944 static void ir_presentResponse (void *o, Z_PresentResponse *presrs)
947 IRSetObj *setobj = p->child;
948 Z_Records *zrs = presrs->records;
949 setobj->z_records = presrs->records;
951 printf ("Received presentResponse\n");
954 if (zrs->which == Z_Records_NSD)
956 setobj->numberOfRecordsReturned = 0;
957 printf ("They are diagnostic!!!\n");
960 sprintf (buf, "%d", *zrs->u.nonSurrogateDiagnostic->condition);
961 Tcl_AppendResult (interp, "Diagnostic message: ", buf,
963 zrs->u.nonSurrogateDiagnostic->addinfo, NULL);
973 setobj->numberOfRecordsReturned =
974 zrs->u.databaseOrSurDiagnostics->num_records;
975 printf ("Got %d records\n", setobj->numberOfRecordsReturned);
976 for (offset = 0; offset<setobj->numberOfRecordsReturned; offset++)
978 int no = setobj->start + offset;
980 for (rl = setobj->record_list; rl; rl = rl->next)
985 iso2709_rm (rl->rec);
991 rl = malloc (sizeof(*rl));
993 rl->next = setobj->record_list;
996 setobj->record_list = rl;
998 if (zrs->u.databaseOrSurDiagnostics->records[offset]->which ==
999 Z_NamePlusRecord_surrogateDiagnostic)
1006 Z_DatabaseRecord *zr;
1010 zr = zrs->u.databaseOrSurDiagnostics->records[offset]
1012 oe = (Odr_external*) zr;
1013 if (oe->which == ODR_EXTERNAL_octet
1014 && zr->u.octet_aligned->len)
1016 const char *buf = (char*) zr->u.octet_aligned->buf;
1017 rl->rec = iso2709_cvt (buf);
1025 printf ("No records!\n");
1029 void ir_select_proc (ClientData clientData)
1031 IRObj *p = clientData;
1037 if ((r=cs_get (p->cs_link, &p->buf_in, &p->len_in)) < 0)
1039 printf ("cs_get failed\n");
1040 ir_select_remove (cs_fileno (p->cs_link), p);
1043 odr_setbuf (p->odr_in, p->buf_in, r);
1044 printf ("cs_get ok, got %d\n", r);
1045 if (!z_APDU (p->odr_in, &apdu, 0))
1047 printf ("%s\n", odr_errlist [odr_geterror (p->odr_in)]);
1052 case Z_APDU_initResponse:
1053 ir_initResponse (p, apdu->u.initResponse);
1055 case Z_APDU_searchResponse:
1056 ir_searchResponse (p, apdu->u.searchResponse);
1058 case Z_APDU_presentResponse:
1059 ir_presentResponse (p, apdu->u.presentResponse);
1062 printf("Received unknown APDU type (%d).\n",
1066 Tcl_Eval (p->interp, p->callback);
1067 } while (cs_more (p->cs_link));
1070 /* ------------------------------------------------------- */
1073 * ir_tcl_init: Registration of TCL commands.
1075 int ir_tcl_init (Tcl_Interp *interp)
1077 Tcl_CreateCommand (interp, "ir", ir_obj_mk, (ClientData) NULL,
1078 (Tcl_CmdDeleteProc *) NULL);
1079 Tcl_CreateCommand (interp, "ir-set", ir_set_obj_mk,
1080 (ClientData) NULL, (Tcl_CmdDeleteProc *) NULL);