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