Add mutex for service (ref counting)
[pazpar2-moved-to-github.git] / src / pazpar2_config.h
1 /* This file is part of Pazpar2.
2    Copyright (C) 2006-2010 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 "normalize_cache.h"
24
25 #include <yaz/nmem.h>
26 #include <yaz/mutex.h>
27 #include "charsets.h"
28
29 enum conf_metadata_type {
30     Metadata_type_generic,    // Generic text field
31     Metadata_type_number,     // A number
32     Metadata_type_year,        // A number
33     Metadata_type_date        // A number
34 };
35
36 enum conf_metadata_merge {
37     Metadata_merge_no,        // Don't merge
38     Metadata_merge_unique,    // Include unique elements in merged block
39     Metadata_merge_longest,   // Include the longest (strlen) value
40     Metadata_merge_range,     // Store value as a range of lowest-highest
41     Metadata_merge_all        // Just include all elements found
42 };
43
44 enum conf_sortkey_type {
45     Metadata_sortkey_relevance,
46     Metadata_sortkey_numeric,       // Standard numerical sorting
47     Metadata_sortkey_skiparticle,   // Skip leading article when sorting
48     Metadata_sortkey_string         // Flat string
49 };
50
51 // This controls the ability to insert 'static' values from settings into retrieval recs
52 enum conf_setting_type {
53     Metadata_setting_no,
54     Metadata_setting_postproc,      // Insert setting value into normalized record
55     Metadata_setting_parameter      // Expose value to normalization stylesheets
56 };
57
58 enum conf_metadata_mergekey {
59     Metadata_mergekey_no,
60     Metadata_mergekey_optional,
61     Metadata_mergekey_required
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_mergekey 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 struct conf_server;
94
95 // It is conceivable that there will eventually be several 'services'
96 // offered from one server, with separate configuration -- possibly
97 // more than one services associated with the same port. For now,
98 // however, only a single service is possible.
99 struct conf_service
100 {
101     YAZ_MUTEX mutex;
102     int num_metadata;
103     struct conf_metadata *metadata;
104     int num_sortkeys;
105     struct conf_sortkey *sortkeys;
106     struct setting_dictionary *dictionary;
107     struct conf_service *next;
108     char *id;
109     char *settings;
110     NMEM nmem;
111     int session_timeout;
112     int z3950_session_timeout;
113     int z3950_operation_timeout;
114
115     int ref_count;
116     /* duplicated from conf_server */
117     pp2_charset_t relevance_pct;
118     pp2_charset_t sort_pct;
119     pp2_charset_t mergekey_pct;
120
121     struct database *databases;
122     struct conf_targetprofiles *targetprofiles;
123     struct conf_server *server;
124 };
125
126 int conf_service_metadata_field_id(struct conf_service *service, const char * name);
127
128 int conf_service_sortkey_field_id(struct conf_service *service, const char * name);
129
130 struct conf_server
131 {
132     char *host;
133     int port;
134     char *proxy_host;
135     int proxy_port;
136     char *myurl;
137     struct sockaddr_in *proxy_addr;
138     int listener_socket;
139     char *server_settings;
140     char *server_id;
141
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 };
149
150 struct conf_targetprofiles
151 {
152     enum {
153         Targetprofiles_local
154     } type;
155     char *src;
156 };
157
158 struct conf_config *config_create(const char *fname, int verbose);
159 void config_destroy(struct conf_config *config);
160 void config_start_databases(struct conf_config *config);
161
162 struct conf_service *locate_service(struct conf_server *server,
163                                     const char *service_id);
164
165 struct conf_service *service_create(struct conf_server *server,
166                                     xmlNode *node);
167 void service_incref(struct conf_service *service);
168 void service_destroy(struct conf_service *service);
169
170 int config_start_listeners(struct conf_config *conf,
171                            const char *listener_override);
172
173 void config_stop_listeners(struct conf_config *conf);
174
175 WRBUF conf_get_fname(struct conf_service *service, const char *fname);
176
177 #endif
178
179 /*
180  * Local variables:
181  * c-basic-offset: 4
182  * c-file-style: "Stroustrup"
183  * indent-tabs-mode: nil
184  * End:
185  * vim: shiftwidth=4 tabstop=8 expandtab
186  */
187