SRW/SRU 1.1
[yaz-moved-to-github.git] / client / client.c
index 237ea63..0b0e8fe 100644 (file)
@@ -2,7 +2,7 @@
  * Copyright (c) 1995-2003, Index Data
  * See the file LICENSE for details.
  *
- * $Id: client.c,v 1.209 2003-10-17 14:13:59 adam Exp $
+ * $Id: client.c,v 1.216 2003-12-20 00:51:19 adam Exp $
  */
 
 #include <stdio.h>
@@ -104,6 +104,8 @@ static char *refid = NULL;
 static char *last_open_command = NULL;
 static int auto_reconnect = 0;
 
+static char cur_host[200];
+
 typedef enum {
     QueryType_Prefix,
     QueryType_CCL,
@@ -115,7 +117,7 @@ typedef enum {
 static QueryType queryType = QueryType_Prefix;
 
 static CCL_bibset bibset;               /* CCL bibset handle */
-static cql_transform_t cqltrans;       /* CQL qualifier-set handle */
+static cql_transform_t cqltrans;       /* CQL context-set handle */
 
 #if HAVE_READLINE_COMPLETION_OVER
 
@@ -325,6 +327,11 @@ static void send_initRequest(const char* type_and_host)
         printf("Sent initrequest.\n");
 }
 
+
+/* These two are used only from process_initResponse() */
+static void render_initUserInfo(Z_OtherInformation *ui1);
+static void render_diag(Z_DiagnosticFormat *diag);
+
 static int process_initResponse(Z_InitResponse *res)
 {
     int ver = 0;
@@ -349,22 +356,24 @@ static int process_initResponse(Z_InitResponse *res)
     if (res->userInformationField)
     {
        Z_External *uif = res->userInformationField;
-        printf("UserInformationfield:\n");
-        if (!z_External(print, (Z_External**)&uif, 0, 0))
-        {
-            odr_perror(print, "Printing userinfo\n");
-            odr_reset(print);
-        }
-        if (uif->which == Z_External_octet)
-        {
-            printf("Guessing visiblestring:\n");
-            printf("'%s'\n", uif->u. octet_aligned->buf);
-        } else if (uif->which == Z_External_single) {
-           /* Peek at any private Init-diagnostic APDUs */
-           Odr_any *sat = uif->u.single_ASN1_type;
-           printf("### NAUGHTY: External is '%s'\n", sat->buf);
+       if (uif->which == Z_External_userInfo1) {
+           render_initUserInfo(uif->u.userInfo1);
+       } else {
+           printf("UserInformationfield:\n");
+           if (!z_External(print, (Z_External**)&uif, 0, 0)) {
+               odr_perror(print, "Printing userinfo\n");
+               odr_reset(print);
+           }
+           if (uif->which == Z_External_octet) {
+               printf("Guessing visiblestring:\n");
+               printf("'%s'\n", uif->u. octet_aligned->buf);
+           } else if (uif->which == Z_External_single) {
+               /* Peek at any private Init-diagnostic APDUs */
+               Odr_any *sat = uif->u.single_ASN1_type;
+               printf("### NAUGHTY: External is '%s'\n", sat->buf);
+           }
+           odr_reset (print);
        }
-        odr_reset (print);
     }
     printf ("Options:");
     if (ODR_MASK_GET(res->options, Z_Options_search))
@@ -439,6 +448,60 @@ static int process_initResponse(Z_InitResponse *res)
     return 0;
 }
 
+
+static void render_initUserInfo(Z_OtherInformation *ui1) {
+    int i;
+    printf("Init response contains %d otherInfo unit%s:\n",
+          ui1->num_elements, ui1->num_elements == 1 ? "" : "s");
+
+    for (i = 0; i < ui1->num_elements; i++) {
+       Z_OtherInformationUnit *unit = ui1->list[i];
+       printf("  %d: otherInfo unit contains ", i+1);
+       if (unit->which == Z_OtherInfo_externallyDefinedInfo &&
+           unit->information.externallyDefinedInfo->which ==
+           Z_External_diag1) {
+           render_diag(unit->information.externallyDefinedInfo->u.diag1);
+       } else {
+           printf("unsupported otherInfo unit type %d\n", unit->which);
+       }
+    }
+}
+
+
+/* ### should this share code with display_diagrecs()? */
+static void render_diag(Z_DiagnosticFormat *diag) {
+    int i;
+
+    printf("%d diagnostic%s:\n", diag->num, diag->num == 1 ? "" : "s");
+    for (i = 0; i < diag->num; i++) {
+       Z_DiagnosticFormat_s *ds = diag->elements[i];
+       printf("    %d: ", i+1);
+       switch (ds->which) {
+       case Z_DiagnosticFormat_s_defaultDiagRec: {
+           Z_DefaultDiagFormat *dd = ds->u.defaultDiagRec;
+           /* ### should check `dd->diagnosticSetId' */
+           printf("code=%d (%s)", *dd->condition,
+                  diagbib1_str(*dd->condition));
+           /* Both types of addinfo are the same, so use type-pun */
+           if (dd->u.v2Addinfo != 0)
+               printf(",\n\taddinfo='%s'", dd->u.v2Addinfo);
+           break;
+       }
+       case Z_DiagnosticFormat_s_explicitDiagnostic:
+           printf("Explicit diagnostic (not supported)");
+           break;
+       default:
+           printf("Unrecognised diagnostic type %d", ds->which);
+           break;
+       }
+
+       if (ds->message != 0)
+           printf(", message='%s'", ds->message);
+       printf("\n");
+    }
+}
+
+
 static int set_base(const char *arg)
 {
     int i;
@@ -568,7 +631,6 @@ int session_connect(const char *arg)
 
 int cmd_open(const char *arg)
 {
-    static char cur_host[200];
     if (arg)
     {
         strncpy (cur_host, arg, sizeof(cur_host)-1);
@@ -1065,11 +1127,11 @@ static int send_deleteResultSetRequest(const char *arg)
 static int send_srw(Z_SRW_PDU *sr)
 {
     const char *charset = negotiationCharset;
-    const char *host_port = 0;
+    const char *host_port = cur_host;
     char *path = 0;
     char ctype[50];
     Z_SOAP_Handler h[2] = {
-        {"http://www.loc.gov/zing/srw/v1.0/", 0, (Z_SOAP_fun) yaz_srw_codec},
+        {"http://www.loc.gov/zing/srw/", 0, (Z_SOAP_fun) yaz_srw_codec},
         {0, 0, 0}
     };
     ODR o = odr_createmem(ODR_ENCODE);
@@ -1103,7 +1165,7 @@ static int send_srw(Z_SRW_PDU *sr)
             memcpy (h, cp0, cp1 - cp0);
             h[cp1-cp0] = '\0';
             z_HTTP_header_add(out, &gdu->u.HTTP_Request->headers,
-                              "host", h);
+                              "Host", h);
         }
     }
 
@@ -1135,6 +1197,8 @@ static int send_srw(Z_SRW_PDU *sr)
         char *buf_out;
         int len_out;
         int r;
+       if (apdu_file && !z_GDU(print, &gdu, 0, 0))
+            printf ("Failed to print outgoing APDU\n");
         buf_out = odr_getbuf(out, &len_out, 0);
         
         /* we don't odr_reset(out), since we may need the buffer again */
@@ -2069,6 +2133,29 @@ static int cmd_itemorder(const char *arg)
     return 2;
 }
 
+static int cmd_explain(const char *arg)
+{
+    if (protocol != PROTO_HTTP)
+       return 0;
+#if HAVE_XML2
+    if (!conn)
+       cmd_open(0);
+    if (1)
+    {
+       Z_SRW_PDU *sr = 0;
+       
+       setno = 1;
+       
+       /* save this for later .. when fetching individual records */
+       sr = yaz_srw_get(out, Z_SRW_explain_request);
+       send_srw(sr);
+       return 2;
+    }
+#else
+    return 0;
+#endif
+}
+    
 static int cmd_find(const char *arg)
 {
     if (!*arg)
@@ -2510,7 +2597,9 @@ int send_sortrequest(const char *arg, int newset)
 
 void display_term(Z_TermInfo *t)
 {
-    if (t->term->which == Z_Term_general)
+    if (t->displayTerm)
+        printf("%s", t->displayTerm);
+    else if (t->term->which == Z_Term_general)
     {
         printf("%.*s", t->term->u.general->len, t->term->u.general->buf);
         sprintf(last_scan_line, "%.*s", t->term->u.general->len,
@@ -3182,6 +3271,28 @@ struct timeval tv_start, tv_end;
 #endif
 
 #if HAVE_XML2
+static void handle_srw_record(Z_SRW_record *rec)
+{
+    if (rec->recordPosition)
+    {
+       printf ("pos=%d", *rec->recordPosition);
+       setno = *rec->recordPosition + 1;
+    }
+    if (rec->recordSchema)
+       printf (" schema=%s", rec->recordSchema);
+    printf ("\n");
+    if (rec->recordData_buf && rec->recordData_len)
+    {
+       fwrite(rec->recordData_buf, 1, rec->recordData_len, stdout);
+       printf ("\n");
+    }
+}
+
+static void handle_srw_explain_response(Z_SRW_explainResponse *res)
+{
+    handle_srw_record(&res->record);
+}
+
 static void handle_srw_response(Z_SRW_searchRetrieveResponse *res)
 {
     int i;
@@ -3200,23 +3311,7 @@ static void handle_srw_response(Z_SRW_searchRetrieveResponse *res)
     if (res->numberOfRecords)
         printf ("Number of hits: %d\n", *res->numberOfRecords);
     for (i = 0; i<res->num_records; i++)
-    {
-        Z_SRW_record *rec = res->records + i;
-
-        if (rec->recordPosition)
-        {
-            printf ("pos=%d", *rec->recordPosition);
-            setno = *rec->recordPosition + 1;
-        }
-        if (rec->recordSchema)
-            printf (" schema=%s", rec->recordSchema);
-        printf ("\n");
-        if (rec->recordData_buf && rec->recordData_len)
-        {
-            fwrite(rec->recordData_buf, 1, rec->recordData_len, stdout);
-            printf ("\n");
-        }
-    }
+       handle_srw_record(res->records + i);
 }
 
 static void http_response(Z_HTTP_Response *hres)
@@ -3231,7 +3326,7 @@ static void http_response(Z_HTTP_Response *hres)
         Z_SOAP *soap_package = 0;
         ODR o = odr_createmem(ODR_DECODE);
         Z_SOAP_Handler soap_handlers[2] = {
-            {"http://www.loc.gov/zing/srw/v1.0/", 0,
+            {"http://www.loc.gov/zing/srw/", 0,
              (Z_SOAP_fun) yaz_srw_codec},
             {0, 0, 0}
         };
@@ -3244,10 +3339,12 @@ static void http_response(Z_HTTP_Response *hres)
             Z_SRW_PDU *sr = soap_package->u.generic->p;
             if (sr->which == Z_SRW_searchRetrieve_response)
                 handle_srw_response(sr->u.response);
+            else if (sr->which == Z_SRW_explain_response)
+                handle_srw_explain_response(sr->u.explain_response);
             else
                 ret = -1;
         }
-        else if (!ret && (soap_package->which == Z_SOAP_fault
+        else if (soap_package && (soap_package->which == Z_SOAP_fault
                           || soap_package->which == Z_SOAP_error))
         {
             printf ("HTTP Error Status=%d\n", hres->code);
@@ -3255,6 +3352,9 @@ static void http_response(Z_HTTP_Response *hres)
                     soap_package->u.fault->fault_code);
             printf ("SOAP Fault string %s\n", 
                     soap_package->u.fault->fault_string);
+           if (soap_package->u.fault->details)
+               printf ("SOAP Details %s\n", 
+                       soap_package->u.fault->details);
         }
         else
             ret = -1;
@@ -3272,17 +3372,20 @@ static void http_response(Z_HTTP_Response *hres)
         }
         close_session();
     }
-    if (!strcmp(hres->version, "1.0"))
-    {
-        /* HTTP 1.0: only if Keep-Alive we stay alive.. */
-        if (!connection_head || strcmp(connection_head, "Keep-Alive"))
-            close_session();
-    }
-    else 
+    else
     {
-        /* HTTP 1.1: only if no close we stay alive .. */
-        if (connection_head && !strcmp(connection_head, "close"))
-            close_session();
+       if (!strcmp(hres->version, "1.0"))
+       {
+           /* HTTP 1.0: only if Keep-Alive we stay alive.. */
+           if (!connection_head || strcmp(connection_head, "Keep-Alive"))
+               close_session();
+       }
+       else 
+       {
+           /* HTTP 1.1: only if no close we stay alive .. */
+           if (connection_head && !strcmp(connection_head, "close"))
+               close_session();
+       }
     }
 }
 #endif
@@ -3486,7 +3589,6 @@ int cmd_set_otherinfo(const char* args)
         printf("Error otherinfo index to large (%d>%d)\n",otherinfoNo,maxOtherInfosSupported);
     }
     
-    
     oidval = oid_getvalbyname (oid);
     if(oidval == -1 ) {
         printf("Error in set_otherinfo command unknown oid %s \n",oid);
@@ -3700,6 +3802,7 @@ static struct {
     {"adm-commit", cmd_adm_commit, "",NULL,0,NULL},
     {"adm-shutdown", cmd_adm_shutdown, "",NULL,0,NULL},
     {"adm-startup", cmd_adm_startup, "",NULL,0,NULL},
+    {"explain", cmd_explain, "", NULL, 0, NULL},
     {"help", cmd_help, "", NULL,0,NULL},
     {0,0,0,0,0,0}
 };