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"
38 enum pazpar2_error_code {
42 PAZPAR2_MISSING_PARAMETER,
43 PAZPAR2_MALFORMED_PARAMETER_VALUE,
44 PAZPAR2_MALFORMED_PARAMETER_ENCODING,
45 PAZPAR2_MALFORMED_SETTING,
46 PAZPAR2_HITCOUNTS_FAILED,
47 PAZPAR2_RECORD_MISSING,
49 PAZPAR2_CONFIG_TARGET,
51 PAZPAR2_NOT_IMPLEMENTED,
53 PAZPAR2_ALREADY_BLOCKED,
58 // Represents a database
62 struct setting **settings;
63 struct database *next;
67 // Represents a database as viewed from one session, possibly with settings overriden
69 struct session_database
71 struct database *database;
73 struct setting **settings;
74 normalize_record_t map;
75 struct session_database *next;
78 #define SESSION_WATCH_SHOW 0
79 #define SESSION_WATCH_RECORD 1
80 #define SESSION_WATCH_SHOW_PREF 2
81 #define SESSION_WATCH_TERMLIST 3
82 #define SESSION_WATCH_BYTARGET 4
83 #define SESSION_WATCH_MAX 4
85 #define SESSION_MAX_TERMLISTS 10
87 typedef void (*session_watchfun)(void *data);
92 struct termlist *termlist;
95 struct session_watchentry {
97 http_channel_observer_t obs;
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_active; // Clients connected for current search
108 struct client_list *clients_cached; // Clients in cache
109 NMEM session_nmem; // Nmem for session-permanent storage
110 NMEM nmem; // Nmem for each operation (i.e. search, result set, etc)
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];
118 int number_of_warnings_unknown_elements;
119 int number_of_warnings_unknown_metadata;
120 normalize_cache_t normalize_cache;
121 Pazpar2_lock_rdwr lock;
123 int settings_modified;
124 facet_limits_t facet_limits;
125 struct reclist_sortparms *sorted_results;
130 int num_no_connection;
140 struct hitsbytarget {
144 Odr_int approximation;
153 char *suggestions_xml;
156 struct hitsbytarget *get_hitsbytarget(struct session *s, int *count, NMEM nmem);
157 struct session *session_create(NMEM nmem, struct conf_service *service,
158 unsigned session_id);
159 void session_destroy(struct session *s);
160 void session_init_databases(struct session *s);
161 void statistics(struct session *s, struct statistics *stat);
163 void session_sort(struct session *se, struct reclist_sortparms *sp);
165 enum pazpar2_error_code session_search(struct session *s, const char *query,
166 const char *startrecs,
168 const char *filter, const char *limit,
169 const char **addinfo,
170 struct reclist_sortparms *sort_parm);
171 struct record_cluster **show_range_start(struct session *s,
172 struct reclist_sortparms *sp,
174 int *num, int *total, Odr_int *sumhits, Odr_int *approximation);
175 void show_range_stop(struct session *s, struct record_cluster **recs);
177 struct record_cluster *show_single_start(struct session *s, const char *id,
178 struct record_cluster **prev_r,
179 struct record_cluster **next_r);
180 void show_single_stop(struct session *s, struct record_cluster *rec);
181 int session_set_watch(struct session *s, int what, session_watchfun fun, void *data, struct http_channel *c);
182 int session_active_clients(struct session *s);
183 int session_is_preferred_clients_ready(struct session *s);
184 void session_apply_setting(struct session *se, char *dbname, char *setting, char *value);
185 const char *session_setting_oneval(struct session_database *db, int offset);
187 int ingest_record(struct client *cl, const char *rec, int record_no, NMEM nmem);
188 void session_alert_watch(struct session *s, int what);
189 void add_facet(struct session *s, const char *type, const char *value, int count);
191 int session_check_cluster_limit(struct session *se, struct record_cluster *rec);
193 void perform_termlist(struct http_channel *c, struct session *se, const char *name, int num, int version);
195 void session_enter_ro(struct session *s, const char *caller);
196 void session_leave_ro(struct session *s, const char *caller);
198 void session_enter_rw(struct session *s, const char *caller);
199 void session_leave_rw(struct session *s, const char *caller);
201 void session_log(struct session *s, int level, const char *fmt, ...)
203 __attribute__ ((format (printf, 3, 4)))
211 * c-file-style: "Stroustrup"
212 * indent-tabs-mode: nil
214 * vim: shiftwidth=4 tabstop=8 expandtab