7647e469f8e9e5b9fbb1c0cc25010ef86e8b47a7
[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     int errors;
61     int num_settings;
62     struct setting **settings;
63     struct database *next;
64 };
65
66
67 // Represents a database as viewed from one session, possibly with settings overriden
68 // for that session
69 struct session_database
70 {
71     struct database *database;
72     int num_settings;
73     struct setting **settings;
74     normalize_record_t map;
75     struct session_database *next;
76 };
77
78 #define SESSION_WATCH_SHOW      0
79 #define SESSION_WATCH_RECORD    1
80 #define SESSION_WATCH_SHOW_PREF 2
81 #define SESSION_WATCH_MAX       2
82
83 #define SESSION_MAX_TERMLISTS 10
84
85 typedef void (*session_watchfun)(void *data);
86
87 struct named_termlist
88 {
89     char *name;
90     struct termlist *termlist;
91 };
92
93 struct session_watchentry {
94     void *data;
95     http_channel_observer_t obs;
96     session_watchfun fun;
97 };
98
99 struct client_list;
100
101 // End-user session
102 struct session {
103     struct conf_service *service; /* service in use for this session */
104     struct session_database *databases;  // All databases, settings overriden
105     struct client_list *clients;   // Clients connected for current search
106     NMEM session_nmem;  // Nmem for session-permanent storage
107     NMEM nmem;          // Nmem for each operation (i.e. search, result set, etc)
108     int num_termlists;
109     struct named_termlist termlists[SESSION_MAX_TERMLISTS];
110     struct relevance *relevance;
111     struct reclist *reclist;
112     struct session_watchentry watchlist[SESSION_WATCH_MAX + 1];
113     Odr_int total_hits;
114     int total_records;
115     int total_merged;
116     int number_of_warnings_unknown_elements;
117     int number_of_warnings_unknown_metadata;
118     normalize_cache_t normalize_cache;
119     YAZ_MUTEX session_mutex;
120     unsigned session_id;
121 };
122
123 struct statistics {
124     int num_clients;
125     int num_no_connection;
126     int num_connecting;
127     int num_working;
128     int num_idle;
129     int num_failed;
130     int num_error;
131     Odr_int num_hits;
132     int num_records;
133 };
134
135 struct hitsbytarget {
136     char *id;
137     const char *name;
138     Odr_int hits;
139     int diagnostic;
140     int records;
141     const char *state;
142     int connected;
143     char *settings_xml;
144 };
145
146 struct hitsbytarget *get_hitsbytarget(struct session *s, int *count, NMEM nmem);
147 struct session *new_session(NMEM nmem, struct conf_service *service,
148                             unsigned session_id);
149 void destroy_session(struct session *s);
150 void session_init_databases(struct session *s);
151 int load_targets(struct session *s, const char *fn);
152 void statistics(struct session *s, struct statistics *stat);
153 enum pazpar2_error_code search(struct session *s, const char *query,
154                                const char *startrecs, const char *maxrecs,
155                                const char *filter, const char *limit,
156                                const char **addinfo);
157 struct record_cluster **show_range_start(struct session *s,
158                                          struct reclist_sortparms *sp,
159                                          int start,
160                                          int *num, int *total, Odr_int *sumhits);
161 void show_range_stop(struct session *s, struct record_cluster **recs);
162
163 struct record_cluster *show_single_start(struct session *s, const char *id,
164                                          struct record_cluster **prev_r,
165                                          struct record_cluster **next_r);
166 void show_single_stop(struct session *s, struct record_cluster *rec);
167 struct termlist_score **get_termlist_score(struct session *s,
168                                            const char *name, int *num);
169 int session_set_watch(struct session *s, int what, session_watchfun fun, void *data, struct http_channel *c);
170 int session_active_clients(struct session *s);
171 int session_is_preferred_clients_ready(struct session *s);
172 void session_apply_setting(struct session *se, char *dbname, char *setting, char *value);
173 const char *session_setting_oneval(struct session_database *db, int offset);
174
175 int host_getaddrinfo(struct host *host, iochan_man_t iochan_man);
176
177 int ingest_record(struct client *cl, const char *rec, int record_no, NMEM nmem);
178 void session_alert_watch(struct session *s, int what);
179 void add_facet(struct session *s, const char *type, const char *value, int count);
180
181 void perform_termlist(struct http_channel *c, struct session *se,
182                       const char *name, int num);
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