2 * Copyright (C) 1995-2002, Index Data
5 * $Id: zebraapi.c,v 1.49 2002-03-21 10:25:42 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 zebraExplain_flush (zh->service->zei, 1, zh);
39 extract_flushWriteKeys (zh);
40 zebra_index_merge (zh);
44 static int zebra_register_activate (ZebraHandle zh, int rw, int useshadow);
45 static int zebra_register_deactivate (ZebraHandle zh);
47 static int zebra_begin_read (ZebraHandle zh);
48 static void zebra_end_read (ZebraHandle zh);
50 ZebraHandle zebra_open (ZebraService zs)
58 zh = (ZebraHandle) xmalloc (sizeof(*zh));
59 yaz_log (LOG_LOG, "zebra_open zs=%p returns %p", zs, zh);
71 zh->lock_normal = zebra_lock_create (res_get(zs->res, "lockDir"),
73 zh->lock_shadow = zebra_lock_create (res_get(zs->res, "lockDir"),
77 zh->admin_databaseName = 0;
82 zebra_mutex_cond_lock (&zs->session_lock);
84 zh->next = zs->sessions;
87 zebra_mutex_cond_unlock (&zs->session_lock);
93 ZebraService zebra_start (const char *configName)
95 ZebraService zh = xmalloc (sizeof(*zh));
97 yaz_log (LOG_LOG, "zebra_start %s", configName);
99 zh->configName = xstrdup(configName);
104 zh->registerState = -1;
105 zh->registerChange = 0;
107 if (!(zh->res = res_open (zh->configName)))
109 logf (LOG_WARN, "Failed to read resources `%s'", zh->configName);
114 zebra_mutex_cond_init (&zh->session_lock);
115 if (!res_get (zh->res, "passwd"))
116 zh->passwd_db = NULL;
119 zh->passwd_db = passwd_db_open ();
121 logf (LOG_WARN|LOG_ERRNO, "passwd_db_open failed");
123 passwd_db_file (zh->passwd_db, res_get (zh->res, "passwd"));
129 static int zebra_register_activate (ZebraHandle zh, int rw, int useshadow)
131 ZebraService zs = zh->service;
132 int record_compression = REC_COMPRESS_NONE;
133 char *recordCompression = 0;
135 yaz_log (LOG_LOG, "zebra_open_register_activate rw = %d useshadow=%d",
138 zs->dh = data1_create ();
141 zs->bfs = bfs_create (res_get (zs->res, "register"));
144 data1_destroy(zs->dh);
147 bf_lockDir (zs->bfs, res_get (zs->res, "lockDir"));
149 bf_cache (zs->bfs, res_get (zs->res, "shadow"));
150 data1_set_tabpath (zs->dh, res_get(zs->res, "profilePath"));
151 zs->recTypes = recTypes_init (zs->dh);
152 recTypes_default_handlers (zs->recTypes);
154 zs->zebra_maps = zebra_maps_open (zs->res);
155 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");
186 zs->matchDict = dict_open (zs->bfs, GMATCH_DICT, 20, 1, 0);
188 if (!(zs->dict = dict_open (zs->bfs, FNAME_DICT, 40, rw, 0)))
190 logf (LOG_WARN, "dict_open");
193 if (!(zs->sortIdx = sortIdx_open (zs->bfs, rw)))
195 logf (LOG_WARN, "sortIdx_open");
198 if (res_get_match (zs->res, "isam", "s", ISAM_DEFAULT))
200 struct ISAMS_M_s isams_m;
201 if (!(zs->isams = isams_open (zs->bfs, FNAME_ISAMS, rw,
202 key_isams_m(zs->res, &isams_m))))
204 logf (LOG_WARN, "isams_open");
209 else if (res_get_match (zs->res, "isam", "i", ISAM_DEFAULT))
211 if (!(zs->isam = is_open (zs->bfs, FNAME_ISAM, key_compare, rw,
212 sizeof (struct it_key), zs->res)))
214 logf (LOG_WARN, "is_open");
218 else if (res_get_match (zs->res, "isam", "c", ISAM_DEFAULT))
220 struct ISAMC_M_s isamc_m;
221 if (!(zs->isamc = isc_open (zs->bfs, FNAME_ISAMC,
222 rw, key_isamc_m(zs->res, &isamc_m))))
224 logf (LOG_WARN, "isc_open");
228 else if (res_get_match (zs->res, "isam", "d", ISAM_DEFAULT))
230 struct ISAMD_M_s isamd_m;
232 if (!(zs->isamd = isamd_open (zs->bfs, FNAME_ISAMD,
233 rw, key_isamd_m(zs->res, &isamd_m))))
235 logf (LOG_WARN, "isamd_open");
240 zs->zei = zebraExplain_open (zs->records, zs->dh,
245 logf (LOG_WARN, "Cannot obtain EXPLAIN information");
249 yaz_log (LOG_LOG, "zebra_register_activate ok");
253 void zebra_admin_shutdown (ZebraHandle zh)
255 zebra_mutex_cond_lock (&zh->service->session_lock);
256 zh->service->stop_flag = 1;
257 if (!zh->service->sessions)
258 zebra_register_deactivate(zh);
259 zh->service->active = 0;
260 zebra_mutex_cond_unlock (&zh->service->session_lock);
263 void zebra_admin_start (ZebraHandle zh)
265 ZebraService zs = zh->service;
267 zebra_mutex_cond_lock (&zs->session_lock);
269 zh->service->active = 1;
270 zebra_mutex_cond_unlock (&zs->session_lock);
273 static int zebra_register_deactivate (ZebraHandle zh)
275 ZebraService zs = zh->service;
279 yaz_log(LOG_LOG, "zebra_register_deactivate (ignored since active=%d)",
283 yaz_log(LOG_LOG, "zebra_register_deactivate");
287 zebraExplain_close (zs->zei, 0);
288 dict_close (zs->dict);
290 dict_close (zs->matchDict);
291 sortIdx_close (zs->sortIdx);
293 isams_close (zs->isams);
298 isc_close (zs->isamc);
300 isamd_close (zs->isamd);
302 rec_close (&zs->records);
304 resultSetInvalidate (zh);
306 recTypes_destroy (zs->recTypes);
307 zebra_maps_close (zs->zebra_maps);
308 zebraRankDestroy (zs);
309 bfs_destroy (zs->bfs);
310 data1_destroy (zs->dh);
313 passwd_db_close (zs->passwd_db);
318 void zebra_stop(ZebraService zs)
322 yaz_log (LOG_LOG, "zebra_stop");
324 zebra_mutex_cond_lock (&zs->session_lock);
327 zebra_register_deactivate(zs->sessions);
328 zebra_close (zs->sessions);
331 zebra_mutex_cond_unlock (&zs->session_lock);
333 zebra_mutex_cond_destroy (&zs->session_lock);
336 xfree (zs->configName);
340 void zebra_close (ZebraHandle zh)
343 struct zebra_session **sp;
349 yaz_log (LOG_LOG, "zebra_close zh=%p", zh);
352 resultSetDestroy (zh, -1, 0, 0);
360 xfree (zh->admin_databaseName);
361 zebra_mutex_cond_lock (&zs->session_lock);
362 zebra_lock_destroy (zh->lock_normal);
363 zebra_lock_destroy (zh->lock_shadow);
375 // if (!zs->sessions && zs->stop_flag)
376 // zebra_register_deactivate(zs);
377 zebra_mutex_cond_unlock (&zs->session_lock);
381 struct map_baseinfo {
387 char **new_basenames;
391 void map_basenames_func (void *vp, const char *name, const char *value)
393 struct map_baseinfo *p = (struct map_baseinfo *) vp;
395 char fromdb[128], todb[8][128];
398 sscanf (value, "%127s %127s %127s %127s %127s %127s %127s %127s %127s",
399 fromdb, todb[0], todb[1], todb[2], todb[3], todb[4],
400 todb[5], todb[6], todb[7]);
404 for (i = 0; i<p->num_bases; i++)
405 if (p->basenames[i] && !strcmp (p->basenames[i], fromdb))
408 for (i = 0; i < no; i++)
410 if (p->new_num_bases == p->new_num_max)
412 p->new_basenames[(p->new_num_bases)++] =
413 nmem_strdup (p->mem, todb[i]);
419 void map_basenames (ZebraHandle zh, ODR stream,
420 int *num_bases, char ***basenames)
422 struct map_baseinfo info;
423 struct map_baseinfo *p = &info;
427 info.num_bases = *num_bases;
428 info.basenames = *basenames;
429 info.new_num_max = 128;
430 info.new_num_bases = 0;
431 info.new_basenames = (char **)
432 odr_malloc (stream, sizeof(*info.new_basenames) * info.new_num_max);
433 info.mem = stream->mem;
435 res_trav (zh->service->res, "mapdb", &info, map_basenames_func);
437 for (i = 0; i<p->num_bases; i++)
438 if (p->basenames[i] && p->new_num_bases < p->new_num_max)
440 p->new_basenames[(p->new_num_bases)++] =
441 nmem_strdup (p->mem, p->basenames[i]);
443 *num_bases = info.new_num_bases;
444 *basenames = info.new_basenames;
445 for (i = 0; i<*num_bases; i++)
446 logf (LOG_LOG, "base %s", (*basenames)[i]);
449 void zebra_search_rpn (ZebraHandle zh, ODR stream, ODR decode,
450 Z_RPNQuery *query, int num_bases, char **basenames,
454 if (zebra_begin_read (zh))
456 map_basenames (zh, stream, &num_bases, &basenames);
457 resultSetAddRPN (zh, stream, decode, query, num_bases, basenames, setname);
461 logf(LOG_APP,"SEARCH:%d:",zh->hits);
466 void zebra_records_retrieve (ZebraHandle zh, ODR stream,
467 const char *setname, Z_RecordComposition *comp,
468 oid_value input_format, int num_recs,
469 ZebraRetrievalRecord *recs)
474 if (zebra_begin_read (zh))
477 pos_array = (int *) xmalloc (num_recs * sizeof(*pos_array));
478 for (i = 0; i<num_recs; i++)
479 pos_array[i] = recs[i].position;
480 poset = zebraPosSetCreate (zh, setname, num_recs, pos_array);
483 logf (LOG_DEBUG, "zebraPosSetCreate error");
485 zh->errString = nmem_strdup (stream->mem, setname);
489 for (i = 0; i<num_recs; i++)
494 recs[i].format = VAL_SUTRS;
495 recs[i].len = strlen(poset[i].term);
496 recs[i].buf = poset[i].term;
497 recs[i].base = poset[i].db;
499 else if (poset[i].sysno)
502 zebra_record_fetch (zh, poset[i].sysno, poset[i].score,
503 stream, input_format, comp,
504 &recs[i].format, &recs[i].buf,
507 recs[i].errString = NULL;
513 sprintf (num_str, "%d", pos_array[i]);
515 zh->errString = nmem_strdup (stream->mem, num_str);
519 zebraPosSetDestroy (zh, poset, num_recs);
525 void zebra_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
526 oid_value attributeset,
527 int num_bases, char **basenames,
528 int *position, int *num_entries, ZebraScanEntry **entries,
531 if (zebra_begin_read (zh))
537 map_basenames (zh, stream, &num_bases, &basenames);
538 rpn_scan (zh, stream, zapt, attributeset,
539 num_bases, basenames, position,
540 num_entries, entries, is_partial);
544 void zebra_sort (ZebraHandle zh, ODR stream,
545 int num_input_setnames, const char **input_setnames,
546 const char *output_setname, Z_SortKeySpecList *sort_sequence,
549 if (zebra_begin_read (zh))
551 resultSetSort (zh, stream->mem, num_input_setnames, input_setnames,
552 output_setname, sort_sequence, sort_status);
556 int zebra_deleleResultSet(ZebraHandle zh, int function,
557 int num_setnames, char **setnames,
561 if (zebra_begin_read(zh))
562 return Z_DeleteStatus_systemProblemAtTarget;
565 case Z_DeleteRequest_list:
566 resultSetDestroy (zh, num_setnames, setnames, statuses);
568 case Z_DeleteRequest_all:
569 resultSetDestroy (zh, -1, 0, statuses);
573 status = Z_DeleteStatus_success;
574 for (i = 0; i<num_setnames; i++)
575 if (statuses[i] == Z_DeleteStatus_resultSetDidNotExist)
576 status = statuses[i];
580 int zebra_errCode (ZebraHandle zh)
585 const char *zebra_errString (ZebraHandle zh)
587 return diagbib1_str (zh->errCode);
590 char *zebra_errAdd (ZebraHandle zh)
592 return zh->errString;
595 int zebra_hits (ZebraHandle zh)
600 int zebra_auth (ZebraService zh, const char *user, const char *pass)
602 if (!zh->passwd_db || !passwd_db_auth (zh->passwd_db, user, pass))
604 logf(LOG_APP,"AUTHOK:%s", user?user:"ANONYMOUS");
608 logf(LOG_APP,"AUTHFAIL:%s", user?user:"ANONYMOUS");
612 void zebra_admin_import_begin (ZebraHandle zh, const char *database)
614 zebra_begin_trans (zh);
615 xfree (zh->admin_databaseName);
616 zh->admin_databaseName = xstrdup(database);
619 void zebra_admin_import_end (ZebraHandle zh)
621 zebra_end_trans (zh);
624 void zebra_admin_import_segment (ZebraHandle zh, Z_Segment *segment)
628 if (zh->service->active < 2)
630 for (i = 0; i<segment->num_segmentRecords; i++)
632 Z_NamePlusRecord *npr = segment->segmentRecords[i];
633 const char *databaseName = npr->databaseName;
636 databaseName = zh->admin_databaseName;
637 printf ("--------------%d--------------------\n", i);
638 if (npr->which == Z_NamePlusRecord_intermediateFragment)
640 Z_FragmentSyntax *fragment = npr->u.intermediateFragment;
641 if (fragment->which == Z_FragmentSyntax_notExternallyTagged)
643 Odr_oct *oct = fragment->u.notExternallyTagged;
644 printf ("%.*s", (oct->len > 100 ? 100 : oct->len) ,
648 extract_rec_in_mem (zh, "grs.sgml",
656 0 /* match criteria */);
662 void zebra_admin_create (ZebraHandle zh, const char *database)
666 zebra_begin_trans (zh);
669 /* announce database */
670 if (zebraExplain_newDatabase (zh->service->zei, database, 0
671 /* explainDatabase */))
674 zh->errString = "Database already exist";
676 zebra_end_trans (zh);
679 int zebra_string_norm (ZebraHandle zh, unsigned reg_id,
680 const char *input_str, int input_len,
681 char *output_str, int output_len)
684 if (!zh->service->zebra_maps)
686 wrbuf = zebra_replace(zh->service->zebra_maps, reg_id, "",
687 input_str, input_len);
690 if (wrbuf_len(wrbuf) >= output_len)
692 if (wrbuf_len(wrbuf))
693 memcpy (output_str, wrbuf_buf(wrbuf), wrbuf_len(wrbuf));
694 output_str[wrbuf_len(wrbuf)] = '\0';
695 return wrbuf_len(wrbuf);
699 void zebra_set_state (ZebraHandle zh, int val, int seqno)
701 char *fname = zebra_mk_fname (res_get(zh->service->res, "lockDir"),
704 FILE *f = fopen (fname, "w");
705 fprintf (f, "%c %d %ld\n", val, seqno, p);
710 void zebra_get_state (ZebraHandle zh, char *val, int *seqno)
712 char *fname = zebra_mk_fname (res_get(zh->service->res, "lockDir"),
714 FILE *f = fopen (fname, "r");
721 fscanf (f, "%c %d", val, seqno);
727 static int zebra_begin_read (ZebraHandle zh)
736 if (zh->trans_no != 1)
738 zebra_flush_reg (zh);
742 zebra_get_state (zh, &val, &seqno);
745 if (seqno != zh->seqno)
747 yaz_log (LOG_LOG, "reopen seqno cur/old %d/%d", seqno, zh->seqno);
750 else if (zh->last_val != val)
752 yaz_log (LOG_LOG, "reopen last cur/old %d/%d", val, zh->last_val);
759 zebra_lock_r (zh->lock_shadow);
761 zebra_lock_r (zh->lock_normal);
766 zebra_register_deactivate (zh);
768 zebra_register_activate (zh, 0, val == 'c' ? 1 : 0);
772 static void zebra_end_read (ZebraHandle zh)
776 if (zh->trans_no != 0)
779 zebra_unlock (zh->lock_normal);
780 zebra_unlock (zh->lock_shadow);
783 void zebra_begin_trans (ZebraHandle zh)
791 if (zh->trans_no != 1)
796 yaz_log (LOG_LOG, "zebra_begin_trans");
802 rval = res_get (zh->service->res, "shadow");
804 for (pass = 0; pass < 2; pass++)
808 zebra_lock_r (zh->lock_normal);
809 zebra_lock_w (zh->lock_shadow);
813 zebra_lock_w (zh->lock_normal);
814 zebra_lock_w (zh->lock_shadow);
817 zebra_get_state (zh, &val, &seqno);
820 yaz_log (LOG_LOG, "previous transaction didn't finish commit");
821 zebra_unlock (zh->lock_shadow);
822 zebra_unlock (zh->lock_normal);
830 BFiles bfs = bfs_create (res_get (zh->service->res, "shadow"));
831 yaz_log (LOG_LOG, "previous transaction didn't reach commit");
832 bf_commitClean (bfs, rval);
837 yaz_log (LOG_WARN, "your previous transaction didn't finish");
844 yaz_log (LOG_FATAL, "zebra_begin_trans couldn't finish commit");
848 zebra_set_state (zh, 'd', seqno);
850 zebra_register_activate (zh, 1, rval ? 1 : 0);
854 void zebra_end_trans (ZebraHandle zh)
861 if (zh->trans_no != 0)
864 yaz_log (LOG_LOG, "zebra_end_trans");
865 rval = res_get (zh->service->res, "shadow");
867 zebra_flush_reg (zh);
869 zebra_register_deactivate (zh);
871 zebra_get_state (zh, &val, &seqno);
874 BFiles bfs = bfs_create (res_get (zh->service->res, "shadow"));
875 bf_commitClean (bfs, rval);
880 zebra_set_state (zh, 'o', seqno);
882 zebra_unlock (zh->lock_shadow);
883 zebra_unlock (zh->lock_normal);
887 logf (LOG_LOG, "user/system: %ld/%ld",
888 (long) (zh->tms2.tms_utime - zh->tms1.tms_utime),
889 (long) (zh->tms2.tms_stime - zh->tms1.tms_stime));
894 void zebra_repository_update (ZebraHandle zh)
896 zebra_begin_trans (zh);
897 logf (LOG_LOG, "updating %s", zh->rGroup.path);
898 repositoryUpdate (zh);
899 zebra_end_trans (zh);
902 void zebra_repository_delete (ZebraHandle zh)
904 logf (LOG_LOG, "deleting %s", zh->rGroup.path);
905 repositoryDelete (zh);
908 void zebra_repository_show (ZebraHandle zh)
913 void zebra_commit (ZebraHandle zh)
917 const char *rval = res_get (zh->service->res, "shadow");
922 logf (LOG_WARN, "Cannot perform commit");
923 logf (LOG_WARN, "No shadow area defined");
927 zebra_lock_w (zh->lock_normal);
928 zebra_lock_r (zh->lock_shadow);
930 bfs = bfs_create (res_get (zh->service->res, "register"));
932 zebra_get_state (zh, &val, &seqno);
935 bf_cache (bfs, rval);
936 if (bf_commitExists (bfs))
938 zebra_set_state (zh, 'c', seqno);
940 logf (LOG_LOG, "commit start");
945 logf (LOG_LOG, "commit clean");
946 bf_commitClean (bfs, rval);
948 zebra_set_state (zh, 'o', seqno);
952 logf (LOG_LOG, "nothing to commit");
956 zebra_unlock (zh->lock_shadow);
957 zebra_unlock (zh->lock_normal);
960 void zebra_init (ZebraHandle zh)
962 const char *rval = res_get (zh->service->res, "shadow");
965 bfs = bfs_create (res_get (zh->service->res, "register"));
967 bf_cache (bfs, rval);
971 zebra_set_state (zh, 'o', 0);
974 void zebra_compact (ZebraHandle zh)
976 BFiles bfs = bfs_create (res_get (zh->service->res, "register"));
981 int zebra_record_insert (ZebraHandle zh, const char *buf, int len)
984 zebra_begin_trans (zh);
985 extract_rec_in_mem (zh, "grs.sgml",
987 "Default", /* database */
993 0 /* match criteria */);
994 zebra_end_trans (zh);