6f43d695d8dbf654428cfcef39f580c81e43e887
[pazpar2-moved-to-github.git] / src / session.h
1 /* This file is part of Pazpar2.
2    Copyright (C) 2006-2011 Index Data
3
4 Pazpar2 is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
7 version.
8
9 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
12 for more details.
13
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17
18 */
19
20 #ifndef PAZPAR2_SESSION_H
21 #define PAZPAR2_SESSION_H
22
23 #include <yaz/comstack.h>
24 #include <yaz/pquery.h>
25 #include <yaz/ccl.h>
26 #include <yaz/yaz-ccl.h>
27
28 #include "termlists.h"
29 #include "reclists.h"
30 #include "http.h"
31
32 struct record;
33 struct client;
34
35
36 enum pazpar2_error_code {
37     PAZPAR2_NO_ERROR = 0,
38
39     PAZPAR2_NO_SESSION,
40     PAZPAR2_MISSING_PARAMETER,
41     PAZPAR2_MALFORMED_PARAMETER_VALUE,
42     PAZPAR2_MALFORMED_PARAMETER_ENCODING,
43     PAZPAR2_MALFORMED_SETTING,
44     PAZPAR2_HITCOUNTS_FAILED,
45     PAZPAR2_RECORD_MISSING,
46     PAZPAR2_NO_TARGETS,
47     PAZPAR2_CONFIG_TARGET,
48     PAZPAR2_RECORD_FAIL,
49     PAZPAR2_NOT_IMPLEMENTED,
50     PAZPAR2_NO_SERVICE,
51
52     PAZPAR2_LAST_ERROR
53 };
54
55 struct host;
56 // Represents a (virtual) database on a host
57 struct database {
58     struct host *host;
59     char *url;
60     char **databases;
61     int errors;
62     struct zr_explain *explain;
63     int num_settings;
64     struct setting **settings;
65     struct database *next;
66 };
67
68
69 // Represents a database as viewed from one session, possibly with settings overriden
70 // for that session
71 struct session_database
72 {
73     struct database *database;
74     int num_settings;
75     struct setting **settings;
76     normalize_record_t map;
77     struct session_database *next;
78 };
79
80 #define SESSION_WATCH_SHOW      0
81 #define SESSION_WATCH_RECORD    1
82 #define SESSION_WATCH_SHOW_PREF 2
83 #define SESSION_WATCH_MAX       2
84
85 #define SESSION_MAX_TERMLISTS 10
86
87 typedef void (*session_watchfun)(void *data);
88
89 struct named_termlist
90 {
91     char *name;
92     struct termlist *termlist;
93 };
94
95 struct session_watchentry {
96     void *data;
97     http_channel_observer_t obs;
98     session_watchfun fun;
99 };
100
101 struct client_list;
102
103 // End-user session
104 struct session {
105     struct conf_service *service; /* service in use for this session */
106     struct session_database *databases;  // All databases, settings overriden
107     struct client_list *clients;   // Clients connected for current search
108     NMEM session_nmem;  // Nmem for session-permanent storage
109     NMEM nmem;          // Nmem for each operation (i.e. search, result set, etc)
110     WRBUF wrbuf;        // Wrbuf for scratch(i.e. search)
111     int num_termlists;
112     struct named_termlist termlists[SESSION_MAX_TERMLISTS];
113     struct relevance *relevance;
114     struct reclist *reclist;
115     struct session_watchentry watchlist[SESSION_WATCH_MAX + 1];
116     Odr_int total_hits;
117     int total_records;
118     int total_merged;
119     int number_of_warnings_unknown_elements;
120     int number_of_warnings_unknown_metadata;
121     normalize_cache_t normalize_cache;
122     YAZ_MUTEX session_mutex;
123     unsigned session_id;
124 };
125
126 struct statistics {
127     int num_clients;
128     int num_no_connection;
129     int num_connecting;
130     int num_working;
131     int num_idle;
132     int num_failed;
133     int num_error;
134     Odr_int num_hits;
135     int num_records;
136 };
137
138 struct hitsbytarget {
139     char *id;
140     const char *name;
141     Odr_int hits;
142     int diagnostic;
143     int records;
144     const char *state;
145     int connected;
146     WRBUF settings_xml;
147 };
148
149 struct hitsbytarget *hitsbytarget(struct session *s, int *count, NMEM nmem);
150 struct session *new_session(NMEM nmem, struct conf_service *service,
151                             unsigned session_id);
152 void destroy_session(struct session *s);
153 void session_init_databases(struct session *s);
154 int load_targets(struct session *s, const char *fn);
155 void statistics(struct session *s, struct statistics *stat);
156 enum pazpar2_error_code search(struct session *s, const char *query,
157                                const char *startrecs, const char *maxrecs,
158                                const char *filter, const char **addinfo);
159 struct record_cluster **show_range_start(struct session *s,
160                                          struct reclist_sortparms *sp,
161                                          int start,
162                                          int *num, int *total, Odr_int *sumhits);
163 void show_range_stop(struct session *s, struct record_cluster **recs);
164
165 struct record_cluster *show_single_start(struct session *s, const char *id,
166                                          struct record_cluster **prev_r,
167                                          struct record_cluster **next_r);
168 void show_single_stop(struct session *s, struct record_cluster *rec);
169 struct termlist_score **termlist(struct session *s, const char *name, int *num);
170 int session_set_watch(struct session *s, int what, session_watchfun fun, void *data, struct http_channel *c);
171 int session_active_clients(struct session *s);
172 int session_is_preferred_clients_ready(struct session *s);
173 void session_apply_setting(struct session *se, char *dbname, char *setting, char *value);
174 const char *session_setting_oneval(struct session_database *db, int offset);
175
176 int host_getaddrinfo(struct host *host, iochan_man_t iochan_man);
177
178 int ingest_record(struct client *cl, const char *rec, int record_no, NMEM nmem);
179 void session_alert_watch(struct session *s, int what);
180 void pull_terms(NMEM nmem, struct ccl_rpn_node *n, char **termlist, int *num);
181
182 void add_facet(struct session *s, const char *type, const char *value, int count);
183 void session_log(struct session *s, int level, const char *fmt, ...)
184 #ifdef __GNUC__
185     __attribute__ ((format (printf, 3, 4)))
186 #endif
187     ;
188 #endif
189
190 /*
191  * Local variables:
192  * c-basic-offset: 4
193  * c-file-style: "Stroustrup"
194  * indent-tabs-mode: nil
195  * End:
196  * vim: shiftwidth=4 tabstop=8 expandtab
197  */
198