2 * Copyright (C) 1995-1999, Index Data
4 * Sebastian Hammer, Adam Dickmeiss
7 * Revision 1.26 1999-11-30 13:48:03 adam
8 * Improved installation. Updated for inclusion of YAZ header files.
10 * Revision 1.25 1999/11/04 15:00:45 adam
11 * Implemented delete result set(s).
13 * Revision 1.24 1999/10/14 14:33:50 adam
14 * Added truncation 5=106.
16 * Revision 1.23 1999/09/07 11:36:32 adam
19 * Revision 1.22 1999/08/02 10:13:47 adam
20 * Fixed bug regarding zebra_hits.
22 * Revision 1.21 1999/07/14 10:59:26 adam
23 * Changed functions isc_getmethod, isams_getmethod.
24 * Improved fatal error handling (such as missing EXPLAIN schema).
26 * Revision 1.20 1999/07/06 12:28:04 adam
27 * Updated record index structure. Format includes version ID. Compression
28 * algorithm ID is stored for each record block.
30 * Revision 1.19 1999/05/26 07:49:13 adam
33 * Revision 1.18 1999/05/15 14:36:38 adam
34 * Updated dictionary. Implemented "compression" of dictionary.
36 * Revision 1.17 1999/05/12 13:08:06 adam
37 * First version of ISAMS.
39 * Revision 1.16 1999/02/19 10:38:30 adam
40 * Implemented chdir-setting.
42 * Revision 1.15 1999/02/17 12:18:12 adam
43 * Fixed zebra_close so that a NULL pointer is ignored.
45 * Revision 1.14 1999/02/02 14:51:11 adam
46 * Updated WIN32 code specific sections. Changed header.
48 * Revision 1.13 1998/12/16 12:23:30 adam
49 * Added facility for database name mapping using resource mapdb.
51 * Revision 1.12 1998/11/16 10:18:10 adam
52 * Better error reporting for result sets.
54 * Revision 1.11 1998/10/16 08:14:34 adam
55 * Updated record control system.
57 * Revision 1.10 1998/09/22 10:03:42 adam
58 * Changed result sets to be persistent in the sense that they can
59 * be re-searched if needed.
60 * Fixed memory leak in rsm_or.
62 * Revision 1.9 1998/09/02 13:53:17 adam
63 * Extra parameter decode added to search routines to implement
66 * Revision 1.8 1998/08/24 17:29:23 adam
69 * Revision 1.7 1998/06/24 12:16:13 adam
70 * Support for relations on text operands. Open range support in
71 * DFA module (i.e. [-j], [g-]).
73 * Revision 1.6 1998/06/22 11:36:47 adam
74 * Added authentication check facility to zebra.
76 * Revision 1.5 1998/06/13 00:14:08 adam
79 * Revision 1.4 1998/06/12 12:22:12 adam
82 * Revision 1.3 1998/05/27 16:57:44 adam
83 * Zebra returns surrogate diagnostic for single records when
86 * Revision 1.2 1998/05/20 10:12:19 adam
87 * Implemented automatic EXPLAIN database maintenance.
88 * Modified Zebra to work with ASN.1 compiled version of YAZ.
90 * Revision 1.1 1998/03/05 08:45:13 adam
91 * New result set model and modular ranking system. Moved towards
92 * descent server API. System information stored as "SGML" records.
105 #include <yaz/diagbib1.h>
108 static void zebra_chdir (ZebraHandle zh)
110 const char *dir = res_get (zh->res, "chdir");
113 logf (LOG_DEBUG, "chdir %s", dir);
121 static void zebra_register_unlock (ZebraHandle zh);
123 static int zebra_register_lock (ZebraHandle zh)
133 state = zebra_server_lock_get_state(zh, &lastChange);
143 zebra_server_lock (zh, state);
147 if (zh->registerState == state)
149 if (zh->registerChange >= lastChange)
151 logf (LOG_LOG, "Register completely updated since last access");
153 else if (zh->registerState == -1)
154 logf (LOG_LOG, "Reading register using state %d pid=%ld", state,
157 logf (LOG_LOG, "Register has changed state from %d to %d",
158 zh->registerState, state);
159 zh->registerChange = lastChange;
162 zebraExplain_close (zh->zei, 0, 0);
164 dict_close (zh->dict);
166 sortIdx_close (zh->sortIdx);
168 isams_close (zh->isams);
173 isc_close (zh->isamc);
175 rec_close (&zh->records);
177 bf_cache (zh->bfs, state ? res_get (zh->res, "shadow") : NULL);
178 zh->registerState = state;
189 if (!(zh->records = rec_open (zh->bfs, 0, 0)))
191 logf (LOG_WARN, "rec_open");
196 if (!(zh->dict = dict_open (zh->bfs, FNAME_DICT, 40, 0, 0)))
198 logf (LOG_WARN, "dict_open");
201 if (!(zh->sortIdx = sortIdx_open (zh->bfs, 0)))
203 logf (LOG_WARN, "sortIdx_open");
206 if (res_get_match (zh->res, "isam", "s", ISAM_DEFAULT))
208 struct ISAMS_M_s isams_m;
209 if (!(zh->isams = isams_open (zh->bfs, FNAME_ISAMS, 0,
210 key_isams_m(zh->res, &isams_m))))
212 logf (LOG_WARN, "isams_open");
217 else if (res_get_match (zh->res, "isam", "i", ISAM_DEFAULT))
219 if (!(zh->isam = is_open (zh->bfs, FNAME_ISAM, key_compare, 0,
220 sizeof (struct it_key), zh->res)))
222 logf (LOG_WARN, "is_open");
226 else if (res_get_match (zh->res, "isam", "c", ISAM_DEFAULT))
228 struct ISAMC_M_s isamc_m;
229 if (!(zh->isamc = isc_open (zh->bfs, FNAME_ISAMC,
230 0, key_isamc_m(zh->res, &isamc_m))))
232 logf (LOG_WARN, "isc_open");
237 zh->zei = zebraExplain_open (zh->records, zh->dh, zh->res, 0, 0, 0);
240 logf (LOG_WARN, "Cannot obtain EXPLAIN information");
246 zebra_register_unlock (zh);
247 zh->registerState = -1;
253 static void zebra_register_unlock (ZebraHandle zh)
255 static int waitSec = -1;
259 logf (LOG_LOG, "user/system: %ld/%ld",
260 (long) (zh->tms2.tms_utime - zh->tms1.tms_utime),
261 (long) (zh->tms2.tms_stime - zh->tms1.tms_stime));
265 char *s = res_get (zh->res, "debugRequestWait");
276 if (zh->registerState != -1)
277 zebra_server_unlock (zh, zh->registerState);
280 ZebraHandle zebra_open (const char *configName)
284 zh = (ZebraHandle) xmalloc (sizeof(*zh));
285 if (!(zh->res = res_open (configName)))
287 logf (LOG_WARN, "Failed to read resources `%s'", configName);
291 zebra_server_lock_init (zh);
292 zh->dh = data1_create ();
295 zebra_server_lock_destroy (zh);
299 zh->bfs = bfs_create (res_get (zh->res, "register"));
302 zebra_server_lock_destroy (zh);
303 data1_destroy(zh->dh);
307 bf_lockDir (zh->bfs, res_get (zh->res, "lockDir"));
308 data1_set_tabpath (zh->dh, res_get(zh->res, "profilePath"));
310 zh->registerState = -1; /* trigger open of registers! */
311 zh->registerChange = 0;
312 zh->recTypes = recTypes_init (zh->dh);
313 recTypes_default_handlers (zh->recTypes);
316 zh->zebra_maps = zebra_maps_open (zh->res);
317 zh->rank_classes = NULL;
321 zebraRankInstall (zh, rank1_class);
323 if (!res_get (zh->res, "passwd"))
324 zh->passwd_db = NULL;
327 zh->passwd_db = passwd_db_open ();
329 logf (LOG_WARN|LOG_ERRNO, "passwd_db_open failed");
331 passwd_db_file (zh->passwd_db, res_get (zh->res, "passwd"));
336 void zebra_close (ZebraHandle zh)
343 resultSetDestroy (zh, -1, 0, 0);
344 zebraExplain_close (zh->zei, 0, 0);
345 dict_close (zh->dict);
346 sortIdx_close (zh->sortIdx);
348 isams_close (zh->isams);
353 isc_close (zh->isamc);
355 rec_close (&zh->records);
356 zebra_register_unlock (zh);
358 recTypes_destroy (zh->recTypes);
359 zebra_maps_close (zh->zebra_maps);
360 zebraRankDestroy (zh);
361 bfs_destroy (zh->bfs);
362 data1_destroy (zh->dh);
363 zebra_server_lock_destroy (zh);
366 passwd_db_close (zh->passwd_db);
371 struct map_baseinfo {
377 char **new_basenames;
381 void map_basenames_func (void *vp, const char *name, const char *value)
383 struct map_baseinfo *p = (struct map_baseinfo *) vp;
385 char fromdb[128], todb[8][128];
388 sscanf (value, "%127s %127s %127s %127s %127s %127s %127s %127s %127s",
389 fromdb, todb[0], todb[1], todb[2], todb[3], todb[4],
390 todb[5], todb[6], todb[7]);
394 for (i = 0; i<p->num_bases; i++)
395 if (p->basenames[i] && !strcmp (p->basenames[i], fromdb))
398 for (i = 0; i < no; i++)
400 if (p->new_num_bases == p->new_num_max)
402 p->new_basenames[(p->new_num_bases)++] =
403 nmem_strdup (p->mem, todb[i]);
409 void map_basenames (ZebraHandle zh, ODR stream,
410 int *num_bases, char ***basenames)
412 struct map_baseinfo info;
413 struct map_baseinfo *p = &info;
417 info.num_bases = *num_bases;
418 info.basenames = *basenames;
419 info.new_num_max = 128;
420 info.new_num_bases = 0;
421 info.new_basenames = (char **)
422 odr_malloc (stream, sizeof(*info.new_basenames) * info.new_num_max);
423 info.mem = stream->mem;
425 res_trav (zh->res, "mapdb", &info, map_basenames_func);
427 for (i = 0; i<p->num_bases; i++)
428 if (p->basenames[i] && p->new_num_bases < p->new_num_max)
430 p->new_basenames[(p->new_num_bases)++] =
431 nmem_strdup (p->mem, p->basenames[i]);
433 *num_bases = info.new_num_bases;
434 *basenames = info.new_basenames;
435 for (i = 0; i<*num_bases; i++)
436 logf (LOG_LOG, "base %s", (*basenames)[i]);
439 void zebra_search_rpn (ZebraHandle zh, ODR stream, ODR decode,
440 Z_RPNQuery *query, int num_bases, char **basenames,
444 if (zebra_register_lock (zh))
446 map_basenames (zh, stream, &num_bases, &basenames);
447 resultSetAddRPN (zh, stream, decode, query, num_bases, basenames, setname);
449 zebra_register_unlock (zh);
452 void zebra_records_retrieve (ZebraHandle zh, ODR stream,
453 const char *setname, Z_RecordComposition *comp,
454 oid_value input_format, int num_recs,
455 ZebraRetrievalRecord *recs)
460 if (zebra_register_lock (zh))
462 pos_array = (int *) xmalloc (num_recs * sizeof(*pos_array));
463 for (i = 0; i<num_recs; i++)
464 pos_array[i] = recs[i].position;
465 poset = zebraPosSetCreate (zh, setname, num_recs, pos_array);
468 logf (LOG_DEBUG, "zebraPosSetCreate error");
470 zh->errString = nmem_strdup (stream->mem, setname);
474 for (i = 0; i<num_recs; i++)
480 sprintf (num_str, "%d", pos_array[i]);
482 zh->errString = nmem_strdup (stream->mem, num_str);
488 zebra_record_fetch (zh, poset[i].sysno, poset[i].score,
489 stream, input_format, comp,
490 &recs[i].format, &recs[i].buf,
493 recs[i].errString = NULL;
496 zebraPosSetDestroy (zh, poset, num_recs);
498 zebra_register_unlock (zh);
502 void zebra_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
503 oid_value attributeset,
504 int num_bases, char **basenames,
505 int *position, int *num_entries, ZebraScanEntry **entries,
508 if (zebra_register_lock (zh))
514 map_basenames (zh, stream, &num_bases, &basenames);
515 rpn_scan (zh, stream, zapt, attributeset,
516 num_bases, basenames, position,
517 num_entries, entries, is_partial);
518 zebra_register_unlock (zh);
521 void zebra_sort (ZebraHandle zh, ODR stream,
522 int num_input_setnames, const char **input_setnames,
523 const char *output_setname, Z_SortKeySpecList *sort_sequence,
526 if (zebra_register_lock (zh))
528 resultSetSort (zh, stream->mem, num_input_setnames, input_setnames,
529 output_setname, sort_sequence, sort_status);
530 zebra_register_unlock (zh);
533 int zebra_deleleResultSet(ZebraHandle zh, int function,
534 int num_setnames, char **setnames,
538 if (zebra_register_lock (zh))
539 return Z_DeleteStatus_systemProblemAtTarget;
542 case Z_DeleteRequest_list:
543 resultSetDestroy (zh, num_setnames, setnames, statuses);
545 case Z_DeleteRequest_all:
546 resultSetDestroy (zh, -1, 0, statuses);
549 zebra_register_unlock (zh);
550 status = Z_DeleteStatus_success;
551 for (i = 0; i<num_setnames; i++)
552 if (statuses[i] == Z_DeleteStatus_resultSetDidNotExist)
553 status = statuses[i];
557 int zebra_errCode (ZebraHandle zh)
562 const char *zebra_errString (ZebraHandle zh)
564 return diagbib1_str (zh->errCode);
567 char *zebra_errAdd (ZebraHandle zh)
569 return zh->errString;
572 int zebra_hits (ZebraHandle zh)
577 int zebra_auth (ZebraHandle zh, const char *user, const char *pass)
579 if (!zh->passwd_db || !passwd_db_auth (zh->passwd_db, user, pass))
584 void zebra_setDB (ZebraHandle zh, int num_bases, char **basenames)
589 void zebra_setRecordType (ZebraHandle zh, const char *type)
594 void zebra_setGroup (ZebraHandle zh, const char *group)
599 void zebra_admin (ZebraHandle zh, const char *command)