Functional settings system. At this point, they control the CCL map only
[pazpar2-moved-to-github.git] / src / pazpar2.h
1 #ifndef PAZPAR2_H
2 #define PAZPAR2_H
3
4 struct record;
5
6 #include <netdb.h>
7
8 #include <libxslt/xsltutils.h>
9 #include <libxslt/transform.h>
10
11 #include <yaz/comstack.h>
12 #include <yaz/pquery.h>
13 #include <yaz/ccl.h>
14 #include <yaz/yaz-ccl.h>
15
16 #include "termlists.h"
17 #include "relevance.h"
18 #include "reclists.h"
19 #include "eventl.h"
20 #include "config.h"
21
22 struct client;
23
24 union data_types {
25     char *text;
26     struct {
27         int min;
28         int max;
29     } number;
30 };
31
32 struct record_metadata {
33     union data_types data;
34     struct record_metadata *next; // next item of this name
35 };
36
37 struct record {
38     struct client *client;
39     struct record_metadata **metadata; // Array mirrors list of metadata fields in config
40     union data_types **sortkeys;       // Array mirrors list of sortkey fields in config
41     struct record *next;  // Next in cluster of merged records
42 };
43
44 struct record_cluster
45 {
46     struct record_metadata **metadata; // Array mirrors list of metadata fields in config
47     union data_types **sortkeys;
48     char *merge_key;
49     int relevance;
50     int *term_frequency_vec;
51     int recid; // Set-specific ID for this record
52     struct record *records;
53 };
54
55 struct connection;
56
57 // Represents a host (irrespective of databases)
58 struct host {
59     char *hostport;
60     char *ipport;
61     struct connection *connections; // All connections to this
62     struct host *next;
63 };
64
65 // Represents a (virtual) database on a host
66 struct database {
67     struct host *host;
68     char *url;
69     char *name;
70     char **databases;
71     int errors;
72     struct zr_explain *explain;
73     struct conf_retrievalprofile *rprofile;
74     struct setting **settings;
75     struct database *next;
76     CCL_bibset ccl_map;
77 };
78
79 struct database_criterion_value {
80     char *value;
81     struct database_criterion_value *next;
82 };
83
84 struct database_criterion {
85     char *name;
86     struct database_criterion_value *values;
87     struct database_criterion *next;
88 };
89
90 // Represents a physical, reusable  connection to a remote Z39.50 host
91 struct connection {
92     IOCHAN iochan;
93     COMSTACK link;
94     struct host *host;
95     struct client *client;
96     char *ibuf;
97     int ibufsize;
98     enum {
99         Conn_Connecting,
100         Conn_Open,
101         Conn_Waiting,
102     } state;
103     struct connection *next;
104 };
105
106 // Represents client state for a connection to one search target
107 struct client {
108     struct database *database;
109     struct connection *connection;
110     struct session *session;
111     int hits;
112     int records;
113     int setno;
114     int requestid;                              // ID of current outstanding request
115     int diagnostic;
116     enum client_state
117     {
118         Client_Connecting,
119         Client_Connected,
120         Client_Idle,
121         Client_Initializing,
122         Client_Searching,
123         Client_Presenting,
124         Client_Error,
125         Client_Failed,
126         Client_Disconnected,
127         Client_Stopped
128     } state;
129     struct client *next;
130 };
131
132 #define SESSION_WATCH_RECORDS   0
133 #define SESSION_WATCH_MAX       0
134
135 #define SESSION_MAX_TERMLISTS 10
136
137 typedef void (*session_watchfun)(void *data);
138
139 struct named_termlist
140 {
141     char *name;
142     struct termlist *termlist;
143 };
144
145 // End-user session
146 struct session {
147     struct client *clients;
148     int requestid; 
149     char query[1024];
150     NMEM nmem;          // Nmem for each operation (i.e. search)
151     WRBUF wrbuf;        // Wrbuf for scratch(i.e. search)
152     int num_termlists;
153     struct named_termlist termlists[SESSION_MAX_TERMLISTS];
154     struct relevance *relevance;
155     struct reclist *reclist;
156     struct {
157         void *data;
158         session_watchfun fun;
159     } watchlist[SESSION_WATCH_MAX + 1];
160     int expected_maxrecs;
161     int total_hits;
162     int total_records;
163     int total_merged;
164 };
165
166 struct statistics {
167     int num_clients;
168     int num_no_connection;
169     int num_connecting;
170     int num_initializing;
171     int num_searching;
172     int num_presenting;
173     int num_idle;
174     int num_failed;
175     int num_error;
176     int num_hits;
177     int num_records;
178 };
179
180 struct hitsbytarget {
181     char *id;
182     char *name;
183     int hits;
184     int diagnostic;
185     int records;
186     char* state;
187     int connected;
188 };
189
190 struct parameters {
191     char proxy_override[128];
192     char listener_override[128];
193     char zproxy_override[128];
194     char settings_path_override[128];
195     struct conf_server *server;
196     int dump_records;
197     int timeout;                /* operations timeout, in seconds */
198     char implementationId[128];
199     char implementationName[128];
200     char implementationVersion[128];
201     int target_timeout; // seconds
202     int session_timeout;
203     int toget;
204     int chunk;
205     yaz_marc_t yaz_marc;
206     ODR odr_out;
207     ODR odr_in;
208 };
209
210 struct hitsbytarget *hitsbytarget(struct session *s, int *count);
211 int select_targets(struct session *se, struct database_criterion *crit);
212 struct session *new_session();
213 void destroy_session(struct session *s);
214 int load_targets(struct session *s, const char *fn);
215 void statistics(struct session *s, struct statistics *stat);
216 char *search(struct session *s, char *query, char *filter);
217 struct record_cluster **show(struct session *s, struct reclist_sortparms *sp, int start,
218         int *num, int *total, int *sumhits, NMEM nmem_show);
219 struct record_cluster *show_single(struct session *s, int id);
220 struct termlist_score **termlist(struct session *s, const char *name, int *num);
221 void session_set_watch(struct session *s, int what, session_watchfun fun, void *data);
222 int session_active_clients(struct session *s);
223
224 #endif
225
226 /*
227  * Local variables:
228  * c-basic-offset: 4
229  * indent-tabs-mode: nil
230  * End:
231  * vim: shiftwidth=4 tabstop=8 expandtab
232  */