Prototype changed for reader functions in extract/retrieve. File
[idzebra-moved-to-github.git] / index / zserver.c
1 /*
2  * Copyright (C) 1994-1995, Index Data I/S 
3  * All rights reserved.
4  * Sebastian Hammer, Adam Dickmeiss
5  *
6  * $Log: zserver.c,v $
7  * Revision 1.33  1996-01-17 14:57:56  adam
8  * Prototype changed for reader functions in extract/retrieve. File
9  *  is identified by 'void *' instead of 'int.
10  *
11  * Revision 1.32  1995/12/11  09:12:58  adam
12  * The rec_get function returns NULL if record doesn't exist - will
13  * happen in the server if the result set records have been deleted since
14  * the creation of the set (i.e. the search).
15  * The server saves a result temporarily if it is 'volatile', i.e. the
16  * set is register dependent.
17  *
18  * Revision 1.31  1995/12/08  16:22:56  adam
19  * Work on update while servers are running. Three lock files introduced.
20  * The servers reload their registers when necessary, but they don't
21  * reestablish result sets yet.
22  *
23  * Revision 1.30  1995/12/07  17:38:48  adam
24  * Work locking mechanisms for concurrent updates/commit.
25  *
26  * Revision 1.29  1995/12/04  14:22:32  adam
27  * Extra arg to recType_byName.
28  * Started work on new regular expression parsed input to
29  * structured records.
30  *
31  * Revision 1.28  1995/11/28  09:09:48  adam
32  * Zebra config renamed.
33  * Use setting 'recordId' to identify record now.
34  * Bug fix in recindex.c: rec_release_blocks was invokeded even
35  * though the blocks were already released.
36  * File traversal properly deletes records when needed.
37  *
38  * Revision 1.27  1995/11/27  13:58:54  adam
39  * New option -t. storeStore data implemented in server.
40  *
41  * Revision 1.26  1995/11/25  10:24:07  adam
42  * More record fields - they are enumerated now.
43  * New options: flagStoreData flagStoreKey.
44  *
45  * Revision 1.25  1995/11/21  15:29:13  adam
46  * Config file 'base' read by default by both indexer and server.
47  *
48  * Revision 1.24  1995/11/20  16:59:47  adam
49  * New update method: the 'old' keys are saved for each records.
50  *
51  * Revision 1.23  1995/11/16  17:00:56  adam
52  * Better logging of rpn query.
53  *
54  * Revision 1.22  1995/11/16  15:34:55  adam
55  * Uses new record management system in both indexer and server.
56  *
57  * Revision 1.21  1995/11/01  16:25:52  quinn
58  * *** empty log message ***
59  *
60  * Revision 1.20  1995/10/27  14:00:12  adam
61  * Implemented detection of database availability.
62  *
63  * Revision 1.19  1995/10/17  18:02:11  adam
64  * New feature: databases. Implemented as prefix to words in dictionary.
65  *
66  * Revision 1.18  1995/10/16  14:03:09  quinn
67  * Changes to support element set names and espec1
68  *
69  * Revision 1.17  1995/10/16  09:32:40  adam
70  * More work on relational op.
71  *
72  * Revision 1.16  1995/10/13  12:26:44  adam
73  * Optimization of truncation.
74  *
75  * Revision 1.15  1995/10/12  12:40:55  adam
76  * Bug fixes in rpn_prox.
77  *
78  * Revision 1.14  1995/10/09  16:18:37  adam
79  * Function dict_lookup_grep got extra client data parameter.
80  *
81  * Revision 1.13  1995/10/06  14:38:00  adam
82  * New result set method: r_score.
83  * Local no (sysno) and score is transferred to retrieveCtrl.
84  *
85  * Revision 1.12  1995/10/06  13:52:06  adam
86  * Bug fixes. Handler may abort further scanning.
87  *
88  * Revision 1.11  1995/10/06  10:43:57  adam
89  * Scan added. 'occurrences' in scan entries not set yet.
90  *
91  * Revision 1.10  1995/10/02  16:43:32  quinn
92  * Set default resulting record type in fetch.
93  *
94  * Revision 1.9  1995/10/02  15:18:52  adam
95  * New member in recRetrieveCtrl: diagnostic.
96  *
97  * Revision 1.8  1995/09/28  09:19:47  adam
98  * xfree/xmalloc used everywhere.
99  * Extract/retrieve method seems to work for text records.
100  *
101  * Revision 1.7  1995/09/27  16:17:32  adam
102  * More work on retrieve.
103  *
104  * Revision 1.6  1995/09/08  08:53:22  adam
105  * Record buffer maintained in server_info.
106  *
107  * Revision 1.5  1995/09/06  16:11:18  adam
108  * Option: only one word key per file.
109  *
110  * Revision 1.4  1995/09/06  10:33:04  adam
111  * More work on present. Some log messages removed.
112  *
113  * Revision 1.3  1995/09/05  15:28:40  adam
114  * More work on search engine.
115  *
116  * Revision 1.2  1995/09/04  12:33:43  adam
117  * Various cleanup. YAZ util used instead.
118  *
119  * Revision 1.1  1995/09/04  09:10:41  adam
120  * More work on index add/del/update.
121  * Merge sort implemented.
122  * Initial work on z39 server.
123  *
124  */
125 #include <stdio.h>
126 #include <assert.h>
127 #include <unistd.h>
128 #include <fcntl.h>
129
130 #include <common.h>
131 #include <data1.h>
132 #include <recctrl.h>
133 #include <dmalloc.h>
134 #include "zserver.h"
135
136 ZServerInfo server_info;
137
138 static int register_lock (ZServerInfo *zi)
139 {
140     time_t lastChange;
141     int state = zebraServerLockGetState(&lastChange);
142
143     switch (state)
144     {
145     case 'c':
146         state = 1;
147         break;
148     default:
149         state = 0;
150     }
151     zebraServerLock (state);
152     if (zi->registerState == state)
153     {
154         if (zi->registerChange >= lastChange)
155             return 0;
156         logf (LOG_LOG, "Register completely updated since last access");
157     }
158     else if (zi->registerState == -1)
159         logf (LOG_LOG, "Reading register using state %d pid=%ld", state,
160               (long) getpid());
161     else
162         logf (LOG_LOG, "Register has changed state from %d to %d",
163               zi->registerState, state);
164     zi->registerChange = lastChange;
165     if (zi->records)
166     {
167         dict_close (zi->wordDict);
168         is_close (zi->wordIsam);
169         rec_close (&zi->records);
170     }
171     bf_cache (state);
172     zi->registerState = state;
173     zi->records = rec_open (0);
174     if (!(zi->wordDict = dict_open (FNAME_WORD_DICT, 40, 0)))
175         return -1;
176     if (!(zi->wordIsam = is_open (FNAME_WORD_ISAM, key_compare, 0,
177                                   sizeof (struct it_key))))
178         return -1;
179     return 0;
180 }
181
182 static void register_unlock (ZServerInfo *zi)
183 {
184     static int waitSec = -1;
185
186     if (waitSec == -1)
187     {
188         char *s = res_get (common_resource, "debugRequestWait");
189         if (s)
190             waitSec = atoi (s);
191         else
192             waitSec = 0;
193     }
194     if (waitSec > 0)
195         sleep (waitSec);
196     if (zi->registerState != -1)
197         zebraServerUnlock (zi->registerState);
198 }
199
200 bend_initresult *bend_init (bend_initrequest *q)
201 {
202     static bend_initresult r;
203     static char *name = "zserver";
204
205     r.errcode = 0;
206     r.errstring = 0;
207     r.handle = name;
208
209     logf (LOG_DEBUG, "bend_init");
210
211     if (!common_resource)
212     {
213         struct statserv_options_block *sob;
214
215         sob = statserv_getcontrol ();
216         logf (LOG_LOG, "Reading resources from %s", sob->configname);
217         if (!(common_resource = res_open (sob->configname)))
218         {
219             logf (LOG_FATAL, "Cannot open resource `%s'", sob->configname);
220             exit (1);
221         }
222     }
223     data1_tabpath = res_get(common_resource, "profilePath");
224     server_info.sets = NULL;
225     server_info.registerState = -1;  /* trigger open of registers! */
226     server_info.registerChange = 0;
227
228     server_info.records = NULL;
229     server_info.wordDict = NULL;
230     server_info.wordIsam = NULL;
231     server_info.odr = odr_createmem (ODR_ENCODE);
232     return &r;
233 }
234
235 bend_searchresult *bend_search (void *handle, bend_searchrequest *q, int *fd)
236 {
237     static bend_searchresult r;
238
239     r.errcode = 0;
240     r.errstring = 0;
241     r.hits = 0;
242
243     register_lock (&server_info);
244     odr_reset (server_info.odr);
245     server_info.errCode = 0;
246     server_info.errString = NULL;
247
248     logf (LOG_LOG, "ResultSet '%s'", q->setname);
249     switch (q->query->which)
250     {
251     case Z_Query_type_1:
252         r.errcode = rpn_search (&server_info, q->query->u.type_1,
253                                 q->num_bases, q->basenames, q->setname,
254                                 &r.hits);
255         r.errstring = server_info.errString;
256         break;
257     default:
258         r.errcode = 107;
259     }
260     register_unlock (&server_info);
261     return &r;
262 }
263
264 static int record_ext_read (void *fh, char *buf, size_t count)
265 {
266     return read (*((int*) fh), buf, count);
267 }
268
269 static int record_int_pos;
270 static char *record_int_buf;
271 static int record_int_len;
272
273 static int record_int_read (void *fh, char *buf, size_t count)
274 {
275     int l = record_int_len - record_int_pos;
276     if (l <= 0)
277         return 0;
278     l = (l < count) ? l : count;
279     memcpy (buf, record_int_buf + record_int_pos, l);
280     record_int_pos += l;
281     return l;
282 }
283
284 static int record_fetch (ZServerInfo *zi, int sysno, int score, ODR stream,
285                           oid_value input_format, Z_RecordComposition *comp,
286                           oid_value *output_format, char **rec_bufp,
287                           int *rec_lenp)
288 {
289     Record rec;
290     char *fname, *file_type;
291     RecType rt;
292     int fd = -1;
293     struct recRetrieveCtrl retrieveCtrl;
294     char subType[128];
295
296     rec = rec_get (zi->records, sysno);
297     if (!rec)
298     {
299         char *msg = "Record is deleted\n";
300         *output_format = VAL_SUTRS;
301         *rec_bufp = msg;
302         *rec_lenp = strlen (msg);
303         return 0;
304     }
305     file_type = rec->info[recInfo_fileType];
306     fname = rec->info[recInfo_filename];
307
308     if (!(rt = recType_byName (file_type, subType)))
309     {
310         logf (LOG_FATAL|LOG_ERRNO, "Retrieve: Cannot handle type %s", 
311               file_type);
312         exit (1);
313     }
314     logf (LOG_DEBUG, "retrieve localno=%d score=%d", sysno, score);
315     if (rec->size[recInfo_storeData] > 0)
316     {
317         retrieveCtrl.readf = record_int_read;
318         record_int_len = rec->size[recInfo_storeData];
319         record_int_buf = rec->info[recInfo_storeData];
320         record_int_pos = 0;
321         logf (LOG_DEBUG, "Internal retrieve. %d bytes", record_int_len);
322     }
323     else 
324     {
325         if ((fd = open (fname, O_RDONLY)) == -1)
326         {
327             char *msg = "Record doesn't exist\n";
328             logf (LOG_WARN|LOG_ERRNO, "Retrieve: Open record file %s", fname);
329             *output_format = VAL_SUTRS;
330             *rec_bufp = msg;
331             *rec_lenp = strlen (msg);
332             rec_rm (&rec);
333             return 0;     /* or 14: System error in presenting records */
334         }
335         retrieveCtrl.fh = &fd;
336         retrieveCtrl.readf = record_ext_read;
337     }
338     retrieveCtrl.subType = subType;
339     retrieveCtrl.localno = sysno;
340     retrieveCtrl.score = score;
341     retrieveCtrl.odr = stream;
342     retrieveCtrl.input_format = retrieveCtrl.output_format = input_format;
343     retrieveCtrl.comp = comp;
344     retrieveCtrl.diagnostic = 0;
345     (*rt->retrieve)(&retrieveCtrl);
346     *output_format = retrieveCtrl.output_format;
347     *rec_bufp = retrieveCtrl.rec_buf;
348     *rec_lenp = retrieveCtrl.rec_len;
349     if (fd != -1)
350         close (fd);
351     rec_rm (&rec);
352
353     return retrieveCtrl.diagnostic;
354 }
355
356 bend_fetchresult *bend_fetch (void *handle, bend_fetchrequest *q, int *num)
357 {
358     static bend_fetchresult r;
359     int positions[2];
360     ZServerSetSysno *records;
361
362     register_lock (&server_info);
363
364     r.errstring = 0;
365     r.last_in_set = 0;
366     r.basename = "base";
367
368     odr_reset (server_info.odr);
369     server_info.errCode = 0;
370
371     positions[0] = q->number;
372     records = resultSetSysnoGet (&server_info, q->setname, 1, positions);
373     if (!records)
374     {
375         logf (LOG_DEBUG, "resultSetRecordGet, error");
376         r.errcode = 13;
377         register_unlock (&server_info);
378         return &r;
379     }
380     if (!records[0].sysno)
381     {
382         r.errcode = 13;
383         logf (LOG_DEBUG, "Out of range. pos=%d", q->number);
384         register_unlock (&server_info);
385         return &r;
386     }
387     r.errcode = record_fetch (&server_info, records[0].sysno,
388                               records[0].score, q->stream, q->format,
389                               q->comp, &r.format, &r.record, &r.len);
390     resultSetSysnoDel (&server_info, records, 1);
391     register_unlock (&server_info);
392     return &r;
393 }
394
395 bend_deleteresult *bend_delete (void *handle, bend_deleterequest *q, int *num)
396 {
397     register_lock (&server_info);
398     register_unlock (&server_info);
399     return 0;
400 }
401
402 bend_scanresult *bend_scan (void *handle, bend_scanrequest *q, int *num)
403 {
404     static bend_scanresult r;
405     int status;
406
407     register_lock (&server_info);
408     odr_reset (server_info.odr);
409     server_info.errCode = 0;
410     server_info.errString = 0;
411
412     r.term_position = q->term_position;
413     r.num_entries = q->num_entries;
414     r.errcode = rpn_scan (&server_info, q->term,
415                           q->num_bases, q->basenames,
416                           &r.term_position,
417                           &r.num_entries, &r.entries, &status);
418     r.errstring = server_info.errString;
419     r.status = status;
420     register_unlock (&server_info);
421     return &r;
422 }
423
424 void bend_close (void *handle)
425 {
426     if (server_info.records)
427     {
428         dict_close (server_info.wordDict);
429         is_close (server_info.wordIsam);
430         rec_close (&server_info.records);
431         register_unlock (&server_info);
432     }
433     return;
434 }
435
436 int main (int argc, char **argv)
437 {
438     struct statserv_options_block *sob;
439
440     sob = statserv_getcontrol ();
441     strcpy (sob->configname, FNAME_CONFIG);
442     statserv_setcontrol (sob);
443
444     return statserv_main (argc, argv);
445 }