Added "schema" command.
[yaz-moved-to-github.git] / client / client.c
index d813167..21d1650 100644 (file)
@@ -1,10 +1,50 @@
 /*
- * Copyright (c) 1995-1998, Index Data.
+ * Copyright (c) 1995-1999, Index Data
  * See the file LICENSE for details.
  * Sebastian Hammer, Adam Dickmeiss
  *
  * $Log: client.c,v $
- * Revision 1.73  1998-10-20 13:55:43  quinn
+ * Revision 1.86  1999-07-06 12:13:35  adam
+ * Added "schema" command.
+ *
+ * Revision 1.85  1999/06/16 11:55:24  adam
+ * Added APDU log to client.
+ *
+ * Revision 1.84  1999/06/01 14:29:11  adam
+ * Work on Extended Services.
+ *
+ * Revision 1.83  1999/05/26 15:24:26  adam
+ * Fixed minor bugs regarding DB Update (introduced by previous commit).
+ *
+ * Revision 1.82  1999/05/26 13:49:12  adam
+ * DB Update implemented in client (very basic).
+ *
+ * Revision 1.81  1999/04/20 09:56:48  adam
+ * Added 'name' paramter to encoder/decoder routines (typedef Odr_fun).
+ * Modified all encoders/decoders to reflect this change.
+ *
+ * Revision 1.80  1999/03/31 11:18:24  adam
+ * Implemented odr_strdup. Added Reference ID to backend server API.
+ *
+ * Revision 1.79  1999/03/23 14:14:25  adam
+ * Yet another fix.
+ *
+ * Revision 1.78  1999/03/18 12:57:18  adam
+ * Minor fix.
+ *
+ * Revision 1.77  1999/03/11 15:26:51  adam
+ * Fixed bug (introduced by previous commit).
+ *
+ * Revision 1.76  1999/03/11 11:12:07  adam
+ * Added GNU readline support. HTML display in client.
+ *
+ * Revision 1.75  1999/02/01 15:37:32  adam
+ * Fixed minor bug introduced by previous commit.
+ *
+ * Revision 1.74  1999/02/01 15:35:21  adam
+ * Added XML display.
+ *
+ * Revision 1.73  1998/10/20 13:55:43  quinn
  * Fixed Scan bug in asn and client
  *
  * Revision 1.72  1998/10/20 13:23:15  quinn
 
 #include <yaz-util.h>
 
-#include <comstack.h>
 #include <tcpip.h>
 #ifdef USE_XTIMOSI
 #include <xmosi.h>
 #include <yaz-ccl.h>
 #endif
 
+#if HAVE_READLINE_READLINE_H
+#include <readline/readline.h>
+#endif
+#if HAVE_READLINE_HISTORY_H
+#include <readline/history.h>
+#endif
+
 #define C_PROMPT "Z> "
 
 static ODR out, in, print;              /* encoding and decoding streams */
+static FILE *apdu_file = 0;
 static COMSTACK conn = 0;               /* our z-association */
 static Z_IdAuthentication *auth = 0;    /* our current auth definition */
 static char *databaseNames[128];
+static Z_External *record_last = 0;
 static int num_databaseNames = 0;
 static int setnumber = 0;               /* current result set number */
 static int smallSetUpperBound = 0;
@@ -281,6 +329,7 @@ static Z_ElementSetNames *elementSetNames = 0;
 static int setno = 1;                   /* current set offset */
 static enum oid_proto protocol = PROTO_Z3950;      /* current app protocol */
 static enum oid_value recordsyntax = VAL_USMARC;
+static enum oid_value schema = VAL_NONE;
 static int sent_close = 0;
 static NMEM session_mem = NULL;      /* memory handle for init-response */
 static Z_InitResponse *session = 0;     /* session parameters */
@@ -306,11 +355,16 @@ static void send_apdu(Z_APDU *a)
     char *buf;
     int len;
 
-    if (!z_APDU(out, &a, 0))
+    if (!z_APDU(out, &a, 0, 0))
     {
         odr_perror(out, "Encoding APDU");
         exit(1);
     }
+    if (apdu_file)
+    {
+        z_APDU(print, &a, 0, 0);
+        odr_reset(print);
+    }
     buf = odr_getbuf(out, &len, 0);
     if (cs_put(conn, buf, len) < 0)
     {
@@ -361,6 +415,7 @@ static void send_initRequest()
     ODR_MASK_SET(req->protocolVersion, Z_ProtocolVersion_3);
 
     *req->maximumRecordSize = 1024*1024;
+    *req->preferredMessageSize = 1024*1024;
 
     req->idAuthentication = auth;
 
@@ -388,7 +443,7 @@ static int process_initResponse(Z_InitResponse *res)
     {
         printf("UserInformationfield:\n");
         if (!z_External(print, (Z_External**)&res-> userInformationField,
-            0))
+            0, 0))
         {
             odr_perror(print, "Printing userinfo\n");
             odr_reset(print);
@@ -610,6 +665,7 @@ static void display_record(Z_DatabaseRecord *p)
     Z_External *r = (Z_External*) p;
     oident *ent = oid_getentbyoid(r->direct_reference);
 
+    record_last = r;
     /*
      * Tell the user what we got.
      */
@@ -618,7 +674,7 @@ static void display_record(Z_DatabaseRecord *p)
         printf("Record type: ");
         if (ent)
             printf("%s\n", ent->desc);
-        else if (!odr_oid(print, &r->direct_reference, 0))
+        else if (!odr_oid(print, &r->direct_reference, 0, 0))
         {
             odr_perror(print, "print oid");
             odr_reset(print);
@@ -637,7 +693,7 @@ static void display_record(Z_DatabaseRecord *p)
             */
            odr_setbuf(in, (char*)p->u.octet_aligned->buf,
                p->u.octet_aligned->len, 0);
-           if (!(*type->fun)(in, (char **)&rr, 0))
+           if (!(*type->fun)(in, (char **)&rr, 0, 0))
            {
                odr_perror(in, "Decoding constructed record.");
                fprintf(stderr, "[Near %d]\n", odr_offset(in));
@@ -659,10 +715,22 @@ static void display_record(Z_DatabaseRecord *p)
         printf("%.*s", r->u.octet_aligned->len, r->u.octet_aligned->buf);
     else if (r->which == Z_External_octet && p->u.octet_aligned->len)
     {
-        const char *marc_buf = (char*)p->u.octet_aligned->buf;
-        marc_display (marc_buf, NULL);
+        const char *octet_buf = (char*)p->u.octet_aligned->buf;
+       if (ent->value == VAL_TEXT_XML || ent->value == VAL_APPLICATION_XML ||
+            ent->value == VAL_HTML)
+       {
+            int i;
+            for (i = 0; i<p->u.octet_aligned->len; i++)
+                if (octet_buf[i] > 126 || octet_buf[i] < 7)
+                    printf ("<%02X>", octet_buf[i]);
+                else
+                    fputc (octet_buf[i], stdout);
+           printf ("\n");
+        }
+       else
+            marc_display (octet_buf, NULL);
         if (marcdump)
-            fwrite (marc_buf, strlen (marc_buf), 1, marcdump);
+            fwrite (octet_buf, 1, p->u.octet_aligned->len, marcdump);
     }
     else if (ent && ent->value == VAL_SUTRS)
     {
@@ -685,7 +753,7 @@ static void display_record(Z_DatabaseRecord *p)
     else 
     {
         printf("Unknown record representation.\n");
-        if (!z_External(print, &r, 0))
+        if (!z_External(print, &r, 0, 0))
         {
             odr_perror(print, "Printing external");
             odr_reset(print);
@@ -741,7 +809,7 @@ static void display_nameplusrecord(Z_NamePlusRecord *p)
         printf("[%s]", p->databaseName);
     if (p->which == Z_NamePlusRecord_surrogateDiagnostic)
         display_diagrecs(&p->u.surrogateDiagnostic, 1);
-    else
+    else if (p->which == Z_NamePlusRecord_databaseRecord)
         display_record(p->u.databaseRecord);
 }
 
@@ -1077,7 +1145,20 @@ static int process_resourceControlRequest (Z_ResourceControlRequest *req)
 
 void process_ESResponse(Z_ExtendedServicesResponse *res)
 {
-    printf("process_ESResponse\n");
+    printf("process_ESResponse status=");
+    switch (*res->operationStatus)
+    {
+    case Z_ExtendedServicesResponse_done:
+       printf ("done\n");
+       break;
+    case Z_ExtendedServicesResponse_accepted:
+       printf ("accepted\n");
+       break;
+    case Z_ExtendedServicesResponse_failure:
+       printf ("failure\n");
+       display_diagrecs(res->diagnostics, res->num_diagnostics);
+       break;
+    }
 }
 
 static Z_External *CreateItemOrderExternal(int itemno)
@@ -1090,10 +1171,8 @@ static Z_External *CreateItemOrderExternal(int itemno)
     ItemOrderRequest.value = VAL_ITEMORDER;
  
     r->direct_reference = odr_oiddup(out,oid_getoidbyent(&ItemOrderRequest)); 
-    r->indirect_reference = (int *) odr_malloc(out,sizeof(int));
-    *r->indirect_reference = 0;
-
-    r->descriptor = "Extended services item order";
+    r->indirect_reference = 0;
+    r->descriptor = 0;
 
     r->which = Z_External_itemOrder;
 
@@ -1146,10 +1225,6 @@ static int send_itemorder(char *arg)
 
     /* Set up item order request */
 
-    /* Function being performed by this extended services request */
-    req->function = (int *) odr_malloc(out, sizeof(int));
-    *req->function = Z_ExtendedServicesRequest_create;
-
     /* Package type, Using protocol ILL ( But that's not in the oid.h file yet */
     /* create an object of class Extended Service, value Item Order            */
     ItemOrderRequest.proto = PROTO_Z3950;
@@ -1161,13 +1236,67 @@ static int send_itemorder(char *arg)
     /* ** taskSpecificParameters ** */
     req->taskSpecificParameters = CreateItemOrderExternal(itemno);
 
-    /* waitAction - Create the ILL request and that's it */
-    *req->waitAction = Z_ExtendedServicesRequest_wait;
-
     send_apdu(apdu);
     return 0;
 }
 
+static int cmd_update(char *arg)
+{
+    Z_APDU *apdu = zget_APDU(out, Z_APDU_extendedServicesRequest );
+    Z_ExtendedServicesRequest *req = apdu->u.extendedServicesRequest;
+    Z_External *r;
+    int oid[OID_SIZE];
+    Z_IUOriginPartToKeep *toKeep;
+    Z_IUSuppliedRecords *notToKeep;
+    oident update_oid;
+    printf ("Update request\n");
+    fflush(stdout);
+
+    if (!record_last)
+       return 0;
+    update_oid.proto = PROTO_Z3950;
+    update_oid.oclass = CLASS_EXTSERV;
+    update_oid.value = VAL_DBUPDATE;
+    oid_ent_to_oid (&update_oid, oid);
+    req->packageType = odr_oiddup(out,oid);
+    req->packageName = "1.Extendedserveq";
+
+    r = req->taskSpecificParameters = (Z_External *)
+       odr_malloc (out, sizeof(*r));
+    r->direct_reference = odr_oiddup(out,oid);
+    r->indirect_reference = 0;
+    r->descriptor = 0;
+    r->which = Z_External_update;
+    r->u.update = (Z_IUUpdate *) odr_malloc(out, sizeof(*r->u.update));
+    r->u.update->which = Z_IUUpdate_esRequest;
+    r->u.update->u.esRequest = (Z_IUUpdateEsRequest *)
+       odr_malloc(out, sizeof(*r->u.update->u.esRequest));
+    toKeep = r->u.update->u.esRequest->toKeep = (Z_IUOriginPartToKeep *)
+       odr_malloc(out, sizeof(*r->u.update->u.esRequest->toKeep));
+    toKeep->databaseName = databaseNames[0];
+    toKeep->schema = 0;
+    toKeep->elementSetName = 0;
+    toKeep->actionQualifier = 0;
+    toKeep->action = (int *) odr_malloc(out, sizeof(*toKeep->action));
+    *toKeep->action = Z_IUOriginPartToKeep_recordInsert;
+
+    notToKeep = r->u.update->u.esRequest->notToKeep = (Z_IUSuppliedRecords *)
+       odr_malloc(out, sizeof(*r->u.update->u.esRequest->notToKeep));
+    notToKeep->num = 1;
+    notToKeep->elements = (Z_IUSuppliedRecords_elem **)
+       odr_malloc(out, sizeof(*notToKeep->elements));
+    notToKeep->elements[0] = (Z_IUSuppliedRecords_elem *)
+       odr_malloc(out, sizeof(**notToKeep->elements));
+    notToKeep->elements[0]->u.number = 0;
+    notToKeep->elements[0]->supplementalId = 0;
+    notToKeep->elements[0]->correlationInfo = 0;
+    notToKeep->elements[0]->record = record_last;
+    
+    send_apdu(apdu);
+
+    return 2;
+}
+
 /* II : Added to do DALI Item Order Extended services request */
 static int cmd_itemorder(char *arg)
 {
@@ -1299,9 +1428,53 @@ static int send_presentRequest(char *arg)
     prefsyn.proto = protocol;
     prefsyn.oclass = CLASS_RECSYN;
     prefsyn.value = recordsyntax;
-    req->preferredRecordSyntax = oid_ent_to_oid(&prefsyn, oid);
-
-    if (elementSetNames)
+    req->preferredRecordSyntax =
+       odr_oiddup (out, oid_ent_to_oid(&prefsyn, oid));
+
+    if (schema != VAL_NONE)
+    {
+        oident prefschema;
+
+        prefschema.proto = protocol;
+        prefschema.oclass = CLASS_SCHEMA;
+        prefschema.value = schema;
+
+       req->recordComposition = &compo;
+       compo.which = Z_RecordComp_complex;
+       compo.u.complex = (Z_CompSpec *)
+           odr_malloc(out, sizeof(*compo.u.complex));
+       compo.u.complex->selectAlternativeSyntax = (bool_t *) 
+           odr_malloc(out, sizeof(bool_t));
+       *compo.u.complex->selectAlternativeSyntax = 0;
+
+       compo.u.complex->generic = (Z_Specification *)
+           odr_malloc(out, sizeof(*compo.u.complex->generic));
+       compo.u.complex->generic->schema = (Odr_oid *)
+           odr_oiddup(out, oid_ent_to_oid(&prefschema, oid));
+       if (!compo.u.complex->generic->schema)
+       {
+           /* OID wasn't a schema! Try record syntax instead. */
+           prefschema.oclass = CLASS_RECSYN;
+           compo.u.complex->generic->schema = (Odr_oid *)
+               odr_oiddup(out, oid_ent_to_oid(&prefschema, oid));
+       }
+       if (!elementSetNames)
+           compo.u.complex->generic->elementSpec = 0;
+       else
+       {
+           compo.u.complex->generic->elementSpec = (Z_ElementSpec *)
+               odr_malloc(out, sizeof(Z_ElementSpec));
+           compo.u.complex->generic->elementSpec->which =
+               Z_ElementSpec_elementSetName;
+           compo.u.complex->generic->elementSpec->u.elementSetName =
+               elementSetNames->u.generic;
+       }
+       compo.u.complex->num_dbSpecific = 0;
+       compo.u.complex->dbSpecific = 0;
+       compo.u.complex->num_recordSyntax = 0;
+       compo.u.complex->recordSyntax = 0;
+    }
+    else if (elementSetNames)
     {
         req->recordComposition = &compo;
         compo.which = Z_RecordComp_simple;
@@ -1421,7 +1594,8 @@ int send_sortrequest(char *arg, int newset)
 {
     Z_APDU *apdu = zget_APDU(out, Z_APDU_sortRequest);
     Z_SortRequest *req = apdu->u.sortRequest;
-    Z_SortKeySpecList *sksl = (Z_SortKeySpecList *)odr_malloc (out, sizeof(*sksl));
+    Z_SortKeySpecList *sksl = (Z_SortKeySpecList *)
+        odr_malloc (out, sizeof(*sksl));
     char setstring[32];
     char sort_string[32], sort_flags[32];
     int off;
@@ -1439,9 +1613,7 @@ int send_sortrequest(char *arg, int newset)
     req->num_inputResultSetNames = 1;
     req->inputResultSetNames = (Z_InternationalString **)
        odr_malloc (out, sizeof(*req->inputResultSetNames));
-    req->inputResultSetNames[0] = (char *)
-       odr_malloc (out, strlen(setstring)+1);
-    strcpy (req->inputResultSetNames[0], setstring);
+    req->inputResultSetNames[0] = odr_strdup (out, setstring);
 #else
     req->inputResultSetNames =
        (Z_StringList *)odr_malloc (out, sizeof(*req->inputResultSetNames));
@@ -1449,15 +1621,13 @@ int send_sortrequest(char *arg, int newset)
     req->inputResultSetNames->strings =
        (char **)odr_malloc (out, sizeof(*req->inputResultSetNames->strings));
     req->inputResultSetNames->strings[0] =
-       (char *)odr_malloc (out, strlen(setstring)+1);
-    strcpy (req->inputResultSetNames->strings[0], setstring);
+       odr_strdup (out, setstring);
 #endif
 
     if (newset && setnumber >= 0)
        sprintf (setstring, "%d", ++setnumber);
 
-    req->sortedResultSetName = (char *)odr_malloc (out, strlen(setstring)+1);
-    strcpy (req->sortedResultSetName, setstring);
+    req->sortedResultSetName = odr_strdup (out, setstring);
 
     req->sortSequence = sksl;
     sksl->num_specs = 0;
@@ -1504,8 +1674,7 @@ int send_sortrequest(char *arg, int newset)
        else
        {
            sk->which = Z_SortKey_sortField;
-           sk->u.sortField = (char *)odr_malloc (out, strlen(sort_string)+1);
-           strcpy (sk->u.sortField, sort_string);
+           sk->u.sortField = odr_strdup (out, sort_string);
        }
        sks->sortRelation = (int *)odr_malloc (out, sizeof(*sks->sortRelation));
        *sks->sortRelation = Z_SortRelation_ascending;
@@ -1681,6 +1850,22 @@ int cmd_scan(char *arg)
     return 2;
 }
 
+int cmd_schema(char *arg)
+{
+    if (!arg || !*arg)
+    {
+       schema = VAL_NONE;
+        return 1;
+    }
+    schema = oid_getvalbyname (arg);
+    if (schema == VAL_NONE)
+    {
+        printf ("unknown schema\n");
+        return 0;
+    }
+    return 1;
+}
+
 int cmd_format(char *arg)
 {
     if (!arg || !*arg)
@@ -1704,8 +1889,8 @@ int cmd_elements(char *arg)
 
     if (!arg || !*arg)
     {
-        printf("Usage: elements <esn>\n");
-        return 0;
+       elementSetNames = 0;
+        return 1;
     }
     strcpy(what, arg);
     esn.which = Z_ElementSetNames_generic;
@@ -1797,6 +1982,8 @@ static void initialize(void)
         exit(1);
     }
     setvbuf(stdout, 0, _IONBF, 0);
+    if (apdu_file)
+        odr_setprint(print, apdu_file);
 
 #if CCL2RPN
     bibset = ccl_qual_mk (); 
@@ -1834,12 +2021,14 @@ static int client(int wait)
         {"setnames", cmd_setnames, ""},
         {"cancel", cmd_cancel, ""},
         {"format", cmd_format, "<recordsyntax>"},
+       {"schema", cmd_schema, "<schema>"},
         {"elements", cmd_elements, "<elementSetName>"},
         {"close", cmd_close, ""},
        {"attributeset", cmd_attributeset, "<attrset>"},
         {"querytype", cmd_querytype, "<type>"},
        {"refid", cmd_refid, "<id>"},
        {"itemorder", cmd_itemorder, "<item>"},
+       {"update", cmd_update, "<item>"},
         {0,0}
     };
     char *netbuffer= 0;
@@ -1871,13 +2060,27 @@ static int client(int wait)
 #else
        if (!wait)
 #endif
-           {
-            /* quick & dirty way to get a command line. */
-               char *end_p;
-               if (!fgets(line, 1023, stdin))
-                   break;
-               if ((end_p = strchr (line, '\n')))
-                   *end_p = '\0';
+       {
+#if HAVE_READLINE_READLINE_H
+           char* line_in;
+           line_in=readline(C_PROMPT);
+            if (!line_in)
+                break;
+#if HAVE_READLINE_HISTORY_H
+            if (*line_in)
+               add_history(line_in);
+#endif
+           strcpy(line,line_in);
+            free (line_in);
+#else    
+           char *end_p;
+            printf (C_PROMPT);
+           fflush(stdout);
+           if (!fgets(line, 1023, stdin))
+               break;
+           if ((end_p = strchr (line, '\n')))
+               *end_p = '\0';
+#endif 
             if ((res = sscanf(line, "%s %[^;]", word, arg)) <= 0)
             {
                 strcpy(word, last_cmd);
@@ -1902,7 +2105,6 @@ static int client(int wait)
             }
             if (res < 2)
            {
-                printf(C_PROMPT);
                continue;
            }
         }
@@ -1924,8 +2126,9 @@ static int client(int wait)
                     exit(1);
                 }
                 odr_reset(in); /* release APDU from last round */
+               record_last = 0;
                 odr_setbuf(in, netbuffer, res, 0);
-                if (!z_APDU(in, &apdu, 0))
+                if (!z_APDU(in, &apdu, 0, 0))
                 {
                     odr_perror(in, "Decoding incoming APDU");
                    fprintf(stderr, "[Near %d]\n", odr_offset(in));
@@ -1934,14 +2137,12 @@ static int client(int wait)
                     fprintf(stderr, "---------\n");
                     exit(1);
                 }
-#if 0
-                if (!z_APDU(print, &apdu, 0))
+                if (apdu_file && !z_APDU(print, &apdu, 0, 0))
                 {
                     odr_perror(print, "Failed to print incoming APDU");
                     odr_reset(print);
                     continue;
                 }
-#endif
                 switch(apdu->which)
                 {
                case Z_APDU_initResponse:
@@ -1991,8 +2192,6 @@ static int client(int wait)
                 }
             }
             while (conn && cs_more(conn));
-           printf(C_PROMPT);
-           fflush(stdout);
         }
     }
     return 0;
@@ -2005,7 +2204,7 @@ int main(int argc, char **argv)
     int ret;
     int opened = 0;
 
-    while ((ret = options("m:v:", argv, argc, &arg)) != -2)
+    while ((ret = options("a:m:v:", argv, argc, &arg)) != -2)
     {
         switch (ret)
         {
@@ -2024,20 +2223,24 @@ int main(int argc, char **argv)
                 exit (1);
             }
             break;
+        case 'a':
+            if (!strcmp(arg, "-"))
+                apdu_file=stderr;
+            else
+                apdu_file=fopen(arg, "a");
+            break;
        case 'v':
            log_init (log_mask_str(arg), "", NULL);
            break;
         default:
-            fprintf (stderr, "Usage: %s [-m <marclog>] [<server-addr>]\n",
+            fprintf (stderr, "Usage: %s [-m <marclog>] [ -m <apdulog>] "
+                             "[<server-addr>]\n",
                      prog);
             exit (1);
         }
     }
     if (!opened)
-    {
        initialize ();
-        printf (C_PROMPT);
-    }
     return client (opened);
 }