Happy new year
[pazpar2-moved-to-github.git] / src / pazpar2_config.h
index fbfe5c6..00612a1 100644 (file)
@@ -1,5 +1,5 @@
 /* This file is part of Pazpar2.
-   Copyright (C) 2006-2009 Index Data
+   Copyright (C) Index Data
 
 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
@@ -20,18 +20,24 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 #ifndef PAZPAR2_CONFIG_H
 #define PAZPAR2_CONFIG_H
 
-#include <libxslt/xslt.h>
-#include <libxslt/transform.h>
-#include <libxslt/xsltutils.h>
+#include "normalize_cache.h"
 
 #include <yaz/nmem.h>
+#include <yaz/mutex.h>
+#include <yaz/ccl.h>
 #include "charsets.h"
+#include "http.h"
+#include "database.h"
 
 enum conf_metadata_type {
     Metadata_type_generic,    // Generic text field
-    Metadata_type_number,     // A number
-    Metadata_type_year,        // A number
-    Metadata_type_date        // A number
+    Metadata_type_year,       // year YYYY - YYYY
+    Metadata_type_date,       // date YYYYMMDD - YYYYMMDD
+    Metadata_type_float,      // float number
+    Metadata_type_skiparticle,
+    Metadata_type_relevance,
+    Metadata_type_position,
+    Metadata_type_retrieval,
 };
 
 enum conf_metadata_merge {
@@ -39,14 +45,8 @@ enum conf_metadata_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
-};
-
-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
+    Metadata_merge_all,       // Just include all elements found
+    Metadata_merge_first      // All from first target
 };
 
 // This controls the ability to insert 'static' values from settings into retrieval recs
@@ -58,27 +58,31 @@ enum conf_setting_type {
 
 enum conf_metadata_mergekey {
     Metadata_mergekey_no,
-    Metadata_mergekey_yes
+    Metadata_mergekey_optional,
+    Metadata_mergekey_required
 };
 
 // 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 
+struct conf_metadata
 {
     char *name;  // The field name. 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
+    const char *rank;
     int sortkey_offset; // -1 if it's not a sortkey, otherwise index
                         // into service/record_cluster->sortkey array
     enum conf_metadata_type type;
     enum conf_metadata_merge merge;
     enum conf_setting_type setting; // Value is to be taken from session/db settings?
-    enum conf_metadata_type mergekey;
+    enum conf_metadata_mergekey mergekey;
+    char *facetrule;
+
+    char *limitmap;  // Should be expanded into service-wide default e.g. pz:limitmap:<name>=value setting
+    char *limitcluster;
+    char *icurule;
 };
 
 
@@ -87,93 +91,92 @@ struct conf_metadata
 struct conf_sortkey
 {
     char *name;
-    enum conf_sortkey_type type;
+    enum conf_metadata_type type;
 };
 
+struct conf_server;
+
 // 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
 {
+    YAZ_MUTEX mutex;
     int num_metadata;
     struct conf_metadata *metadata;
     int num_sortkeys;
     struct conf_sortkey *sortkeys;
     struct setting_dictionary *dictionary;
+    struct settings_array *settings;
     struct conf_service *next;
     char *id;
     NMEM nmem;
+    int session_timeout;
+    int z3950_session_timeout;
+    int z3950_operation_timeout;
+    int rank_cluster;
+    int rank_debug;
+    double rank_follow;
+    double rank_lead;
+    int rank_length;
+    char *default_sort;
+
+    int ref_count;
+    /* duplicated from conf_server */
+    pp2_charset_fact_t charsets;
+
+    struct service_xslt *xslt_list;
+
+    CCL_bibset ccl_bibset;
+    struct database *databases;
+    struct conf_server *server;
+    char *xml_node;
 };
 
-struct conf_service * conf_service_create(int num_metadata, int num_sortkeys,
-    const char *service_id);
-
-struct conf_metadata* conf_service_add_metadata(struct conf_service *service,
-                                                int field_id,
-                                                const char *name,
-                                                enum conf_metadata_type type,
-                                                enum conf_metadata_merge merge,
-                                                enum conf_setting_type setting,
-                                                int brief,
-                                                int termlist,
-                                                int rank,
-                                                int sortkey_offset,
-                                                enum conf_metadata_mergekey mt);
-
-struct conf_sortkey * conf_service_add_sortkey(struct conf_service *service,
-                                               int field_id,
-                                               const char *name,
-                                               enum conf_sortkey_type type);
-
-
 int conf_service_metadata_field_id(struct conf_service *service, const char * name);
 
 int conf_service_sortkey_field_id(struct conf_service *service, const char * name);
 
-
-struct conf_service *locate_service(const char *service_id);
-
 struct conf_server
 {
     char *host;
-    int port;
+    char *port;
     char *proxy_host;
     int proxy_port;
     char *myurl;
-    char *settings;
+    char *settings_fname;
+    char *server_id;
 
-    pp2_charset_t relevance_pct;
-    pp2_charset_t sort_pct;
-    pp2_charset_t mergekey_pct;
+    pp2_charset_fact_t charsets;
 
     struct conf_service *service;
     struct conf_server *next;
+    struct conf_config *config;
+    http_server_t http_server;
+    iochan_man_t iochan_man;
 };
 
-struct conf_targetprofiles
-{
-    enum {
-        Targetprofiles_local
-    } type;
-    char *src;
-};
+struct conf_config *config_create(const char *fname);
+void config_destroy(struct conf_config *config);
+void config_process_events(struct conf_config *config);
+void info_services(struct conf_server *server, WRBUF w);
 
-struct conf_config
-{
-    NMEM nmem;
-    struct conf_server *servers;
-    struct conf_targetprofiles *targetprofiles;
-};
+struct conf_service *locate_service(struct conf_server *server,
+                                    const char *service_id);
 
-#ifndef CONFIG_NOEXTERNS
+struct conf_service *service_create(struct conf_server *server,
+                                    xmlNode *node);
+void service_incref(struct conf_service *service);
+void service_destroy(struct conf_service *service);
 
-extern struct conf_config *config;
+int config_start_listeners(struct conf_config *conf,
+                           const char *listener_override,
+                           const char *record_fname);
 
-#endif
+void config_stop_listeners(struct conf_config *conf);
 
-int read_config(const char *fname);
-xsltStylesheet *conf_load_stylesheet(const char *fname);
+WRBUF conf_get_fname(struct conf_config *config, const char *fname);
 
 #endif