More work on SDRKit integration.
[idzebra-moved-to-github.git] / index / index.h
1 /*
2  * Copyright (C) 1995-1998, Index Data
3  * All rights reserved.
4  * Sebastian Hammer, Adam Dickmeiss
5  *
6  * $Log: index.h,v $
7  * Revision 1.61  1999-03-09 16:27:49  adam
8  * More work on SDRKit integration.
9  *
10  * Revision 1.60  1998/10/16 08:14:31  adam
11  * Updated record control system.
12  *
13  * Revision 1.59  1998/06/08 14:43:11  adam
14  * Added suport for EXPLAIN Proxy servers - added settings databasePath
15  * and explainDatabase to facilitate this. Increased maximum number
16  * of databases and attributes in one register.
17  *
18  * Revision 1.58  1998/05/20 10:12:16  adam
19  * Implemented automatic EXPLAIN database maintenance.
20  * Modified Zebra to work with ASN.1 compiled version of YAZ.
21  *
22  * Revision 1.57  1998/03/05 08:45:12  adam
23  * New result set model and modular ranking system. Moved towards
24  * descent server API. System information stored as "SGML" records.
25  *
26  * Revision 1.56  1998/01/12 15:04:08  adam
27  * The test option (-s) only uses read-lock (and not write lock).
28  *
29  * Revision 1.55  1997/10/27 14:33:04  adam
30  * Moved towards generic character mapping depending on "structure"
31  * field in abstract syntax file. Fixed a few memory leaks. Fixed
32  * bug with negative integers when doing searches with relational
33  * operators.
34  *
35  * Revision 1.54  1997/09/29 09:08:36  adam
36  * Revised locking system to be thread safe for the server.
37  *
38  * Revision 1.53  1997/09/25 14:54:43  adam
39  * WIN32 files lock support.
40  *
41  * Revision 1.52  1997/09/22 12:39:06  adam
42  * Added get_pos method for the ranked result sets.
43  *
44  * Revision 1.51  1997/09/18 08:59:19  adam
45  * Extra generic handle for the character mapping routines.
46  *
47  * Revision 1.50  1997/09/17 12:19:13  adam
48  * Zebra version corresponds to YAZ version 1.4.
49  * Changed Zebra server so that it doesn't depend on global common_resource.
50  *
51  * Revision 1.49  1997/09/05 15:30:08  adam
52  * Changed prototype for chr_map_input - added const.
53  * Added support for C++, headers uses extern "C" for public definitions.
54  *
55  * Revision 1.48  1997/02/12 20:39:45  adam
56  * Implemented options -f <n> that limits the log to the first <n>
57  * records.
58  * Changed some log messages also.
59  *
60  * Revision 1.47  1996/12/23 15:30:44  adam
61  * Work on truncation.
62  * Bug fix: result sets weren't deleted after server shut down.
63  *
64  * Revision 1.46  1996/11/08 11:10:19  adam
65  * Buffers used during file match got bigger.
66  * Compressed ISAM support everywhere.
67  * Bug fixes regarding masking characters in queries.
68  * Redesigned Regexp-2 queries.
69  *
70  * Revision 1.45  1996/10/29 14:09:42  adam
71  * Use of cisam system - enabled if setting isamc is 1.
72  *
73  * Revision 1.44  1996/06/06 12:08:40  quinn
74  * Added showRecord function
75  *
76  * Revision 1.43  1996/06/04  10:18:12  adam
77  * Search/scan uses character mapping module.
78  *
79  * Revision 1.42  1996/06/04  08:20:16  quinn
80  * Smallish
81  *
82  * Revision 1.41  1996/06/04  07:54:55  quinn
83  * Added output-map.
84  *
85  * Revision 1.40  1996/05/31  09:06:58  quinn
86  * Work on character-set handling
87  *
88  * Revision 1.39  1996/05/14  14:04:33  adam
89  * In zebraidx, the 'stat' command is improved. Statistics about ISAM/DICT
90  * is collected.
91  *
92  * Revision 1.38  1996/04/12  07:02:23  adam
93  * File update of single files.
94  *
95  * Revision 1.37  1996/03/26 16:01:13  adam
96  * New setting lockPath: directory of various lock files.
97  *
98  * Revision 1.36  1996/03/21  14:50:09  adam
99  * File update uses modify-time instead of change-time.
100  *
101  * Revision 1.35  1996/02/12  18:45:36  adam
102  * New fileVerboseFlag in record group control.
103  *
104  * Revision 1.34  1995/12/11  11:43:29  adam
105  * Locking based on fcntl instead of flock.
106  * Setting commitEnable removed. Command line option -n can be used to
107  * prevent commit if commit setting is defined in the configuration file.
108  *
109  * Revision 1.33  1995/12/08  16:22:53  adam
110  * Work on update while servers are running. Three lock files introduced.
111  * The servers reload their registers when necessary, but they don't
112  * reestablish result sets yet.
113  *
114  * Revision 1.32  1995/12/07  17:38:46  adam
115  * Work locking mechanisms for concurrent updates/commit.
116  *
117  * Revision 1.31  1995/12/06  12:41:22  adam
118  * New command 'stat' for the index program.
119  * Filenames can be read from stdin by specifying '-'.
120  * Bug fix/enhancement of the transformation from terms to regular
121  * expressons in the search engine.
122  *
123  * Revision 1.30  1995/12/05  11:25:02  adam
124  * Include of zebraver.h.
125  *
126  * Revision 1.29  1995/11/28  09:09:40  adam
127  * Zebra config renamed.
128  * Use setting 'recordId' to identify record now.
129  * Bug fix in recindex.c: rec_release_blocks was invokeded even
130  * though the blocks were already released.
131  * File traversal properly deletes records when needed.
132  *
133  * Revision 1.28  1995/11/27  13:58:53  adam
134  * New option -t. storeStore data implemented in server.
135  *
136  * Revision 1.27  1995/11/25  10:24:06  adam
137  * More record fields - they are enumerated now.
138  * New options: flagStoreData flagStoreKey.
139  *
140  * Revision 1.26  1995/11/22  17:19:17  adam
141  * Record management uses the bfile system.
142  *
143  * Revision 1.25  1995/11/21  15:29:12  adam
144  * Config file 'base' read by default by both indexer and server.
145  *
146  * Revision 1.24  1995/11/21  15:01:15  adam
147  * New general match criteria implemented.
148  * New feature: document groups.
149  *
150  * Revision 1.23  1995/11/20  16:59:45  adam
151  * New update method: the 'old' keys are saved for each records.
152  *
153  * Revision 1.22  1995/11/20  11:56:26  adam
154  * Work on new traversal.
155  *
156  * Revision 1.21  1995/11/16  15:34:55  adam
157  * Uses new record management system in both indexer and server.
158  *
159  * Revision 1.20  1995/11/15  14:46:18  adam
160  * Started work on better record management system.
161  *
162  * Revision 1.19  1995/10/27  14:00:11  adam
163  * Implemented detection of database availability.
164  *
165  * Revision 1.18  1995/10/17  18:02:08  adam
166  * New feature: databases. Implemented as prefix to words in dictionary.
167  *
168  * Revision 1.17  1995/10/13  16:01:49  adam
169  * Work on relations.
170  *
171  * Revision 1.16  1995/10/10  12:24:38  adam
172  * Temporary sort files are compressed.
173  *
174  * Revision 1.15  1995/10/04  16:57:19  adam
175  * Key input and merge sort in one pass.
176  *
177  * Revision 1.14  1995/09/29  14:01:40  adam
178  * Bug fixes.
179  *
180  * Revision 1.13  1995/09/28  14:22:56  adam
181  * Sort uses smaller temporary files.
182  *
183  * Revision 1.12  1995/09/28  12:10:32  adam
184  * Bug fixes. Field prefix used in queries.
185  *
186  * Revision 1.11  1995/09/27  12:22:28  adam
187  * More work on extract in record control.
188  * Field name is not in isam keys but in prefix in dictionary words.
189  *
190  * Revision 1.10  1995/09/14  07:48:23  adam
191  * Record control management.
192  *
193  * Revision 1.9  1995/09/11  13:09:33  adam
194  * More work on relevance feedback.
195  *
196  * Revision 1.8  1995/09/08  14:52:27  adam
197  * Minor changes. Dictionary is lower case now.
198  *
199  * Revision 1.7  1995/09/06  16:11:16  adam
200  * Option: only one word key per file.
201  *
202  * Revision 1.6  1995/09/05  15:28:39  adam
203  * More work on search engine.
204  *
205  * Revision 1.5  1995/09/04  12:33:42  adam
206  * Various cleanup. YAZ util used instead.
207  *
208  * Revision 1.4  1995/09/04  09:10:35  adam
209  * More work on index add/del/update.
210  * Merge sort implemented.
211  * Initial work on z39 server.
212  *
213  * Revision 1.3  1995/09/01  14:06:35  adam
214  * Split of work into more files.
215  *
216  * Revision 1.2  1995/09/01  10:30:24  adam
217  * More work on indexing. Not working yet.
218  *
219  * Revision 1.1  1995/08/31  14:50:24  adam
220  * New simple file index tool.
221  *
222  */
223 #include <time.h>
224 #include <zebraver.h>
225 #include <zebrautl.h>
226 #include <zebramap.h>
227
228 #include <dict.h>
229 #include <isam.h>
230 #include <isamc.h>
231 #include <data1.h>
232 #include <recctrl.h>
233
234 #define IT_MAX_WORD 256
235 #define IT_KEY_HAVE_SEQNO 1
236 #define IT_KEY_HAVE_FIELD 0
237
238 typedef int SYSNO;
239
240 struct it_key {
241     int  sysno;
242     int  seqno;
243 };
244
245 enum dirsKind { dirs_dir, dirs_file };
246
247 struct dir_entry {
248     enum dirsKind kind;
249     char *name;
250     time_t mtime;
251 };
252
253 struct dirs_entry {
254     enum dirsKind kind;
255     char path[256];
256     SYSNO sysno;
257     time_t mtime;
258 };
259
260 struct recordGroup {
261     char         *groupName;
262     char         *databaseName;
263     char         *path;
264     char         *recordId;
265     char         *recordType;
266     int          flagStoreData;
267     int          flagStoreKeys;
268     int          flagRw;
269     int          fileVerboseLimit;
270     int          databaseNamePath;
271     int          explainDatabase;
272 #if ZEBRASDR
273     int          useSDR;
274 #endif
275     data1_handle dh;
276     BFiles       bfs;
277     ZebraMaps    zebra_maps;
278     RecTypes     recTypes;
279 };
280
281 void getFnameTmp (char *fname, int no);
282         
283 struct dirs_info *dirs_open (Dict dict, const char *rep, int rw);
284 struct dirs_info *dirs_fopen (Dict dict, const char *path);
285 struct dirs_entry *dirs_read (struct dirs_info *p);
286 struct dirs_entry *dirs_last (struct dirs_info *p);
287 void dirs_mkdir (struct dirs_info *p, const char *src, time_t mtime);
288 void dirs_rmdir (struct dirs_info *p, const char *src);
289 void dirs_add (struct dirs_info *p, const char *src, int sysno, time_t mtime);
290 void dirs_del (struct dirs_info *p, const char *src);
291 void dirs_free (struct dirs_info **pp);
292
293 struct dir_entry *dir_open (const char *rep);
294 void dir_sort (struct dir_entry *e);
295 void dir_free (struct dir_entry **e_p);
296
297 void repositoryUpdate (struct recordGroup *rGroup);
298 void repositoryAdd (struct recordGroup *rGroup);
299 void repositoryDelete (struct recordGroup *rGroup);
300 void repositoryShow (struct recordGroup *rGroup);
301
302 int key_open (struct recordGroup *rGroup, int mem);
303 int key_close (struct recordGroup *group);
304 int key_compare (const void *p1, const void *p2);
305 int key_get_pos (const void *p);
306 int key_compare_it (const void *p1, const void *p2);
307 int key_qsort_compare (const void *p1, const void *p2);
308 void key_logdump (int mask, const void *p);
309 void inv_prstat (BFiles bfs);
310 void inv_compact (BFiles bfs);
311 void key_input (BFiles bfs, int nkeys, int cache);
312 ISAMC_M key_isamc_m (Res res);
313 int merge_sort (char **buf, int from, int to);
314 int key_SU_code (int ch, char *out);
315
316 #define FNAME_DICT "dict"
317 #define FNAME_ISAM "isam"
318 #define FNAME_ISAMC "isamc"
319 #define FNAME_CONFIG "zebra.cfg"
320
321 #define GMATCH_DICT "gmatch"
322 #define FMATCH_DICT "fmatch"
323
324 struct strtab *strtab_mk (void);
325 int strtab_src (struct strtab *t, const char *name, void ***infop);
326 void strtab_del (struct strtab *t,
327                  void (*func)(const char *name, void *info, void *data),
328                  void *data);
329 int index_char_cvt (int c);
330 int index_word_prefix (char *string, int attset_ordinal,
331                        int local_attribute, const char *databaseName);
332
333 int fileExtract (SYSNO *sysno, const char *fname,
334                  const struct recordGroup *rGroup, int deleteFlag);
335
336 void zebraIndexLockMsg (const char *str);
337 void zebraIndexUnlock (void);
338 void zebraIndexLock (BFiles bfs, int commitNow, const char *rval);
339 int zebraIndexWait (int commitPhase);
340
341 #define FNAME_MAIN_LOCK   "zebraidx.LCK"
342 #define FNAME_COMMIT_LOCK "zebracmt.LCK"
343 #define FNAME_ORG_LOCK    "zebraorg.LCK"
344 #define FNAME_TOUCH_TIME  "zebraidx.time"
345
346 typedef struct zebra_lock_info *ZebraLockHandle;
347 ZebraLockHandle zebra_lock_create(const char *file, int excl_flag);
348 void zebra_lock_destroy (ZebraLockHandle h);
349 int zebra_lock (ZebraLockHandle h);
350 int zebra_lock_nb (ZebraLockHandle h);
351 int zebra_unlock (ZebraLockHandle h);
352 int zebra_lock_fd (ZebraLockHandle h);
353 void zebra_lock_prefix (Res res, char *dst);
354
355 void zebra_load_atts (data1_handle dh, Res res);
356
357 extern Res common_resource;