Note incorrect ID-private OID for VAL_ADMINSERVICE
[yaz-moved-to-github.git] / client / client.c
index 2d24363..a57f354 100644 (file)
@@ -2,7 +2,7 @@
  * Copyright (c) 1995-2003, Index Data
  * See the file LICENSE for details.
  *
- * $Id: client.c,v 1.195 2003-05-20 20:33:29 adam Exp $
+ * $Id: client.c,v 1.205 2003-07-23 12:57:22 mike Exp $
  */
 
 #include <stdio.h>
@@ -41,6 +41,7 @@
 #include <yaz/ill.h>
 #include <yaz/srw.h>
 #include <yaz/yaz-ccl.h>
+#include <yaz/cql.h>
 
 #if HAVE_READLINE_READLINE_H
 #include <readline/readline.h>
 #define C_PROMPT "Z> "
 
 static char *codeset = 0;               /* character set for output */
-
+static int hex_dump = 0;
 static ODR out, in, print;              /* encoding and decoding streams */
+#if HAVE_XML2
 static ODR srw_sr_odr_out = 0;
 static Z_SRW_PDU *srw_sr = 0;
+#endif
 static FILE *apdu_file = 0;
 static FILE *ber_file = 0;
 static COMSTACK conn = 0;               /* our z-association */
@@ -84,6 +87,8 @@ static Z_InitResponse *session = 0;     /* session parameters */
 static char last_scan_line[512] = "0";
 static char last_scan_query[512] = "0";
 static char ccl_fields[512] = "default.bib";
+/* ### How can I set this path to use wherever YAZ is installed? */
+static char cql_fields[512] = "/usr/local/share/yaz/etc/pqf.properties";
 static char *esPackageName = 0;
 static char *yazProxy = 0;
 static int kilobytes = 1024;
@@ -102,12 +107,14 @@ typedef enum {
     QueryType_Prefix,
     QueryType_CCL,
     QueryType_CCL2RPN,
-    QueryType_CQL
+    QueryType_CQL,
+    QueryType_CQL2RPN
 } QueryType;
 
 static QueryType queryType = QueryType_Prefix;
 
 static CCL_bibset bibset;               /* CCL bibset handle */
+static cql_transform_t cqltrans;       /* CQL qualifier-set handle */
 
 #if HAVE_READLINE_COMPLETION_OVER
 
@@ -146,26 +153,27 @@ const char* query_type_as_string(QueryType q)
     case QueryType_CCL: return "CCL (CCL sent to server) ";
     case QueryType_CCL2RPN: return "CCL -> RPN (RPN sent to server)";
     case QueryType_CQL: return "CQL (CQL sent to server)";
+    case QueryType_CQL2RPN: return "CQL -> RPN (RPN sent to server)";
     default: 
         return "unknown Query type internal yaz-client error";
     }
 }
 
-
-void do_hex_dump(char* buf,int len) 
+static void do_hex_dump(const char* buf, int len) 
 {
-#if 0 
-    int i,x;
-    for( i=0; i<len ; i=i+16 ) 
-    {                  
-        printf(" %4.4d ",i);
-        for(x=0 ; i+x<len && x<16; ++x) 
-        {
-            printf("%2.2X ",(unsigned int)((unsigned char)buf[i+x]));
-        }
-        printf("\n");
+    if (hex_dump)
+    {
+       int i,x;
+       for( i=0; i<len ; i=i+16 ) 
+       {                       
+           printf(" %4.4d ",i);
+           for(x=0 ; i+x<len && x<16; ++x) 
+           {
+               printf("%2.2X ",(unsigned int)((unsigned char)buf[i+x]));
+           }
+           printf("\n");
+       }
     }
-#endif
 }
 
 void add_otherInfos(Z_APDU *a) 
@@ -324,18 +332,22 @@ static int process_initResponse(Z_InitResponse *res)
         printf("Version: %s\n", res->implementationVersion);
     if (res->userInformationField)
     {
+       Z_External *uif = res->userInformationField;
         printf("UserInformationfield:\n");
-        if (!z_External(print, (Z_External**)&res-> userInformationField,
-            0, 0))
+        if (!z_External(print, (Z_External**)&uif, 0, 0))
         {
             odr_perror(print, "Printing userinfo\n");
             odr_reset(print);
         }
-        if (res->userInformationField->which == Z_External_octet)
+        if (uif->which == Z_External_octet)
         {
             printf("Guessing visiblestring:\n");
-            printf("'%s'\n", res->userInformationField->u. octet_aligned->buf);
-        }
+            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);
     }
     printf ("Options:");
@@ -572,14 +584,20 @@ int cmd_authentication(const char *arg)
     r = sscanf (arg, "%39s %39s %39s", user, group, pass);
     if (r == 0)
     {
-        printf("Auth field set to null\n");
+        printf("Authentication set to null\n");
         auth = 0;
     }
     if (r == 1)
     {
         auth = &au;
-        au.which = Z_IdAuthentication_open;
-        au.u.open = user;
+       if (!strcmp(user, "-")) {
+           au.which = Z_IdAuthentication_anonymous;
+           printf("Authentication set to Anonymous\n");
+       } else {
+           au.which = Z_IdAuthentication_open;
+           au.u.open = user;
+           printf("Authentication set to Open (%s)\n", user);
+       }
     }
     if (r == 2)
     {
@@ -589,6 +607,7 @@ int cmd_authentication(const char *arg)
         idPass.groupId = NULL;
         idPass.userId = user;
         idPass.password = group;
+       printf("Authentication set to User (%s), Pass (%s)\n", user, group);
     }
     if (r == 3)
     {
@@ -598,6 +617,8 @@ int cmd_authentication(const char *arg)
         idPass.groupId = group;
         idPass.userId = user;
         idPass.password = pass;
+       printf("Authentication set to User (%s), Group (%s), Pass (%s)\n",
+              user, group, pass);
     }
     return 1;
 }
@@ -708,31 +729,35 @@ static void display_record(Z_External *r)
                                         &result, &rlen)> 0)
                 {
                     char *from = 0;
-                    if (marcCharset && strcmp(marcCharset, "auto"))
-                        from = marcCharset;
-                    else
+                    if (marcCharset && !strcmp(marcCharset, "auto"))
                     {
                         if (ent->value == VAL_USMARC)
                         {
                             if (octet_buf[9] == 'a')
                                 from = "UTF-8";
                             else
-                                from = "MARC8";
+                                from = "MARC-8";
                         }
                         else
                             from = "ISO-8859-1";
                     }
+                   else if (marcCharset)
+                       from = marcCharset;
                     if (outputCharset && from)
                     {   
-                        printf ("convert from %s to %s\n", from, 
-                                outputCharset);
                         cd = yaz_iconv_open(outputCharset, from);
+                        printf ("convert from %s to %s", from, 
+                                outputCharset);
+                       if (!cd)
+                           printf (" unsupported\n");
+                       else
+                           printf ("\n");
                     }
                     if (!cd)
                         fwrite (result, 1, rlen, stdout);
                     else
                     {
-                        char outbuf[12];
+                        char outbuf[6];
                         size_t inbytesleft = rlen;
                         const char *inp = result;
                         
@@ -740,9 +765,11 @@ static void display_record(Z_External *r)
                         {
                             size_t outbytesleft = sizeof(outbuf);
                             char *outp = outbuf;
-                            size_t r = yaz_iconv (cd, (char**) &inp,
-                                                  &inbytesleft, 
-                                                  &outp, &outbytesleft);
+                           size_t r;
+
+                            r = yaz_iconv (cd, (char**) &inp,
+                                          &inbytesleft, 
+                                          &outp, &outbytesleft);
                             if (r == (size_t) (-1))
                             {
                                 int e = yaz_iconv_error(cd);
@@ -794,6 +821,107 @@ static void display_record(Z_External *r)
         puts (wrbuf_buf(w));
         wrbuf_free(w, 1);
     }
+    else if ( /* OPAC display not complete yet .. */
+            ent && ent->value == VAL_OPAC)
+    {
+       int i;
+       if (r->u.opac->bibliographicRecord)
+           display_record(r->u.opac->bibliographicRecord);
+       for (i = 0; i<r->u.opac->num_holdingsData; i++)
+       {
+           Z_HoldingsRecord *h = r->u.opac->holdingsData[i];
+           if (h->which == Z_HoldingsRecord_marcHoldingsRecord)
+           {
+               printf ("MARC holdings %d\n", i);
+               display_record(h->u.marcHoldingsRecord);
+           }
+           else if (h->which == Z_HoldingsRecord_holdingsAndCirc)
+           {
+               int j;
+
+               Z_HoldingsAndCircData *data = h->u.holdingsAndCirc;
+
+               printf ("Data holdings %d\n", i);
+               if (data->typeOfRecord)
+                   printf ("typeOfRecord: %s\n", data->typeOfRecord);
+               if (data->encodingLevel)
+                   printf ("encodingLevel: %s\n", data->encodingLevel);
+               if (data->receiptAcqStatus)
+                   printf ("receiptAcqStatus: %s\n", data->receiptAcqStatus);
+               if (data->generalRetention)
+                   printf ("generalRetention: %s\n", data->generalRetention);
+               if (data->completeness)
+                   printf ("completeness: %s\n", data->completeness);
+               if (data->dateOfReport)
+                   printf ("dateOfReport: %s\n", data->dateOfReport);
+               if (data->nucCode)
+                   printf ("nucCode: %s\n", data->nucCode);
+               if (data->localLocation)
+                   printf ("localLocation: %s\n", data->localLocation);
+               if (data->shelvingLocation)
+                   printf ("shelvingLocation: %s\n", data->shelvingLocation);
+               if (data->callNumber)
+                   printf ("callNumber: %s\n", data->callNumber);
+               if (data->copyNumber)
+                   printf ("copyNumber: %s\n", data->copyNumber);
+               if (data->publicNote)
+                   printf ("publicNote: %s\n", data->publicNote);
+               if (data->reproductionNote)
+                   printf ("reproductionNote: %s\n", data->reproductionNote);
+               if (data->termsUseRepro)
+                   printf ("termsUseRepro: %s\n", data->termsUseRepro);
+               if (data->enumAndChron)
+                   printf ("enumAndChron: %s\n", data->enumAndChron);
+               for (j = 0; j<data->num_volumes; j++)
+               {
+                   printf ("volume %d\n", j);
+                   if (data->volumes[j]->enumeration)
+                       printf (" enumeration: %s\n",
+                               data->volumes[j]->enumeration);
+                   if (data->volumes[j]->chronology)
+                       printf (" chronology: %s\n",
+                               data->volumes[j]->chronology);
+                   if (data->volumes[j]->enumAndChron)
+                       printf (" enumAndChron: %s\n",
+                               data->volumes[j]->enumAndChron);
+               }
+               for (j = 0; j<data->num_circulationData; j++)
+               {
+                   printf ("circulation %d\n", j);
+                   if (data->circulationData[j]->availableNow)
+                       printf (" availableNow: %d\n",
+                               *data->circulationData[j]->availableNow);
+                   if (data->circulationData[j]->availablityDate)
+                       printf (" availabiltyDate: %s\n",
+                               data->circulationData[j]->availablityDate);
+                   if (data->circulationData[j]->availableThru)
+                       printf (" availableThru: %s\n",
+                               data->circulationData[j]->availableThru);
+                   if (data->circulationData[j]->restrictions)
+                       printf (" restrictions: %s\n",
+                               data->circulationData[j]->restrictions);
+                   if (data->circulationData[j]->itemId)
+                       printf (" itemId: %s\n",
+                               data->circulationData[j]->itemId);
+                   if (data->circulationData[j]->renewable)
+                       printf (" renewable: %d\n",
+                               *data->circulationData[j]->renewable);
+                   if (data->circulationData[j]->onHold)
+                       printf (" onHold: %d\n",
+                               *data->circulationData[j]->onHold);
+                   if (data->circulationData[j]->enumAndChron)
+                       printf (" enumAndChron: %s\n",
+                               data->circulationData[j]->enumAndChron);
+                   if (data->circulationData[j]->midspine)
+                       printf (" midspine: %s\n",
+                               data->circulationData[j]->midspine);
+                   if (data->circulationData[j]->temporaryLocation)
+                       printf (" temporaryLocation: %s\n",
+                               data->circulationData[j]->temporaryLocation);
+               }
+           }
+       }
+    }
     else 
     {
         printf("Unknown record representation.\n");
@@ -1038,8 +1166,10 @@ static int send_searchRequest(const char *arg)
     Odr_oct ccl_query;
     YAZ_PQF_Parser pqf_parser;
     Z_External *ext;
+    QueryType myQueryType = queryType;
+    char pqfbuf[512];
 
-    if (queryType == QueryType_CCL2RPN)
+    if (myQueryType == QueryType_CCL2RPN)
     {
         rpn = ccl_find_str(bibset, arg, &error, &pos);
         if (error)
@@ -1047,7 +1177,32 @@ static int send_searchRequest(const char *arg)
             printf("CCL ERROR: %s\n", ccl_err_msg(error));
             return 0;
         }
+    } else if (myQueryType == QueryType_CQL2RPN) {
+       /* ### All this code should be wrapped in a utility function */
+       CQL_parser parser;
+       struct cql_node *node;
+       const char *addinfo;
+       if (cqltrans == 0) {
+            printf("Can't use CQL: no translation file.  Try set_cqlfile\n");
+           return 0;
+       }
+       parser = cql_parser_create();
+       if ((error = cql_parser_string(parser, arg)) != 0) {
+            printf("Can't parse CQL: must be a syntax error\n");
+            return 0;
+       }
+       node = cql_parser_result(parser);
+       if ((error = cql_transform_buf(cqltrans, node, pqfbuf,
+                                      sizeof pqfbuf)) != 0) {
+           error = cql_transform_error(cqltrans, &addinfo);
+           printf ("Can't convert CQL to PQF: %s (addinfo=%s)\n",
+                   cql_strerror(error), addinfo);
+            return 0;
+        }
+       arg = pqfbuf;
+       myQueryType = QueryType_Prefix;
     }
+
     req->referenceId = set_refid (out);
     if (!strcmp(arg, "@big")) /* strictly for troublemaking */
     {
@@ -1087,7 +1242,7 @@ static int send_searchRequest(const char *arg)
 
     req->query = &query;
 
-    switch (queryType)
+    switch (myQueryType)
     {
     case QueryType_Prefix:
         query.which = Z_Query_type_1;
@@ -2487,6 +2642,8 @@ int cmd_querytype (const char *arg)
         queryType = QueryType_CCL2RPN;
     else if (!strcmp(arg, "cql"))
         queryType = QueryType_CQL;        
+    else if (!strcmp (arg, "cql2rpn") || !strcmp (arg, "cqlrpn"))
+        queryType = QueryType_CQL2RPN;
     else
     {
         printf ("Querytype must be one of:\n");
@@ -2494,6 +2651,7 @@ int cmd_querytype (const char *arg)
         printf (" ccl            - CCL query\n");
         printf (" ccl2rpn        - CCL query converted to RPN\n");
         printf (" cql            - CQL\n");
+        printf (" cql2rpn        - CQL query converted to RPN\n");
         return 0;
     }
     return 1;
@@ -2731,6 +2889,22 @@ int cmd_set_cclfile(const char* arg)
     return 0;
 }
 
+int cmd_set_cqlfile(const char* arg)
+{
+    cql_transform_t newcqltrans;
+
+    if ((newcqltrans = cql_transform_open_fname(arg)) == 0) {
+        perror("unable to open CQL file");
+       return 0;
+    }
+    if (cqltrans != 0)
+       cql_transform_close(cqltrans);
+
+    cqltrans = newcqltrans;
+    strcpy(cql_fields, arg);
+    return 0;
+}
+
 int cmd_set_auto_reconnect(const char* arg)
 {  
     if(strlen(arg)==0) {
@@ -2771,17 +2945,6 @@ int cmd_set_marcdump(const char* arg)
     return 1;
 }
 
-int cmd_set_proxy(const char* arg)
-{
-    if(yazProxy) free(yazProxy);
-    yazProxy=NULL;
-    
-    if(strlen(arg) > 1) {
-        yazProxy=strdup(arg);
-    }
-    return 1;
-}
-
 /* 
    this command takes 3 arge {name class oid} 
 */
@@ -2917,6 +3080,10 @@ static void initialize(void)
         ccl_qual_file (bibset, inf);
         fclose (inf);
     }
+
+    cqltrans = cql_transform_open_fname(cql_fields);
+    /* If this fails, no problem: we detect cqltrans == 0 later */
+
 #if HAVE_READLINE_READLINE_H
     rl_attempted_completion_function = (CPPFunction*)readline_completer;
 #endif
@@ -3079,6 +3246,7 @@ void wait_and_handle_response()
         odr_reset(out);
         odr_reset(in); /* release APDU from last round */
         record_last = 0;
+        do_hex_dump(netbuffer, res);
         odr_setbuf(in, netbuffer, res, 0);
         
         if (!z_GDU(in, &gdu, 0, 0))
@@ -3091,8 +3259,9 @@ void wait_and_handle_response()
             fprintf(f, "---------\n");
             if (apdu_file)
                 z_GDU(print, &gdu, 0, 0);
-            close_session ();
-            break;
+            if (conn && cs_more(conn))
+                continue;
+           break;
         }
         if (ber_file)
             odr_dumpBER(ber_file, netbuffer, res);
@@ -3328,6 +3497,7 @@ int cmd_list_all(const char* args) {
     
     /* Query options */
     printf("CCL file             : %s\n",ccl_fields);
+    printf("CQL file             : %s\n",cql_fields);
     printf("Query type           : %s\n",query_type_as_string(queryType));
     
     printf("Named Result Sets    : %s\n",setnumber==-1?"off":"on");
@@ -3427,6 +3597,7 @@ static struct {
     {"set_berfile", cmd_set_berfile, "<filename>",NULL,1,NULL},
     {"set_marcdump", cmd_set_marcdump," <filename>",NULL,1,NULL},
     {"set_cclfile", cmd_set_cclfile," <filename>",NULL,1,NULL},
+    {"set_cqlfile", cmd_set_cqlfile," <filename>",NULL,1,NULL},
     {"set_auto_reconnect", cmd_set_auto_reconnect," on|off",complete_auto_reconnect,1,NULL},
        {"set_otherinfo", cmd_set_otherinfo,"<otherinfoinddex> <oid> <string>",NULL,0,NULL},
     {"register_oid", cmd_register_oid,"<name> <class> <oid>",NULL,0,NULL},
@@ -3742,8 +3913,10 @@ int main(int argc, char **argv)
     codeset = nl_langinfo(CODESET);
 #endif
 #endif
+    if (codeset)
+       outputCharset = xstrdup(codeset);
 
-    while ((ret = options("k:c:a:b:m:v:p:u:t:V", argv, argc, &arg)) != -2)
+    while ((ret = options("k:c:q:a:b:m:v:p:u:t:Vx", argv, argc, &arg)) != -2)
     {
         switch (ret)
         {
@@ -3772,6 +3945,10 @@ int main(int argc, char **argv)
             strncpy (ccl_fields, arg, sizeof(ccl_fields)-1);
             ccl_fields[sizeof(ccl_fields)-1] = '\0';
             break;
+        case 'q':
+            strncpy (cql_fields, arg, sizeof(cql_fields)-1);
+            cql_fields[sizeof(cql_fields)-1] = '\0';
+            break;
         case 'b':
             if (!strcmp(arg, "-"))
                 ber_file=stderr;
@@ -3784,6 +3961,9 @@ int main(int argc, char **argv)
             else
                 apdu_file=fopen(arg, "a");
             break;
+       case 'x':
+           hex_dump = 1;
+           break;
         case 'p':
             yazProxy=strdup(arg);
             break;
@@ -3803,7 +3983,8 @@ int main(int argc, char **argv)
             break;
         default:
             fprintf (stderr, "Usage: %s [-m <marclog>] [ -a <apdulog>] "
-                     "[-b berdump] [-c cclfields]\n      [-p <proxy-addr>] [-u <auth>] "
+                     "[-b berdump] [-c cclfields] \n"
+                    "[-q cqlfields] [-p <proxy-addr>] [-u <auth>] "
                      "[-k size] [-V] [<server-addr>]\n",
                      prog);
             exit (1);