Big update. Introduced session-specific settings. These can be supplied
[pazpar2-moved-to-github.git] / src / pazpar2.h
index a66956e..85360a7 100644 (file)
@@ -1,3 +1,24 @@
+/* $Id: pazpar2.h,v 1.22 2007-04-11 02:14:15 quinn Exp $
+   Copyright (c) 2006-2007, Index Data.
+
+This file is part of Pazpar2.
+
+Pazpar2 is free software; you can redistribute it and/or modify it under
+the terms of the GNU General Public License as published by the Free
+Software Foundation; either version 2, or (at your option) any later
+version.
+
+Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
+WARRANTY; without even the implied warranty of MERCHANTABILITY or
+FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+for more details.
+
+You should have received a copy of the GNU General Public License
+along with Pazpar2; see the file LICENSE.  If not, write to the
+Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
+02111-1307, USA.
+ */
+
 #ifndef PAZPAR2_H
 #define PAZPAR2_H
 
@@ -70,9 +91,18 @@ struct database {
     char **databases;
     int errors;
     struct zr_explain *explain;
-    struct conf_queryprofile *qprofile;
-    struct conf_retrievalprofile *rprofile;
+    struct setting **settings;
     struct database *next;
+    CCL_bibset ccl_map;
+    yaz_marc_t yaz_marc;
+    struct database_retrievalmap *map;
+};
+
+// Normalization filter. Turns incoming record into internal representation
+// Simple sequence of stylesheets run in series.
+struct database_retrievalmap {
+    xsltStylesheet *stylesheet;
+    struct database_retrievalmap *next;
 };
 
 struct database_criterion_value {
@@ -104,7 +134,7 @@ struct connection {
 
 // Represents client state for a connection to one search target
 struct client {
-    struct database *database;
+    struct session_database *database;
     struct connection *connection;
     struct session *session;
     int hits;
@@ -141,12 +171,23 @@ struct named_termlist
     struct termlist *termlist;
 };
 
+// Represents a database as viewed from one session, possibly with settings overriden
+// for that session (to support authorization/authentication)
+struct session_database
+{
+    struct database *database;
+    struct setting **settings;
+    struct session_database *next;
+};
+
 // End-user session
 struct session {
-    struct client *clients;
+    struct session_database *databases;  // All databases, settings overriden
+    struct client *clients;              // Clients connected for current search
     int requestid; 
     char query[1024];
-    NMEM nmem;          // Nmem for each operation (i.e. search)
+    NMEM session_nmem;  // Nmem for session-permanent storage
+    NMEM nmem;          // Nmem for each operation (i.e. search, result set, etc)
     WRBUF wrbuf;        // Wrbuf for scratch(i.e. search)
     int num_termlists;
     struct named_termlist termlists[SESSION_MAX_TERMLISTS];
@@ -190,6 +231,7 @@ struct parameters {
     char proxy_override[128];
     char listener_override[128];
     char zproxy_override[128];
+    char settings_path_override[128];
     struct conf_server *server;
     int dump_records;
     int timeout;               /* operations timeout, in seconds */
@@ -200,15 +242,13 @@ struct parameters {
     int session_timeout;
     int toget;
     int chunk;
-    CCL_bibset ccl_filter;
-    yaz_marc_t yaz_marc;
     ODR odr_out;
     ODR odr_in;
 };
 
 struct hitsbytarget *hitsbytarget(struct session *s, int *count);
 int select_targets(struct session *se, struct database_criterion *crit);
-struct session *new_session();
+struct session *new_session(NMEM nmem);
 void destroy_session(struct session *s);
 int load_targets(struct session *s, const char *fn);
 void statistics(struct session *s, struct statistics *stat);
@@ -219,6 +259,7 @@ struct record_cluster *show_single(struct session *s, int id);
 struct termlist_score **termlist(struct session *s, const char *name, int *num);
 void session_set_watch(struct session *s, int what, session_watchfun fun, void *data);
 int session_active_clients(struct session *s);
+void session_apply_setting(struct session *se, char *dbname, char *setting, char *value);
 
 #endif