src/config.h

   1 /* $Id: config.h,v 1.16 2007-04-10 08:48:56 adam 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 // Describes known metadata elements and how they are to be manipulated
  38 // An array of these structure provides a 'map' against which discovered metadata
  39 // elements are matched. It also governs storage, to minimize number of cycles needed
  40 // at various tages of processing
  41 struct conf_metadata
  42 {
  43     char *name;  // The name of this element. Output by normalization stylesheet
  44     int brief;   // Is this element to be returned in the brief format?
  45     int termlist;// Is this field to be treated as a termlist for browsing?
  46     int rank;    // Rank factor. 0 means don't use this field for ranking, 1 is default
  47                  // values >1  give additional significance to a field
  48     int sortkey_offset; // -1 if it's not a sortkey, otherwise index
  49                         // into service/record_cluster->sortkey array
  50     enum
  51     {
  52         Metadata_type_generic,          // Generic text field
  53         Metadata_type_number,           // A number
  54         Metadata_type_year              // A number
  55     } type;
  56     enum
  57     {
  58         Metadata_merge_no,              // Don't merge
  59         Metadata_merge_unique,          // Include unique elements in merged block
  60         Metadata_merge_longest,         // Include the longest (strlen) value
  61         Metadata_merge_range,           // Store value as a range of lowest-highest
  62         Metadata_merge_all              // Just include all elements found
  63     } merge;
  64 };
  65
  66 // Controls sorting
  67 struct conf_sortkey
  68 {
  69     char *name;
  70     enum conf_sortkey_type type;
  71 };
  72
  73 // It is conceivable that there will eventually be several 'services' offered
  74 // from one server, with separate configuration -- possibly more than one services
  75 // associated with the same port. For now, however, only a single service is possible.
  76 struct conf_service
  77 {
  78     int num_metadata;
  79     struct conf_metadata *metadata;
  80     int num_sortkeys;
  81     struct conf_sortkey *sortkeys;
  82 };
  83
  84 struct conf_server
  85 {
  86     char *host;
  87     int port;
  88     char *proxy_host;
  89     int proxy_port;
  90     char *myurl;
  91     char *zproxy_host;
  92     int zproxy_port;
  93     char *settings;
  94     struct conf_service *service;
  95     struct conf_server *next;
  96 };
  97
  98 struct conf_targetprofiles
  99 {
 100     enum {
 101         Targetprofiles_local
 102     } type;
 103     char *src;
 104 };
 105
 106 struct conf_config
 107 {
 108     struct conf_server *servers;
 109     struct conf_targetprofiles *targetprofiles;
 110 };
 111
 112 #ifndef CONFIG_NOEXTERNS
 113
 114 extern struct conf_config *config;
 115
 116 #endif
 117
 118 int read_config(const char *fname);
 119 xsltStylesheet *conf_load_stylesheet(const char *fname);
 120
 121 #endif
 122
 123 /*
 124  * Local variables:
 125  * c-basic-offset: 4
 126  * indent-tabs-mode: nil
 127  * End:
 128  * vim: shiftwidth=4 tabstop=8 expandtab
 129  */