Fix:
[yaz-moved-to-github.git] / src / zoom-p.h
index 3e6bcff..51125b5 100644 (file)
@@ -1,19 +1,45 @@
-/*
- * Copyright (C) 1995-2005, Index Data ApS
- * See the file LICENSE for details.
+/* This file is part of the YAZ toolkit.
+ * Copyright (C) 1995-2010 Index Data.
+ * All rights reserved.
+ * Redistribution and use in source and binary forms, with or without
+ * modification, are permitted provided that the following conditions are met:
+ *
+ *     * Redistributions of source code must retain the above copyright
+ *       notice, this list of conditions and the following disclaimer.
+ *     * Redistributions in binary form must reproduce the above copyright
+ *       notice, this list of conditions and the following disclaimer in the
+ *       documentation and/or other materials provided with the distribution.
+ *     * Neither the name of Index Data nor the names of its contributors
+ *       may be used to endorse or promote products derived from this
+ *       software without specific prior written permission.
  *
- * $Id: zoom-p.h,v 1.11 2006-05-10 07:34:38 adam Exp $
+ * THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND ANY
+ * EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+ * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+ * DISCLAIMED. IN NO EVENT SHALL THE REGENTS AND CONTRIBUTORS BE LIABLE FOR ANY
+ * DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+ * (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+ * LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ * ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+ * (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
+ * THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
  */
 /**
  * \file zoom-p.h
  * \brief Internal header for ZOOM implementation
  */
-
 #include <yaz/proto.h>
+#include <yaz/oid_db.h>
 #include <yaz/comstack.h>
 #include <yaz/wrbuf.h>
 #include <yaz/zoom.h>
 #include <yaz/sortspec.h>
+#include <yaz/srw.h>
+#include <yaz/mutex.h>
+
+#define SHPTR 1
+#define ZOOM_RESULT_LISTS 0
+
 typedef struct ZOOM_Event_p *ZOOM_Event;
 
 struct ZOOM_query_p {
@@ -28,7 +54,7 @@ typedef enum {
     zoom_sru_error,
     zoom_sru_soap,
     zoom_sru_get,
-    zoom_sru_post,
+    zoom_sru_post
 } zoom_sru_mode;
     
 
@@ -38,9 +64,9 @@ typedef struct ZOOM_task_p *ZOOM_task;
 #define STATE_CONNECTING 1
 #define STATE_ESTABLISHED 2
 
-#define ZOOM_SELECT_READ 1
-#define ZOOM_SELECT_WRITE 2
-#define ZOOM_SELECT_EXCEPT 4
+#if ZOOM_RESULT_LISTS
+typedef struct ZOOM_resultsets_p *ZOOM_resultsets;
+#endif
 
 struct ZOOM_connection_p {
     enum oid_proto proto;
@@ -55,6 +81,7 @@ struct ZOOM_connection_p {
     int reconnect_ok;
     ODR odr_in;
     ODR odr_out;
+    ODR odr_print;
     char *buf_in;
     int len_in;
     char *buf_out;
@@ -65,17 +92,39 @@ struct ZOOM_connection_p {
     char *cookie_out;
     char *cookie_in;
     char *client_IP;
+    char *sru_version;
+
+    char *user;
+    char *group;
+    char *password;
+
     int async;
     int support_named_resultsets;
     int last_event;
+
+    int maximum_record_size;
+    int preferred_message_size;
+
     ZOOM_task tasks;
     ZOOM_options options;
+#if ZOOM_RESULT_LISTS
+    ZOOM_resultsets resultsets;
+#else
     ZOOM_resultset resultsets;
+#endif
     ZOOM_Event m_queue_front;
     ZOOM_Event m_queue_back;
     zoom_sru_mode sru_mode;
+    int no_redirects; /* 0 for no redirects. >0 for number of redirects */
 };
 
+#if ZOOM_RESULT_LISTS
+struct ZOOM_resultsets_p {
+    ZOOM_resultset resultset;
+    ZOOM_resultsets next;
+};
+#endif
+
 struct ZOOM_options_entry {
     char *name;
     char *value;
@@ -101,9 +150,7 @@ struct ZOOM_resultset_p {
     Z_SortKeySpecList *r_sort_spec;
     ZOOM_query query;
     int refcount;
-    int size;
-    int start;
-    int count;
+    Odr_int size;
     int step;
     int piggyback;
     char *setname;
@@ -112,17 +159,50 @@ struct ZOOM_resultset_p {
     ZOOM_record_cache record_hash[RECORD_HASH_SIZE];
     ZOOM_options options;
     ZOOM_connection connection;
+    char **databaseNames;
+    int num_databaseNames;
+    YAZ_MUTEX mutex;
+#if SHPTR
+    struct WRBUF_shptr *record_wrbuf;
+#endif
+#if ZOOM_RESULT_LISTS
+#else
     ZOOM_resultset next;
+#endif
+    ZOOM_facet_field *facets;
+    int num_facets;
+    char **facets_names;
 };
 
 struct ZOOM_record_p {
     ODR odr;
-    WRBUF wrbuf_marc;
-    WRBUF wrbuf_iconv;
-    WRBUF wrbuf_opac;
+#if SHPTR
+    struct WRBUF_shptr *record_wrbuf;
+#else
+    WRBUF wrbuf;
+#endif
+
     Z_NamePlusRecord *npr;
+    const char *schema;
+
+    const char *diag_uri;
+    const char *diag_message;
+    const char *diag_details;
+    const char *diag_set;
+};
+
+struct facet_term_p {
+    char *term;
+    int frequency;
 };
 
+struct ZOOM_facet_field_p {
+    char *facet_name;
+    int num_terms;
+    struct facet_term_p *facet_terms;
+};
+
+
 struct ZOOM_record_cache_p {
     struct ZOOM_record_p rec;
     char *elementSetName;
@@ -137,9 +217,12 @@ struct ZOOM_scanset_p {
     ODR odr;
     ZOOM_options options;
     ZOOM_connection connection;
-    Z_AttributesPlusTerm *termListAndStartPoint;
-    Z_AttributeSetId *attributeSet;
+    ZOOM_query query;
     Z_ScanResponse *scan_response;
+    Z_SRW_scanResponse *srw_scan_response;
+
+    char **databaseNames;
+    int num_databaseNames;
 };
 
 struct ZOOM_package_p {
@@ -157,13 +240,20 @@ struct ZOOM_task_p {
     union {
 #define ZOOM_TASK_SEARCH 1
         struct {
+            int count;
+            int start;
             ZOOM_resultset resultset;
+            char *syntax;
+            char *elementSetName;
+            int recv_search_fired;
         } search;
 #define ZOOM_TASK_RETRIEVE 2
         struct {
             int start;
             ZOOM_resultset resultset;
             int count;
+            char *syntax;
+            char *elementSetName;
         } retrieve;
 #define ZOOM_TASK_CONNECT 3
 #define ZOOM_TASK_SCAN 4
@@ -188,9 +278,11 @@ struct ZOOM_Event_p {
 };
 
 void ZOOM_options_addref (ZOOM_options opt);
+
 /*
  * Local variables:
  * c-basic-offset: 4
+ * c-file-style: "Stroustrup"
  * indent-tabs-mode: nil
  * End:
  * vim: shiftwidth=4 tabstop=8 expandtab