X-Git-Url: http://git.indexdata.com/?p=yaz-moved-to-github.git;a=blobdiff_plain;f=src%2Fzoom-p.h;h=5abaa2aefde1f0364cb02e5717e907d0fac18500;hp=4718a0e4e429f9c88eb5c06c7abe2abaf3ed247b;hb=7ee4de722ccf984fc27203e70c432e29290f3984;hpb=d3deed18d17648b5561f11b926be6d6eb1d9110c diff --git a/src/zoom-p.h b/src/zoom-p.h index 4718a0e..5abaa2a 100644 --- a/src/zoom-p.h +++ b/src/zoom-p.h @@ -1,36 +1,57 @@ -/* - * Copyright (C) 1995-2005, Index Data ApS - * See the file LICENSE for details. +/* This file is part of the YAZ toolkit. + * Copyright (C) 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.12 2006-08-08 20:58:52 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 +#include #include #include #include -#include -typedef struct ZOOM_Event_p *ZOOM_Event; +#include +#include +#include +#if HAVE_LIBMEMCACHED_MEMCACHED_H +#include +#endif -struct ZOOM_query_p { - Z_Query *z_query; - Z_SortKeySpecList *sort_spec; - int refcount; - ODR odr; - char *query_string; -}; +#define SHPTR 1 + +typedef struct ZOOM_Event_p *ZOOM_Event; typedef enum { zoom_sru_error, zoom_sru_soap, zoom_sru_get, zoom_sru_post, + zoom_sru_solr } zoom_sru_mode; - + typedef struct ZOOM_task_p *ZOOM_task; @@ -38,15 +59,10 @@ 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 - struct ZOOM_connection_p { enum oid_proto proto; COMSTACK cs; char *host_port; - char *path; int error; char *addinfo; char *diagset; @@ -55,44 +71,52 @@ struct ZOOM_connection_p { int reconnect_ok; ODR odr_in; ODR odr_out; + ODR odr_print; + ODR odr_save; + char *buf_in; int len_in; char *buf_out; int len_out; char *proxy; + char *tproxy; char *charset; char *lang; char *cookie_out; char *cookie_in; char *client_IP; + char *sru_version; + + char *user; + char *group; + char *password; + int url_authentication; + int async; int support_named_resultsets; int last_event; + + int maximum_record_size; + int preferred_message_size; + ZOOM_task tasks; ZOOM_options options; ZOOM_resultset resultsets; 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 */ + yaz_cookies_t cookies; + char *location; -struct ZOOM_options_entry { - char *name; - char *value; - int len; /* of `value', which may contain NULs */ - struct ZOOM_options_entry *next; + int log_details; + int log_api; + WRBUF saveAPDU_wrbuf; +#if HAVE_LIBMEMCACHED_MEMCACHED_H + memcached_st *mc_st; +#endif }; -struct ZOOM_options_p { - int refcount; - void *callback_handle; - ZOOM_options_callback callback_func; - struct ZOOM_options_entry *entries; - ZOOM_options parent1; - ZOOM_options parent2; -}; - - typedef struct ZOOM_record_cache_p *ZOOM_record_cache; #define RECORD_HASH_SIZE 131 @@ -101,33 +125,38 @@ struct ZOOM_resultset_p { Z_SortKeySpecList *r_sort_spec; ZOOM_query query; int refcount; - int size; + Odr_int size; int step; int piggyback; char *setname; - char *schema; ODR odr; 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 ZOOM_resultset next; + char *req_facets; + ZOOM_facet_field *res_facets; + int num_res_facets; + char **facets_names; /* redundant. For ZOOM_resultset_facets_names only */ + WRBUF mc_key; + int live_set; /* 0=no hit count, 1=cached hit, 2=hits + real set */ }; -struct ZOOM_record_p { - ODR odr; - WRBUF wrbuf_marc; - WRBUF wrbuf_iconv; - WRBUF wrbuf_opac; - Z_NamePlusRecord *npr; +struct facet_term_p { + char *term; + int frequency; }; -struct ZOOM_record_cache_p { - struct ZOOM_record_p rec; - char *elementSetName; - char *syntax; - char *schema; - int pos; - ZOOM_record_cache next; +struct ZOOM_facet_field_p { + char *facet_name; + int num_terms; + struct facet_term_p *facet_terms; }; struct ZOOM_scanset_p { @@ -135,9 +164,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 { @@ -158,13 +190,10 @@ struct ZOOM_task_p { int count; int start; ZOOM_resultset resultset; + char *syntax; + char *elementSetName; + char *schema; } search; -#define ZOOM_TASK_RETRIEVE 2 - struct { - int start; - ZOOM_resultset resultset; - int count; - } retrieve; #define ZOOM_TASK_CONNECT 3 #define ZOOM_TASK_SCAN 4 struct { @@ -181,16 +210,98 @@ struct ZOOM_task_p { ZOOM_task next; }; -struct ZOOM_Event_p { - int kind; - ZOOM_Event next; - ZOOM_Event prev; -}; +typedef enum { + zoom_pending, + zoom_complete +} zoom_ret; void ZOOM_options_addref (ZOOM_options opt); + +void ZOOM_handle_Z3950_apdu(ZOOM_connection c, Z_APDU *apdu); + +void ZOOM_set_dset_error(ZOOM_connection c, int error, + const char *dset, + const char *addinfo, const char *addinfo2); + +void ZOOM_set_error(ZOOM_connection c, int error, const char *addinfo); + +ZOOM_Event ZOOM_Event_create(int kind); +void ZOOM_connection_put_event(ZOOM_connection c, ZOOM_Event event); + +zoom_ret ZOOM_connection_Z3950_search(ZOOM_connection c); +zoom_ret ZOOM_connection_Z3950_send_scan(ZOOM_connection c); +zoom_ret ZOOM_send_buf(ZOOM_connection c); +zoom_ret send_Z3950_sort(ZOOM_connection c, ZOOM_resultset resultset); +char **ZOOM_connection_get_databases(ZOOM_connection con, ZOOM_options options, + int *num, ODR odr); +zoom_ret ZOOM_connection_Z3950_send_init(ZOOM_connection c); + +ZOOM_task ZOOM_connection_add_task(ZOOM_connection c, int which); +void ZOOM_connection_remove_task(ZOOM_connection c); +int ZOOM_test_reconnect(ZOOM_connection c); + +ZOOM_record ZOOM_record_cache_lookup(ZOOM_resultset r, int pos, + const char *syntax, + const char *elementSetName, + const char *schema); +void ZOOM_record_cache_add(ZOOM_resultset r, Z_NamePlusRecord *npr, + int pos, + const char *syntax, const char *elementSetName, + const char *schema, + Z_SRW_diagnostic *diag); + +Z_Query *ZOOM_query_get_Z_Query(ZOOM_query s); +Z_SortKeySpecList *ZOOM_query_get_sortspec(ZOOM_query s); +const char *ZOOM_query_get_query_string(ZOOM_query s); +const char *ZOOM_query_get_sru11(ZOOM_query s); +void ZOOM_query_get_hash(ZOOM_query s, WRBUF w); + +int ZOOM_uri_to_code(const char *uri); + +zoom_ret ZOOM_connection_srw_send_search(ZOOM_connection c); +zoom_ret ZOOM_connection_srw_send_scan(ZOOM_connection c); + +int ZOOM_handle_sru(ZOOM_connection c, Z_HTTP_Response *hres, + zoom_ret *cret, char **addinfo); + +void ZOOM_set_HTTP_error(ZOOM_connection c, int error, + const char *addinfo, const char *addinfo2); + +ZOOM_Event ZOOM_connection_get_event(ZOOM_connection c); +void ZOOM_connection_remove_events(ZOOM_connection c); +void ZOOM_Event_destroy(ZOOM_Event event); +zoom_ret ZOOM_send_GDU(ZOOM_connection c, Z_GDU *gdu); +void ZOOM_handle_facet_list(ZOOM_resultset r, Z_FacetList *fl); + +void ZOOM_memcached_init(ZOOM_connection c); +int ZOOM_memcached_configure(ZOOM_connection c); +void ZOOM_memcached_destroy(ZOOM_connection c); +void ZOOM_memcached_resultset(ZOOM_resultset r, ZOOM_query q); +void ZOOM_memcached_search(ZOOM_connection c, ZOOM_resultset r); +void ZOOM_memcached_hitcount(ZOOM_connection c, ZOOM_resultset result, + Z_OtherInformation *oi, const char *precision); +void ZOOM_memcached_add(ZOOM_resultset r, Z_NamePlusRecord *npr, + int pos, + const char *syntax, const char *elementSetName, + const char *schema, + Z_SRW_diagnostic *diag); +Z_NamePlusRecord *ZOOM_memcached_lookup(ZOOM_resultset r, int pos, + const char *syntax, + const char *elementSetName, + const char *schema); +ZOOM_record ZOOM_record_cache_lookup_i(ZOOM_resultset r, int pos, + const char *syntax, + const char *elementSetName, + const char *schema); +void ZOOM_handle_facet_result(ZOOM_connection c, ZOOM_resultset r, + Z_OtherInformation *o); +void ZOOM_handle_search_result(ZOOM_connection c, ZOOM_resultset resultset, + Z_OtherInformation *o); + /* * Local variables: * c-basic-offset: 4 + * c-file-style: "Stroustrup" * indent-tabs-mode: nil * End: * vim: shiftwidth=4 tabstop=8 expandtab