Made load of XSLT normalization stylesheet dynamic
[pazpar2-moved-to-github.git] / src / pazpar2.h
index 6bb709a..c962c47 100644 (file)
@@ -1,7 +1,27 @@
+/* $Id: pazpar2.h,v 1.31 2007-04-20 16:21:19 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
 
-struct record;
 
 #include <netdb.h>
 
@@ -15,21 +35,13 @@ struct record;
 
 #include "termlists.h"
 #include "relevance.h"
+#include "reclists.h"
 #include "eventl.h"
 #include "config.h"
 
+struct record;
 struct client;
 
-struct record {
-    struct client *client;
-    int target_offset;
-    char *merge_key;
-    char *title;
-    int relevance;
-    int *term_frequency_vec;
-    struct record *next_cluster;
-};
-
 struct connection;
 
 // Represents a host (irrespective of databases)
@@ -46,11 +58,21 @@ struct database {
     char *url;
     char **databases;
     int errors;
-    struct conf_queryprofile *qprofile;
-    struct conf_retrievalprofile *rprofile;
+    struct zr_explain *explain;
+    struct setting **settings;
     struct database *next;
 };
 
+struct database_criterion_value {
+    char *value;
+    struct database_criterion_value *next;
+};
+
+struct database_criterion {
+    char *name;
+    struct database_criterion_value *values;
+    struct database_criterion *next;
+};
 
 // Represents a physical, reusable  connection to a remote Z39.50 host
 struct connection {
@@ -70,9 +92,10 @@ 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;
+    char *pquery; // Current search
     int hits;
     int records;
     int setno;
@@ -94,6 +117,24 @@ struct client {
     struct client *next;
 };
 
+// Normalization filter. Turns incoming record into internal representation
+// Simple sequence of stylesheets run in series.
+struct database_retrievalmap {
+    xsltStylesheet *stylesheet;
+    struct database_retrievalmap *next;
+};
+
+// Represents a database as viewed from one session, possibly with settings overriden
+// for that session
+struct session_database
+{
+    struct database *database;
+    struct setting **settings;
+    yaz_marc_t yaz_marc;
+    struct database_retrievalmap *map;
+    struct session_database *next;
+};
+
 #define SESSION_WATCH_RECORDS   0
 #define SESSION_WATCH_MAX       0
 
@@ -109,10 +150,11 @@ struct named_termlist
 
 // 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];
@@ -125,6 +167,7 @@ struct session {
     int expected_maxrecs;
     int total_hits;
     int total_records;
+    int total_merged;
 };
 
 struct statistics {
@@ -142,7 +185,8 @@ struct statistics {
 };
 
 struct hitsbytarget {
-    char id[256];
+    char *id;
+    char *name;
     int hits;
     int diagnostic;
     int records;
@@ -151,6 +195,11 @@ struct hitsbytarget {
 };
 
 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 */
     char implementationId[128];
@@ -160,24 +209,35 @@ 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 session *new_session();
+int select_targets(struct session *se, struct database_criterion *crit);
+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);
-char *search(struct session *s, char *query);
-struct record **show(struct session *s, int start, int *num, int *total,
-                     int *sumhits, NMEM nmem_show);
+char *search(struct session *s, char *query, char *filter);
+struct record_cluster **show(struct session *s, struct reclist_sortparms *sp, int start,
+        int *num, int *total, int *sumhits, NMEM nmem_show);
+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);
+char *session_setting_oneval(struct session_database *db, int offset);
+
+void start_http_listener(void);
+void start_proxy(void);
+void start_zproxy(void);
+
+extern struct parameters global_parameters;
+void pazpar2_add_channel(IOCHAN c);
+void pazpar2_event_loop(void);
+
+
 
 #endif