1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2012 Index Data
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
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
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
20 #ifndef PAZPAR2_CONFIG_H
21 #define PAZPAR2_CONFIG_H
23 #include "normalize_cache.h"
26 #include <yaz/mutex.h>
33 enum conf_metadata_type {
34 Metadata_type_generic, // Generic text field
35 Metadata_type_year, // A number
36 Metadata_type_date // A number
39 enum conf_metadata_merge {
40 Metadata_merge_no, // Don't merge
41 Metadata_merge_unique, // Include unique elements in merged block
42 Metadata_merge_longest, // Include the longest (strlen) value
43 Metadata_merge_range, // Store value as a range of lowest-highest
44 Metadata_merge_all // Just include all elements found
47 enum conf_sortkey_type {
48 Metadata_sortkey_relevance,
49 Metadata_sortkey_numeric, // Standard numerical sorting
50 Metadata_sortkey_skiparticle, // Skip leading article when sorting
51 Metadata_sortkey_string, // Flat string
52 Metadata_sortkey_position // Position
55 // This controls the ability to insert 'static' values from settings into retrieval recs
56 enum conf_setting_type {
58 Metadata_setting_postproc, // Insert setting value into normalized record
59 Metadata_setting_parameter // Expose value to normalization stylesheets
62 enum conf_metadata_mergekey {
64 Metadata_mergekey_optional,
65 Metadata_mergekey_required
68 // Describes known metadata elements and how they are to be manipulated
69 // An array of these structure provides a 'map' against which
70 // discovered metadata elements are matched. It also governs storage,
71 // to minimize number of cycles needed at various tages of processing
74 char *name; // The field name. Output by normalization stylesheet
75 int brief; // Is this element to be returned in the brief format?
76 int termlist;// Is this field to be treated as a termlist for browsing?
78 int sortkey_offset; // -1 if it's not a sortkey, otherwise index
79 // into service/record_cluster->sortkey array
80 enum conf_metadata_type type;
81 enum conf_metadata_merge merge;
82 enum conf_setting_type setting; // Value is to be taken from session/db settings?
83 enum conf_metadata_mergekey mergekey;
86 char *limitmap; // Should be expanded into service-wide default e.g. pz:limitmap:<name>=value setting
95 enum conf_sortkey_type type;
100 // It is conceivable that there will eventually be several 'services'
101 // offered from one server, with separate configuration -- possibly
102 // more than one services associated with the same port. For now,
103 // however, only a single service is possible.
108 struct conf_metadata *metadata;
110 struct conf_sortkey *sortkeys;
111 struct setting_dictionary *dictionary;
112 struct settings_array *settings;
113 struct conf_service *next;
117 int z3950_session_timeout;
118 int z3950_operation_timeout;
127 /* duplicated from conf_server */
128 pp2_charset_fact_t charsets;
130 struct service_xslt *xslt_list;
132 CCL_bibset ccl_bibset;
133 struct database *databases;
134 struct conf_server *server;
137 int conf_service_metadata_field_id(struct conf_service *service, const char * name);
139 int conf_service_sortkey_field_id(struct conf_service *service, const char * name);
148 char *settings_fname;
151 pp2_charset_fact_t charsets;
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 database_hosts_t database_hosts;
161 struct conf_config *config_create(const char *fname, int verbose);
162 void config_destroy(struct conf_config *config);
163 void config_process_events(struct conf_config *config);
164 void info_services(struct conf_server *server, WRBUF w);
166 struct conf_service *locate_service(struct conf_server *server,
167 const char *service_id);
169 struct conf_service *service_create(struct conf_server *server,
171 void service_incref(struct conf_service *service);
172 void service_destroy(struct conf_service *service);
174 int config_start_listeners(struct conf_config *conf,
175 const char *listener_override,
176 const char *record_fname);
178 void config_stop_listeners(struct conf_config *conf);
180 WRBUF conf_get_fname(struct conf_config *config, const char *fname);
187 * c-file-style: "Stroustrup"
188 * indent-tabs-mode: nil
190 * vim: shiftwidth=4 tabstop=8 expandtab