Actual presentation in line-by-line format. RPN query support.
[ir-tcl-moved-to-github.git] / ir-tcl.c
index 85577da..e17320a 100644 (file)
--- a/ir-tcl.c
+++ b/ir-tcl.c
@@ -2,7 +2,13 @@
  * IR toolkit for tcl/tk
  * (c) Index Data 1995
  *
- * $Id: ir-tcl.c,v 1.2 1995-03-08 07:28:29 adam Exp $
+ * $Log: ir-tcl.c,v $
+ * Revision 1.5  1995-03-10 18:00:15  adam
+ * Actual presentation in line-by-line format. RPN query support.
+ *
+ * Revision 1.4  1995/03/09  16:15:08  adam
+ * First presentRequest attempts. Hot-target list.
+ *
  */
 
 #include <stdlib.h>
@@ -10,6 +16,8 @@
 #include <sys/time.h>
 #include <assert.h>
 
+#include <yaz-ccl.h>
+#include <iso2709p.h>
 #include <comstack.h>
 #include <tcpip.h>
 #include <xmosi.h>
@@ -44,10 +52,35 @@ typedef struct {
 
     Tcl_Interp *interp;
     char *callback;
+
+    int smallSetUpperBound;
+    int largeSetLowerBound;
+    int mediumSetPresentNumber;
+    int replaceIndicator;
+    char **databaseNames;
+    int num_databaseNames;
+    char *query_method;
+
+    CCL_bibset bibset;
+
+    struct IRSetObj_ *child;
 } IRObj;
 
-typedef struct {
+typedef struct IRRecordList_ {
+    int status;
+    Iso2709Rec rec;
+    int no;
+    struct IRRecordList_ *next;
+} IRRecordList;
+
+typedef struct IRSetObj_ {
     IRObj *parent;
+    int resultCount;
+    int start;
+    int number;
+    int numberOfRecordsReturned;
+    Z_Records *z_records;
+    IRRecordList *record_list;
 } IRSetObj;
 
 typedef struct {
@@ -78,7 +111,10 @@ static int get_parent_info (Tcl_Interp *interp, const char *name,
     memcpy (parent_name, name, pos);
     parent_name[pos] = '\0';
     if (!Tcl_GetCommandInfo (interp, parent_name, parent_info))
+    {
+        interp->result = "No parent";
         return TCL_ERROR;
+    }
     return TCL_OK;
 }
 
@@ -400,6 +436,59 @@ static int do_callback (void *obj, Tcl_Interp *interp,
     return TCL_OK;
 }
 
+/*
+ * do_databaseNames: specify database names
+ */
+static int do_databaseNames (void *obj, Tcl_Interp *interp,
+                          int argc, char **argv)
+{
+    int i;
+    IRObj *p = obj;
+
+    if (argc < 3)
+    {
+        interp->result = "wrong # args";
+        return TCL_ERROR;
+    }
+    if (p->databaseNames)
+    {
+        for (i=0; i<p->num_databaseNames; i++)
+            free (p->databaseNames[i]);
+        free (p->databaseNames);
+    }
+    p->num_databaseNames = argc - 2;
+    if (!(p->databaseNames = malloc (sizeof(*p->databaseNames) *
+                               p->num_databaseNames)))
+    {
+        interp->result = "malloc fail";
+        return TCL_ERROR;
+    }
+    for (i=0; i<p->num_databaseNames; i++)
+    {
+        if (ir_strdup (interp, &p->databaseNames[i], argv[2+i]) 
+            == TCL_ERROR)
+            return TCL_ERROR;
+    }
+    return TCL_OK;
+}
+
+/*
+ * do_query: Set/Get query mothod
+ */
+static int do_query (void *obj, Tcl_Interp *interp,
+                      int argc, char **argv)
+{
+    IRObj *p = obj;
+    if (argc == 3)
+    {
+        free (p->query_method);
+        if (ir_strdup (interp, &p->query_method, argv[2]) == TCL_ERROR)
+            return TCL_ERROR;
+    }
+    Tcl_AppendResult (interp, p->query_method, NULL);
+    return TCL_OK;
+}
+
 /* 
  * ir_obj_method: IR Object methods
  */
@@ -407,18 +496,20 @@ static int ir_obj_method (ClientData clientData, Tcl_Interp *interp,
                           int argc, char **argv)
 {
     static IRMethod tab[] = {
-    { "comstack", do_comstack },
-    { "connect", do_connect },
-    { "protocolVersion", do_protocolVersion },
-    { "options", do_options },
-    { "preferredMessageSize", do_preferredMessageSize },
-    { "maximumMessageSize",   do_maximumMessageSize },
-    { "implementationName", do_implementationName },
-    { "implementationId",   do_implementationId },
-    { "idAuthentication",   do_idAuthentication },
-    { "init", do_init_request },
-    { "disconnect", do_disconnect },
-    { "callback", do_callback },
+    { "comstack",                do_comstack },
+    { "connect",                 do_connect },
+    { "protocolVersion",         do_protocolVersion },
+    { "options",                 do_options },
+    { "preferredMessageSize",    do_preferredMessageSize },
+    { "maximumMessageSize",      do_maximumMessageSize },
+    { "implementationName",      do_implementationName },
+    { "implementationId",        do_implementationId },
+    { "idAuthentication",        do_idAuthentication },
+    { "init",                    do_init_request },
+    { "disconnect",              do_disconnect },
+    { "callback",                do_callback },
+    { "databaseNames",           do_databaseNames},
+    { "query",                   do_query },
     { NULL, NULL}
     };
     if (argc < 2)
@@ -444,6 +535,7 @@ static int ir_obj_mk (ClientData clientData, Tcl_Interp *interp,
               int argc, char **argv)
 {
     IRObj *obj;
+    FILE *inf;
 
     if (argc != 2)
     {
@@ -458,7 +550,7 @@ static int ir_obj_mk (ClientData clientData, Tcl_Interp *interp,
     }
     obj->cs_link = cs_create (tcpip_type);
 
-    obj->maximumMessageSize = 10000;
+    obj->maximumMessageSize = 32768;
     obj->preferredMessageSize = 4096;
 
     obj->idAuthentication = NULL;
@@ -470,7 +562,21 @@ static int ir_obj_mk (ClientData clientData, Tcl_Interp *interp,
     if (ir_strdup (interp, &obj->implementationId, "TCL/TK/YAZ")
         == TCL_ERROR)
         return TCL_ERROR;
-
+    
+    obj->smallSetUpperBound = 0;
+    obj->largeSetLowerBound = 2;
+    obj->mediumSetPresentNumber = 0;
+    obj->replaceIndicator = 1;
+    obj->databaseNames = NULL;
+    obj->num_databaseNames = 0; 
+    if (ir_strdup (interp, &obj->query_method, "rpn") == TCL_ERROR)
+        return TCL_ERROR;
+    obj->bibset = ccl_qual_mk (); 
+    if ((inf = fopen ("default.bib", "r")))
+    {
+       ccl_qual_file (obj->bibset, inf);
+       fclose (inf);
+    }
     ODR_MASK_ZERO (&obj->protocolVersion);
     ODR_MASK_SET (&obj->protocolVersion, 0);
     ODR_MASK_SET (&obj->protocolVersion, 1);
@@ -495,7 +601,6 @@ static int ir_obj_mk (ClientData clientData, Tcl_Interp *interp,
     obj->buf_in = NULL;
 
     obj->callback = NULL;
-
     Tcl_CreateCommand (interp, argv[1], ir_obj_method,
                        (ClientData) obj, ir_obj_delete);
     return TCL_OK;
@@ -503,14 +608,233 @@ static int ir_obj_mk (ClientData clientData, Tcl_Interp *interp,
 
 /* ------------------------------------------------------- */
 /*
- * do_query: Set query for a Set Object
+ * do_search: Do search request
  */
-static int do_query (void *obj, Tcl_Interp *interp,
+static int do_search (void *o, Tcl_Interp *interp,
+                      int argc, char **argv)
+{
+    Z_SearchRequest req;
+    Z_Query query;
+    Z_APDU apdu, *apdup;
+    static Odr_oid bib1[] = {1, 2, 840, 10003, 3, 1, -1};
+    Odr_oct ccl_query;
+    IRSetObj *obj = o;
+    IRObj *p = obj->parent;
+    char *sbuf;
+    int slen;
+
+    p->child = o;
+    if (argc != 3)
+    {
+        interp->result = "wrong # args";
+        return TCL_ERROR;
+    }
+    if (!p->num_databaseNames)
+    {
+        interp->result = "no databaseNames";
+        return TCL_ERROR;
+    }
+    apdu.which = Z_APDU_searchRequest;
+    apdu.u.searchRequest = &req;
+    apdup = &apdu;
+
+    req.referenceId = 0;
+    req.smallSetUpperBound = &p->smallSetUpperBound;
+    req.largeSetLowerBound = &p->largeSetLowerBound;
+    req.mediumSetPresentNumber = &p->mediumSetPresentNumber;
+    req.replaceIndicator = &p->replaceIndicator;
+    req.resultSetName = "Default";
+    req.num_databaseNames = p->num_databaseNames;
+    req.databaseNames = p->databaseNames;
+    req.smallSetElementSetNames = 0;
+    req.mediumSetElementSetNames = 0;
+    req.preferredRecordSyntax = 0;
+    req.query = &query;
+
+    if (!strcmp (p->query_method, "rpn"))
+    {
+        int error;
+        int pos;
+        struct ccl_rpn_node *rpn;
+        Z_RPNQuery *RPNquery;
+
+        rpn = ccl_find_str(p->bibset, argv[2], &error, &pos);
+        if (error)
+        {
+            Tcl_AppendResult (interp, "CCL error: ", ccl_err_msg(error),NULL);
+            return TCL_ERROR;
+        }
+        query.which = Z_Query_type_1;
+        assert((RPNquery = ccl_rpn_query(rpn)));
+        RPNquery->attributeSetId = bib1;
+        query.u.type_1 = RPNquery;
+    }
+    else if (!strcmp (p->query_method, "ccl"))
+    {
+        query.which = Z_Query_type_2;
+        query.u.type_2 = &ccl_query;
+        ccl_query.buf = argv[2];
+        ccl_query.len = strlen (argv[2]);
+    }
+    else
+    {
+        interp->result = "unknown query method";
+        return TCL_ERROR;
+    }
+    if (!z_APDU (p->odr_out, &apdup, 0))
+    {
+        interp->result = odr_errlist [odr_geterror (p->odr_out)];
+        odr_reset (p->odr_out);
+        return TCL_ERROR;
+    } 
+    sbuf = odr_getbuf (p->odr_out, &slen);
+    if (cs_put (p->cs_link, sbuf, slen) < 0)
+    {
+        interp->result = "cs_put failed in init";
+        return TCL_ERROR;
+    }
+    printf ("Search request\n");
+    return TCL_OK;
+}
+
+/*
+ * do_resultCount: Get number of hits
+ */
+static int do_resultCount (void *o, Tcl_Interp *interp,
                       int argc, char **argv)
 {
+    IRSetObj *obj = o;
+
+    sprintf (interp->result, "%d", obj->resultCount);
     return TCL_OK;
 }
 
+/*
+ * do_numberOfRecordsReturned: Get number of records returned
+ */
+static int do_numberOfRecordsReturned (void *o, Tcl_Interp *interp,
+                      int argc, char **argv)
+{
+    IRSetObj *obj = o;
+
+    sprintf (interp->result, "%d", obj->numberOfRecordsReturned);
+    return TCL_OK;
+}
+
+static int get_marc_record(Tcl_Interp *interp, Iso2709Rec rec,
+                           int argc, char **argv)
+{
+    struct iso2709_dir *dir;
+    struct iso2709_field *field;
+    
+    for (dir = rec->directory; dir; dir = dir->next)
+    {
+        if (strcmp (dir->tag, argv[3]))
+            continue;
+        for (field = dir->fields; field; field = field->next)
+        {
+            if (argc > 4 && strcmp (field->identifier, argv[4]))
+                continue;
+            Tcl_AppendElement (interp, field->data);
+        }
+    }
+    return TCL_OK;
+}
+
+/*
+ * do_getRecord: Get an ISO2709 Record
+ */
+static int do_getRecord (void *o, Tcl_Interp *interp,
+                      int argc, char **argv)
+{
+    IRSetObj *obj = o;
+    int offset;
+    IRRecordList *rl;
+
+    if (argc < 3)
+    {
+        sprintf (interp->result, "wrong # args");
+        return TCL_ERROR;
+    }
+    if (Tcl_GetInt (interp, argv[2], &offset)==TCL_ERROR)
+        return TCL_ERROR;
+    for (rl = obj->record_list; rl; rl = rl->next)
+    {
+        if (rl->no == offset)
+            break;
+    }
+    if (!rl)
+    {
+        Tcl_AppendResult (interp, "No record at #", argv[2], NULL);
+        return TCL_ERROR;
+    }
+    if (!rl->rec)
+    {
+        Tcl_AppendResult (interp, "Not a MARC record at #", argv[2], NULL);
+        return TCL_ERROR;
+    }
+    return get_marc_record (interp, rl->rec, argc, argv);
+}
+
+/*
+ * do_present: Perform Present Request
+ */
+
+static int do_present (void *o, Tcl_Interp *interp,
+                       int argc, char **argv)
+{
+    IRSetObj *obj = o;
+    IRObj *p = obj->parent;
+    Z_APDU apdu, *apdup;
+    Z_PresentRequest req;
+    int start;
+    int number;
+    char *sbuf;
+    int slen;
+
+    if (argc >= 3)
+    {
+        if (Tcl_GetInt (interp, argv[2], &start) == TCL_ERROR)
+            return TCL_ERROR;
+    }
+    else
+        start = 1;
+    if (argc >= 4)
+    {
+        if (Tcl_GetInt (interp, argv[3], &number) == TCL_ERROR)
+            return TCL_ERROR;
+    }
+    else 
+        number = 10;
+    obj->start = start;
+    obj->number = number;
+
+    apdup = &apdu;
+    apdu.which = Z_APDU_presentRequest;
+    apdu.u.presentRequest = &req;
+    req.referenceId = 0;
+    /* sprintf(setstring, "%d", setnumber); */
+    req.resultSetId = "Default";
+    req.resultSetStartPoint = &start;
+    req.numberOfRecordsRequested = &number;
+    req.elementSetNames = 0;
+    req.preferredRecordSyntax = 0;
+
+    if (!z_APDU (p->odr_out, &apdup, 0))
+    {
+        interp->result = odr_errlist [odr_geterror (p->odr_out)];
+        odr_reset (p->odr_out);
+        return TCL_ERROR;
+    } 
+    sbuf = odr_getbuf (p->odr_out, &slen);
+    if (cs_put (p->cs_link, sbuf, slen) < 0)
+    {
+        interp->result = "cs_put failed in init";
+        return TCL_ERROR;
+    }
+    printf ("Present request, start=%d, num=%d\n", start, number);
+    return TCL_OK;
+}
 
 /* 
  * ir_set_obj_method: IR Set Object methods
@@ -519,7 +843,11 @@ static int ir_set_obj_method (ClientData clientData, Tcl_Interp *interp,
                           int argc, char **argv)
 {
     static IRMethod tab[] = {
-    { "query", do_query },
+    { "search",                  do_search },
+    { "resultCount",             do_resultCount },
+    { "numberOfRecordsReturned", do_numberOfRecordsReturned },
+    { "present",                 do_present },
+    { "getRecord",               do_getRecord },
     { NULL, NULL}
     };
 
@@ -554,16 +882,15 @@ static int ir_set_obj_mk (ClientData clientData, Tcl_Interp *interp,
         return TCL_ERROR;
     }
     if (get_parent_info (interp, argv[1], &parent_info) == TCL_ERROR)
-    {
-        interp->result = "No parent";
         return TCL_ERROR;
-    }
     obj = malloc (sizeof(*obj));
     if (!obj)
     {
         interp->result = "malloc fail";
         return TCL_ERROR;
     }
+    obj->z_records = NULL;
+    obj->record_list = NULL;
     obj->parent = (IRObj *) parent_info.clientData;
     Tcl_CreateCommand (interp, argv[1], ir_set_obj_method,
                        (ClientData) obj, ir_set_obj_delete);
@@ -572,14 +899,18 @@ static int ir_set_obj_mk (ClientData clientData, Tcl_Interp *interp,
 
 /* ------------------------------------------------------- */
 
-static void ir_searchResponse (void *obj, Z_SearchResponse *searchrs)
+static void ir_searchResponse (void *o, Z_SearchResponse *searchrs)
 {    
+    IRObj *p = o;
+    IRSetObj *obj = p->child;
+
+    if (obj)
+        obj->resultCount = *searchrs->resultCount;
     if (searchrs->searchStatus)
         printf("Search was a success.\n");
     else
-            printf("Search was a bloomin' failure.\n");
-    printf("Number of hits: %d, setno %d\n",
-           *searchrs->resultCount, 1);
+        printf("Search was a bloomin' failure.\n");
+    printf("Number of hits: %d\n", *searchrs->resultCount);
 #if 0
     if (searchrs->records)
         display_records(searchrs->records);
@@ -588,6 +919,8 @@ static void ir_searchResponse (void *obj, Z_SearchResponse *searchrs)
 
 static void ir_initResponse (void *obj, Z_InitResponse *initrs)
 {
+    IRObj *p = obj;
+
     if (!*initrs->result)
         printf("Connection rejected by target.\n");
     else
@@ -608,13 +941,89 @@ static void ir_initResponse (void *obj, Z_InitResponse *initrs)
 #endif
 }
 
-static void ir_presentResponse (void *obj, Z_PresentResponse *presrs)
+static void ir_presentResponse (void *o, Z_PresentResponse *presrs)
 {
-    printf("Received presentResponse.\n");
-    if (presrs->records)
-        printf ("Got records\n");
+    IRObj *p = o;
+    IRSetObj *setobj = p->child;
+    Z_Records *zrs = presrs->records;
+    setobj->z_records = presrs->records;
+    
+    printf ("Received presentResponse\n");
+    if (zrs)
+    {
+        if (zrs->which == Z_Records_NSD)
+        {
+            setobj->numberOfRecordsReturned = 0;
+            printf ("They are diagnostic!!!\n");
+            /*            
+               char buf[16];
+               sprintf (buf, "%d", *zrs->u.nonSurrogateDiagnostic->condition);
+               Tcl_AppendResult (interp, "Diagnostic message: ", buf,
+               " : ",
+               zrs->u.nonSurrogateDiagnostic->addinfo, NULL);
+               return TCL_ERROR;
+               */
+            return;
+        }
+        else
+        {
+            int offset;
+            IRRecordList *rl;
+            
+            setobj->numberOfRecordsReturned = 
+                zrs->u.databaseOrSurDiagnostics->num_records;
+            printf ("Got %d records\n", setobj->numberOfRecordsReturned);
+            for (offset = 0; offset<setobj->numberOfRecordsReturned; offset++)
+            {
+                int no = setobj->start + offset;
+                
+                for (rl = setobj->record_list; rl; rl = rl->next)
+                {
+                    if (no == rl->no)
+                    {
+                        if (rl->rec)
+                            iso2709_rm (rl->rec);
+                        break;
+                    }
+                }
+                if (!rl)
+                {
+                    rl = malloc (sizeof(*rl));
+                    assert (rl);
+                    rl->next = setobj->record_list;
+                    rl->no = no;
+                    rl->status = 0;
+                    setobj->record_list = rl;
+                }
+                if (zrs->u.databaseOrSurDiagnostics->records[offset]->which ==
+                    Z_NamePlusRecord_surrogateDiagnostic)
+                {
+                    rl->status = -1;
+                    rl->rec = NULL;
+                }
+                else
+                {
+                    Z_DatabaseRecord *zr; 
+                    Odr_external *oe;
+                    
+                    rl->status = 0;
+                    zr = zrs->u.databaseOrSurDiagnostics->records[offset]
+                        ->u.databaseRecord;
+                    oe = (Odr_external*) zr;
+                    if (oe->which == ODR_EXTERNAL_octet
+                        && zr->u.octet_aligned->len)
+                    {
+                        const char *buf = (char*) zr->u.octet_aligned->buf;
+                        rl->rec = iso2709_cvt (buf);
+                    }
+                }
+            }
+        }
+    }
     else
-        printf("No records\n");
+    {
+        printf ("No records!\n");
+    }
 }
 
 void ir_select_proc (ClientData clientData)
@@ -628,6 +1037,7 @@ void ir_select_proc (ClientData clientData)
         if ((r=cs_get (p->cs_link, &p->buf_in, &p->len_in))  < 0)
         {
             printf ("cs_get failed\n");
+            ir_select_remove (cs_fileno (p->cs_link), p);
             return;
         }        
         odr_setbuf (p->odr_in, p->buf_in, r);
@@ -637,25 +1047,23 @@ void ir_select_proc (ClientData clientData)
             printf ("%s\n", odr_errlist [odr_geterror (p->odr_in)]);
             return;
         }
-        if (p->callback)
-        {
-           Tcl_Eval (p->interp, p->callback);
-       }
         switch(apdu->which)
         {
         case Z_APDU_initResponse:
-            ir_initResponse (NULL, apdu->u.initResponse);
+            ir_initResponse (p, apdu->u.initResponse);
             break;
         case Z_APDU_searchResponse:
-            ir_searchResponse (NULL, apdu->u.searchResponse);
+            ir_searchResponse (p, apdu->u.searchResponse);
             break;
         case Z_APDU_presentResponse:
-            ir_presentResponse (NULL, apdu->u.presentResponse);
+            ir_presentResponse (p, apdu->u.presentResponse);
             break;
         default:
             printf("Received unknown APDU type (%d).\n", 
                    apdu->which);
         }
+        if (p->callback)
+           Tcl_Eval (p->interp, p->callback);
     } while (cs_more (p->cs_link));    
 }
 
@@ -672,5 +1080,3 @@ int ir_tcl_init (Tcl_Interp *interp)
                       (ClientData) NULL, (Tcl_CmdDeleteProc *) NULL);
     return TCL_OK;
 }
-
-