2 * Copyright (C) 1995-2002, Index Data
5 * $Id: zebraapi.c,v 1.45 2002-02-20 17:30:01 adam Exp $
18 #include <yaz/diagbib1.h>
22 static void zebra_chdir (ZebraService zh)
24 const char *dir = res_get (zh->res, "chdir");
27 logf (LOG_DEBUG, "chdir %s", dir);
35 static void zebra_flush_reg (ZebraHandle zh)
37 if (zh->service->matchDict)
38 dict_close (zh->service->matchDict);
39 zh->service->matchDict = 0;
40 zebraExplain_flush (zh->service->zei, 1, zh);
42 extract_flushWriteKeys (zh);
43 zebra_index_merge (zh);
47 static int zebra_register_activate (ZebraHandle zh, int rw, int useshadow);
48 static int zebra_register_deactivate (ZebraHandle zh);
50 static int zebra_begin_read (ZebraHandle zh);
51 static void zebra_end_read (ZebraHandle zh);
53 ZebraHandle zebra_open (ZebraService zs)
61 zh = (ZebraHandle) xmalloc (sizeof(*zh));
62 yaz_log (LOG_LOG, "zebra_open zs=%p returns %p", zs, zh);
74 zh->lock_normal = zebra_lock_create ("norm.LCK", 0);
75 zh->lock_shadow = zebra_lock_create ("shadow.LCK", 0);
78 zh->admin_databaseName = 0;
83 zebra_mutex_cond_lock (&zs->session_lock);
85 zh->next = zs->sessions;
88 zebra_mutex_cond_unlock (&zs->session_lock);
94 ZebraService zebra_start (const char *configName)
96 ZebraService zh = xmalloc (sizeof(*zh));
98 yaz_log (LOG_LOG, "zebra_start %s", configName);
100 zh->configName = xstrdup(configName);
105 zh->registerState = -1;
106 zh->registerChange = 0;
108 if (!(zh->res = res_open (zh->configName)))
110 logf (LOG_WARN, "Failed to read resources `%s'", zh->configName);
115 zebra_mutex_cond_init (&zh->session_lock);
116 if (!res_get (zh->res, "passwd"))
117 zh->passwd_db = NULL;
120 zh->passwd_db = passwd_db_open ();
122 logf (LOG_WARN|LOG_ERRNO, "passwd_db_open failed");
124 passwd_db_file (zh->passwd_db, res_get (zh->res, "passwd"));
130 static int zebra_register_activate (ZebraHandle zh, int rw, int useshadow)
132 ZebraService zs = zh->service;
133 int record_compression = REC_COMPRESS_NONE;
134 char *recordCompression = 0;
136 yaz_log (LOG_LOG, "zebra_open_register_activate rw = %d useshadow=%d",
139 zs->dh = data1_create ();
142 zs->bfs = bfs_create (res_get (zs->res, "register"));
145 data1_destroy(zs->dh);
148 bf_lockDir (zs->bfs, res_get (zs->res, "lockDir"));
150 bf_cache (zs->bfs, res_get (zs->res, "shadow"));
151 data1_set_tabpath (zs->dh, res_get(zs->res, "profilePath"));
152 zs->recTypes = recTypes_init (zs->dh);
153 recTypes_default_handlers (zs->recTypes);
156 zs->zebra_maps = zebra_maps_open (zs->res);
157 zs->rank_classes = NULL;
170 zebraRankInstall (zs, rank1_class);
172 recordCompression = res_get_def (zh->service->res,
173 "recordCompression", "none");
174 if (!strcmp (recordCompression, "none"))
175 record_compression = REC_COMPRESS_NONE;
176 if (!strcmp (recordCompression, "bzip2"))
177 record_compression = REC_COMPRESS_BZIP2;
179 if (!(zs->records = rec_open (zs->bfs, rw, record_compression)))
181 logf (LOG_WARN, "rec_open");
184 if (!(zs->dict = dict_open (zs->bfs, FNAME_DICT, 80, rw, 0)))
186 logf (LOG_WARN, "dict_open");
189 if (!(zs->sortIdx = sortIdx_open (zs->bfs, rw)))
191 logf (LOG_WARN, "sortIdx_open");
194 if (res_get_match (zs->res, "isam", "s", ISAM_DEFAULT))
196 struct ISAMS_M_s isams_m;
197 if (!(zs->isams = isams_open (zs->bfs, FNAME_ISAMS, rw,
198 key_isams_m(zs->res, &isams_m))))
200 logf (LOG_WARN, "isams_open");
205 else if (res_get_match (zs->res, "isam", "i", ISAM_DEFAULT))
207 if (!(zs->isam = is_open (zs->bfs, FNAME_ISAM, key_compare, rw,
208 sizeof (struct it_key), zs->res)))
210 logf (LOG_WARN, "is_open");
214 else if (res_get_match (zs->res, "isam", "c", ISAM_DEFAULT))
216 struct ISAMC_M_s isamc_m;
217 if (!(zs->isamc = isc_open (zs->bfs, FNAME_ISAMC,
218 rw, key_isamc_m(zs->res, &isamc_m))))
220 logf (LOG_WARN, "isc_open");
224 else if (res_get_match (zs->res, "isam", "d", ISAM_DEFAULT))
226 struct ISAMD_M_s isamd_m;
228 if (!(zs->isamd = isamd_open (zs->bfs, FNAME_ISAMD,
229 rw, key_isamd_m(zs->res, &isamd_m))))
231 logf (LOG_WARN, "isamd_open");
236 zs->zei = zebraExplain_open (zs->records, zs->dh,
241 logf (LOG_WARN, "Cannot obtain EXPLAIN information");
245 yaz_log (LOG_LOG, "zebra_register_activate ok");
249 void zebra_admin_shutdown (ZebraHandle zh)
251 zebra_mutex_cond_lock (&zh->service->session_lock);
252 zh->service->stop_flag = 1;
253 if (!zh->service->sessions)
254 zebra_register_deactivate(zh);
255 zh->service->active = 0;
256 zebra_mutex_cond_unlock (&zh->service->session_lock);
259 void zebra_admin_start (ZebraHandle zh)
261 ZebraService zs = zh->service;
263 zebra_mutex_cond_lock (&zs->session_lock);
265 zh->service->active = 1;
266 zebra_mutex_cond_unlock (&zs->session_lock);
269 static int zebra_register_deactivate (ZebraHandle zh)
271 ZebraService zs = zh->service;
275 yaz_log(LOG_LOG, "zebra_register_deactivate (ignored since active=%d)",
279 yaz_log(LOG_LOG, "zebra_register_deactivate");
283 zebraExplain_close (zs->zei, 0);
284 dict_close (zs->dict);
285 sortIdx_close (zs->sortIdx);
287 isams_close (zs->isams);
292 isc_close (zs->isamc);
294 isamd_close (zs->isamd);
296 rec_close (&zs->records);
298 resultSetInvalidate (zh);
300 recTypes_destroy (zs->recTypes);
301 zebra_maps_close (zs->zebra_maps);
302 zebraRankDestroy (zs);
303 bfs_destroy (zs->bfs);
304 data1_destroy (zs->dh);
307 passwd_db_close (zs->passwd_db);
312 void zebra_stop(ZebraService zs)
316 yaz_log (LOG_LOG, "zebra_stop");
318 zebra_mutex_cond_lock (&zs->session_lock);
321 zebra_register_deactivate(zs->sessions);
322 zebra_close (zs->sessions);
325 zebra_mutex_cond_unlock (&zs->session_lock);
327 zebra_mutex_cond_destroy (&zs->session_lock);
330 xfree (zs->configName);
334 void zebra_close (ZebraHandle zh)
337 struct zebra_session **sp;
343 yaz_log (LOG_LOG, "zebra_close zh=%p", zh);
346 resultSetDestroy (zh, -1, 0, 0);
354 xfree (zh->admin_databaseName);
355 zebra_mutex_cond_lock (&zs->session_lock);
356 zebra_lock_destroy (zh->lock_normal);
357 zebra_lock_destroy (zh->lock_shadow);
369 // if (!zs->sessions && zs->stop_flag)
370 // zebra_register_deactivate(zs);
371 zebra_mutex_cond_unlock (&zs->session_lock);
375 struct map_baseinfo {
381 char **new_basenames;
385 void map_basenames_func (void *vp, const char *name, const char *value)
387 struct map_baseinfo *p = (struct map_baseinfo *) vp;
389 char fromdb[128], todb[8][128];
392 sscanf (value, "%127s %127s %127s %127s %127s %127s %127s %127s %127s",
393 fromdb, todb[0], todb[1], todb[2], todb[3], todb[4],
394 todb[5], todb[6], todb[7]);
398 for (i = 0; i<p->num_bases; i++)
399 if (p->basenames[i] && !strcmp (p->basenames[i], fromdb))
402 for (i = 0; i < no; i++)
404 if (p->new_num_bases == p->new_num_max)
406 p->new_basenames[(p->new_num_bases)++] =
407 nmem_strdup (p->mem, todb[i]);
413 void map_basenames (ZebraHandle zh, ODR stream,
414 int *num_bases, char ***basenames)
416 struct map_baseinfo info;
417 struct map_baseinfo *p = &info;
421 info.num_bases = *num_bases;
422 info.basenames = *basenames;
423 info.new_num_max = 128;
424 info.new_num_bases = 0;
425 info.new_basenames = (char **)
426 odr_malloc (stream, sizeof(*info.new_basenames) * info.new_num_max);
427 info.mem = stream->mem;
429 res_trav (zh->service->res, "mapdb", &info, map_basenames_func);
431 for (i = 0; i<p->num_bases; i++)
432 if (p->basenames[i] && p->new_num_bases < p->new_num_max)
434 p->new_basenames[(p->new_num_bases)++] =
435 nmem_strdup (p->mem, p->basenames[i]);
437 *num_bases = info.new_num_bases;
438 *basenames = info.new_basenames;
439 for (i = 0; i<*num_bases; i++)
440 logf (LOG_LOG, "base %s", (*basenames)[i]);
443 void zebra_search_rpn (ZebraHandle zh, ODR stream, ODR decode,
444 Z_RPNQuery *query, int num_bases, char **basenames,
448 if (zebra_begin_read (zh))
450 map_basenames (zh, stream, &num_bases, &basenames);
451 resultSetAddRPN (zh, stream, decode, query, num_bases, basenames, setname);
455 logf(LOG_APP,"SEARCH:%d:",zh->hits);
458 void zebra_records_retrieve (ZebraHandle zh, ODR stream,
459 const char *setname, Z_RecordComposition *comp,
460 oid_value input_format, int num_recs,
461 ZebraRetrievalRecord *recs)
466 if (zebra_begin_read (zh))
469 pos_array = (int *) xmalloc (num_recs * sizeof(*pos_array));
470 for (i = 0; i<num_recs; i++)
471 pos_array[i] = recs[i].position;
472 poset = zebraPosSetCreate (zh, setname, num_recs, pos_array);
475 logf (LOG_DEBUG, "zebraPosSetCreate error");
477 zh->errString = nmem_strdup (stream->mem, setname);
481 for (i = 0; i<num_recs; i++)
486 recs[i].format = VAL_SUTRS;
487 recs[i].len = strlen(poset[i].term);
488 recs[i].buf = poset[i].term;
489 recs[i].base = poset[i].db;
491 else if (poset[i].sysno)
494 zebra_record_fetch (zh, poset[i].sysno, poset[i].score,
495 stream, input_format, comp,
496 &recs[i].format, &recs[i].buf,
499 recs[i].errString = NULL;
505 sprintf (num_str, "%d", pos_array[i]);
507 zh->errString = nmem_strdup (stream->mem, num_str);
511 zebraPosSetDestroy (zh, poset, num_recs);
517 void zebra_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
518 oid_value attributeset,
519 int num_bases, char **basenames,
520 int *position, int *num_entries, ZebraScanEntry **entries,
523 if (zebra_begin_read (zh))
529 map_basenames (zh, stream, &num_bases, &basenames);
530 rpn_scan (zh, stream, zapt, attributeset,
531 num_bases, basenames, position,
532 num_entries, entries, is_partial);
536 void zebra_sort (ZebraHandle zh, ODR stream,
537 int num_input_setnames, const char **input_setnames,
538 const char *output_setname, Z_SortKeySpecList *sort_sequence,
541 if (zebra_begin_read (zh))
543 resultSetSort (zh, stream->mem, num_input_setnames, input_setnames,
544 output_setname, sort_sequence, sort_status);
548 int zebra_deleleResultSet(ZebraHandle zh, int function,
549 int num_setnames, char **setnames,
553 if (zebra_begin_read(zh))
554 return Z_DeleteStatus_systemProblemAtTarget;
557 case Z_DeleteRequest_list:
558 resultSetDestroy (zh, num_setnames, setnames, statuses);
560 case Z_DeleteRequest_all:
561 resultSetDestroy (zh, -1, 0, statuses);
565 status = Z_DeleteStatus_success;
566 for (i = 0; i<num_setnames; i++)
567 if (statuses[i] == Z_DeleteStatus_resultSetDidNotExist)
568 status = statuses[i];
572 int zebra_errCode (ZebraHandle zh)
577 const char *zebra_errString (ZebraHandle zh)
579 return diagbib1_str (zh->errCode);
582 char *zebra_errAdd (ZebraHandle zh)
584 return zh->errString;
587 int zebra_hits (ZebraHandle zh)
592 int zebra_auth (ZebraService zh, const char *user, const char *pass)
594 if (!zh->passwd_db || !passwd_db_auth (zh->passwd_db, user, pass))
596 logf(LOG_APP,"AUTHOK:%s", user?user:"ANONYMOUS");
600 logf(LOG_APP,"AUTHFAIL:%s", user?user:"ANONYMOUS");
604 void zebra_admin_import_begin (ZebraHandle zh, const char *database)
606 zebra_begin_trans (zh);
607 xfree (zh->admin_databaseName);
608 zh->admin_databaseName = xstrdup(database);
611 void zebra_admin_import_end (ZebraHandle zh)
613 zebra_end_trans (zh);
616 void zebra_admin_import_segment (ZebraHandle zh, Z_Segment *segment)
620 if (zh->service->active < 2)
622 for (i = 0; i<segment->num_segmentRecords; i++)
624 Z_NamePlusRecord *npr = segment->segmentRecords[i];
625 const char *databaseName = npr->databaseName;
628 databaseName = zh->admin_databaseName;
629 printf ("--------------%d--------------------\n", i);
630 if (npr->which == Z_NamePlusRecord_intermediateFragment)
632 Z_FragmentSyntax *fragment = npr->u.intermediateFragment;
633 if (fragment->which == Z_FragmentSyntax_notExternallyTagged)
635 Odr_oct *oct = fragment->u.notExternallyTagged;
636 printf ("%.*s", (oct->len > 100 ? 100 : oct->len) ,
640 extract_rec_in_mem (zh, "grs.sgml",
648 0 /* match criteria */);
654 void zebra_admin_create (ZebraHandle zh, const char *database)
658 zebra_begin_trans (zh);
661 /* announce database */
662 if (zebraExplain_newDatabase (zh->service->zei, database, 0
663 /* explainDatabase */))
666 zh->errString = "Database already exist";
668 zebra_end_trans (zh);
671 int zebra_string_norm (ZebraHandle zh, unsigned reg_id,
672 const char *input_str, int input_len,
673 char *output_str, int output_len)
676 if (!zh->service->zebra_maps)
678 wrbuf = zebra_replace(zh->service->zebra_maps, reg_id, "",
679 input_str, input_len);
682 if (wrbuf_len(wrbuf) >= output_len)
684 if (wrbuf_len(wrbuf))
685 memcpy (output_str, wrbuf_buf(wrbuf), wrbuf_len(wrbuf));
686 output_str[wrbuf_len(wrbuf)] = '\0';
687 return wrbuf_len(wrbuf);
691 void zebra_set_state (int val, int seqno)
694 FILE *f = fopen ("state.LCK", "w");
695 fprintf (f, "%c %d %ld\n", val, seqno, p);
699 void zebra_get_state (char *val, int *seqno)
701 FILE *f = fopen ("state.LCK", "r");
708 fscanf (f, "%c %d", val, seqno);
713 static int zebra_begin_read (ZebraHandle zh)
719 zebra_flush_reg (zh);
723 if (zh->trans_no != 1)
726 zebra_get_state (&val, &seqno);
729 if (seqno != zh->seqno)
731 yaz_log (LOG_LOG, "reopen seqno cur/old %d/%d", seqno, zh->seqno);
734 else if (zh->last_val != val)
736 yaz_log (LOG_LOG, "reopen last cur/old %d/%d", val, zh->last_val);
743 zebra_lock_r (zh->lock_shadow);
745 zebra_lock_r (zh->lock_normal);
750 zebra_register_deactivate (zh);
752 zebra_register_activate (zh, 0, val == 'c' ? 1 : 0);
756 static void zebra_end_read (ZebraHandle zh)
760 if (zh->trans_no != 0)
763 zebra_unlock (zh->lock_normal);
764 zebra_unlock (zh->lock_shadow);
767 void zebra_begin_trans (ZebraHandle zh)
775 if (zh->trans_no != 1)
780 yaz_log (LOG_LOG, "zebra_begin_trans");
786 rval = res_get (zh->service->res, "shadow");
788 for (pass = 0; pass < 2; pass++)
792 zebra_lock_r (zh->lock_normal);
793 zebra_lock_w (zh->lock_shadow);
797 zebra_lock_w (zh->lock_normal);
798 zebra_lock_w (zh->lock_shadow);
801 zebra_get_state (&val, &seqno);
804 yaz_log (LOG_LOG, "previous transaction didn't finish commit");
805 zebra_unlock (zh->lock_shadow);
806 zebra_unlock (zh->lock_normal);
814 BFiles bfs = bfs_create (res_get (zh->service->res, "shadow"));
815 yaz_log (LOG_LOG, "previous transaction didn't reach commit");
816 bf_commitClean (bfs, rval);
821 yaz_log (LOG_WARN, "your previous transaction didn't finish");
828 yaz_log (LOG_FATAL, "zebra_begin_trans couldn't finish commit");
832 zebra_set_state ('d', seqno);
834 zebra_register_activate (zh, 1, rval ? 1 : 0);
835 zh->service->matchDict = dict_open (zh->service->bfs, GMATCH_DICT,
840 void zebra_end_trans (ZebraHandle zh)
847 if (zh->trans_no != 0)
850 yaz_log (LOG_LOG, "zebra_end_trans");
851 rval = res_get (zh->service->res, "shadow");
853 zebra_flush_reg (zh);
855 zebra_register_deactivate (zh);
857 zebra_get_state (&val, &seqno);
860 BFiles bfs = bfs_create (res_get (zh->service->res, "shadow"));
861 bf_commitClean (bfs, rval);
866 zebra_set_state ('o', seqno);
868 zebra_unlock (zh->lock_shadow);
869 zebra_unlock (zh->lock_normal);
873 logf (LOG_LOG, "user/system: %ld/%ld",
874 (long) (zh->tms2.tms_utime - zh->tms1.tms_utime),
875 (long) (zh->tms2.tms_stime - zh->tms1.tms_stime));
880 void zebra_repository_update (ZebraHandle zh)
882 zebra_begin_trans (zh);
883 logf (LOG_LOG, "updating %s", zh->rGroup.path);
884 repositoryUpdate (zh);
885 zebra_end_trans (zh);
888 void zebra_repository_delete (ZebraHandle zh)
890 logf (LOG_LOG, "deleting %s", zh->rGroup.path);
891 repositoryDelete (zh);
894 void zebra_repository_show (ZebraHandle zh)
899 void zebra_commit (ZebraHandle zh)
903 const char *rval = res_get (zh->service->res, "shadow");
908 logf (LOG_WARN, "Cannot perform commit");
909 logf (LOG_WARN, "No shadow area defined");
913 zebra_lock_w (zh->lock_normal);
914 zebra_lock_r (zh->lock_shadow);
916 bfs = bfs_create (res_get (zh->service->res, "register"));
918 zebra_get_state (&val, &seqno);
921 bf_cache (bfs, rval);
922 if (bf_commitExists (bfs))
924 zebra_set_state ('c', seqno);
926 logf (LOG_LOG, "commit start");
931 logf (LOG_LOG, "commit clean");
932 bf_commitClean (bfs, rval);
934 zebra_set_state ('o', seqno);
938 logf (LOG_LOG, "nothing to commit");
942 zebra_unlock (zh->lock_shadow);
943 zebra_unlock (zh->lock_normal);
946 void zebra_init (ZebraHandle zh)
948 const char *rval = res_get (zh->service->res, "shadow");
951 bfs = bfs_create (res_get (zh->service->res, "register"));
953 bf_cache (bfs, rval);
957 zebra_set_state ('o', 0);
960 void zebra_compact (ZebraHandle zh)
962 BFiles bfs = bfs_create (res_get (zh->service->res, "register"));
967 int zebra_record_insert (ZebraHandle zh, const char *buf, int len)
970 zebra_begin_trans (zh);
971 extract_rec_in_mem (zh, "grs.sgml",
973 "Default", /* database */
979 0 /* match criteria */);
980 zebra_end_trans (zh);