Fix: proxy doesn't cache searches/result sets when errors occur.
[yazpp-moved-to-github.git] / src / yaz-proxy.cpp
index a73c95a..3a6bb9e 100644 (file)
@@ -2,7 +2,7 @@
  * Copyright (c) 1998-2001, Index Data.
  * See the file LICENSE for details.
  * 
- * $Id: yaz-proxy.cpp,v 1.28 2001-11-04 22:36:21 adam Exp $
+ * $Id: yaz-proxy.cpp,v 1.31 2002-01-14 12:01:28 adam Exp $
  */
 
 #include <assert.h>
@@ -21,16 +21,20 @@ Yaz_Proxy::Yaz_Proxy(IYaz_PDU_Observable *the_PDU_Observable) :
     m_seqno = 1;
     m_keepalive = 1;
     m_proxyTarget = 0;
+    m_proxy_authentication = 0;
     m_max_clients = 50;
     m_seed = time(0);
+    m_optimize = xstrdup ("1");
 }
 
 Yaz_Proxy::~Yaz_Proxy()
 {
     xfree (m_proxyTarget);
+    xfree (m_proxy_authentication);
+    xfree (m_optimize);
 }
 
-void Yaz_Proxy::set_proxyTarget(const char *target)
+void Yaz_Proxy::set_proxy_target(const char *target)
 {
     xfree (m_proxyTarget);
     m_proxyTarget = 0;
@@ -38,14 +42,23 @@ void Yaz_Proxy::set_proxyTarget(const char *target)
        m_proxyTarget = (char *) xstrdup (target);
 }
 
+void Yaz_Proxy::set_proxy_authentication (const char *auth)
+{
+    xfree (m_proxy_authentication);
+    m_proxy_authentication = 0;
+    if (auth)
+       m_proxy_authentication = (char *) xstrdup (auth);
+}
+
 IYaz_PDU_Observer *Yaz_Proxy::sessionNotify(IYaz_PDU_Observable
                                            *the_PDU_Observable, int fd)
 {
     Yaz_Proxy *new_proxy = new Yaz_Proxy(the_PDU_Observable);
     new_proxy->m_parent = this;
     new_proxy->timeout(500);
-    new_proxy->set_proxyTarget(m_proxyTarget);
+    new_proxy->set_proxy_target(m_proxyTarget);
     new_proxy->set_APDU_log(get_APDU_log());
+    new_proxy->set_proxy_authentication(m_proxy_authentication);
     return new_proxy;
 }
 
@@ -90,34 +103,28 @@ Yaz_ProxyClient *Yaz_Proxy::get_client(Z_APDU *apdu)
     
     get_otherInfoAPDU(apdu, &oi);
     char *cookie = get_cookie(oi);
-    yaz_log (LOG_LOG, "Yaz_Proxy::get_client cookie=%s", cookie ? cookie :
-         "null");
 
     const char *proxy_host = get_proxy(oi);
     if (proxy_host)
-       set_proxyTarget(proxy_host);
-    yaz_log (LOG_LOG, "proxy_host = %s", m_proxyTarget ? m_proxyTarget:"none");
+       set_proxy_target(proxy_host);
     
     // no target specified at all?
     if (!m_proxyTarget)
        return 0;
 
+    if (!strcmp(m_proxyTarget, "stop"))
+       exit (0);
     if (cookie && *cookie)
     {
-       yaz_log (LOG_LOG, "lookup of clients cookie=%s target=%s",
-             cookie, m_proxyTarget);
        Yaz_ProxyClient *cc = 0;
        
        for (c = parent->m_clientPool; c; c = c->m_next)
        {
-           yaz_log (LOG_LOG, " found client cookie = %s target=%s seqno=%d",
-                 c->m_cookie, c->get_hostname(), c->m_seqno);
            assert (c->m_prev);
            assert (*c->m_prev == c);
            if (!strcmp(cookie,c->m_cookie) &&
                !strcmp(m_proxyTarget, c->get_hostname()))
            {
-               yaz_log (LOG_LOG, "found!");
                cc = c;
            }
        }
@@ -134,9 +141,8 @@ Yaz_ProxyClient *Yaz_Proxy::get_client(Z_APDU *apdu)
                c->close();
                c->client(m_proxyTarget);
                c->m_init_flag = 0;
-               
-               delete c->m_last_query;
-               c->m_last_query = 0;
+
+               c->m_last_ok = 0;
                c->m_last_resultCount = 0;
                c->m_sr_transform = 0;
                c->m_waiting = 0;
@@ -148,7 +154,7 @@ Yaz_ProxyClient *Yaz_Proxy::get_client(Z_APDU *apdu)
            c->m_server = this;
            c->m_seqno = parent->m_seqno;
            (parent->m_seqno)++;
-           yaz_log (LOG_LOG, "get_client 1 %p %p", this, c);
+           yaz_log (LOG_DEBUG, "get_client 1 %p %p", this, c);
            return c;
        }
     }
@@ -160,7 +166,23 @@ Yaz_ProxyClient *Yaz_Proxy::get_client(Z_APDU *apdu)
            return 0;
        }
        yaz_log (LOG_LOG, "got InitRequest");
-           
+        Z_InitRequest *initRequest = apdu->u.initRequest;
+
+        if (!initRequest->idAuthentication)
+        {
+            if (m_proxy_authentication)
+            {
+                initRequest->idAuthentication =
+                    (Z_IdAuthentication *)
+                    odr_malloc (odr_encode(),
+                                sizeof(*initRequest->idAuthentication));
+                initRequest->idAuthentication->which =
+                    Z_IdAuthentication_open;
+                initRequest->idAuthentication->u.open =
+                    odr_strdup (odr_encode(), m_proxy_authentication);
+            }
+        }
+
        // go through list of clients - and find the lowest/oldest one.
        Yaz_ProxyClient *c_min = 0;
        int min_seq = -1;
@@ -201,7 +223,7 @@ Yaz_ProxyClient *Yaz_Proxy::get_client(Z_APDU *apdu)
                    delete c->m_server;
                }
                (parent->m_seqno)++;
-               yaz_log (LOG_LOG, "get_client 2 %p %p", this, c);
+               yaz_log (LOG_DEBUG, "get_client 2 %p %p", this, c);
                return c;
            }
        }
@@ -225,17 +247,15 @@ Yaz_ProxyClient *Yaz_Proxy::get_client(Z_APDU *apdu)
        c->m_seqno = parent->m_seqno;
        c->client(m_proxyTarget);
        c->m_init_flag = 0;
-
-       delete c->m_last_query;
-       c->m_last_query = 0;
        c->m_last_resultCount = 0;
+        c->m_last_ok = 0;
        c->m_sr_transform = 0;
        c->m_waiting = 0;
        c->timeout(10);
 
        (parent->m_seqno)++;
     }
-    yaz_log (LOG_LOG, "get_client 3 %p %p", this, c);
+    yaz_log (LOG_DEBUG, "get_client 3 %p %p", this, c);
     return c;
 }
 
@@ -243,19 +263,27 @@ Z_APDU *Yaz_Proxy::result_set_optimize(Z_APDU *apdu)
 {
     if (apdu->which != Z_APDU_searchRequest)
        return apdu;
+    if (*m_parent->m_optimize != '1')
+        return apdu;
     Z_SearchRequest *sr = apdu->u.searchRequest;
     Yaz_Z_Query *this_query = new Yaz_Z_Query;
+    Yaz_Z_Databases this_databases;
+
+    this_databases.set(sr->num_databaseNames, (const char **)
+                       sr->databaseNames);
     
     this_query->set_Z_Query(sr->query);
     
-    if (m_client->m_last_query &&
-       m_client->m_last_query->match(this_query))
+    if (m_client->m_last_ok && m_client->m_last_query &&
+       m_client->m_last_query->match(this_query) &&
+        m_client->m_last_databases.match(this_databases))
     {
        delete this_query;
        if (m_client->m_last_resultCount > *sr->smallSetUpperBound &&
            m_client->m_last_resultCount < *sr->largeSetLowerBound)
        {
            // medium Set
+            // send present request (medium size)
            yaz_log (LOG_LOG, "Yaz_Proxy::result_set_optimize medium set");
            Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentRequest);
            Z_PresentRequest *pr = new_apdu->u.presentRequest;
@@ -276,7 +304,7 @@ Z_APDU *Yaz_Proxy::result_set_optimize(Z_APDU *apdu)
        else if (m_client->m_last_resultCount >= *sr->largeSetLowerBound ||
            m_client->m_last_resultCount == 0)
        {
-           // large set
+            // large set. Return pseudo-search response immediately
            yaz_log (LOG_LOG, "Yaz_Proxy::result_set_optimize large set");
            Z_APDU *new_apdu = create_Z_PDU(Z_APDU_searchResponse);
            new_apdu->u.searchResponse->referenceId = sr->referenceId;
@@ -288,6 +316,7 @@ Z_APDU *Yaz_Proxy::result_set_optimize(Z_APDU *apdu)
        else
        {
            // small set
+            // send a present request (small set)
            yaz_log (LOG_LOG, "Yaz_Proxy::result_set_optimize small set");
            Z_APDU *new_apdu = create_Z_PDU(Z_APDU_presentRequest);
            Z_PresentRequest *pr = new_apdu->u.presentRequest;
@@ -311,6 +340,9 @@ Z_APDU *Yaz_Proxy::result_set_optimize(Z_APDU *apdu)
        yaz_log (LOG_LOG, "Yaz_Proxy::result_set_optimize new set");
        delete m_client->m_last_query;
        m_client->m_last_query = this_query;
+        m_client->m_last_ok = 0;
+        m_client->m_last_databases.set(sr->num_databaseNames,
+                                       (const char **) sr->databaseNames);
     }
     return apdu;
 }
@@ -369,29 +401,31 @@ void Yaz_Proxy::connectNotify()
 
 void Yaz_Proxy::shutdown()
 {
-    yaz_log (LOG_LOG, "shutdown (client to proxy)");
     // only keep if keep_alive flag and cookie is set...
     if (m_keepalive && m_client && m_client->m_cookie[0])
     {
-       yaz_log (LOG_LOG, "shutdown - keepalive this=%p, m_server=%p",
-            this, m_client->m_server);
        if (m_client->m_waiting == 2)
            abort();
        // Tell client (if any) that no server connection is there..
        m_client->m_server = 0;
+        yaz_log (LOG_LOG, "shutdown (client to proxy) keepalive %s", m_client->get_hostname());
     }
     else if (m_client)
     {
-       yaz_log (LOG_LOG, "deleting %p %p", this, m_client);
        if (m_client->m_waiting == 2)
            abort();
+        yaz_log (LOG_LOG, "shutdown (client to proxy) close %s", m_client->get_hostname());
        delete m_client;
     }
     else if (!m_parent)
     {
-       yaz_log (LOG_LOG, "abort %p", this);
+        yaz_log (LOG_LOG, "shutdown (client to proxy) bad state");
         abort();
     }
+    else 
+    {
+        yaz_log (LOG_LOG, "shutdown (client to proxy)");
+    }
     delete this;
 }
 
@@ -404,7 +438,7 @@ void Yaz_ProxyClient::shutdown()
 
 void Yaz_Proxy::failNotify()
 {
-    yaz_log (LOG_LOG, "connection closed by client");
+    yaz_log (LOG_LOG, "Yaz_Proxy connection closed by client");
     shutdown();
 }
 
@@ -458,10 +492,23 @@ Yaz_ProxyClient::Yaz_ProxyClient(IYaz_PDU_Observable *the_PDU_Observable) :
     m_init_flag = 0;
     m_last_query = 0;
     m_last_resultCount = 0;
+    m_last_ok = 0;
     m_sr_transform = 0;
     m_waiting = 0;
 }
 
+const char *Yaz_Proxy::option(const char *name, const char *value)
+{
+    if (!strcmp (name, "optimize")) {
+       if (value) {
+            xfree (m_optimize);        
+           m_optimize = xstrdup (value);
+        }
+       return m_optimize;
+    }
+    return 0;
+}
+
 void Yaz_ProxyClient::recv_Z_PDU(Z_APDU *apdu)
 {
     m_waiting = 0;
@@ -470,13 +517,10 @@ void Yaz_ProxyClient::recv_Z_PDU(Z_APDU *apdu)
     {
        m_last_resultCount = *apdu->u.searchResponse->resultCount;
        int status = *apdu->u.searchResponse->searchStatus;
-       if (! status || (
-               apdu->u.searchResponse->records &&
-               apdu->u.searchResponse->records->which != Z_Records_DBOSD))
-       {
-           delete m_last_query;
-           m_last_query = 0;
-       }
+       if (status && 
+               (!apdu->u.searchResponse->records ||
+                 apdu->u.searchResponse->records->which == Z_Records_DBOSD))
+            m_last_ok = 1;
     }
     if (apdu->which == Z_APDU_presentResponse && m_sr_transform)
     {
@@ -491,7 +535,7 @@ void Yaz_ProxyClient::recv_Z_PDU(Z_APDU *apdu)
        sr->numberOfRecordsReturned = pr->numberOfRecordsReturned;
        apdu = new_apdu;
     }
-    if (m_cookie)
+    if (m_cookie && *m_cookie)
        set_otherInformationString (apdu, VAL_COOKIE, 1, m_cookie);
     if (m_server)
     {