src/pazpar2_config.h

   1 /* This file is part of Pazpar2.
   2    Copyright (C) Index Data
   3
   4 Pazpar2 is free software; you can redistribute it and/or modify it under
   5 the terms of the GNU General Public License as published by the Free
   6 Software Foundation; either version 2, or (at your option) any later
   7 version.
   8
   9 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
  10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12 for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program; if not, write to the Free Software
  16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17
  18 */
  19
  20 #ifndef PAZPAR2_CONFIG_H
  21 #define PAZPAR2_CONFIG_H
  22
  23 #include "normalize_cache.h"
  24
  25 #include <yaz/nmem.h>
  26 #include <yaz/mutex.h>
  27 #include <yaz/ccl.h>
  28 #include "charsets.h"
  29 #include "http.h"
  30 #include "database.h"
  31
  32 enum conf_metadata_type {
  33     Metadata_type_generic,    // Generic text field
  34     Metadata_type_year,       // year YYYY - YYYY
  35     Metadata_type_date,       // date YYYYMMDD - YYYYMMDD
  36     Metadata_type_float,      // float number
  37     Metadata_type_skiparticle,
  38     Metadata_type_relevance,
  39     Metadata_type_position,
  40     Metadata_type_retrieval,
  41 };
  42
  43 enum conf_metadata_merge {
  44     Metadata_merge_no,        // Don't merge
  45     Metadata_merge_unique,    // Include unique elements in merged block
  46     Metadata_merge_longest,   // Include the longest (strlen) value
  47     Metadata_merge_range,     // Store value as a range of lowest-highest
  48     Metadata_merge_all,       // Just include all elements found
  49     Metadata_merge_first      // All from first target
  50 };
  51
  52 // This controls the ability to insert 'static' values from settings into retrieval recs
  53 enum conf_setting_type {
  54     Metadata_setting_no,
  55     Metadata_setting_postproc,      // Insert setting value into normalized record
  56     Metadata_setting_parameter      // Expose value to normalization stylesheets
  57 };
  58
  59 enum conf_metadata_mergekey {
  60     Metadata_mergekey_no,
  61     Metadata_mergekey_optional,
  62     Metadata_mergekey_required
  63 };
  64
  65 // Describes known metadata elements and how they are to be manipulated
  66 // An array of these structure provides a 'map' against which
  67 // discovered metadata elements are matched. It also governs storage,
  68 // to minimize number of cycles needed at various tages of processing
  69 struct conf_metadata
  70 {
  71     char *name;  // The field name. Output by normalization stylesheet
  72     int brief;   // Is this element to be returned in the brief format?
  73     int termlist;// Is this field to be treated as a termlist for browsing?
  74     const char *rank;
  75     int sortkey_offset; // -1 if it's not a sortkey, otherwise index
  76                         // into service/record_cluster->sortkey array
  77     enum conf_metadata_type type;
  78     enum conf_metadata_merge merge;
  79     enum conf_setting_type setting; // Value is to be taken from session/db settings?
  80     enum conf_metadata_mergekey mergekey;
  81     char *facetrule;
  82
  83     char *limitmap;  // Should be expanded into service-wide default e.g. pz:limitmap:<name>=value setting
  84     char *limitcluster;
  85     char *icurule;
  86 };
  87
  88
  89
  90 // Controls sorting
  91 struct conf_sortkey
  92 {
  93     char *name;
  94     enum conf_metadata_type type;
  95 };
  96
  97 struct conf_server;
  98
  99 // It is conceivable that there will eventually be several 'services'
 100 // offered from one server, with separate configuration -- possibly
 101 // more than one services associated with the same port. For now,
 102 // however, only a single service is possible.
 103 struct conf_service
 104 {
 105     YAZ_MUTEX mutex;
 106     int num_metadata;
 107     struct conf_metadata *metadata;
 108     int num_sortkeys;
 109     struct conf_sortkey *sortkeys;
 110     struct setting_dictionary *dictionary;
 111     struct settings_array *settings;
 112     struct conf_service *next;
 113     char *id;
 114     NMEM nmem;
 115     int session_timeout;
 116     int z3950_session_timeout;
 117     int z3950_operation_timeout;
 118     int rank_cluster;
 119     int rank_debug;
 120     double rank_follow;
 121     double rank_lead;
 122     int rank_length;
 123     char *default_sort;
 124
 125     int ref_count;
 126     /* duplicated from conf_server */
 127     pp2_charset_fact_t charsets;
 128
 129     struct service_xslt *xslt_list;
 130
 131     CCL_bibset ccl_bibset;
 132     struct database *databases;
 133     struct conf_server *server;
 134     char *xml_node;
 135 };
 136
 137 int conf_service_metadata_field_id(struct conf_service *service, const char * name);
 138
 139 int conf_service_sortkey_field_id(struct conf_service *service, const char * name);
 140
 141 struct conf_server
 142 {
 143     char *host;
 144     char *port;
 145     char *proxy_host;
 146     int proxy_port;
 147     char *myurl;
 148     char *settings_fname;
 149     char *server_id;
 150
 151     pp2_charset_fact_t charsets;
 152
 153     struct conf_service *service;
 154     struct conf_server *next;
 155     struct conf_config *config;
 156     http_server_t http_server;
 157     iochan_man_t iochan_man;
 158 };
 159
 160 struct conf_config *config_create(const char *fname);
 161 void config_destroy(struct conf_config *config);
 162 void config_process_events(struct conf_config *config);
 163 void info_services(struct conf_server *server, WRBUF w);
 164
 165 struct conf_service *locate_service(struct conf_server *server,
 166                                     const char *service_id);
 167
 168 struct conf_service *service_create(struct conf_server *server,
 169                                     xmlNode *node);
 170 void service_incref(struct conf_service *service);
 171 void service_destroy(struct conf_service *service);
 172
 173 int config_start_listeners(struct conf_config *conf,
 174                            const char *listener_override,
 175                            const char *record_fname);
 176
 177 void config_stop_listeners(struct conf_config *conf);
 178
 179 WRBUF conf_get_fname(struct conf_config *config, const char *fname);
 180
 181 #endif
 182
 183 /*
 184  * Local variables:
 185  * c-basic-offset: 4
 186  * c-file-style: "Stroustrup"
 187  * indent-tabs-mode: nil
 188  * End:
 189  * vim: shiftwidth=4 tabstop=8 expandtab
 190  */
 191