1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2010 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>
31 enum conf_metadata_type {
32 Metadata_type_generic, // Generic text field
33 Metadata_type_number, // A number
34 Metadata_type_year, // A number
35 Metadata_type_date // A number
38 enum conf_metadata_merge {
39 Metadata_merge_no, // Don't merge
40 Metadata_merge_unique, // Include unique elements in merged block
41 Metadata_merge_longest, // Include the longest (strlen) value
42 Metadata_merge_range, // Store value as a range of lowest-highest
43 Metadata_merge_all // Just include all elements found
46 enum conf_sortkey_type {
47 Metadata_sortkey_relevance,
48 Metadata_sortkey_numeric, // Standard numerical sorting
49 Metadata_sortkey_skiparticle, // Skip leading article when sorting
50 Metadata_sortkey_string // Flat string
53 // This controls the ability to insert 'static' values from settings into retrieval recs
54 enum conf_setting_type {
56 Metadata_setting_postproc, // Insert setting value into normalized record
57 Metadata_setting_parameter // Expose value to normalization stylesheets
60 enum conf_metadata_mergekey {
62 Metadata_mergekey_optional,
63 Metadata_mergekey_required
66 // Describes known metadata elements and how they are to be manipulated
67 // An array of these structure provides a 'map' against which
68 // discovered metadata elements are matched. It also governs storage,
69 // to minimize number of cycles needed at various tages of processing
72 char *name; // The field name. Output by normalization stylesheet
73 int brief; // Is this element to be returned in the brief format?
74 int termlist;// Is this field to be treated as a termlist for browsing?
75 int rank; // Rank factor. 0 means don't use this field for ranking,
77 // values >1 give additional significance to a field
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;
92 enum conf_sortkey_type type;
97 // It is conceivable that there will eventually be several 'services'
98 // offered from one server, with separate configuration -- possibly
99 // more than one services associated with the same port. For now,
100 // however, only a single service is possible.
105 struct conf_metadata *metadata;
107 struct conf_sortkey *sortkeys;
108 struct setting_dictionary *dictionary;
109 struct conf_service *next;
114 int z3950_session_timeout;
115 int z3950_operation_timeout;
118 /* duplicated from conf_server */
119 pp2_charset_t relevance_pct;
120 pp2_charset_t sort_pct;
121 pp2_charset_t mergekey_pct;
123 struct database *databases;
124 struct conf_targetprofiles *targetprofiles;
125 struct conf_server *server;
128 int conf_service_metadata_field_id(struct conf_service *service, const char * name);
130 int conf_service_sortkey_field_id(struct conf_service *service, const char * name);
139 char *server_settings;
142 pp2_charset_t relevance_pct;
143 pp2_charset_t sort_pct;
144 pp2_charset_t mergekey_pct;
145 struct conf_service *service;
146 struct conf_server *next;
147 struct conf_config *config;
148 http_server_t http_server;
149 iochan_man_t iochan_man;
150 database_hosts_t database_hosts;
153 struct conf_targetprofiles
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);
165 struct conf_service *locate_service(struct conf_server *server,
166 const char *service_id);
168 struct conf_service *service_create(struct conf_server *server,
170 void service_incref(struct conf_service *service);
171 void service_destroy(struct conf_service *service);
173 int config_start_listeners(struct conf_config *conf,
174 const char *listener_override);
176 void config_stop_listeners(struct conf_config *conf);
178 WRBUF conf_get_fname(struct conf_service *service, const char *fname);
185 * c-file-style: "Stroustrup"
186 * indent-tabs-mode: nil
188 * vim: shiftwidth=4 tabstop=8 expandtab