GPLv2. Added appendix with full license. Added refernece to that from

[pazpar2-moved-to-github.git] / src / pazpar2.h

diff --git a/src/pazpar2.h b/src/pazpar2.h
index 4ee4c0f..78862fb 100644 (file)
--- a/src/pazpar2.h
+++ b/src/pazpar2.h
@@ -1,3 +1,24 @@
+/* $Id: pazpar2.h,v 1.21 2007-04-10 08:48:56 adam 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
 
@@ -15,33 +36,41 @@ struct record;
 
 #include "termlists.h"
 #include "relevance.h"
+#include "reclists.h"
 #include "eventl.h"
 #include "config.h"
 
 struct client;
 
-struct record_metadata
-{
-    union
-    {
-        char *text;
-        struct {
-            int first;
-            int last;
-        } year_range;
-        int year;
-    } interpretation;
+union data_types {
+    char *text;
+    struct {
+        int min;
+        int max;
+    } number;
+};
+
+struct record_metadata {
+    union data_types data;
+    struct record_metadata *next; // next item of this name
 };
 
 struct record {
     struct client *client;
-    char *title;
-    int target_offset;
+    struct record_metadata **metadata; // Array mirrors list of metadata fields in config
+    union data_types **sortkeys;       // Array mirrors list of sortkey fields in config
+    struct record *next;  // Next in cluster of merged records
+};
+
+struct record_cluster
+{
+    struct record_metadata **metadata; // Array mirrors list of metadata fields in config
+    union data_types **sortkeys;
     char *merge_key;
-    struct record_metadata *md;
     int relevance;
     int *term_frequency_vec;
-    struct record *next_cluster;
+    int recid; // Set-specific ID for this record
+    struct record *records;
 };
 
 struct connection;
@@ -58,13 +87,33 @@ struct host {
 struct database {
     struct host *host;
     char *url;
+    char *name;
     char **databases;
     int errors;
-    struct conf_queryprofile *qprofile;
-    struct conf_retrievalprofile *rprofile;
+    struct zr_explain *explain;
+    struct setting **settings;
     struct database *next;
+    CCL_bibset ccl_map;
+    yaz_marc_t yaz_marc;
+    struct database_retrievalmap *map;
+};
+
+// Normalization filter chain. Turns incoming record into internal representation
+struct database_retrievalmap {
+    xsltStylesheet *stylesheet;
+    struct database_retrievalmap *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 {
@@ -121,12 +170,22 @@ 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;
     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];
@@ -139,6 +198,7 @@ struct session {
     int expected_maxrecs;
     int total_hits;
     int total_records;
+    int total_merged;
 };
 
 struct statistics {
@@ -156,7 +216,8 @@ struct statistics {
 };
 
 struct hitsbytarget {
-    char id[256];
+    char *id;
+    char *name;
     int hits;
     int diagnostic;
     int records;
@@ -165,6 +226,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];
@@ -174,21 +240,20 @@ 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);