src/config.h

   1 /* $Id: config.h,v 1.18 2007-04-19 11:57:53 marc Exp $
   2    Copyright (c) 2006-2007, Index Data.
   3
   4 This file is part of Pazpar2.
   5
   6 Pazpar2 is free software; you can redistribute it and/or modify it under
   7 the terms of the GNU General Public License as published by the Free
   8 Software Foundation; either version 2, or (at your option) any later
   9 version.
  10
  11 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
  12 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  13 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  14 for more details.
  15
  16 You should have received a copy of the GNU General Public License
  17 along with Pazpar2; see the file LICENSE.  If not, write to the
  18 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  19 02111-1307, USA.
  20  */
  21
  22 #ifndef CONFIG_H
  23 #define CONFIG_H
  24
  25 #include <libxslt/xslt.h>
  26 #include <libxslt/transform.h>
  27 #include <libxslt/xsltutils.h>
  28
  29 enum conf_sortkey_type
  30 {
  31     Metadata_sortkey_relevance,
  32     Metadata_sortkey_numeric,       // Standard numerical sorting
  33     Metadata_sortkey_skiparticle,   // Skip leading article when sorting
  34     Metadata_sortkey_string         // Flat string
  35 };
  36
  37 enum conf_metadata_type
  38     {
  39         Metadata_type_generic,    // Generic text field
  40         Metadata_type_number,     // A number
  41         Metadata_type_year        // A number
  42     };
  43
  44 enum conf_metadata_merge
  45     {
  46         Metadata_merge_no,        // Don't merge
  47         Metadata_merge_unique,    // Include unique elements in merged block
  48         Metadata_merge_longest,   // Include the longest (strlen) value
  49         Metadata_merge_range,     // Store value as a range of lowest-highest
  50         Metadata_merge_all        // Just include all elements found
  51     };
  52
  53
  54 // Describes known metadata elements and how they are to be manipulated
  55 // An array of these structure provides a 'map' against which
  56 // discovered metadata elements are matched. It also governs storage,
  57 // to minimize number of cycles needed at various tages of processing
  58 struct conf_metadata
  59 {
  60     char *name;  // The field name. Output by normalization stylesheet
  61     int brief;   // Is this element to be returned in the brief format?
  62     int termlist;// Is this field to be treated as a termlist for browsing?
  63     int rank;    // Rank factor. 0 means don't use this field for ranking,
  64                  // 1 is default
  65                  // values >1  give additional significance to a field
  66     int sortkey_offset; // -1 if it's not a sortkey, otherwise index
  67                         // into service/record_cluster->sortkey array
  68     enum conf_metadata_type type;
  69     enum conf_metadata_merge merge;
  70 };
  71
  72
  73 struct conf_metadata * conf_metadata_create(NMEM nmem,
  74                                             const char *name,
  75                                             enum conf_metadata_type type,
  76                                             enum conf_metadata_merge merge,
  77                                             int brief,
  78                                             int termlist,
  79                                             int rank,
  80                                             int sortkey_offset);
  81
  82
  83 // Controls sorting
  84 struct conf_sortkey
  85 {
  86     char *name;
  87     enum conf_sortkey_type type;
  88 };
  89
  90 // It is conceivable that there will eventually be several 'services'
  91 // offered from one server, with separate configuration -- possibly
  92 // more than one services associated with the same port. For now,
  93 // however, only a single service is possible.
  94 struct conf_service
  95 {
  96     int num_metadata;
  97     struct conf_metadata *metadata;
  98     int num_sortkeys;
  99     struct conf_sortkey *sortkeys;
 100 };
 101
 102 struct conf_service * conf_service_create(NMEM nmem);
 103
 104 struct conf_metadata* conf_service_add_metadata(NMEM nmem,
 105                                                 struct conf_service *service,
 106                                                 const char *name,
 107                                                 enum conf_metadata_type type,
 108                                                 enum conf_metadata_merge merge,
 109                                                 int brief,
 110                                                 int termlist,
 111                                                 int rank,
 112                                                 int sortkey_offset);
 113
 114
 115 struct conf_server
 116 {
 117     char *host;
 118     int port;
 119     char *proxy_host;
 120     int proxy_port;
 121     char *myurl;
 122     char *zproxy_host;
 123     int zproxy_port;
 124     char *settings;
 125     struct conf_service *service;
 126     struct conf_server *next;
 127 };
 128
 129 struct conf_targetprofiles
 130 {
 131     enum {
 132         Targetprofiles_local
 133     } type;
 134     char *src;
 135 };
 136
 137 struct conf_config
 138 {
 139     struct conf_server *servers;
 140     struct conf_targetprofiles *targetprofiles;
 141 };
 142
 143 #ifndef CONFIG_NOEXTERNS
 144
 145 extern struct conf_config *config;
 146
 147 #endif
 148
 149 int read_config(const char *fname);
 150 xsltStylesheet *conf_load_stylesheet(const char *fname);
 151
 152 #endif
 153
 154 /*
 155  * Local variables:
 156  * c-basic-offset: 4
 157  * indent-tabs-mode: nil
 158  * End:
 159  * vim: shiftwidth=4 tabstop=8 expandtab
 160  */