X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=src%2Fpazpar2.h;h=6c4faaea9eceae53cdd9e70094f55b34a859920f;hb=5562d7ab1e9bdb91437836c4c8d12f7e9e1d3a6e;hp=4ee4c0fb181b59a29a86fc8525e438917bb1c7c1;hpb=5c0b5b368867a9b8fe6c3ffe7887890584ee9643;p=pazpar2-moved-to-github.git diff --git a/src/pazpar2.h b/src/pazpar2.h index 4ee4c0f..6c4faae 100644 --- a/src/pazpar2.h +++ b/src/pazpar2.h @@ -1,12 +1,24 @@ -#ifndef PAZPAR2_H -#define PAZPAR2_H +/* This file is part of Pazpar2. + Copyright (C) 2006-2009 Index Data -struct record; +Pazpar2 is free software; you can redistribute it and/or modify it under +the terms of the GNU General Public License as published by the Free +Software Foundation; either version 2, or (at your option) any later +version. + +Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY +WARRANTY; without even the implied warranty of MERCHANTABILITY or +FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +for more details. -#include +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA -#include -#include +*/ + +#ifndef PAZPAR2_H +#define PAZPAR2_H #include #include @@ -14,102 +26,60 @@ struct record; #include #include "termlists.h" -#include "relevance.h" -#include "eventl.h" -#include "config.h" +#include "reclists.h" +#include "pazpar2_config.h" +#include "http.h" +struct record; struct client; -struct record_metadata -{ - union - { - char *text; - struct { - int first; - int last; - } year_range; - int year; - } interpretation; -}; -struct record { - struct client *client; - char *title; - int target_offset; - char *merge_key; - struct record_metadata *md; - int relevance; - int *term_frequency_vec; - struct record *next_cluster; -}; +enum pazpar2_error_code { + PAZPAR2_NO_ERROR = 0, -struct connection; + PAZPAR2_NO_SESSION, + PAZPAR2_MISSING_PARAMETER, + PAZPAR2_MALFORMED_PARAMETER_VALUE, + PAZPAR2_MALFORMED_PARAMETER_ENCODING, + PAZPAR2_MALFORMED_SETTING, + PAZPAR2_HITCOUNTS_FAILED, + PAZPAR2_RECORD_MISSING, + PAZPAR2_NO_TARGETS, + PAZPAR2_CONFIG_TARGET, + PAZPAR2_RECORD_FAIL, + PAZPAR2_NOT_IMPLEMENTED, -// Represents a host (irrespective of databases) -struct host { - char *hostport; - char *ipport; - struct connection *connections; // All connections to this - struct host *next; + PAZPAR2_LAST_ERROR }; +struct host; // Represents a (virtual) database on a host struct database { struct host *host; char *url; char **databases; int errors; - struct conf_queryprofile *qprofile; - struct conf_retrievalprofile *rprofile; + struct zr_explain *explain; + int num_settings; + struct setting **settings; struct database *next; }; -// Represents a physical, reusable connection to a remote Z39.50 host -struct connection { - IOCHAN iochan; - COMSTACK link; - struct host *host; - struct client *client; - char *ibuf; - int ibufsize; - enum { - Conn_Connecting, - Conn_Open, - Conn_Waiting, - } state; - struct connection *next; -}; - -// Represents client state for a connection to one search target -struct client { +// Represents a database as viewed from one session, possibly with settings overriden +// for that session +struct session_database +{ struct database *database; - struct connection *connection; - struct session *session; - int hits; - int records; - int setno; - int requestid; // ID of current outstanding request - int diagnostic; - enum client_state - { - Client_Connecting, - Client_Connected, - Client_Idle, - Client_Initializing, - Client_Searching, - Client_Presenting, - Client_Error, - Client_Failed, - Client_Disconnected, - Client_Stopped - } state; - struct client *next; + int num_settings; + struct setting **settings; + normalize_record_t map; + struct session_database *next; }; -#define SESSION_WATCH_RECORDS 0 -#define SESSION_WATCH_MAX 0 +#define SESSION_WATCH_SHOW 0 +#define SESSION_WATCH_RECORD 1 +#define SESSION_WATCH_MAX 1 #define SESSION_MAX_TERMLISTS 10 @@ -121,84 +91,94 @@ struct named_termlist struct termlist *termlist; }; +struct session_watchentry { + void *data; + http_channel_observer_t obs; + session_watchfun fun; +}; + // End-user session struct session { - struct client *clients; - int requestid; - char query[1024]; - NMEM nmem; // Nmem for each operation (i.e. search) + struct conf_service *service; /* service in use for this session */ + struct session_database *databases; // All databases, settings overriden + struct client *clients; // Clients connected for current search + NMEM session_nmem; // Nmem for session-permanent storage + NMEM nmem; // Nmem for each operation (i.e. search, result set, etc) WRBUF wrbuf; // Wrbuf for scratch(i.e. search) int num_termlists; struct named_termlist termlists[SESSION_MAX_TERMLISTS]; struct relevance *relevance; struct reclist *reclist; - struct { - void *data; - session_watchfun fun; - } watchlist[SESSION_WATCH_MAX + 1]; - int expected_maxrecs; - int total_hits; + struct session_watchentry watchlist[SESSION_WATCH_MAX + 1]; + Odr_int total_hits; int total_records; + int total_merged; + int number_of_warnings_unknown_elements; + int number_of_warnings_unknown_metadata; + normalize_cache_t normalize_cache; }; struct statistics { int num_clients; int num_no_connection; int num_connecting; - int num_initializing; - int num_searching; - int num_presenting; + int num_working; int num_idle; int num_failed; int num_error; - int num_hits; + Odr_int num_hits; int num_records; }; struct hitsbytarget { - char id[256]; - int hits; + char *id; + const char *name; + Odr_int hits; int diagnostic; int records; - char* state; + const char *state; int connected; + WRBUF settings_xml; }; -struct parameters { - int dump_records; - int timeout; /* operations timeout, in seconds */ - char implementationId[128]; - char implementationName[128]; - char implementationVersion[128]; - int target_timeout; // seconds - int session_timeout; - int toget; - int chunk; - CCL_bibset ccl_filter; - yaz_marc_t yaz_marc; - ODR odr_out; - ODR odr_in; -}; - -struct hitsbytarget *hitsbytarget(struct session *s, int *count); -int select_targets(struct session *se); -struct session *new_session(); +struct hitsbytarget *hitsbytarget(struct session *s, int *count, NMEM nmem); +struct session *new_session(NMEM nmem, struct conf_service *service); void destroy_session(struct session *s); +void session_init_databases(struct session *s); int load_targets(struct session *s, const char *fn); void statistics(struct session *s, struct statistics *stat); -char *search(struct session *s, char *query); -struct record **show(struct session *s, int start, int *num, int *total, - int *sumhits, NMEM nmem_show); +enum pazpar2_error_code search(struct session *s, const char *query, + const char *startrecs, const char *maxrecs, + const char *filter, const char **addinfo); +struct record_cluster **show(struct session *s, struct reclist_sortparms *sp, int start, + int *num, int *total, Odr_int *sumhits, NMEM nmem_show); +struct record_cluster *show_single(struct session *s, const char *id, + struct record_cluster **prev_r, + struct record_cluster **next_r); struct termlist_score **termlist(struct session *s, const char *name, int *num); -void session_set_watch(struct session *s, int what, session_watchfun fun, void *data); +int session_set_watch(struct session *s, int what, session_watchfun fun, void *data, struct http_channel *c); int session_active_clients(struct session *s); +void session_apply_setting(struct session *se, char *dbname, char *setting, char *value); +const char *session_setting_oneval(struct session_database *db, int offset); + +void pazpar2_add_channel(IOCHAN c); +void pazpar2_event_loop(void); + +int host_getaddrinfo(struct host *host); + +struct record *ingest_record(struct client *cl, const char *rec, + int record_no); +void session_alert_watch(struct session *s, int what); +void pull_terms(NMEM nmem, struct ccl_rpn_node *n, char **termlist, int *num); #endif /* * Local variables: * c-basic-offset: 4 + * c-file-style: "Stroustrup" * indent-tabs-mode: nil * End: * vim: shiftwidth=4 tabstop=8 expandtab */ +