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