1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2011 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 "termlists.h"
36 enum pazpar2_error_code {
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,
47 PAZPAR2_CONFIG_TARGET,
49 PAZPAR2_NOT_IMPLEMENTED,
51 PAZPAR2_ALREADY_BLOCKED,
56 // Represents a database
60 struct setting **settings;
61 struct database *next;
65 // Represents a database as viewed from one session, possibly with settings overriden
67 struct session_database
69 struct database *database;
71 struct setting **settings;
72 normalize_record_t map;
73 struct session_database *next;
76 #define SESSION_WATCH_SHOW 0
77 #define SESSION_WATCH_RECORD 1
78 #define SESSION_WATCH_SHOW_PREF 2
79 #define SESSION_WATCH_TERMLIST 3
80 #define SESSION_WATCH_BYTARGET 4
81 #define SESSION_WATCH_MAX 4
83 #define SESSION_MAX_TERMLISTS 10
85 typedef void (*session_watchfun)(void *data);
90 struct termlist *termlist;
93 struct session_watchentry {
95 http_channel_observer_t obs;
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)
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];
115 int number_of_warnings_unknown_elements;
116 int number_of_warnings_unknown_metadata;
117 normalize_cache_t normalize_cache;
118 YAZ_MUTEX session_mutex;
120 struct session_sorted_results *sorted_results;
125 int num_no_connection;
135 struct hitsbytarget {
144 char *suggestions_xml;
147 struct hitsbytarget *get_hitsbytarget(struct session *s, int *count, NMEM nmem);
148 struct session *new_session(NMEM nmem, struct conf_service *service,
149 unsigned session_id);
150 void destroy_session(struct session *s);
151 void session_init_databases(struct session *s);
152 void statistics(struct session *s, struct statistics *stat);
154 void session_sort(struct session *se, const char *field, int increasing);
156 enum pazpar2_error_code session_search(struct session *s, const char *query,
157 const char *startrecs,
159 const char *filter, const char *limit,
160 const char **addinfo,
161 const char *sort_field, int increasing);
162 struct record_cluster **show_range_start(struct session *s,
163 struct reclist_sortparms *sp,
165 int *num, int *total, Odr_int *sumhits);
166 void show_range_stop(struct session *s, struct record_cluster **recs);
168 struct record_cluster *show_single_start(struct session *s, const char *id,
169 struct record_cluster **prev_r,
170 struct record_cluster **next_r);
171 void show_single_stop(struct session *s, struct record_cluster *rec);
172 struct termlist_score **get_termlist_score(struct session *s,
173 const char *name, int *num);
174 int session_set_watch(struct session *s, int what, session_watchfun fun, void *data, struct http_channel *c);
175 int session_active_clients(struct session *s);
176 int session_is_preferred_clients_ready(struct session *s);
177 void session_apply_setting(struct session *se, char *dbname, char *setting, char *value);
178 const char *session_setting_oneval(struct session_database *db, int offset);
180 int ingest_record(struct client *cl, const char *rec, int record_no, NMEM nmem);
181 void session_alert_watch(struct session *s, int what);
182 void add_facet(struct session *s, const char *type, const char *value, int count);
184 void perform_termlist(struct http_channel *c, struct session *se,
185 const char *name, int num);
186 void session_log(struct session *s, int level, const char *fmt, ...)
188 __attribute__ ((format (printf, 3, 4)))
196 * c-file-style: "Stroustrup"
197 * indent-tabs-mode: nil
199 * vim: shiftwidth=4 tabstop=8 expandtab