added optional <zproxy> element to config file, containing any of these attribute...
[pazpar2-moved-to-github.git] / src / config.h
index 53c1de6..5c2c8b1 100644 (file)
@@ -5,15 +5,59 @@
 #include <libxslt/transform.h>
 #include <libxslt/xsltutils.h>
 
-struct conf_termlist
+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
+    int brief;   // Is this element to be returned in the brief format?
+    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_number,           // A number
+        Metadata_type_year              // A number
+    } type;
+    enum
+    {
+        Metadata_merge_no,              // Don't merge
+        Metadata_merge_unique,          // Include unique elements in merged block
+        Metadata_merge_longest,         // Include the longest (strlen) value
+        Metadata_merge_range,           // Store value as a range of lowest-highest
+        Metadata_merge_all              // Just include all elements found
+    } merge;
+};
+
+// Controls sorting
+struct conf_sortkey
 {
     char *name;
-    struct conf_termlist *next;
+    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
 {
-    struct conf_termlist *termlists;
+    int num_metadata;
+    struct conf_metadata *metadata;
+    int num_sortkeys;
+    struct conf_sortkey *sortkeys;
 };
 
 struct conf_server
@@ -22,12 +66,16 @@ struct conf_server
     int port;
     char *proxy_host;
     int proxy_port;
+    char *myurl;
+    char *zproxy_host;
+    int zproxy_port;
     struct conf_service *service;
     struct conf_server *next;
 };
 
 struct conf_queryprofile
 {
+    int dummy;
 };
 
 struct conf_retrievalmap
@@ -63,10 +111,19 @@ struct conf_retrievalprofile
     struct conf_retrievalprofile *next;
 };
 
+struct conf_targetprofiles
+{
+    enum {
+        Targetprofiles_local
+    } type;
+    char *src;
+};
+
 struct conf_config
 {
     struct conf_server *servers;
     struct conf_queryprofile *queryprofiles;
+    struct conf_targetprofiles *targetprofiles;
     struct conf_retrievalprofile *retrievalprofiles;
 };