src/pazpar2_config.h

   1 /* This file is part of Pazpar2.
   2    Copyright (C) 2006-2009 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 <libxslt/xslt.h>
  24 #include <libxslt/transform.h>
  25 #include <libxslt/xsltutils.h>
  26
  27 #include <yaz/nmem.h>
  28 #include "charsets.h"
  29
  30 enum conf_metadata_type {
  31     Metadata_type_generic,    // Generic text field
  32     Metadata_type_number,     // A number
  33     Metadata_type_year,        // A number
  34     Metadata_type_date        // A number
  35 };
  36
  37 enum conf_metadata_merge {
  38     Metadata_merge_no,        // Don't merge
  39     Metadata_merge_unique,    // Include unique elements in merged block
  40     Metadata_merge_longest,   // Include the longest (strlen) value
  41     Metadata_merge_range,     // Store value as a range of lowest-highest
  42     Metadata_merge_all        // Just include all elements found
  43 };
  44
  45 enum conf_sortkey_type {
  46     Metadata_sortkey_relevance,
  47     Metadata_sortkey_numeric,       // Standard numerical sorting
  48     Metadata_sortkey_skiparticle,   // Skip leading article when sorting
  49     Metadata_sortkey_string         // Flat string
  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_yes
  62 };
  63
  64 // Describes known metadata elements and how they are to be manipulated
  65 // An array of these structure provides a 'map' against which
  66 // discovered metadata elements are matched. It also governs storage,
  67 // to minimize number of cycles needed at various tages of processing
  68 struct conf_metadata
  69 {
  70     char *name;  // The field name. Output by normalization stylesheet
  71     int brief;   // Is this element to be returned in the brief format?
  72     int termlist;// Is this field to be treated as a termlist for browsing?
  73     int rank;    // Rank factor. 0 means don't use this field for ranking,
  74                  // 1 is default
  75                  // values >1  give additional significance to a field
  76     int sortkey_offset; // -1 if it's not a sortkey, otherwise index
  77                         // into service/record_cluster->sortkey array
  78     enum conf_metadata_type type;
  79     enum conf_metadata_merge merge;
  80     enum conf_setting_type setting; // Value is to be taken from session/db settings?
  81     enum conf_metadata_type mergekey;
  82 };
  83
  84
  85
  86 // Controls sorting
  87 struct conf_sortkey
  88 {
  89     char *name;
  90     enum conf_sortkey_type type;
  91 };
  92
  93 // It is conceivable that there will eventually be several 'services'
  94 // offered from one server, with separate configuration -- possibly
  95 // more than one services associated with the same port. For now,
  96 // however, only a single service is possible.
  97 struct conf_service
  98 {
  99     int num_metadata;
 100     struct conf_metadata *metadata;
 101     int num_sortkeys;
 102     struct conf_sortkey *sortkeys;
 103     struct setting_dictionary *dictionary;
 104     struct conf_service *next;
 105     char *id;
 106     char *settings;
 107     NMEM nmem;
 108
 109     /* duplicated from conf_server */
 110     pp2_charset_t relevance_pct;
 111     pp2_charset_t sort_pct;
 112     pp2_charset_t mergekey_pct;
 113
 114
 115     struct database *databases;
 116 };
 117
 118 struct conf_service * conf_service_create(int num_metadata, int num_sortkeys,
 119     const char *service_id);
 120
 121 struct conf_metadata* conf_service_add_metadata(struct conf_service *service,
 122                                                 int field_id,
 123                                                 const char *name,
 124                                                 enum conf_metadata_type type,
 125                                                 enum conf_metadata_merge merge,
 126                                                 enum conf_setting_type setting,
 127                                                 int brief,
 128                                                 int termlist,
 129                                                 int rank,
 130                                                 int sortkey_offset,
 131                                                 enum conf_metadata_mergekey mt);
 132
 133 struct conf_sortkey * conf_service_add_sortkey(struct conf_service *service,
 134                                                int field_id,
 135                                                const char *name,
 136                                                enum conf_sortkey_type type);
 137
 138
 139 int conf_service_metadata_field_id(struct conf_service *service, const char * name);
 140
 141 int conf_service_sortkey_field_id(struct conf_service *service, const char * name);
 142
 143
 144 struct conf_server
 145 {
 146     char *host;
 147     int port;
 148     char *proxy_host;
 149     int proxy_port;
 150     char *myurl;
 151     char *server_settings;
 152
 153     pp2_charset_t relevance_pct;
 154     pp2_charset_t sort_pct;
 155     pp2_charset_t mergekey_pct;
 156
 157     struct conf_service *service;
 158     struct conf_server *next;
 159 };
 160
 161 struct conf_targetprofiles
 162 {
 163     enum {
 164         Targetprofiles_local
 165     } type;
 166     char *src;
 167 };
 168
 169 struct conf_config
 170 {
 171     NMEM nmem;
 172     struct conf_server *servers;
 173     struct conf_targetprofiles *targetprofiles;
 174 };
 175
 176 struct conf_config *read_config(const char *fname);
 177 xsltStylesheet *conf_load_stylesheet(const char *fname);
 178
 179 void config_read_settings(struct conf_config *config,
 180                           const char *path_override);
 181
 182 struct conf_service *locate_service(struct conf_server *server,
 183                                     const char *service_id);
 184
 185
 186 #endif
 187
 188 /*
 189  * Local variables:
 190  * c-basic-offset: 4
 191  * c-file-style: "Stroustrup"
 192  * indent-tabs-mode: nil
 193  * End:
 194  * vim: shiftwidth=4 tabstop=8 expandtab
 195  */
 196