2 * Copyright (C) 1995-1999, Index Data
4 * Sebastian Hammer, Adam Dickmeiss
7 * Revision 1.27 2000-02-24 12:31:17 adam
8 * Added zebra_string_norm.
10 * Revision 1.26 1999/11/30 13:48:03 adam
11 * Improved installation. Updated for inclusion of YAZ header files.
13 * Revision 1.25 1999/11/04 15:00:45 adam
14 * Implemented delete result set(s).
16 * Revision 1.24 1999/10/14 14:33:50 adam
17 * Added truncation 5=106.
19 * Revision 1.23 1999/09/07 11:36:32 adam
22 * Revision 1.22 1999/08/02 10:13:47 adam
23 * Fixed bug regarding zebra_hits.
25 * Revision 1.21 1999/07/14 10:59:26 adam
26 * Changed functions isc_getmethod, isams_getmethod.
27 * Improved fatal error handling (such as missing EXPLAIN schema).
29 * Revision 1.20 1999/07/06 12:28:04 adam
30 * Updated record index structure. Format includes version ID. Compression
31 * algorithm ID is stored for each record block.
33 * Revision 1.19 1999/05/26 07:49:13 adam
36 * Revision 1.18 1999/05/15 14:36:38 adam
37 * Updated dictionary. Implemented "compression" of dictionary.
39 * Revision 1.17 1999/05/12 13:08:06 adam
40 * First version of ISAMS.
42 * Revision 1.16 1999/02/19 10:38:30 adam
43 * Implemented chdir-setting.
45 * Revision 1.15 1999/02/17 12:18:12 adam
46 * Fixed zebra_close so that a NULL pointer is ignored.
48 * Revision 1.14 1999/02/02 14:51:11 adam
49 * Updated WIN32 code specific sections. Changed header.
51 * Revision 1.13 1998/12/16 12:23:30 adam
52 * Added facility for database name mapping using resource mapdb.
54 * Revision 1.12 1998/11/16 10:18:10 adam
55 * Better error reporting for result sets.
57 * Revision 1.11 1998/10/16 08:14:34 adam
58 * Updated record control system.
60 * Revision 1.10 1998/09/22 10:03:42 adam
61 * Changed result sets to be persistent in the sense that they can
62 * be re-searched if needed.
63 * Fixed memory leak in rsm_or.
65 * Revision 1.9 1998/09/02 13:53:17 adam
66 * Extra parameter decode added to search routines to implement
69 * Revision 1.8 1998/08/24 17:29:23 adam
72 * Revision 1.7 1998/06/24 12:16:13 adam
73 * Support for relations on text operands. Open range support in
74 * DFA module (i.e. [-j], [g-]).
76 * Revision 1.6 1998/06/22 11:36:47 adam
77 * Added authentication check facility to zebra.
79 * Revision 1.5 1998/06/13 00:14:08 adam
82 * Revision 1.4 1998/06/12 12:22:12 adam
85 * Revision 1.3 1998/05/27 16:57:44 adam
86 * Zebra returns surrogate diagnostic for single records when
89 * Revision 1.2 1998/05/20 10:12:19 adam
90 * Implemented automatic EXPLAIN database maintenance.
91 * Modified Zebra to work with ASN.1 compiled version of YAZ.
93 * Revision 1.1 1998/03/05 08:45:13 adam
94 * New result set model and modular ranking system. Moved towards
95 * descent server API. System information stored as "SGML" records.
108 #include <yaz/diagbib1.h>
111 static void zebra_chdir (ZebraHandle zh)
113 const char *dir = res_get (zh->res, "chdir");
116 logf (LOG_DEBUG, "chdir %s", dir);
124 static void zebra_register_unlock (ZebraHandle zh);
126 static int zebra_register_lock (ZebraHandle zh)
136 state = zebra_server_lock_get_state(zh, &lastChange);
146 zebra_server_lock (zh, state);
150 if (zh->registerState == state)
152 if (zh->registerChange >= lastChange)
154 logf (LOG_LOG, "Register completely updated since last access");
156 else if (zh->registerState == -1)
157 logf (LOG_LOG, "Reading register using state %d pid=%ld", state,
160 logf (LOG_LOG, "Register has changed state from %d to %d",
161 zh->registerState, state);
162 zh->registerChange = lastChange;
165 zebraExplain_close (zh->zei, 0, 0);
167 dict_close (zh->dict);
169 sortIdx_close (zh->sortIdx);
171 isams_close (zh->isams);
176 isc_close (zh->isamc);
178 rec_close (&zh->records);
180 bf_cache (zh->bfs, state ? res_get (zh->res, "shadow") : NULL);
181 zh->registerState = state;
192 if (!(zh->records = rec_open (zh->bfs, 0, 0)))
194 logf (LOG_WARN, "rec_open");
199 if (!(zh->dict = dict_open (zh->bfs, FNAME_DICT, 40, 0, 0)))
201 logf (LOG_WARN, "dict_open");
204 if (!(zh->sortIdx = sortIdx_open (zh->bfs, 0)))
206 logf (LOG_WARN, "sortIdx_open");
209 if (res_get_match (zh->res, "isam", "s", ISAM_DEFAULT))
211 struct ISAMS_M_s isams_m;
212 if (!(zh->isams = isams_open (zh->bfs, FNAME_ISAMS, 0,
213 key_isams_m(zh->res, &isams_m))))
215 logf (LOG_WARN, "isams_open");
220 else if (res_get_match (zh->res, "isam", "i", ISAM_DEFAULT))
222 if (!(zh->isam = is_open (zh->bfs, FNAME_ISAM, key_compare, 0,
223 sizeof (struct it_key), zh->res)))
225 logf (LOG_WARN, "is_open");
229 else if (res_get_match (zh->res, "isam", "c", ISAM_DEFAULT))
231 struct ISAMC_M_s isamc_m;
232 if (!(zh->isamc = isc_open (zh->bfs, FNAME_ISAMC,
233 0, key_isamc_m(zh->res, &isamc_m))))
235 logf (LOG_WARN, "isc_open");
240 zh->zei = zebraExplain_open (zh->records, zh->dh, zh->res, 0, 0, 0);
243 logf (LOG_WARN, "Cannot obtain EXPLAIN information");
249 zebra_register_unlock (zh);
250 zh->registerState = -1;
256 static void zebra_register_unlock (ZebraHandle zh)
258 static int waitSec = -1;
262 logf (LOG_LOG, "user/system: %ld/%ld",
263 (long) (zh->tms2.tms_utime - zh->tms1.tms_utime),
264 (long) (zh->tms2.tms_stime - zh->tms1.tms_stime));
268 char *s = res_get (zh->res, "debugRequestWait");
279 if (zh->registerState != -1)
280 zebra_server_unlock (zh, zh->registerState);
283 ZebraHandle zebra_open (const char *configName)
287 zh = (ZebraHandle) xmalloc (sizeof(*zh));
288 if (!(zh->res = res_open (configName)))
290 logf (LOG_WARN, "Failed to read resources `%s'", configName);
294 zebra_server_lock_init (zh);
295 zh->dh = data1_create ();
298 zebra_server_lock_destroy (zh);
302 zh->bfs = bfs_create (res_get (zh->res, "register"));
305 zebra_server_lock_destroy (zh);
306 data1_destroy(zh->dh);
310 bf_lockDir (zh->bfs, res_get (zh->res, "lockDir"));
311 data1_set_tabpath (zh->dh, res_get(zh->res, "profilePath"));
313 zh->registerState = -1; /* trigger open of registers! */
314 zh->registerChange = 0;
315 zh->recTypes = recTypes_init (zh->dh);
316 recTypes_default_handlers (zh->recTypes);
319 zh->zebra_maps = zebra_maps_open (zh->res);
320 zh->rank_classes = NULL;
324 zebraRankInstall (zh, rank1_class);
326 if (!res_get (zh->res, "passwd"))
327 zh->passwd_db = NULL;
330 zh->passwd_db = passwd_db_open ();
332 logf (LOG_WARN|LOG_ERRNO, "passwd_db_open failed");
334 passwd_db_file (zh->passwd_db, res_get (zh->res, "passwd"));
339 void zebra_close (ZebraHandle zh)
346 resultSetDestroy (zh, -1, 0, 0);
347 zebraExplain_close (zh->zei, 0, 0);
348 dict_close (zh->dict);
349 sortIdx_close (zh->sortIdx);
351 isams_close (zh->isams);
356 isc_close (zh->isamc);
358 rec_close (&zh->records);
359 zebra_register_unlock (zh);
361 recTypes_destroy (zh->recTypes);
362 zebra_maps_close (zh->zebra_maps);
363 zebraRankDestroy (zh);
364 bfs_destroy (zh->bfs);
365 data1_destroy (zh->dh);
366 zebra_server_lock_destroy (zh);
369 passwd_db_close (zh->passwd_db);
374 struct map_baseinfo {
380 char **new_basenames;
384 void map_basenames_func (void *vp, const char *name, const char *value)
386 struct map_baseinfo *p = (struct map_baseinfo *) vp;
388 char fromdb[128], todb[8][128];
391 sscanf (value, "%127s %127s %127s %127s %127s %127s %127s %127s %127s",
392 fromdb, todb[0], todb[1], todb[2], todb[3], todb[4],
393 todb[5], todb[6], todb[7]);
397 for (i = 0; i<p->num_bases; i++)
398 if (p->basenames[i] && !strcmp (p->basenames[i], fromdb))
401 for (i = 0; i < no; i++)
403 if (p->new_num_bases == p->new_num_max)
405 p->new_basenames[(p->new_num_bases)++] =
406 nmem_strdup (p->mem, todb[i]);
412 void map_basenames (ZebraHandle zh, ODR stream,
413 int *num_bases, char ***basenames)
415 struct map_baseinfo info;
416 struct map_baseinfo *p = &info;
420 info.num_bases = *num_bases;
421 info.basenames = *basenames;
422 info.new_num_max = 128;
423 info.new_num_bases = 0;
424 info.new_basenames = (char **)
425 odr_malloc (stream, sizeof(*info.new_basenames) * info.new_num_max);
426 info.mem = stream->mem;
428 res_trav (zh->res, "mapdb", &info, map_basenames_func);
430 for (i = 0; i<p->num_bases; i++)
431 if (p->basenames[i] && p->new_num_bases < p->new_num_max)
433 p->new_basenames[(p->new_num_bases)++] =
434 nmem_strdup (p->mem, p->basenames[i]);
436 *num_bases = info.new_num_bases;
437 *basenames = info.new_basenames;
438 for (i = 0; i<*num_bases; i++)
439 logf (LOG_LOG, "base %s", (*basenames)[i]);
442 void zebra_search_rpn (ZebraHandle zh, ODR stream, ODR decode,
443 Z_RPNQuery *query, int num_bases, char **basenames,
447 if (zebra_register_lock (zh))
449 map_basenames (zh, stream, &num_bases, &basenames);
450 resultSetAddRPN (zh, stream, decode, query, num_bases, basenames, setname);
452 zebra_register_unlock (zh);
455 void zebra_records_retrieve (ZebraHandle zh, ODR stream,
456 const char *setname, Z_RecordComposition *comp,
457 oid_value input_format, int num_recs,
458 ZebraRetrievalRecord *recs)
463 if (zebra_register_lock (zh))
465 pos_array = (int *) xmalloc (num_recs * sizeof(*pos_array));
466 for (i = 0; i<num_recs; i++)
467 pos_array[i] = recs[i].position;
468 poset = zebraPosSetCreate (zh, setname, num_recs, pos_array);
471 logf (LOG_DEBUG, "zebraPosSetCreate error");
473 zh->errString = nmem_strdup (stream->mem, setname);
477 for (i = 0; i<num_recs; i++)
483 sprintf (num_str, "%d", pos_array[i]);
485 zh->errString = nmem_strdup (stream->mem, num_str);
491 zebra_record_fetch (zh, poset[i].sysno, poset[i].score,
492 stream, input_format, comp,
493 &recs[i].format, &recs[i].buf,
496 recs[i].errString = NULL;
499 zebraPosSetDestroy (zh, poset, num_recs);
501 zebra_register_unlock (zh);
505 void zebra_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
506 oid_value attributeset,
507 int num_bases, char **basenames,
508 int *position, int *num_entries, ZebraScanEntry **entries,
511 if (zebra_register_lock (zh))
517 map_basenames (zh, stream, &num_bases, &basenames);
518 rpn_scan (zh, stream, zapt, attributeset,
519 num_bases, basenames, position,
520 num_entries, entries, is_partial);
521 zebra_register_unlock (zh);
524 void zebra_sort (ZebraHandle zh, ODR stream,
525 int num_input_setnames, const char **input_setnames,
526 const char *output_setname, Z_SortKeySpecList *sort_sequence,
529 if (zebra_register_lock (zh))
531 resultSetSort (zh, stream->mem, num_input_setnames, input_setnames,
532 output_setname, sort_sequence, sort_status);
533 zebra_register_unlock (zh);
536 int zebra_deleleResultSet(ZebraHandle zh, int function,
537 int num_setnames, char **setnames,
541 if (zebra_register_lock (zh))
542 return Z_DeleteStatus_systemProblemAtTarget;
545 case Z_DeleteRequest_list:
546 resultSetDestroy (zh, num_setnames, setnames, statuses);
548 case Z_DeleteRequest_all:
549 resultSetDestroy (zh, -1, 0, statuses);
552 zebra_register_unlock (zh);
553 status = Z_DeleteStatus_success;
554 for (i = 0; i<num_setnames; i++)
555 if (statuses[i] == Z_DeleteStatus_resultSetDidNotExist)
556 status = statuses[i];
560 int zebra_errCode (ZebraHandle zh)
565 const char *zebra_errString (ZebraHandle zh)
567 return diagbib1_str (zh->errCode);
570 char *zebra_errAdd (ZebraHandle zh)
572 return zh->errString;
575 int zebra_hits (ZebraHandle zh)
580 int zebra_auth (ZebraHandle zh, const char *user, const char *pass)
582 if (!zh->passwd_db || !passwd_db_auth (zh->passwd_db, user, pass))
587 void zebra_setDB (ZebraHandle zh, int num_bases, char **basenames)
592 void zebra_setRecordType (ZebraHandle zh, const char *type)
597 void zebra_setGroup (ZebraHandle zh, const char *group)
602 void zebra_admin (ZebraHandle zh, const char *command)
607 int zebra_string_norm (ZebraHandle zh, unsigned reg_id,
608 const char *input_str, int input_len,
609 char *output_str, int output_len)
614 wrbuf = zebra_replace(zh->zebra_maps, reg_id, "",
615 input_str, input_len);
618 if (wrbuf_len(wrbuf) >= output_len)
620 if (wrbuf_len(wrbuf))
621 memcpy (output_str, wrbuf_buf(wrbuf), wrbuf_len(wrbuf));
622 output_str[wrbuf_len(wrbuf)] = '\0';
623 return wrbuf_len(wrbuf);