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

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

diff --git a/src/config.h b/src/config.h
index 3077451..8648b1d 100644 (file)
--- a/src/config.h
+++ b/src/config.h
@@ -1,3 +1,24 @@
+/* $Id: config.h,v 1.16 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 CONFIG_H
 #define CONFIG_H
 
@@ -5,7 +26,18 @@
 #include <libxslt/transform.h>
 #include <libxslt/xsltutils.h>
 
+enum conf_sortkey_type
+{
+    Metadata_sortkey_relevance,
+    Metadata_sortkey_numeric,       // Standard numerical sorting
+    Metadata_sortkey_skiparticle,   // Skip leading article when sorting
+    Metadata_sortkey_string         // Flat string
+};
+
 // Describes known metadata elements and how they are to be manipulated
+// An array of these structure provides a 'map' against which discovered metadata
+// elements are matched. It also governs storage, to minimize number of cycles needed
+// at various tages of processing
 struct conf_metadata 
 {
     char *name;  // The name of this element. Output by normalization stylesheet
@@ -13,22 +45,16 @@ struct conf_metadata
     int termlist;// Is this field to be treated as a termlist for browsing?
     int rank;    // Rank factor. 0 means don't use this field for ranking, 1 is default
                  // values >1  give additional significance to a field
+    int sortkey_offset; // -1 if it's not a sortkey, otherwise index
+                        // into service/record_cluster->sortkey array
     enum
     {
         Metadata_type_generic,          // Generic text field
-        Metadata_type_integer,          // Integer type
-        Metadata_type_year              // A year
+        Metadata_type_number,           // A number
+        Metadata_type_year              // A number
     } type;
     enum
     {
-        Metadata_sortkey_no,            // This is not to be used as a sortkey
-        Metadata_sortkey_numeric,       // Standard numerical sorting
-        Metadata_sortkey_range,         // Range sorting (pick lowest or highest)
-        Metadata_sortkey_skiparticle,   // Skip leading article when sorting
-        Metadata_sortkey_string
-    } sortkey;
-    enum
-    {
         Metadata_merge_no,              // Don't merge
         Metadata_merge_unique,          // Include unique elements in merged block
         Metadata_merge_longest,         // Include the longest (strlen) value
@@ -37,10 +63,22 @@ struct conf_metadata
     } merge;
 };
 
+// Controls sorting
+struct conf_sortkey
+{
+    char *name;
+    enum conf_sortkey_type type;
+};
+
+// It is conceivable that there will eventually be several 'services' offered
+// from one server, with separate configuration -- possibly more than one services
+// associated with the same port. For now, however, only a single service is possible.
 struct conf_service
 {
     int num_metadata;
     struct conf_metadata *metadata;
+    int num_sortkeys;
+    struct conf_sortkey *sortkeys;
 };
 
 struct conf_server
@@ -49,53 +87,26 @@ struct conf_server
     int port;
     char *proxy_host;
     int proxy_port;
+    char *myurl;
+    char *zproxy_host;
+    int zproxy_port;
+    char *settings;
     struct conf_service *service;
     struct conf_server *next;
 };
 
-struct conf_queryprofile
-{
-    int dummy;
-};
-
-struct conf_retrievalmap
+struct conf_targetprofiles
 {
     enum {
-        Map_xslt
+        Targetprofiles_local
     } type;
-    char *charset;
-    char *format;
-    xsltStylesheet *stylesheet;
-    struct conf_retrievalmap *next;
-};
-
-struct conf_retrievalprofile
-{
-    char *requestsyntax;
-    enum {
-        Nativesyn_xml,
-        Nativesyn_iso2709
-    } native_syntax;
-    enum {
-        Nativeform_na,
-        Nativeform_marc21,
-    } native_format;
-    char *native_encoding;
-    enum {
-        Nativemapto_na,
-        Nativemapto_marcxml,
-        Nativemapto_marcxchange
-    } native_mapto;
-    yaz_marc_t yaz_marc;
-    struct conf_retrievalmap *maplist;
-    struct conf_retrievalprofile *next;
+    char *src;
 };
 
 struct conf_config
 {
     struct conf_server *servers;
-    struct conf_queryprofile *queryprofiles;
-    struct conf_retrievalprofile *retrievalprofiles;
+    struct conf_targetprofiles *targetprofiles;
 };
 
 #ifndef CONFIG_NOEXTERNS
@@ -105,6 +116,7 @@ extern struct conf_config *config;
 #endif
 
 int read_config(const char *fname);
+xsltStylesheet *conf_load_stylesheet(const char *fname);
 
 #endif