Moved prototype of ZOOM_connection_remove_tasks further to the "top" of
[yaz-moved-to-github.git] / src / zoom-c.c
index 2a9d433..cb16f92 100644 (file)
@@ -2,7 +2,7 @@
  * Copyright (C) 1995-2007, Index Data ApS
  * See the file LICENSE for details.
  *
- * $Id: zoom-c.c,v 1.104 2007-01-03 08:42:15 adam Exp $
+ * $Id: zoom-c.c,v 1.113 2007-02-21 09:19:26 adam Exp $
  */
 /**
  * \file zoom-c.c
 #include <yaz/cql.h>
 #include <yaz/ccl.h>
 
-#if HAVE_SYS_TYPES_H
-#include <sys/types.h>
-#endif
-#if HAVE_SYS_TIME_H
-#include <sys/time.h>
-#endif
-#if HAVE_SYS_POLL_H
-#include <sys/poll.h>
-#endif
-#if HAVE_SYS_SELECT_H
-#include <sys/select.h>
-#endif
-#ifdef WIN32
-#if FD_SETSIZE < 512
-#define FD_SETSIZE 512
-#endif
-#include <winsock.h>
-#endif
+#define TASK_FIX 1
 
 static int log_api = 0;
 static int log_details = 0;
@@ -58,6 +41,21 @@ static zoom_ret ZOOM_connection_send_init(ZOOM_connection c);
 static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out);
 static char *cql2pqf(ZOOM_connection c, const char *cql);
 
+
+/*
+ * This wrapper is just for logging failed lookups.  It would be nicer
+ * if it could cause failure when a lookup fails, but that's hard.
+ */
+static Odr_oid *zoom_yaz_str_to_z3950oid(ZOOM_connection c,
+                                         int oid_class, const char *str) {
+    Odr_oid *res = yaz_str_to_z3950oid(c->odr_out, oid_class, str);
+    if (res == 0)
+        yaz_log(YLOG_WARN, "%p OID lookup (%d, '%s') failed",
+                c, (int) oid_class, str);
+    return res;
+}
+
+
 static void initlog(void)
 {
     static int log_level_initialized = 0;
@@ -122,6 +120,14 @@ static ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c)
     return event;
 }
 
+ZOOM_API(int) ZOOM_connection_peek_event(ZOOM_connection c)
+{
+    ZOOM_Event event = c->m_queue_front;
+
+    return event ? event->kind : ZOOM_EVENT_NONE;
+}
+
+void ZOOM_connection_remove_tasks(ZOOM_connection c);
 
 static void set_dset_error(ZOOM_connection c, int error,
                            const char *dset,
@@ -148,11 +154,16 @@ static void set_dset_error(ZOOM_connection c, int error,
     }
     else if (addinfo)
         c->addinfo = xstrdup(addinfo);
-    if (error)
+    if (error != ZOOM_ERROR_NONE)
+    {
         yaz_log(log_api, "%p set_dset_error %s %s:%d %s %s",
                 c, c->host_port ? c->host_port : "<>", dset, error,
                 addinfo ? addinfo : "",
                 addinfo2 ? addinfo2 : "");
+#if TASK_FIX
+        ZOOM_connection_remove_tasks(c);
+#endif
+    }
 }
 
 #if YAZ_HAVE_XML2
@@ -163,6 +174,7 @@ static void set_HTTP_error(ZOOM_connection c, int error,
 }
 #endif
 
+
 static void set_ZOOM_error(ZOOM_connection c, int error,
                            const char *addinfo)
 {
@@ -318,7 +330,7 @@ ZOOM_API(ZOOM_connection)
 
     c->proto = PROTO_Z3950;
     c->cs = 0;
-    c->mask = 0;
+    ZOOM_connection_set_mask(c, 0);
     c->reconnect_ok = 0;
     c->state = STATE_IDLE;
     c->addinfo = 0;
@@ -960,7 +972,7 @@ static void do_close(ZOOM_connection c)
     if (c->cs)
         cs_close(c->cs);
     c->cs = 0;
-    c->mask = 0;
+    ZOOM_connection_set_mask(c, 0);
     c->state = STATE_IDLE;
 }
 
@@ -1115,7 +1127,7 @@ static zoom_ret do_connect(ZOOM_connection c)
                 /* no init request for SRW .. */
                 assert(c->tasks->which == ZOOM_TASK_CONNECT);
                 ZOOM_connection_remove_task(c);
-                c->mask = 0;
+                ZOOM_connection_set_mask(c, 0);
                 ZOOM_connection_exec_task(c);
             }
             c->state = STATE_ESTABLISHED;
@@ -1123,12 +1135,13 @@ static zoom_ret do_connect(ZOOM_connection c)
         }
         else if (ret > 0)
         {
-            c->state = STATE_CONNECTING; 
-            c->mask = ZOOM_SELECT_EXCEPT;
+            int mask = ZOOM_SELECT_EXCEPT;
             if (c->cs->io_pending & CS_WANT_WRITE)
-                c->mask += ZOOM_SELECT_WRITE;
+                mask += ZOOM_SELECT_WRITE;
             if (c->cs->io_pending & CS_WANT_READ)
-                c->mask += ZOOM_SELECT_READ;
+                mask += ZOOM_SELECT_READ;
+            ZOOM_connection_set_mask(c, mask);
+            c->state = STATE_CONNECTING; 
             return zoom_pending;
         }
     }
@@ -1137,20 +1150,6 @@ static zoom_ret do_connect(ZOOM_connection c)
     return zoom_complete;
 }
 
-int z3950_connection_socket(ZOOM_connection c)
-{
-    if (c->cs)
-        return cs_fileno(c->cs);
-    return -1;
-}
-
-int z3950_connection_mask(ZOOM_connection c)
-{
-    if (c->cs)
-        return c->mask;
-    return 0;
-}
-
 static void otherInfo_attach(ZOOM_connection c, Z_APDU *a, ODR out)
 {
     int i;
@@ -1276,7 +1275,7 @@ static zoom_ret ZOOM_connection_send_init(ZOOM_connection c)
                     odr_prepend(c->odr_out, "ZOOM-C",
                                 ireq->implementationName));
     
-    version = odr_strdup(c->odr_out, "$Revision: 1.104 $");
+    version = odr_strdup(c->odr_out, "$Revision: 1.113 $");
     if (strlen(version) > 10)   /* check for unexpanded CVS strings */
         version[strlen(version)-2] = '\0';
     ireq->implementationVersion = 
@@ -1578,7 +1577,7 @@ static zoom_ret ZOOM_connection_send_search(ZOOM_connection c)
     }
     if (syntax)
         search_req->preferredRecordSyntax =
-            yaz_str_to_z3950oid(c->odr_out, CLASS_RECSYN, syntax);
+            zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
     
     if (!r->setname)
     {
@@ -2418,6 +2417,16 @@ static void handle_search_response(ZOOM_connection c, Z_SearchResponse *sr)
 
     resultset = c->tasks->u.search.resultset;
 
+    if (sr->resultSetStatus)
+    {
+        ZOOM_options_set_int(resultset->options, "resultSetStatus",
+                             *sr->resultSetStatus);
+    }
+    if (sr->presentStatus)
+    {
+        ZOOM_options_set_int(resultset->options, "presentStatus",
+                             *sr->presentStatus);
+    }
     handle_searchResult(c, resultset, sr->additionalSearchInfo);
 
     resultset->size = *sr->resultCount;
@@ -2563,7 +2572,7 @@ static zoom_ret send_present(ZOOM_connection c)
 
     if (syntax && *syntax)
         req->preferredRecordSyntax =
-            yaz_str_to_z3950oid(c->odr_out, CLASS_RECSYN, syntax);
+            zoom_yaz_str_to_z3950oid(c, CLASS_RECSYN, syntax);
 
     if (resultset->schema && *resultset->schema)
     {
@@ -2583,14 +2592,14 @@ static zoom_ret send_present(ZOOM_connection c)
 
         compo->u.complex->generic->which = Z_Schema_oid;
         compo->u.complex->generic->schema.oid = (Odr_oid *)
-            yaz_str_to_z3950oid (c->odr_out, CLASS_SCHEMA, resultset->schema);
+            zoom_yaz_str_to_z3950oid (c, CLASS_SCHEMA, resultset->schema);
 
         if (!compo->u.complex->generic->schema.oid)
         {
             /* OID wasn't a schema! Try record syntax instead. */
 
             compo->u.complex->generic->schema.oid = (Odr_oid *)
-                yaz_str_to_z3950oid (c->odr_out, CLASS_RECSYN, resultset->schema);
+                zoom_yaz_str_to_z3950oid (c, CLASS_RECSYN, resultset->schema);
         }
         if (elementSetName && *elementSetName)
         {
@@ -2984,7 +2993,13 @@ static Z_ItemOrder *encode_item_order(ZOOM_package p)
         *req->u.esRequest->notToKeep->resultSetItem->item =
             (str ? atoi(str) : 1);
     }
-    req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
+
+    str = ZOOM_options_get(p->options, "doc");
+    if (str)
+        req->u.esRequest->notToKeep->itemRequest =
+            z_ext_record(p->odr_out, VAL_TEXT_XML, str, strlen(str));
+    else
+        req->u.esRequest->notToKeep->itemRequest = encode_ill_request(p);
     
     return req;
 }
@@ -3452,7 +3467,7 @@ static void recv_apdu(ZOOM_connection c, Z_APDU *apdu)
 {
     Z_InitResponse *initrs;
     
-    c->mask = 0;
+    ZOOM_connection_set_mask(c, 0);
     yaz_log(log_details, "%p recv_apdu apdu->which=%d", c, apdu->which);
     switch(apdu->which)
     {
@@ -3682,7 +3697,7 @@ static void handle_http(ZOOM_connection c, Z_HTTP_Response *hres)
                                                     "Content-Type");
     const char *connection_head = z_HTTP_header_lookup(hres->headers,
                                                        "Connection");
-    c->mask = 0;
+    ZOOM_connection_set_mask(c, 0);
     yaz_log(log_details, "%p handle_http", c);
 
     if (content_type && !yaz_strcmp_del("text/xml", content_type, "; "))
@@ -3826,17 +3841,18 @@ static zoom_ret do_write_ex(ZOOM_connection c, char *buf_out, int len_out)
     }
     else if (r == 1)
     {    
-        c->mask = ZOOM_SELECT_EXCEPT;
+        int mask = ZOOM_SELECT_EXCEPT;
         if (c->cs->io_pending & CS_WANT_WRITE)
-            c->mask += ZOOM_SELECT_WRITE;
+            mask += ZOOM_SELECT_WRITE;
         if (c->cs->io_pending & CS_WANT_READ)
-            c->mask += ZOOM_SELECT_READ;
+            mask += ZOOM_SELECT_READ;
+        ZOOM_connection_set_mask(c, mask);
         yaz_log(log_details, "%p do_write_ex write incomplete mask=%d",
                 c, c->mask);
     }
     else
     {
-        c->mask = ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT;
+        ZOOM_connection_set_mask(c, ZOOM_SELECT_READ|ZOOM_SELECT_EXCEPT);
         yaz_log(log_details, "%p do_write_ex write complete mask=%d",
                 c, c->mask);
     }
@@ -4014,11 +4030,12 @@ static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
                 "cs_rcvconnect returned %d", c, ret);
         if (ret == 1)
         {
-            c->mask = ZOOM_SELECT_EXCEPT;
+            int mask = ZOOM_SELECT_EXCEPT;
             if (c->cs->io_pending & CS_WANT_WRITE)
-                c->mask += ZOOM_SELECT_WRITE;
+                mask += ZOOM_SELECT_WRITE;
             if (c->cs->io_pending & CS_WANT_READ)
-                c->mask += ZOOM_SELECT_READ;
+                mask += ZOOM_SELECT_READ;
+            ZOOM_connection_set_mask(c, mask);
         }
         else if (ret == 0)
         {
@@ -4032,7 +4049,7 @@ static void ZOOM_connection_do_io(ZOOM_connection c, int mask)
                 /* no init request for SRW .. */
                 assert(c->tasks->which == ZOOM_TASK_CONNECT);
                 ZOOM_connection_remove_task(c);
-                c->mask = 0;
+                ZOOM_connection_set_mask(c, 0);
                 ZOOM_connection_exec_task(c);
             }
             c->state = STATE_ESTABLISHED;
@@ -4074,216 +4091,6 @@ ZOOM_API(int)
     return cs->last_event;
 }
 
-ZOOM_API(int)
-    ZOOM_event(int no, ZOOM_connection *cs)
-{
-    int timeout = 30;      /* default timeout in seconds */
-    int timeout_set = 0;   /* whether it was overriden at all */
-#if HAVE_SYS_POLL_H
-    struct pollfd pollfds[1024];
-    ZOOM_connection poll_cs[1024];
-#else
-    struct timeval tv;
-    fd_set input, output, except;
-#endif
-    int i, r, nfds;
-    int max_fd = 0;
-
-    yaz_log(log_details, "ZOOM_event(no=%d,cs=%p)", no, cs);
-    
-    for (i = 0; i<no; i++)
-    {
-        ZOOM_connection c = cs[i];
-        ZOOM_Event event;
-
-#if 0
-        if (c)
-            ZOOM_connection_show_tasks(c);
-#endif
-
-        if (c && (event = ZOOM_connection_get_event(c)))
-        {
-            ZOOM_Event_destroy(event);
-            return i+1;
-        }
-    }
-    for (i = 0; i<no; i++)
-    {
-        ZOOM_connection c = cs[i];
-        if (c)
-        {
-            ZOOM_Event event;
-            ZOOM_connection_exec_task(c);
-            if ((event = ZOOM_connection_get_event(c)))
-            {
-                ZOOM_Event_destroy(event);
-                return i+1;
-            }
-        }
-    }
-#if HAVE_SYS_POLL_H
-
-#else
-    FD_ZERO(&input);
-    FD_ZERO(&output);
-    FD_ZERO(&except);
-#endif
-    nfds = 0;
-    for (i = 0; i<no; i++)
-    {
-        ZOOM_connection c = cs[i];
-        int fd, mask;
-        int this_timeout;
-        
-        if (!c)
-            continue;
-        fd = z3950_connection_socket(c);
-        mask = z3950_connection_mask(c);
-
-        if (fd == -1)
-            continue;
-        if (max_fd < fd)
-            max_fd = fd;
-        
-        /* -1 is used for indefinite timeout (no timeout), so -2 here. */
-        this_timeout = ZOOM_options_get_int(c->options, "timeout", -2);
-        if (this_timeout != -2)
-        {
-            /* ensure the minimum timeout is used */
-            if (!timeout_set)
-                timeout = this_timeout;
-            else if (this_timeout != -1 && this_timeout < timeout)
-                timeout = this_timeout;
-            timeout_set = 1;
-        }               
-#if HAVE_SYS_POLL_H
-        if (mask)
-        {
-            short poll_events = 0;
-
-            if (mask & ZOOM_SELECT_READ)
-                poll_events += POLLIN;
-            if (mask & ZOOM_SELECT_WRITE)
-                poll_events += POLLOUT;
-            if (mask & ZOOM_SELECT_EXCEPT)
-                poll_events += POLLERR;
-            pollfds[nfds].fd = fd;
-            pollfds[nfds].events = poll_events;
-            pollfds[nfds].revents = 0;
-            poll_cs[nfds] = c;
-            nfds++;
-        }
-#else
-        if (mask & ZOOM_SELECT_READ)
-        {
-            FD_SET(fd, &input);
-            nfds++;
-        }
-        if (mask & ZOOM_SELECT_WRITE)
-        {
-            FD_SET(fd, &output);
-            nfds++;
-        }
-        if (mask & ZOOM_SELECT_EXCEPT)
-        {
-            FD_SET(fd, &except);
-            nfds++;
-        }
-#endif
-    }
-    if (!nfds)
-        return 0;
-
-#if HAVE_SYS_POLL_H
-    while ((r = poll(pollfds, nfds,
-         (timeout == -1 ? -1 : timeout * 1000))) < 0
-          && errno == EINTR)
-    {
-        ;
-    }
-    if (r < 0)
-        yaz_log(YLOG_WARN|YLOG_ERRNO, "ZOOM_event: poll");
-    for (i = 0; i<nfds; i++)
-    {
-        ZOOM_connection c = poll_cs[i];
-        if (r && c->mask)
-        {
-            int mask = 0;
-            if (pollfds[i].revents & POLLIN)
-                mask += ZOOM_SELECT_READ;
-            if (pollfds[i].revents & POLLOUT)
-                mask += ZOOM_SELECT_WRITE;
-            if (pollfds[i].revents & POLLERR)
-                mask += ZOOM_SELECT_EXCEPT;
-            if (mask)
-                ZOOM_connection_do_io(c, mask);
-        }
-        else if (r == 0 && c->mask)
-        {
-            ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
-            /* timeout and this connection was waiting */
-            set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
-            do_close(c);
-            ZOOM_connection_put_event(c, event);
-        }
-    }
-#else
-    tv.tv_sec = timeout;
-    tv.tv_usec = 0;
-
-    while ((r = select(max_fd+1, &input, &output, &except,
-                       (timeout == -1 ? 0 : &tv))) < 0 && errno == EINTR)
-    {
-        ;
-    }
-    if (r < 0)
-        yaz_log(YLOG_WARN|YLOG_ERRNO, "ZOOM_event: select");
-
-    r = select(max_fd+1, &input, &output, &except, (timeout == -1 ? 0 : &tv));
-    for (i = 0; i<no; i++)
-    {
-        ZOOM_connection c = cs[i];
-        int fd, mask;
-
-        if (!c)
-            continue;
-        fd = z3950_connection_socket(c);
-        mask = 0;
-        if (r && c->mask)
-        {
-            /* no timeout and real socket */
-            if (FD_ISSET(fd, &input))
-                mask += ZOOM_SELECT_READ;
-            if (FD_ISSET(fd, &output))
-                mask += ZOOM_SELECT_WRITE;
-            if (FD_ISSET(fd, &except))
-                mask += ZOOM_SELECT_EXCEPT;
-            if (mask)
-                ZOOM_connection_do_io(c, mask);
-        }
-        if (r == 0 && c->mask)
-        {
-            ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
-            /* timeout and this connection was waiting */
-            set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
-            do_close(c);
-            ZOOM_connection_put_event(c, event);
-        }
-    }
-#endif
-    for (i = 0; i<no; i++)
-    {
-        ZOOM_connection c = cs[i];
-        ZOOM_Event event;
-        if (c && (event = ZOOM_connection_get_event(c)))
-        {
-            ZOOM_Event_destroy(event);
-            return i+1;
-        }
-    }
-    return 0;
-}
-
 
 /*
  * Returns an xmalloc()d string containing RPN that corresponds to the
@@ -4345,6 +4152,93 @@ static char *cql2pqf(ZOOM_connection c, const char *cql)
     return xstrdup(pqfbuf);
 }
 
+ZOOM_API(int) ZOOM_connection_fire_event_timeout(ZOOM_connection c)
+{
+    if (c->mask)
+    {
+        ZOOM_Event event = ZOOM_Event_create(ZOOM_EVENT_TIMEOUT);
+        /* timeout and this connection was waiting */
+        set_ZOOM_error(c, ZOOM_ERROR_TIMEOUT, 0);
+        do_close(c);
+        ZOOM_connection_put_event(c, event);
+    }
+    return 0;
+}
+
+ZOOM_API(int)
+    ZOOM_connection_process(ZOOM_connection c)
+{
+    ZOOM_Event event;
+    if (!c)
+        return 0;
+
+    event = ZOOM_connection_get_event(c);
+    if (event)
+    {
+        ZOOM_Event_destroy(event);
+        return 1;
+    }
+    ZOOM_connection_exec_task(c);
+    event = ZOOM_connection_get_event(c);
+    if (event)
+    {
+        ZOOM_Event_destroy(event);
+        return 1;
+    }
+    return 0;
+}
+
+ZOOM_API(int)
+    ZOOM_event_nonblock(int no, ZOOM_connection *cs)
+{
+    int i;
+
+    yaz_log(log_details, "ZOOM_process_event(no=%d,cs=%p)", no, cs);
+    
+    for (i = 0; i<no; i++)
+    {
+        ZOOM_connection c = cs[i];
+
+        if (c && ZOOM_connection_process(c))
+            return i+1;
+    }
+    return 0;
+}
+
+ZOOM_API(int) ZOOM_connection_fire_event_socket(ZOOM_connection c, int mask)
+{
+    if (c->mask && mask)
+        ZOOM_connection_do_io(c, mask);
+    return 0;
+}
+
+ZOOM_API(int) ZOOM_connection_get_socket(ZOOM_connection c)
+{
+    if (c->cs)
+        return cs_fileno(c->cs);
+    return -1;
+}
+
+ZOOM_API(int) ZOOM_connection_set_mask(ZOOM_connection c, int mask)
+{
+    c->mask = mask;
+    if (!c->cs)
+        return -1; 
+    return 0;
+}
+
+ZOOM_API(int) ZOOM_connection_get_mask(ZOOM_connection c)
+{
+    if (c->cs)
+        return c->mask;
+    return 0;
+}
+
+ZOOM_API(int) ZOOM_connection_get_timeout(ZOOM_connection c)
+{
+    return ZOOM_options_get_int(c->options, "timeout", 30);
+}
+
 /*
  * Local variables:
  * c-basic-offset: 4