Moved header files to include/yaz++. Switched to libtool and automake.
[yazpp-moved-to-github.git] / src / yaz-client.cpp
index 8a88bc3..de00fd1 100644 (file)
@@ -1,10 +1,44 @@
 /*
- * Copyright (c) 1998-1999, Index Data.
+ * Copyright (c) 1998-2000, Index Data.
  * See the file LICENSE for details.
- * Sebastian Hammer, Adam Dickmeiss
  * 
  * $Log: yaz-client.cpp,v $
- * Revision 1.5  1999-04-09 11:46:57  adam
+ * Revision 1.15  2000-10-11 11:58:16  adam
+ * Moved header files to include/yaz++. Switched to libtool and automake.
+ * Configure script creates yaz++-config script.
+ *
+ * Revision 1.14  2000/09/08 10:23:42  adam
+ * Added skeleton of yaz-z-server.
+ *
+ * Revision 1.13  2000/09/06 14:23:45  adam
+ * WIN32 updates.
+ *
+ * Revision 1.12  2000/09/04 08:59:16  adam
+ * Changed call to logging functions (yaz_ added).
+ *
+ * Revision 1.11  2000/07/04 13:48:49  adam
+ * Implemented upper-limit on proxy-to-target sessions.
+ *
+ * Revision 1.10  2000/05/30 03:12:27  ian
+ * minor change to stop g++ 2.95.2 complaining about taking the address
+ * of a member function.
+ *
+ * Revision 1.9  1999/12/06 13:52:45  adam
+ * Modified for new location of YAZ header files. Experimental threaded
+ * operation.
+ *
+ * Revision 1.8  1999/11/10 10:02:34  adam
+ * Work on proxy.
+ *
+ * Revision 1.7  1999/04/21 12:09:01  adam
+ * Many improvements. Modified to proxy server to work with "sessions"
+ * based on cookies.
+ *
+ * Revision 1.6  1999/04/20 10:30:05  adam
+ * Implemented various stuff for client and proxy. Updated calls
+ * to ODR to reflect new name parameter.
+ *
+ * Revision 1.5  1999/04/09 11:46:57  adam
  * Added object Yaz_Z_Assoc. Much more functional client.
  *
  * Revision 1.4  1999/03/23 14:17:57  adam
  *
  */
 
-#include <log.h>
-#include <options.h>
-#include <yaz-ir-assoc.h>
-#include <yaz-pdu-assoc.h>
-#include <yaz-socket-manager.h>
+#include <yaz/log.h>
+#include <yaz/options.h>
+#include <yaz/diagbib1.h>
+#include <yaz++/yaz-ir-assoc.h>
+#include <yaz++/yaz-pdu-assoc.h>
+#include <yaz++/yaz-socket-manager.h>
 
 extern "C" {
 #if HAVE_READLINE_READLINE_H
@@ -42,6 +77,7 @@ private:
     int m_interactive_flag;
     char m_thisCommand[1024];
     char m_lastCommand[1024];
+    int m_setOffset;
     Yaz_SocketManager *m_socketManager;
 public:
     MyClient(IYaz_PDU_Observable *the_PDU_Observable,
@@ -52,16 +88,55 @@ public:
     int wait();
     void recv_initResponse(Z_InitResponse *initResponse);
     void recv_searchResponse(Z_SearchResponse *searchResponse);
+    void recv_presentResponse(Z_PresentResponse *presentResponse);
+    void recv_records (Z_Records *records);
+    void recv_diagrecs(Z_DiagRec **pp, int num);
+    void recv_namePlusRecord (Z_NamePlusRecord *zpr, int offset);
+    void recv_record(Z_DatabaseRecord *record, int offset,
+                    const char *databaseName);
+    void recv_textRecord(int type, const char *buf, size_t len);
+    void recv_genericRecord(Z_GenericRecord *r);
+    void display_genericRecord(Z_GenericRecord *r, int level);
+    void display_variant(Z_Variant *v, int level);
+    void connectNotify();
+    void failNotify();
+    void timeoutNotify();
+    char *get_cookie (Z_OtherInformation **oi);
     int processCommand(const char *cmd);
     const char *MyClient::getCommand();
     int cmd_open(char *host);
+    int cmd_connect(char *host);
     int cmd_quit(char *args);
     int cmd_close(char *args);
     int cmd_find(char *args);
+    int cmd_show(char *args);
+    int cmd_cookie(char *args);
+    int cmd_init(char *args);
+    int cmd_format(char *args);
+    int cmd_proxy(char *args);
 };
 
-IYaz_PDU_Observer *MyClient::clone(IYaz_PDU_Observable *the_PDU_Observable)
+
+void MyClient::connectNotify()
+{
+    printf ("Connection accepted by target\n");
+    set_lastReceived(-1);
+}
+
+void MyClient::timeoutNotify()
 {
+    printf ("Connection timeout\n");
+    close();
+}
+
+void MyClient::failNotify()
+{
+    printf ("Connection closed by target\n");
+    set_lastReceived(-1);
+}
+
+IYaz_PDU_Observer *MyClient::clone(IYaz_PDU_Observable *the_PDU_Observable)
+{ 
     return new MyClient(the_PDU_Observable, m_socketManager);
 }
 
@@ -69,6 +144,7 @@ MyClient::MyClient(IYaz_PDU_Observable *the_PDU_Observable,
                   Yaz_SocketManager *the_socketManager) :
     Yaz_IR_Assoc (the_PDU_Observable)
 {
+    m_setOffset = 1;
     m_interactive_flag = 1;
     m_thisCommand[0] = '\0';
     m_lastCommand[0] = '\0';
@@ -77,19 +153,287 @@ MyClient::MyClient(IYaz_PDU_Observable *the_PDU_Observable,
 
 void usage(char *prog)
 {
-    fprintf (stderr, "%s: [-v log] [-p proxy] [zurl]\n", prog);
+    fprintf (stderr, "%s: [-v log] [-c cookie] [-p proxy] [zurl]\n", prog);
     exit (1);
 }
 
+char *MyClient::get_cookie(Z_OtherInformation **otherInfo)
+{
+    int oid[OID_SIZE];
+    Z_OtherInformationUnit *oi;
+    struct oident ent;
+    ent.proto = PROTO_Z3950;
+    ent.oclass = CLASS_USERINFO;
+    ent.value = (oid_value) VAL_COOKIE;
+
+    if (oid_ent_to_oid (&ent, oid) && 
+       (oi = update_otherInformation(otherInfo, 0, oid, 1, 1)) &&
+       oi->which == Z_OtherInfo_characterInfo)
+       return oi->information.characterInfo;
+    return 0;
+}
+
 void MyClient::recv_initResponse(Z_InitResponse *initResponse)
 {
     printf ("Got InitResponse. Status ");
     if (*initResponse->result)
+    {
        printf ("Ok\n");
+
+       const char *p = get_cookie (&initResponse->otherInfo);
+       if (p)
+       {
+           printf ("cookie = %s\n", p);
+           set_cookie(p);
+       }
+    }
     else
        printf ("Fail\n");
 }
 
+void MyClient::recv_diagrecs(Z_DiagRec **pp, int num)
+{
+    int i;
+    oident *ent;
+    Z_DefaultDiagFormat *r;
+
+    printf("Diagnostic message(s) from database:\n");
+    for (i = 0; i<num; i++)
+    {
+       Z_DiagRec *p = pp[i];
+       if (p->which != Z_DiagRec_defaultFormat)
+       {
+           printf("Diagnostic record not in default format.\n");
+           return;
+       }
+       else
+           r = p->u.defaultFormat;
+       if (!(ent = oid_getentbyoid(r->diagnosticSetId)) ||
+           ent->oclass != CLASS_DIAGSET || ent->value != VAL_BIB1)
+           printf("Missing or unknown diagset\n");
+       printf("    [%d] %s", *r->condition, diagbib1_str(*r->condition));
+#ifdef ASN_COMPILED
+       switch (r->which)
+       {
+       case Z_DefaultDiagFormat_v2Addinfo:
+           printf (" -- v2 addinfo '%s'\n", r->u.v2Addinfo);
+           break;
+       case Z_DefaultDiagFormat_v3Addinfo:
+           printf (" -- v3 addinfo '%s'\n", r->u.v3Addinfo);
+           break;
+       }
+#else
+       if (r->addinfo && *r->addinfo)
+           printf(" -- '%s'\n", r->addinfo);
+       else
+           printf("\n");
+#endif
+    }
+}
+
+void MyClient::recv_textRecord(int type, const char *buf, size_t len)
+{
+    fwrite (buf, 1, len, stdout);
+    fputc ('\n', stdout);
+}
+
+void MyClient::display_variant(Z_Variant *v, int level)
+{
+    int i;
+
+    for (i = 0; i < v->num_triples; i++)
+    {
+       printf("%*sclass=%d,type=%d", level * 4, "", *v->triples[i]->zclass,
+           *v->triples[i]->type);
+       if (v->triples[i]->which == Z_Triple_internationalString)
+           printf(",value=%s\n", v->triples[i]->value.internationalString);
+       else
+           printf("\n");
+    }
+}
+
+void MyClient::display_genericRecord(Z_GenericRecord *r, int level)
+{
+    int i;
+
+    if (!r)
+        return;
+    for (i = 0; i < r->num_elements; i++)
+    {
+        Z_TaggedElement *t;
+
+        printf("%*s", level * 4, "");
+        t = r->elements[i];
+        printf("(");
+        if (t->tagType)
+            printf("%d,", *t->tagType);
+        else
+            printf("?,");
+        if (t->tagValue->which == Z_StringOrNumeric_numeric)
+            printf("%d) ", *t->tagValue->u.numeric);
+        else
+            printf("%s) ", t->tagValue->u.string);
+        if (t->content->which == Z_ElementData_subtree)
+        {
+            printf("\n");
+            display_genericRecord(t->content->u.subtree, level+1);
+        }
+        else if (t->content->which == Z_ElementData_string)
+            printf("%s\n", t->content->u.string);
+        else if (t->content->which == Z_ElementData_numeric)
+           printf("%d\n", *t->content->u.numeric);
+       else if (t->content->which == Z_ElementData_oid)
+       {
+           int *ip = t->content->u.oid;
+           oident *oent;
+
+           if ((oent = oid_getentbyoid(t->content->u.oid)))
+               printf("OID: %s\n", oent->desc);
+           else
+           {
+               printf("{");
+               while (ip && *ip >= 0)
+                   printf(" %d", *(ip++));
+               printf(" }\n");
+           }
+       }
+       else if (t->content->which == Z_ElementData_noDataRequested)
+           printf("[No data requested]\n");
+       else if (t->content->which == Z_ElementData_elementEmpty)
+           printf("[Element empty]\n");
+       else if (t->content->which == Z_ElementData_elementNotThere)
+           printf("[Element not there]\n");
+       else
+            printf("??????\n");
+       if (t->appliedVariant)
+           display_variant(t->appliedVariant, level+1);
+       if (t->metaData && t->metaData->supportedVariants)
+       {
+           int c;
+
+           printf("%*s---- variant list\n", (level+1)*4, "");
+           for (c = 0; c < t->metaData->num_supportedVariants; c++)
+           {
+               printf("%*svariant #%d\n", (level+1)*4, "", c);
+               display_variant(t->metaData->supportedVariants[c], level + 2);
+           }
+       }
+    }
+}
+
+void MyClient::recv_genericRecord(Z_GenericRecord *r)
+{
+    display_genericRecord(r, 0);
+}
+
+void MyClient::recv_record(Z_DatabaseRecord *record, int offset,
+                          const char *databaseName)
+{
+    Z_External *r = (Z_External*) record;
+    oident *ent = oid_getentbyoid(r->direct_reference);
+
+    /*
+     * Tell the user what we got.
+     */
+    if (r->direct_reference)
+    {
+        printf("Record type: ");
+        if (ent)
+            printf("%s\n", ent->desc);
+    }
+    /* Check if this is a known, ASN.1 type tucked away in an octet string */
+    Z_ext_typeent *etype = z_ext_getentbyref(ent->value);
+    if (ent && (r->which == Z_External_octet || r->which == Z_External_single)
+       && (etype = z_ext_getentbyref(ent->value)))
+
+    {
+       void *rr;
+       /*
+        * Call the given decoder to process the record.
+        */
+       odr_setbuf(odr_decode(), (char*)record->u.octet_aligned->buf,
+                  record->u.octet_aligned->len, 0);
+       if (!(*etype->fun)(odr_decode(), (char **)&rr, 0, 0))
+       {
+           odr_perror(odr_decode(), "Decoding constructed record.");
+           fprintf(stderr, "[Near %d]\n", odr_offset(odr_decode()));
+           fprintf(stderr, "Packet dump:\n---------\n");
+           odr_dumpBER(stderr, (char*)record->u.octet_aligned->buf,
+                       record->u.octet_aligned->len);
+           fprintf(stderr, "---------\n");
+       }
+       if (etype->what == Z_External_sutrs)
+       {
+           Z_SUTRS *sutrs = (Z_SUTRS *) rr;
+           recv_textRecord ((int) VAL_SUTRS, (const char *) sutrs->buf,
+                            (size_t) sutrs->len);
+       }
+       return;
+    }
+    if (r->which == Z_External_octet && record->u.octet_aligned->len)
+    {
+       recv_textRecord((int) ent->value,
+                       (const char *) record->u.octet_aligned->buf,
+                       (size_t) record->u.octet_aligned->len);
+    }
+    else if (ent && ent->value == VAL_SUTRS && r->which == Z_External_sutrs)
+       recv_textRecord((int) VAL_SUTRS, (const char *) r->u.sutrs->buf,
+                       (size_t) r->u.sutrs->len);
+    else if (ent && ent->value == VAL_GRS1 && r->which == Z_External_grs1)
+        recv_genericRecord(r->u.grs1);
+    else 
+    {
+        printf("Unknown record representation.\n");
+        if (!z_External(odr_print(), &r, 0, 0))
+        {
+            odr_perror(odr_print(), "Printing external");
+            odr_reset(odr_print());
+        }
+    }    
+}
+
+void MyClient::recv_namePlusRecord (Z_NamePlusRecord *zpr, int offset)
+{
+    if (zpr->databaseName)
+       printf("[%s]", zpr->databaseName);
+    if (zpr->which == Z_NamePlusRecord_surrogateDiagnostic)
+        recv_diagrecs(&zpr->u.surrogateDiagnostic, 1);
+    else
+        recv_record(zpr->u.databaseRecord, offset, zpr->databaseName);
+}
+
+void MyClient::recv_records (Z_Records *records)
+{
+#ifdef ASN_COMPILED
+    Z_DiagRec dr, *dr_p = &dr;
+#endif
+    if (!records)
+       return;
+    int i;
+    switch (records->which)
+    {
+    case Z_Records_DBOSD:
+        for (i = 0; i < records->u.databaseOrSurDiagnostics->num_records; i++)
+            recv_namePlusRecord(records->u.databaseOrSurDiagnostics->
+                               records[i], i + m_setOffset);
+       m_setOffset += records->u.databaseOrSurDiagnostics->num_records;
+       break;
+    case Z_Records_NSD:
+#ifdef ASN_COMPILED
+       dr.which = Z_DiagRec_defaultFormat;
+       dr.u.defaultFormat = records->u.nonSurrogateDiagnostic;
+       recv_diagrecs (&dr_p, 1);
+#else
+       recv_diagrecs (&records->u.nonSurrogateDiagnostic, 1);
+#endif
+       break;
+    case Z_Records_multipleNSD:
+       recv_diagrecs (records->u.multipleNonSurDiagnostics->diagRecs,
+                      records->u.multipleNonSurDiagnostics->num_diagRecs);
+       break;
+    }
+}
+
 void MyClient::recv_searchResponse(Z_SearchResponse *searchResponse)
 {
     printf ("Got SearchResponse. Status ");
@@ -100,6 +444,13 @@ void MyClient::recv_searchResponse(Z_SearchResponse *searchResponse)
     }
     printf ("Ok\n");
     printf ("Hits: %d\n", *searchResponse->resultCount);
+    recv_records (searchResponse->records);
+}
+
+void MyClient::recv_presentResponse(Z_PresentResponse *presentResponse)
+{
+    printf ("Got PresentResponse\n");
+    recv_records (presentResponse->records);
 }
 
 int MyClient::wait()
@@ -115,9 +466,28 @@ int MyClient::wait()
 
 #define C_PROMPT "Z>"
 
+int MyClient::cmd_connect(char *host)
+{
+    client (host);
+    timeout (10);
+    wait ();
+    timeout (0);
+    return 1;
+}
+
 int MyClient::cmd_open(char *host)
 {
     client (host);
+    timeout (10);
+    wait ();
+    timeout (0);
+    send_initRequest();
+    wait ();
+    return 1;
+}
+
+int MyClient::cmd_init(char *args)
+{
     if (send_initRequest() >= 0)
        wait();
     else
@@ -147,6 +517,39 @@ int MyClient::cmd_find(char *args)
     }
     if (send_searchRequest(&query) >= 0)
        wait();
+    else
+       printf ("Not connected\n");
+    return 1;
+}
+
+int MyClient::cmd_show(char *args)
+{
+    int start = m_setOffset, number = 1;
+
+    sscanf (args, "%d %d", &start, &number);
+    m_setOffset = start;
+    if (send_presentRequest(start, number) >= 0)
+       wait();
+    else
+       printf ("Not connected\n");
+    return 1;
+}
+
+int MyClient::cmd_cookie(char *args)
+{
+    set_cookie(*args ? args : 0);
+    return 1;
+}
+
+int MyClient::cmd_format(char *args)
+{
+    set_preferredRecordSyntax(args);
+    return 1;
+}
+
+int MyClient::cmd_proxy(char *args)
+{
+    set_proxy(args);
     return 1;
 }
 
@@ -160,10 +563,16 @@ int MyClient::processCommand(const char *commandLine)
         int (MyClient::*fun)(char *arg);
         char *ad;
     } cmd[] = {
-       {"open", &cmd_open, "('tcp'|'osi')':'[<tsel>'/']<host>[':'<port>]"},
-        {"quit", &cmd_quit, ""},
-       {"close", &cmd_close, ""},
-       {"find", &cmd_find, ""},
+       {"open", &MyClient::cmd_open, "<host>[':'<port>][/<database>]"},
+       {"connect", &MyClient::cmd_connect, "<host>[':'<port>][/<database>]"},
+       {"quit", &MyClient::cmd_quit, ""},
+       {"close", &MyClient::cmd_close, ""},
+       {"find", &MyClient::cmd_find, "<query>"},
+       {"show", &MyClient::cmd_show, "[<start> [<number>]]"},
+       {"cookie", &MyClient::cmd_cookie, "<cookie>"},
+       {"init", &MyClient::cmd_init, ""},
+       {"format", &MyClient::cmd_format, "<record-syntax>"},
+       {"proxy", &MyClient::cmd_proxy, "<host>:[':'<port>]"},
        {0,0,0}
     };
     
@@ -216,7 +625,7 @@ const char *MyClient::getCommand()
     *cp = '\0';
     cp = m_thisCommand;
     // Remove leading spaces...
-    while (strchr ("\t \n", *cp))
+    while (*cp && strchr ("\t \n", *cp))
        cp++;
     // Save command if non-empty
     if (*cp != '\0')
@@ -245,7 +654,7 @@ int MyClient::args(Yaz_SocketManager *socketManager, int argc, char **argv)
     char *prog = argv[0];
     int ret;
 
-    while ((ret = options("p:v:q", argv, argc, &arg)) != -2)
+    while ((ret = options("c:p:v:q", argv, argc, &arg)) != -2)
     {
         switch (ret)
         {
@@ -265,8 +674,11 @@ int MyClient::args(Yaz_SocketManager *socketManager, int argc, char **argv)
            }
            set_proxy(arg);
            break;
+       case 'c':
+           set_cookie(arg);
+           break;
        case 'v':
-           log_init_level (log_mask_str(arg));
+           yaz_log_init_level (yaz_log_mask_str(arg));
            break;
        case 'q':
            m_interactive_flag = 0;
@@ -279,6 +691,9 @@ int MyClient::args(Yaz_SocketManager *socketManager, int argc, char **argv)
     if (host)
     {
        client (host);
+        timeout (10);
+       wait ();
+        timeout (0);
        send_initRequest();
        wait ();
     }
@@ -288,7 +703,7 @@ int MyClient::args(Yaz_SocketManager *socketManager, int argc, char **argv)
 int main(int argc, char **argv)
 {
     Yaz_SocketManager mySocketManager;
-    Yaz_PDU_Assoc *some = new Yaz_PDU_Assoc(&mySocketManager, 0);
+    Yaz_PDU_Assoc *some = new Yaz_PDU_Assoc(&mySocketManager);
 
     MyClient z(some, &mySocketManager);
 
@@ -296,4 +711,5 @@ int main(int argc, char **argv)
        exit (1);
     if (z.interactive(&mySocketManager))
        exit (1);
+    return 0;
 }