2 * IR toolkit for tcl/tk
4 * Sebastian Hammer, Adam Dickmeiss
7 * Revision 1.25 1995-04-17 09:37:17 adam
8 * Further development of scan.
10 * Revision 1.24 1995/04/11 14:16:42 adam
11 * Further work on scan. Response works. Entries aren't saved yet.
13 * Revision 1.23 1995/04/10 10:50:27 adam
14 * Result-set name defaults to suffix of ir-set name.
15 * Started working on scan. Not finished at this point.
17 * Revision 1.22 1995/03/31 10:43:03 adam
18 * More robust when getting bad MARC records.
20 * Revision 1.21 1995/03/31 08:56:37 adam
21 * New button "Search".
23 * Revision 1.20 1995/03/29 16:07:09 adam
24 * Bug fix: Didn't use setName in present request.
26 * Revision 1.19 1995/03/28 12:45:23 adam
27 * New ir method failback: called on disconnect/protocol error.
28 * New ir set/get method: protocol: SR / Z3950.
29 * Simple popup and disconnect when failback is invoked.
31 * Revision 1.18 1995/03/21 15:50:12 adam
34 * Revision 1.17 1995/03/21 13:41:03 adam
35 * Comstack cs_create not used too often. Non-blocking connect.
37 * Revision 1.16 1995/03/21 08:26:06 adam
38 * New method, setName, to specify the result set name (other than Default).
39 * New method, responseStatus, which returns diagnostic info, if any, after
40 * present response / search response.
42 * Revision 1.15 1995/03/20 15:24:07 adam
43 * Diagnostic records saved on searchResponse.
45 * Revision 1.14 1995/03/20 08:53:22 adam
46 * Event loop in tclmain.c rewritten. New method searchStatus.
48 * Revision 1.13 1995/03/17 18:26:17 adam
49 * Non-blocking i/o used now. Database names popup as cascade items.
51 * Revision 1.12 1995/03/17 15:45:00 adam
52 * Improved target/database setup.
54 * Revision 1.11 1995/03/16 17:54:03 adam
55 * Minor changes really.
57 * Revision 1.10 1995/03/15 16:14:50 adam
58 * Blocking arg in cs_create changed.
60 * Revision 1.9 1995/03/15 13:59:24 adam
63 * Revision 1.8 1995/03/15 08:25:16 adam
64 * New method presentStatus to check for error on present. Misc. cleanup
65 * of IRRecordList manipulations. Full MARC record presentation in
68 * Revision 1.7 1995/03/14 17:32:29 adam
69 * Presentation of full Marc record in popup window.
71 * Revision 1.6 1995/03/12 19:31:55 adam
72 * Pattern matching implemented when retrieving MARC records. More
73 * diagnostic functions.
75 * Revision 1.5 1995/03/10 18:00:15 adam
76 * Actual presentation in line-by-line format. RPN query support.
78 * Revision 1.4 1995/03/09 16:15:08 adam
79 * First presentRequest attempts. Hot-target list.
102 #include <diagbib1.h>
114 int preferredMessageSize;
115 int maximumRecordSize;
117 Odr_bitmask protocolVersion;
118 char *idAuthentication;
119 char *implementationName;
120 char *implementationId;
141 int smallSetUpperBound;
142 int largeSetLowerBound;
143 int mediumSetPresentNumber;
144 int replaceIndicator;
145 char **databaseNames;
146 int num_databaseNames;
152 struct IRSetObj_ *set_child;
153 struct IRScanObj_ *scan_child;
156 typedef struct IRRecordList_ {
168 struct IRRecordList_ *next;
171 typedef struct IRSetObj_ {
177 int numberOfRecordsReturned;
183 IRRecordList *record_list;
186 typedef struct IRScanEntry_ {
191 int globalOccurrences;
200 typedef struct IRScanDiag_ {
204 typedef struct IRScanObj_ {
207 int numberOfTermsRequested;
208 int preferredPositionInResponse;
211 int numberOfEntriesReturned;
220 IRScanEntry *entries;
221 IRScanDiag *nonSurrogateDiagnostics;
227 int (*method) (void *obj, Tcl_Interp *interp, int argc, char **argv);
230 static int do_disconnect (void *obj,Tcl_Interp *interp, int argc, char **argv);
232 static IRRecordList *new_IR_record (IRSetObj *setobj, int no, int which)
236 for (rl = setobj->record_list; rl; rl = rl->next)
242 case Z_NamePlusRecord_databaseRecord:
243 iso2709_rm (rl->u.marc.rec);
245 case Z_NamePlusRecord_surrogateDiagnostic:
246 free (rl->u.diag.addinfo);
247 rl->u.diag.addinfo = NULL;
255 rl = malloc (sizeof(*rl));
257 rl->next = setobj->record_list;
259 setobj->record_list = rl;
265 static IRRecordList *find_IR_record (IRSetObj *setobj, int no)
269 for (rl = setobj->record_list; rl; rl = rl->next)
276 * getsetint: Set/get integer value
278 static int get_set_int (int *val, Tcl_Interp *interp, int argc, char **argv)
284 if (Tcl_GetInt (interp, argv[2], val)==TCL_ERROR)
287 sprintf (buf, "%d", *val);
288 Tcl_AppendResult (interp, buf, NULL);
293 * mk_nonSurrogateDiagnostics: Make Tcl result with diagnostic info
295 static int mk_nonSurrogateDiagnostics (Tcl_Interp *interp,
302 Tcl_AppendElement (interp, "NSD");
303 sprintf (buf, "%d", condition);
304 Tcl_AppendElement (interp, buf);
305 cp = diagbib1_str (condition);
307 Tcl_AppendElement (interp, (char*) cp);
309 Tcl_AppendElement (interp, "");
311 Tcl_AppendElement (interp, (char*) addinfo);
313 Tcl_AppendElement (interp, "");
318 * get_parent_info: Returns information about parent object.
320 static int get_parent_info (Tcl_Interp *interp, const char *name,
321 Tcl_CmdInfo *parent_info,
324 char parent_name[128];
325 const char *csep = strrchr (name, '.');
330 interp->result = "missing .";
338 memcpy (parent_name, name, pos);
339 parent_name[pos] = '\0';
340 if (!Tcl_GetCommandInfo (interp, parent_name, parent_info))
342 interp->result = "No parent";
349 * ir_method: Search for method in table and invoke method handler
351 int ir_method (void *obj, Tcl_Interp *interp, int argc, char **argv,
355 for (t = tab; t->name; t++)
356 if (!strcmp (t->name, argv[1]))
357 return (*t->method)(obj, interp, argc, argv);
358 Tcl_AppendResult (interp, "Bad method. Possible values:", NULL);
359 for (t = tab; t->name; t++)
360 Tcl_AppendResult (interp, " ", t->name, NULL);
365 * ir_method_r: Get status for all readable elements
367 int ir_method_r (void *obj, Tcl_Interp *interp, int argc, char **argv,
375 for (; tab->name; tab++)
378 argv_n[1] = tab->name;
379 Tcl_AppendResult (interp, "{", NULL);
380 (*tab->method)(obj, interp, argc_n, argv_n);
381 Tcl_AppendResult (interp, "} ", NULL);
387 * ir_asc2bitmask: Ascii to ODR bitmask conversion
389 int ir_asc2bitmask (const char *asc, Odr_bitmask *ob)
391 const char *cp = asc + strlen(asc);
398 ODR_MASK_SET (ob, bitno);
405 * ir_strdup: Duplicate string
407 int ir_strdup (Tcl_Interp *interp, char** p, const char *s)
409 *p = malloc (strlen(s)+1);
412 interp->result = "strdup fail";
420 * ir_malloc: Malloc function
422 void *ir_malloc (Tcl_Interp *interp, size_t size)
424 static char buf[128];
425 void *p = malloc (size);
429 sprintf (buf, "Malloc fail. %ld bytes requested", (long) size);
430 interp->result = buf;
436 /* ------------------------------------------------------- */
439 * do_init_request: init method on IR object
441 static int do_init_request (void *obj, Tcl_Interp *interp,
442 int argc, char **argv)
444 Z_APDU apdu, *apdup = &apdu;
451 interp->result = "not connected";
455 req.options = &p->options;
456 req.protocolVersion = &p->protocolVersion;
457 req.preferredMessageSize = &p->preferredMessageSize;
458 req.maximumRecordSize = &p->maximumRecordSize;
460 req.idAuthentication = p->idAuthentication;
461 req.implementationId = p->implementationId;
462 req.implementationName = p->implementationName;
463 req.implementationVersion = "0.1";
464 req.userInformationField = 0;
466 apdu.u.initRequest = &req;
467 apdu.which = Z_APDU_initRequest;
469 if (!z_APDU (p->odr_out, &apdup, 0))
471 Tcl_AppendResult (interp, odr_errlist [odr_geterror (p->odr_out)],
473 odr_reset (p->odr_out);
476 p->sbuf = odr_getbuf (p->odr_out, &p->slen);
477 if ((r=cs_put (p->cs_link, p->sbuf, p->slen)) < 0)
479 interp->result = "cs_put failed in init";
480 do_disconnect (p, NULL, 0, NULL);
485 ir_select_add_write (cs_fileno(p->cs_link), p);
486 printf("Sent part of initializeRequest (%d bytes).\n", p->slen);
489 printf("Sent whole initializeRequest (%d bytes).\n", p->slen);
494 * do_protocolVersion: Set protocol Version
496 static int do_protocolVersion (void *obj, Tcl_Interp *interp,
497 int argc, char **argv)
500 ir_asc2bitmask (argv[2], &((IRObj *) obj)->protocolVersion);
505 * do_options: Set options
507 static int do_options (void *obj, Tcl_Interp *interp,
508 int argc, char **argv)
511 ir_asc2bitmask (argv[2], &((IRObj *) obj)->options);
516 * do_preferredMessageSize: Set/get preferred message size
518 static int do_preferredMessageSize (void *obj, Tcl_Interp *interp,
519 int argc, char **argv)
522 return get_set_int (&p->preferredMessageSize, interp, argc, argv);
526 * do_maximumRecordSize: Set/get maximum record size
528 static int do_maximumRecordSize (void *obj, Tcl_Interp *interp,
529 int argc, char **argv)
532 return get_set_int (&p->maximumRecordSize, interp, argc, argv);
537 * do_implementationName: Set/get Implementation Name.
539 static int do_implementationName (void *obj, Tcl_Interp *interp,
540 int argc, char **argv)
544 free (((IRObj*)obj)->implementationName);
545 if (ir_strdup (interp, &((IRObj*) obj)->implementationName, argv[2])
549 Tcl_AppendResult (interp, ((IRObj*)obj)->implementationName,
555 * do_implementationId: Set/get Implementation Id.
557 static int do_implementationId (void *obj, Tcl_Interp *interp,
558 int argc, char **argv)
562 free (((IRObj*)obj)->implementationId);
563 if (ir_strdup (interp, &((IRObj*) obj)->implementationId, argv[2])
567 Tcl_AppendResult (interp, ((IRObj*)obj)->implementationId,
573 * do_idAuthentication: Set/get id Authentication
575 static int do_idAuthentication (void *obj, Tcl_Interp *interp,
576 int argc, char **argv)
580 free (((IRObj*)obj)->idAuthentication);
581 if (ir_strdup (interp, &((IRObj*) obj)->idAuthentication, argv[2])
585 Tcl_AppendResult (interp, ((IRObj*)obj)->idAuthentication,
591 * do_connect: connect method on IR object
593 static int do_connect (void *obj, Tcl_Interp *interp,
594 int argc, char **argv)
599 int protocol_type = CS_Z3950;
605 interp->result = "already connected";
608 if (!strcmp (p->protocol_type, "Z3950"))
609 protocol_type = CS_Z3950;
610 else if (!strcmp (p->protocol_type, "SR"))
611 protocol_type = CS_SR;
614 interp->result = "bad protocol type";
617 if (!strcmp (p->cs_type, "tcpip"))
619 p->cs_link = cs_create (tcpip_type, CS_BLOCK, protocol_type);
620 addr = tcpip_strtoaddr (argv[2]);
623 interp->result = "tcpip_strtoaddr fail";
626 printf ("tcp/ip connect %s\n", argv[2]);
629 else if (!strcmp (p->cs_type, "mosi"))
631 p->cs_link = cs_create (mosi_type, CS_BLOCK, protocol_type);
632 addr = mosi_strtoaddr (argv[2]);
635 interp->result = "mosi_strtoaddr fail";
638 printf ("mosi connect %s\n", argv[2]);
643 interp->result = "unknown comstack type";
646 if (ir_strdup (interp, &p->hostname, argv[2]) == TCL_ERROR)
648 if ((r=cs_connect (p->cs_link, addr)) < 0)
650 interp->result = "cs_connect fail";
651 do_disconnect (p, NULL, 0, NULL);
654 ir_select_add (cs_fileno (p->cs_link), p);
657 ir_select_add_write (cs_fileno (p->cs_link), p);
664 Tcl_Eval (p->interp, p->callback);
668 Tcl_AppendElement (interp, p->hostname);
673 * do_disconnect: disconnect method on IR object
675 static int do_disconnect (void *obj, Tcl_Interp *interp,
676 int argc, char **argv)
684 ir_select_remove_write (cs_fileno (p->cs_link), p);
685 ir_select_remove (cs_fileno (p->cs_link), p);
688 cs_close (p->cs_link);
691 assert (!p->cs_link);
696 * do_comstack: Set/get comstack method on IR object
698 static int do_comstack (void *o, Tcl_Interp *interp,
699 int argc, char **argv)
706 if (ir_strdup (interp, &obj->cs_type, argv[2]) == TCL_ERROR)
709 Tcl_AppendElement (interp, obj->cs_type);
714 * do_protocol: Set/get protocol method on IR object
716 static int do_protocol (void *o, Tcl_Interp *interp,
717 int argc, char **argv)
723 free (obj->protocol_type);
724 if (ir_strdup (interp, &obj->protocol_type, argv[2]) == TCL_ERROR)
727 Tcl_AppendElement (interp, obj->protocol_type);
732 * do_callback: add callback
734 static int do_callback (void *obj, Tcl_Interp *interp,
735 int argc, char **argv)
742 if (ir_strdup (interp, &p->callback, argv[2]) == TCL_ERROR)
750 * do_failback: add error handle callback
752 static int do_failback (void *obj, Tcl_Interp *interp,
753 int argc, char **argv)
760 if (ir_strdup (interp, &p->failback, argv[2]) == TCL_ERROR)
768 * do_databaseNames: specify database names
770 static int do_databaseNames (void *obj, Tcl_Interp *interp,
771 int argc, char **argv)
778 for (i=0; i<p->num_databaseNames; i++)
779 Tcl_AppendElement (interp, p->databaseNames[i]);
782 if (p->databaseNames)
784 for (i=0; i<p->num_databaseNames; i++)
785 free (p->databaseNames[i]);
786 free (p->databaseNames);
788 p->num_databaseNames = argc - 2;
789 if (!(p->databaseNames = ir_malloc (interp,
790 sizeof(*p->databaseNames) * p->num_databaseNames)))
792 for (i=0; i<p->num_databaseNames; i++)
794 if (ir_strdup (interp, &p->databaseNames[i], argv[2+i])
802 * do_query: Set/Get query mothod
804 static int do_query (void *obj, Tcl_Interp *interp,
805 int argc, char **argv)
810 free (p->query_method);
811 if (ir_strdup (interp, &p->query_method, argv[2]) == TCL_ERROR)
814 Tcl_AppendResult (interp, p->query_method, NULL);
819 * do_replaceIndicator: Set/get replace Set indicator
821 static int do_replaceIndicator (void *obj, Tcl_Interp *interp,
822 int argc, char **argv)
825 return get_set_int (&p->replaceIndicator, interp, argc, argv);
829 * ir_obj_method: IR Object methods
831 static int ir_obj_method (ClientData clientData, Tcl_Interp *interp,
832 int argc, char **argv)
834 static IRMethod tab[] = {
835 { 1, "comstack", do_comstack },
836 { 1, "protocol", do_protocol },
837 { 1, "connect", do_connect },
838 { 0, "protocolVersion", do_protocolVersion },
839 { 0, "options", do_options },
840 { 1, "preferredMessageSize", do_preferredMessageSize },
841 { 1, "maximumRecordSize", do_maximumRecordSize },
842 { 1, "implementationName", do_implementationName },
843 { 1, "implementationId", do_implementationId },
844 { 1, "idAuthentication", do_idAuthentication },
845 { 0, "init", do_init_request },
846 { 0, "disconnect", do_disconnect },
847 { 0, "callback", do_callback },
848 { 0, "failback", do_failback },
849 { 1, "databaseNames", do_databaseNames},
850 { 1, "replaceIndicator", do_replaceIndicator},
851 { 1, "query", do_query },
855 return ir_method_r (clientData, interp, argc, argv, tab);
856 return ir_method (clientData, interp, argc, argv, tab);
860 * ir_obj_delete: IR Object disposal
862 static void ir_obj_delete (ClientData clientData)
864 free ( (void*) clientData);
868 * ir_obj_mk: IR Object creation
870 static int ir_obj_mk (ClientData clientData, Tcl_Interp *interp,
871 int argc, char **argv)
878 interp->result = "wrong # args";
881 if (!(obj = ir_malloc (interp, sizeof(*obj))))
883 if (ir_strdup (interp, &obj->cs_type, "tcpip") == TCL_ERROR)
885 if (ir_strdup (interp, &obj->protocol_type, "Z3950") == TCL_ERROR)
888 obj->bib1.proto = PROTO_Z3950;
889 obj->bib1.class = CLASS_ATTSET;
890 obj->bib1.value = VAL_BIB1;
892 obj->maximumRecordSize = 32768;
893 obj->preferredMessageSize = 4096;
894 obj->connectFlag = 0;
896 obj->idAuthentication = NULL;
898 if (ir_strdup (interp, &obj->implementationName, "TCL/TK on YAZ")
902 if (ir_strdup (interp, &obj->implementationId, "TCL/TK/YAZ")
906 obj->smallSetUpperBound = 0;
907 obj->largeSetLowerBound = 2;
908 obj->mediumSetPresentNumber = 0;
909 obj->replaceIndicator = 1;
911 obj->databaseNames = NULL;
912 obj->num_databaseNames = 0;
914 obj->num_databaseNames = 1;
915 if (!(obj->databaseNames = ir_malloc (interp,
916 sizeof(*obj->databaseNames))))
918 if (ir_strdup (interp, &obj->databaseNames[0], "Default") == TCL_ERROR)
922 obj->hostname = NULL;
924 if (ir_strdup (interp, &obj->query_method, "rpn") == TCL_ERROR)
926 obj->bibset = ccl_qual_mk ();
927 if ((inf = fopen ("default.bib", "r")))
929 ccl_qual_file (obj->bibset, inf);
932 ODR_MASK_ZERO (&obj->protocolVersion);
933 ODR_MASK_SET (&obj->protocolVersion, 0);
934 ODR_MASK_SET (&obj->protocolVersion, 1);
936 ODR_MASK_ZERO (&obj->options);
937 ODR_MASK_SET (&obj->options, 0);
939 obj->odr_in = odr_createmem (ODR_DECODE);
940 obj->odr_out = odr_createmem (ODR_ENCODE);
941 obj->odr_pr = odr_createmem (ODR_PRINT);
943 obj->len_out = 10000;
944 if (!(obj->buf_out = ir_malloc (interp, obj->len_out)))
946 odr_setbuf (obj->odr_out, obj->buf_out, obj->len_out);
951 obj->callback = NULL;
952 obj->failback = NULL;
953 Tcl_CreateCommand (interp, argv[1], ir_obj_method,
954 (ClientData) obj, ir_obj_delete);
958 /* ------------------------------------------------------- */
960 * do_search: Do search request
962 static int do_search (void *o, Tcl_Interp *interp,
963 int argc, char **argv)
967 Z_APDU apdu, *apdup = &apdu;
970 IRObj *p = obj->parent;
976 interp->result = "wrong # args";
979 if (!p->num_databaseNames)
981 interp->result = "no databaseNames";
986 interp->result = "not connected";
989 apdu.which = Z_APDU_searchRequest;
990 apdu.u.searchRequest = &req;
993 req.smallSetUpperBound = &p->smallSetUpperBound;
994 req.largeSetLowerBound = &p->largeSetLowerBound;
995 req.mediumSetPresentNumber = &p->mediumSetPresentNumber;
996 req.replaceIndicator = &p->replaceIndicator;
997 req.resultSetName = obj->setName ? obj->setName : "Default";
998 req.num_databaseNames = p->num_databaseNames;
999 req.databaseNames = p->databaseNames;
1001 for (r=0; r<p->num_databaseNames; r++)
1003 printf (" %s", p->databaseNames[r]);
1005 req.smallSetElementSetNames = 0;
1006 req.mediumSetElementSetNames = 0;
1007 req.preferredRecordSyntax = 0;
1010 if (!strcmp (p->query_method, "rpn"))
1014 struct ccl_rpn_node *rpn;
1015 Z_RPNQuery *RPNquery;
1017 rpn = ccl_find_str(p->bibset, argv[2], &error, &pos);
1020 Tcl_AppendResult (interp, "CCL error: ", ccl_err_msg(error),NULL);
1023 query.which = Z_Query_type_1;
1024 assert((RPNquery = ccl_rpn_query(rpn)));
1025 RPNquery->attributeSetId = oid_getoidbyent (&p->bib1);
1026 query.u.type_1 = RPNquery;
1029 else if (!strcmp (p->query_method, "ccl"))
1031 query.which = Z_Query_type_2;
1032 query.u.type_2 = &ccl_query;
1033 ccl_query.buf = (unsigned char *) argv[2];
1034 ccl_query.len = strlen (argv[2]);
1039 interp->result = "unknown query method";
1042 if (!z_APDU (p->odr_out, &apdup, 0))
1044 interp->result = odr_errlist [odr_geterror (p->odr_out)];
1045 odr_reset (p->odr_out);
1048 p->sbuf = odr_getbuf (p->odr_out, &p->slen);
1049 if ((r=cs_put (p->cs_link, p->sbuf, p->slen)) < 0)
1051 interp->result = "cs_put failed in search";
1056 ir_select_add_write (cs_fileno(p->cs_link), p);
1057 printf("Sent part of searchRequest (%d bytes).\n", p->slen);
1061 printf ("Whole search request\n");
1067 * do_resultCount: Get number of hits
1069 static int do_resultCount (void *o, Tcl_Interp *interp,
1070 int argc, char **argv)
1074 return get_set_int (&obj->resultCount, interp, argc, argv);
1078 * do_searchStatus: Get search status (after search response)
1080 static int do_searchStatus (void *o, Tcl_Interp *interp,
1081 int argc, char **argv)
1085 return get_set_int (&obj->searchStatus, interp, argc, argv);
1089 * do_setName: Set result Set name
1091 static int do_setName (void *o, Tcl_Interp *interp,
1092 int argc, char **argv)
1098 free (obj->setName);
1099 if (ir_strdup (interp, &obj->setName, argv[2])
1103 Tcl_AppendElement (interp, obj->setName);
1108 * do_numberOfRecordsReturned: Get number of records returned
1110 static int do_numberOfRecordsReturned (void *o, Tcl_Interp *interp,
1111 int argc, char **argv)
1115 return get_set_int (&obj->numberOfRecordsReturned, interp, argc, argv);
1118 static int get_marc_fields(Tcl_Interp *interp, Iso2709Rec rec,
1119 int argc, char **argv)
1126 a = iso2709_a_mk (rec);
1127 while (iso2709_a_search (a, argv[4], argv[5], argv[6]))
1129 if (!(iso2709_a_info_field (a, NULL, NULL, NULL, &data)))
1131 Tcl_AppendElement (interp, data);
1139 static int get_marc_lines(Tcl_Interp *interp, Iso2709Rec rec,
1140 int argc, char **argv)
1151 a = iso2709_a_mk (rec);
1152 while (iso2709_a_search (a, argv[4], argv[5], argv[6]))
1154 if (!(iso2709_a_info_field (a, &tag, &indicator, &identifier, &data)))
1156 if (strcmp (tag, ptag))
1159 Tcl_AppendResult (interp, "}} ", NULL);
1161 Tcl_AppendResult (interp, "{", tag, " {} {", NULL);
1163 Tcl_AppendResult (interp, "{", tag, " {", indicator,
1168 Tcl_AppendResult (interp, "{{}", NULL);
1170 Tcl_AppendResult (interp, "{", identifier, NULL);
1171 Tcl_AppendElement (interp, data);
1172 Tcl_AppendResult (interp, "} ", NULL);
1176 Tcl_AppendResult (interp, "}} ", NULL);
1182 * do_recordType: Return record type (if any) at position.
1184 static int do_recordType (void *o, Tcl_Interp *interp, int argc, char **argv)
1192 sprintf (interp->result, "wrong # args");
1195 if (Tcl_GetInt (interp, argv[2], &offset)==TCL_ERROR)
1197 rl = find_IR_record (obj, offset);
1202 case Z_NamePlusRecord_databaseRecord:
1203 interp->result = "databaseRecord";
1205 case Z_NamePlusRecord_surrogateDiagnostic:
1206 interp->result = "surrogateDiagnostic";
1213 * do_recordDiag: Return diagnostic record info
1215 static int do_recordDiag (void *o, Tcl_Interp *interp, int argc, char **argv)
1224 sprintf (interp->result, "wrong # args");
1227 if (Tcl_GetInt (interp, argv[2], &offset)==TCL_ERROR)
1229 rl = find_IR_record (obj, offset);
1232 Tcl_AppendResult (interp, "No record at #", argv[2], NULL);
1235 if (rl->which != Z_NamePlusRecord_surrogateDiagnostic)
1237 Tcl_AppendResult (interp, "No Diagnostic record at #", argv[2], NULL);
1240 sprintf (buf, "%d", rl->u.diag.condition);
1241 Tcl_AppendResult (interp, buf, " {",
1242 (rl->u.diag.addinfo ? rl->u.diag.addinfo : ""),
1248 * do_recordMarc: Get ISO2709 Record lines/fields
1250 static int do_recordMarc (void *o, Tcl_Interp *interp, int argc, char **argv)
1258 sprintf (interp->result, "wrong # args");
1261 if (Tcl_GetInt (interp, argv[2], &offset)==TCL_ERROR)
1263 rl = find_IR_record (obj, offset);
1266 Tcl_AppendResult (interp, "No record at #", argv[2], NULL);
1269 if (rl->which != Z_NamePlusRecord_databaseRecord)
1271 Tcl_AppendResult (interp, "No MARC record at #", argv[2], NULL);
1274 if (!strcmp (argv[3], "field"))
1275 return get_marc_fields (interp, rl->u.marc.rec, argc, argv);
1276 else if (!strcmp (argv[3], "line"))
1277 return get_marc_lines (interp, rl->u.marc.rec, argc, argv);
1280 Tcl_AppendResult (interp, "field/line expected", NULL);
1287 * do_responseStatus: Return response status (present or search)
1289 static int do_responseStatus (void *o, Tcl_Interp *interp,
1290 int argc, char **argv)
1294 if (!obj->recordFlag)
1298 case Z_Records_DBOSD:
1299 Tcl_AppendElement (interp, "DBOSD");
1302 return mk_nonSurrogateDiagnostics (interp, obj->condition,
1309 * do_present: Perform Present Request
1312 static int do_present (void *o, Tcl_Interp *interp,
1313 int argc, char **argv)
1316 IRObj *p = obj->parent;
1317 Z_APDU apdu, *apdup = &apdu;
1318 Z_PresentRequest req;
1325 if (Tcl_GetInt (interp, argv[2], &start) == TCL_ERROR)
1332 if (Tcl_GetInt (interp, argv[3], &number) == TCL_ERROR)
1339 interp->result = "not connected";
1343 obj->number = number;
1345 apdu.which = Z_APDU_presentRequest;
1346 apdu.u.presentRequest = &req;
1347 req.referenceId = 0;
1348 /* sprintf(setstring, "%d", setnumber); */
1350 req.resultSetId = obj->setName ? obj->setName : "Default";
1352 req.resultSetStartPoint = &start;
1353 req.numberOfRecordsRequested = &number;
1354 req.elementSetNames = 0;
1355 req.preferredRecordSyntax = 0;
1357 if (!z_APDU (p->odr_out, &apdup, 0))
1359 interp->result = odr_errlist [odr_geterror (p->odr_out)];
1360 odr_reset (p->odr_out);
1363 p->sbuf = odr_getbuf (p->odr_out, &p->slen);
1364 if ((r=cs_put (p->cs_link, p->sbuf, p->slen)) < 0)
1366 interp->result = "cs_put failed in present";
1371 ir_select_add_write (cs_fileno(p->cs_link), p);
1372 printf ("Part of present request, start=%d, num=%d (%d bytes)\n",
1373 start, number, p->slen);
1377 printf ("Whole present request, start=%d, num=%d (%d bytes)\n",
1378 start, number, p->slen);
1384 * do_loadFile: Load result set from file
1387 static int do_loadFile (void *o, Tcl_Interp *interp,
1388 int argc, char **argv)
1390 IRSetObj *setobj = o;
1397 interp->result = "wrong # args";
1400 inf = fopen (argv[2], "r");
1403 Tcl_AppendResult (interp, "Cannot open ", argv[2], NULL);
1406 while ((buf = iso2709_read (inf)))
1411 rec = iso2709_cvt (buf);
1414 rl = new_IR_record (setobj, no, Z_NamePlusRecord_databaseRecord);
1415 rl->u.marc.rec = rec;
1418 setobj->numberOfRecordsReturned = no-1;
1424 * ir_set_obj_method: IR Set Object methods
1426 static int ir_set_obj_method (ClientData clientData, Tcl_Interp *interp,
1427 int argc, char **argv)
1429 static IRMethod tab[] = {
1430 { 0, "search", do_search },
1431 { 0, "searchStatus", do_searchStatus },
1432 { 0, "setName", do_setName },
1433 { 0, "resultCount", do_resultCount },
1434 { 0, "numberOfRecordsReturned", do_numberOfRecordsReturned },
1435 { 0, "present", do_present },
1436 { 0, "recordType", do_recordType },
1437 { 0, "recordMarc", do_recordMarc },
1438 { 0, "recordDiag", do_recordDiag },
1439 { 0, "responseStatus", do_responseStatus },
1440 { 0, "loadFile", do_loadFile },
1446 interp->result = "wrong # args";
1449 return ir_method (clientData, interp, argc, argv, tab);
1453 * ir_set_obj_delete: IR Set Object disposal
1455 static void ir_set_obj_delete (ClientData clientData)
1457 free ( (void*) clientData);
1461 * ir_set_obj_mk: IR Set Object creation
1463 static int ir_set_obj_mk (ClientData clientData, Tcl_Interp *interp,
1464 int argc, char **argv)
1466 Tcl_CmdInfo parent_info;
1472 interp->result = "wrong # args";
1475 if (get_parent_info (interp, argv[1], &parent_info, &suffix) == TCL_ERROR)
1477 if (!(obj = ir_malloc (interp, sizeof(*obj))))
1479 if (ir_strdup (interp, &obj->setName, suffix) == TCL_ERROR)
1481 obj->record_list = NULL;
1482 obj->addinfo = NULL;
1483 obj->parent = (IRObj *) parent_info.clientData;
1484 Tcl_CreateCommand (interp, argv[1], ir_set_obj_method,
1485 (ClientData) obj, ir_set_obj_delete);
1489 /* ------------------------------------------------------- */
1492 * do_scan: Perform scan
1494 static int do_scan (void *o, Tcl_Interp *interp, int argc, char **argv)
1497 Z_APDU apdu, *apdup = &apdu;
1499 IRObj *p = obj->parent;
1505 interp->result = "wrong # args";
1508 if (!p->num_databaseNames)
1510 interp->result = "no databaseNames";
1515 interp->result = "not connected";
1518 apdu.which = Z_APDU_scanRequest;
1519 apdu.u.scanRequest = &req;
1520 req.referenceId = NULL;
1521 req.num_databaseNames = p->num_databaseNames;
1522 req.databaseNames = p->databaseNames;
1523 req.attributeSet = oid_getoidbyent (&p->bib1);
1525 if (!(req.termListAndStartPoint =
1526 ir_malloc (interp, sizeof(*req.termListAndStartPoint))))
1528 req.termListAndStartPoint->num_attributes = 0;
1529 req.termListAndStartPoint->attributeList = NULL;
1530 if (!(req.termListAndStartPoint->term = ir_malloc (interp,
1533 req.termListAndStartPoint->term->which = Z_Term_general;
1534 if (!(req.termListAndStartPoint->term->u.general =
1535 ir_malloc (interp, sizeof(*req.termListAndStartPoint->
1538 if (ir_strdup (interp, &req.termListAndStartPoint->term->u.general->buf,
1539 argv[2]) == TCL_ERROR)
1541 req.termListAndStartPoint->term->u.general->len =
1542 req.termListAndStartPoint->term->u.general->size = strlen(argv[2]);
1543 req.stepSize = &obj->stepSize;
1544 req.numberOfTermsRequested = &obj->numberOfTermsRequested;
1545 req.preferredPositionInResponse = &obj->preferredPositionInResponse;
1546 printf ("stepSize=%d\n", *req.stepSize);
1547 printf ("numberOfTermsRequested=%d\n", *req.numberOfTermsRequested);
1548 printf ("preferredPositionInResponse=%d\n",
1549 *req.preferredPositionInResponse);
1551 if (!z_APDU (p->odr_out, &apdup, 0))
1553 interp->result = odr_errlist [odr_geterror (p->odr_out)];
1554 odr_reset (p->odr_out);
1557 p->sbuf = odr_getbuf (p->odr_out, &p->slen);
1558 if ((r=cs_put (p->cs_link, p->sbuf, p->slen)) < 0)
1560 interp->result = "cs_put failed in scan";
1565 ir_select_add_write (cs_fileno(p->cs_link), p);
1566 printf("Sent part of scanRequest (%d bytes).\n", p->slen);
1570 printf ("Whole scan request\n");
1576 * do_stepSize: Set/get replace Step Size
1578 static int do_stepSize (void *obj, Tcl_Interp *interp,
1579 int argc, char **argv)
1582 return get_set_int (&p->stepSize, interp, argc, argv);
1586 * do_numberOfTermsRequested: Set/get Number of Terms requested
1588 static int do_numberOfTermsRequested (void *obj, Tcl_Interp *interp,
1589 int argc, char **argv)
1592 return get_set_int (&p->numberOfTermsRequested, interp, argc, argv);
1597 * do_preferredPositionInResponse: Set/get preferred Position
1599 static int do_preferredPositionInResponse (void *obj, Tcl_Interp *interp,
1600 int argc, char **argv)
1603 return get_set_int (&p->preferredPositionInResponse, interp, argc, argv);
1607 * do_scanStatus: Get scan status
1609 static int do_scanStatus (void *obj, Tcl_Interp *interp,
1610 int argc, char **argv)
1613 return get_set_int (&p->scanStatus, interp, argc, argv);
1617 * do_numberOfEntriesReturned: Get number of Entries returned
1619 static int do_numberOfEntriesReturned (void *obj, Tcl_Interp *interp,
1620 int argc, char **argv)
1623 return get_set_int (&p->numberOfEntriesReturned, interp, argc, argv);
1627 * do_positionOfTerm: Get position of Term
1629 static int do_positionOfTerm (void *obj, Tcl_Interp *interp,
1630 int argc, char **argv)
1633 return get_set_int (&p->positionOfTerm, interp, argc, argv);
1637 * do_scanLine: get Scan Line (surrogate or normal) after response
1639 static int do_scanLine (void *obj, Tcl_Interp *interp, int argc, char **argv)
1647 interp->result = "wrong # args";
1650 if (Tcl_GetInt (interp, argv[2], &i) == TCL_ERROR)
1652 if (!p->entries_flag || p->which != Z_ListEntries_entries || !p->entries
1653 || i >= p->num_entries || i < 0)
1655 switch (p->entries[i].which)
1657 case Z_Entry_termInfo:
1658 Tcl_AppendElement (interp, "T");
1659 if (p->entries[i].u.term.buf)
1660 Tcl_AppendElement (interp, p->entries[i].u.term.buf);
1662 Tcl_AppendElement (interp, "");
1663 sprintf (numstr, "%d", p->entries[i].u.term.globalOccurrences);
1664 Tcl_AppendElement (interp, numstr);
1666 case Z_Entry_surrogateDiagnostic:
1668 mk_nonSurrogateDiagnostics (interp, p->entries[i].u.diag.condition,
1669 p->entries[i].u.diag.addinfo);
1676 * ir_scan_obj_method: IR Scan Object methods
1678 static int ir_scan_obj_method (ClientData clientData, Tcl_Interp *interp,
1679 int argc, char **argv)
1681 static IRMethod tab[] = {
1682 { 0, "scan", do_scan },
1683 { 0, "stepSize", do_stepSize },
1684 { 0, "numberOfTermsRequested", do_numberOfTermsRequested },
1685 { 0, "preferredPositionInResponse", do_preferredPositionInResponse },
1686 { 0, "scanStatus", do_scanStatus },
1687 { 0, "numberOfEntriesReturned", do_numberOfEntriesReturned },
1688 { 0, "positionOfTerm", do_positionOfTerm },
1689 { 0, "scanLine", do_scanLine },
1695 interp->result = "wrong # args";
1698 return ir_method (clientData, interp, argc, argv, tab);
1702 * ir_scan_obj_delete: IR Scan Object disposal
1704 static void ir_scan_obj_delete (ClientData clientData)
1706 free ( (void*) clientData);
1710 * ir_scan_obj_mk: IR Scan Object creation
1712 static int ir_scan_obj_mk (ClientData clientData, Tcl_Interp *interp,
1713 int argc, char **argv)
1715 Tcl_CmdInfo parent_info;
1720 interp->result = "wrong # args";
1723 if (get_parent_info (interp, argv[1], &parent_info, NULL) == TCL_ERROR)
1725 if (!(obj = ir_malloc (interp, sizeof(*obj))))
1729 obj->numberOfTermsRequested = 20;
1730 obj->preferredPositionInResponse = 1;
1732 obj->entries = NULL;
1733 obj->nonSurrogateDiagnostics = NULL;
1735 obj->parent = (IRObj *) parent_info.clientData;
1736 Tcl_CreateCommand (interp, argv[1], ir_scan_obj_method,
1737 (ClientData) obj, ir_scan_obj_delete);
1741 /* ------------------------------------------------------- */
1743 static void ir_initResponse (void *obj, Z_InitResponse *initrs)
1745 if (!*initrs->result)
1746 printf("Connection rejected by target.\n");
1748 printf("Connection accepted by target.\n");
1749 if (initrs->implementationId)
1750 printf("ID : %s\n", initrs->implementationId);
1751 if (initrs->implementationName)
1752 printf("Name : %s\n", initrs->implementationName);
1753 if (initrs->implementationVersion)
1754 printf("Version: %s\n", initrs->implementationVersion);
1755 if (initrs->maximumRecordSize)
1756 printf ("MaximumRecordSize=%d\n", *initrs->maximumRecordSize);
1757 if (initrs->preferredMessageSize)
1758 printf ("PreferredMessageSize=%d\n", *initrs->preferredMessageSize);
1760 if (initrs->userInformationField)
1762 printf("UserInformationfield:\n");
1763 odr_external(&print, (Odr_external**)&initrs->
1764 userInformationField, 0);
1769 static void ir_handleRecords (void *o, Z_Records *zrs)
1772 IRSetObj *setobj = p->set_child;
1774 setobj->which = zrs->which;
1775 setobj->recordFlag = 1;
1776 if (zrs->which == Z_Records_NSD)
1778 const char *addinfo;
1780 setobj->numberOfRecordsReturned = 0;
1781 setobj->condition = *zrs->u.nonSurrogateDiagnostic->condition;
1782 free (setobj->addinfo);
1783 setobj->addinfo = NULL;
1784 addinfo = zrs->u.nonSurrogateDiagnostic->addinfo;
1785 if (addinfo && (setobj->addinfo = malloc (strlen(addinfo) + 1)))
1786 strcpy (setobj->addinfo, addinfo);
1787 printf ("Diagnostic response. %s (%d): %s\n",
1788 diagbib1_str (setobj->condition),
1790 setobj->addinfo ? setobj->addinfo : "");
1797 setobj->numberOfRecordsReturned =
1798 zrs->u.databaseOrSurDiagnostics->num_records;
1799 printf ("Got %d records\n", setobj->numberOfRecordsReturned);
1800 for (offset = 0; offset<setobj->numberOfRecordsReturned; offset++)
1802 rl = new_IR_record (setobj, setobj->start + offset,
1803 zrs->u.databaseOrSurDiagnostics->
1804 records[offset]->which);
1805 if (rl->which == Z_NamePlusRecord_surrogateDiagnostic)
1809 diagrec = zrs->u.databaseOrSurDiagnostics->
1810 records[offset]->u.surrogateDiagnostic;
1812 rl->u.diag.condition = *diagrec->condition;
1813 if (diagrec->addinfo && (rl->u.diag.addinfo =
1814 malloc (strlen (diagrec->addinfo)+1)))
1815 strcpy (rl->u.diag.addinfo, diagrec->addinfo);
1819 Z_DatabaseRecord *zr;
1822 zr = zrs->u.databaseOrSurDiagnostics->records[offset]
1824 oe = (Odr_external*) zr;
1825 if (oe->which == ODR_EXTERNAL_octet
1826 && zr->u.octet_aligned->len)
1828 const char *buf = (char*) zr->u.octet_aligned->buf;
1829 rl->u.marc.rec = iso2709_cvt (buf);
1832 rl->u.marc.rec = NULL;
1838 static void ir_searchResponse (void *o, Z_SearchResponse *searchrs)
1841 IRSetObj *setobj = p->set_child;
1842 Z_Records *zrs = searchrs->records;
1846 setobj->searchStatus = searchrs->searchStatus ? 1 : 0;
1847 setobj->resultCount = *searchrs->resultCount;
1848 printf ("Search response %d, %d hits\n",
1849 setobj->searchStatus, setobj->resultCount);
1851 ir_handleRecords (o, zrs);
1853 setobj->recordFlag = 0;
1856 printf ("Search response, no object!\n");
1860 static void ir_presentResponse (void *o, Z_PresentResponse *presrs)
1863 IRSetObj *setobj = p->set_child;
1864 Z_Records *zrs = presrs->records;
1866 printf ("Received presentResponse\n");
1868 ir_handleRecords (o, zrs);
1871 setobj->recordFlag = 0;
1872 printf ("No records!\n");
1876 static void ir_scanResponse (void *o, Z_ScanResponse *scanrs)
1879 IRScanObj *scanobj = p->scan_child;
1881 printf ("Received scanResponse\n");
1883 scanobj->scanStatus = *scanrs->scanStatus;
1884 printf ("scanStatus=%d\n", scanobj->scanStatus);
1886 if (scanrs->stepSize)
1887 scanobj->stepSize = *scanrs->stepSize;
1888 printf ("stepSize=%d\n", scanobj->stepSize);
1890 scanobj->numberOfEntriesReturned = *scanrs->numberOfEntriesReturned;
1891 printf ("numberOfEntriesReturned=%d\n", scanobj->numberOfEntriesReturned);
1893 if (scanrs->positionOfTerm)
1894 scanobj->positionOfTerm = *scanrs->positionOfTerm;
1896 scanobj->positionOfTerm = -1;
1897 printf ("positionOfTerm=%d\n", scanobj->positionOfTerm);
1899 free (scanobj->entries);
1900 scanobj->entries = NULL;
1901 free (scanobj->nonSurrogateDiagnostics);
1902 scanobj->nonSurrogateDiagnostics = NULL;
1904 if (scanrs->entries)
1909 scanobj->entries_flag = 1;
1910 scanobj->which = scanrs->entries->which;
1911 switch (scanobj->which)
1913 case Z_ListEntries_entries:
1914 scanobj->num_entries = scanrs->entries->u.entries->num_entries;
1915 scanobj->entries = malloc (scanobj->num_entries *
1916 sizeof(*scanobj->entries));
1917 for (i=0; i<scanobj->num_entries; i++)
1919 ze = scanrs->entries->u.entries->entries[i];
1920 scanobj->entries[i].which = ze->which;
1923 case Z_Entry_termInfo:
1924 if (ze->u.termInfo->term->which == Z_Term_general)
1926 scanobj->entries[i].u.term.buf =
1927 malloc (1+ze->u.termInfo->term->u.general->len);
1928 strcpy (scanobj->entries[i].u.term.buf,
1929 ze->u.termInfo->term->u.general->buf);
1932 scanobj->entries[i].u.term.buf = NULL;
1933 if (ze->u.termInfo->globalOccurrences)
1934 scanobj->entries[i].u.term.globalOccurrences =
1935 *ze->u.termInfo->globalOccurrences;
1937 scanobj->entries[i].u.term.globalOccurrences = 0;
1939 case Z_Entry_surrogateDiagnostic:
1940 scanobj->entries[i].u.diag.addinfo =
1941 malloc (1+strlen(ze->u.surrogateDiagnostic->
1943 strcpy (scanobj->entries[i].u.diag.addinfo,
1944 ze->u.surrogateDiagnostic->addinfo);
1945 scanobj->entries[i].u.diag.condition =
1946 *ze->u.surrogateDiagnostic->condition;
1951 case Z_ListEntries_nonSurrogateDiagnostics:
1952 scanobj->num_diagRecs = scanrs->entries->
1953 u.nonSurrogateDiagnostics->num_diagRecs;
1954 scanobj->nonSurrogateDiagnostics = malloc (scanobj->num_diagRecs *
1955 sizeof(*scanobj->nonSurrogateDiagnostics));
1960 scanobj->entries_flag = 0;
1964 * ir_select_read: handle incoming packages
1966 void ir_select_read (ClientData clientData)
1968 IRObj *p = clientData;
1974 r = cs_rcvconnect (p->cs_link);
1978 ir_select_remove_write (cs_fileno (p->cs_link), p);
1981 printf ("cs_rcvconnect error\n");
1983 Tcl_Eval (p->interp, p->failback);
1984 do_disconnect (p, NULL, 0, NULL);
1988 Tcl_Eval (p->interp, p->callback);
1993 if ((r=cs_get (p->cs_link, &p->buf_in, &p->len_in)) <= 0)
1995 printf ("cs_get failed\n");
1996 ir_select_remove (cs_fileno (p->cs_link), p);
1998 Tcl_Eval (p->interp, p->failback);
1999 do_disconnect (p, NULL, 0, NULL);
2004 odr_setbuf (p->odr_in, p->buf_in, r);
2005 printf ("cs_get ok, got %d\n", r);
2006 if (!z_APDU (p->odr_in, &apdu, 0))
2008 printf ("%s\n", odr_errlist [odr_geterror (p->odr_in)]);
2010 Tcl_Eval (p->interp, p->failback);
2011 do_disconnect (p, NULL, 0, NULL);
2016 case Z_APDU_initResponse:
2017 ir_initResponse (p, apdu->u.initResponse);
2019 case Z_APDU_searchResponse:
2020 ir_searchResponse (p, apdu->u.searchResponse);
2022 case Z_APDU_presentResponse:
2023 ir_presentResponse (p, apdu->u.presentResponse);
2025 case Z_APDU_scanResponse:
2026 ir_scanResponse (p, apdu->u.scanResponse);
2029 printf("Received unknown APDU type (%d).\n",
2032 Tcl_Eval (p->interp, p->failback);
2033 do_disconnect (p, NULL, 0, NULL);
2036 Tcl_Eval (p->interp, p->callback);
2037 } while (cs_more (p->cs_link));
2041 * ir_select_write: handle outgoing packages - not yet written.
2043 void ir_select_write (ClientData clientData)
2045 IRObj *p = clientData;
2048 printf ("In write handler.....\n");
2051 r = cs_rcvconnect (p->cs_link);
2057 printf ("cs_rcvconnect error\n");
2058 ir_select_remove_write (cs_fileno (p->cs_link), p);
2060 Tcl_Eval (p->interp, p->failback);
2061 do_disconnect (p, NULL, 0, NULL);
2064 ir_select_remove_write (cs_fileno (p->cs_link), p);
2066 Tcl_Eval (p->interp, p->callback);
2069 if ((r=cs_put (p->cs_link, p->sbuf, p->slen)) < 0)
2071 printf ("select write fail\n");
2073 Tcl_Eval (p->interp, p->failback);
2074 do_disconnect (p, NULL, 0, NULL);
2076 else if (r == 0) /* remove select bit */
2078 ir_select_remove_write (cs_fileno (p->cs_link), p);
2082 /* ------------------------------------------------------- */
2085 * ir_tcl_init: Registration of TCL commands.
2087 int ir_tcl_init (Tcl_Interp *interp)
2089 Tcl_CreateCommand (interp, "ir", ir_obj_mk, (ClientData) NULL,
2090 (Tcl_CmdDeleteProc *) NULL);
2091 Tcl_CreateCommand (interp, "ir-set", ir_set_obj_mk,
2092 (ClientData) NULL, (Tcl_CmdDeleteProc *) NULL);
2093 Tcl_CreateCommand (interp, "ir-scan", ir_scan_obj_mk,
2094 (ClientData) NULL, (Tcl_CmdDeleteProc *) NULL);