1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2013 Index Data
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
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
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
20 #ifndef PAZPAR2_SESSION_H
21 #define PAZPAR2_SESSION_H
23 #include <yaz/comstack.h>
24 #include <yaz/pquery.h>
26 #include <yaz/yaz-ccl.h>
28 #include "facet_limit.h"
29 #include "termlists.h"
37 enum pazpar2_error_code {
41 PAZPAR2_MISSING_PARAMETER,
42 PAZPAR2_MALFORMED_PARAMETER_VALUE,
43 PAZPAR2_MALFORMED_PARAMETER_ENCODING,
44 PAZPAR2_MALFORMED_SETTING,
45 PAZPAR2_HITCOUNTS_FAILED,
46 PAZPAR2_RECORD_MISSING,
48 PAZPAR2_CONFIG_TARGET,
50 PAZPAR2_NOT_IMPLEMENTED,
52 PAZPAR2_ALREADY_BLOCKED,
57 // Represents a database
61 struct setting **settings;
62 struct database *next;
66 // Represents a database as viewed from one session, possibly with settings overriden
68 struct session_database
70 struct database *database;
72 struct setting **settings;
73 normalize_record_t map;
74 struct session_database *next;
77 #define SESSION_WATCH_SHOW 0
78 #define SESSION_WATCH_RECORD 1
79 #define SESSION_WATCH_SHOW_PREF 2
80 #define SESSION_WATCH_TERMLIST 3
81 #define SESSION_WATCH_BYTARGET 4
82 #define SESSION_WATCH_MAX 4
84 #define SESSION_MAX_TERMLISTS 10
86 typedef void (*session_watchfun)(void *data);
91 struct termlist *termlist;
94 struct session_watchentry {
96 http_channel_observer_t obs;
104 struct conf_service *service; /* service in use for this session */
105 struct session_database *databases; // All databases, settings overriden
106 struct client_list *clients_active; // Clients connected for current search
107 struct client_list *clients_cached; // Clients in cache
108 NMEM session_nmem; // Nmem for session-permanent storage
109 NMEM nmem; // Nmem for each operation (i.e. search, result set, etc)
111 struct named_termlist termlists[SESSION_MAX_TERMLISTS];
112 struct relevance *relevance;
113 struct reclist *reclist;
116 struct session_watchentry watchlist[SESSION_WATCH_MAX + 1];
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;
124 int settings_modified;
125 facet_limits_t facet_limits;
126 struct reclist_sortparms *sorted_results;
131 int num_no_connection;
141 struct hitsbytarget {
145 Odr_int approximation;
154 char *suggestions_xml;
157 struct hitsbytarget *get_hitsbytarget(struct session *s, int *count, NMEM nmem);
158 struct session *new_session(NMEM nmem, struct conf_service *service,
159 unsigned session_id);
160 int sessions_count(void);
161 void session_destroy(struct session *s);
162 void session_init_databases(struct session *s);
163 void statistics(struct session *s, struct statistics *stat);
165 void session_sort(struct session *se, struct reclist_sortparms *sp,
166 const char *mergekey, const char *rank);
168 enum pazpar2_error_code session_search(struct session *s, const char *query,
169 const char *startrecs,
171 const char *filter, const char *limit,
172 const char **addinfo,
173 struct reclist_sortparms *sort_parm,
174 const char *mergekey,
176 struct record_cluster **show_range_start(struct session *s,
177 struct reclist_sortparms *sp,
179 int *num, int *total,
181 Odr_int *approximation,
182 void (*ready)(void *data),
183 struct http_channel *chan);
184 int session_fetch_more(struct session *s);
185 void show_range_stop(struct session *s, struct record_cluster **recs);
187 struct record_cluster *show_single_start(struct session *s, const char *id,
188 struct record_cluster **prev_r,
189 struct record_cluster **next_r);
190 void show_single_stop(struct session *s, struct record_cluster *rec);
191 int session_set_watch(struct session *s, int what, session_watchfun fun, void *data, struct http_channel *c);
192 int session_active_clients(struct session *s);
193 int session_is_preferred_clients_ready(struct session *s);
194 void session_apply_setting(struct session *se, char *dbname, char *setting, char *value);
195 const char *session_setting_oneval(struct session_database *db, int offset);
197 int ingest_record(struct client *cl, const char *rec, int record_no, NMEM nmem);
198 void session_alert_watch(struct session *s, int what);
199 void add_facet(struct session *s, const char *type, const char *value, int count);
201 int session_check_cluster_limit(struct session *se, struct record_cluster *rec);
203 void perform_termlist(struct http_channel *c, struct session *se, const char *name, int num, int version);
204 void session_log(struct session *s, int level, const char *fmt, ...)
206 __attribute__ ((format (printf, 3, 4)))
214 * c-file-style: "Stroustrup"
215 * indent-tabs-mode: nil
217 * vim: shiftwidth=4 tabstop=8 expandtab