1 /* This file is part of the Zebra server.
2 Copyright (C) 1994-2009 Index Data
4 Zebra is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
9 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
32 #include <yaz/diagbib1.h>
33 #include <yaz/pquery.h>
34 #include <yaz/sortspec.h>
39 #include <idzebra/api.h>
40 #include <yaz/oid_db.h>
42 #define DEFAULT_APPROX_LIMIT 2000000000
44 /* simple asserts to validate the most essential input args */
45 #define ASSERTZH assert(zh && zh->service)
46 #define ASSERTZHRES assert(zh && zh->service && zh->res)
47 #define ASSERTZS assert(zs)
49 static int log_level = 0;
50 static int log_level_initialized = 0;
52 static void zebra_open_res(ZebraHandle zh);
53 static void zebra_close_res(ZebraHandle zh);
55 static ZEBRA_RES zebra_check_handle(ZebraHandle zh)
62 #define ZEBRA_CHECK_HANDLE(zh) if (zebra_check_handle(zh) != ZEBRA_OK) return ZEBRA_FAIL
64 static void zebra_chdir(ZebraService zs)
68 yaz_log(log_level, "zebra_chdir");
69 dir = res_get(zs->global_res, "chdir");
72 yaz_log(YLOG_DEBUG, "chdir %s", dir);
80 static ZEBRA_RES zebra_flush_reg(ZebraHandle zh)
82 ZEBRA_CHECK_HANDLE(zh);
83 yaz_log(log_level, "zebra_flush_reg");
84 zebraExplain_flush(zh->reg->zei, zh);
86 key_block_flush(zh->reg->key_block, 1);
88 zebra_index_merge(zh);
92 static struct zebra_register *zebra_register_open(ZebraService zs,
94 int rw, int useshadow,
96 const char *reg_path);
97 static void zebra_register_close(ZebraService zs, struct zebra_register *reg);
99 const char *zebra_get_encoding(ZebraHandle zh)
101 assert(zh && zh->session_res);
102 return res_get_def(zh->session_res, "encoding", "ISO-8859-1");
105 ZebraHandle zebra_open(ZebraService zs, Res res)
108 const char *default_encoding;
109 if (!log_level_initialized)
111 log_level = yaz_log_module_level("zebraapi");
112 log_level_initialized = 1;
115 yaz_log(log_level, "zebra_open");
120 zh = (ZebraHandle) xmalloc(sizeof(*zh));
121 yaz_log(YLOG_DEBUG, "zebra_open zs=%p returns %p", zs, zh);
124 zh->reg = 0; /* no register attached yet */
130 zh->session_res = res_open(zs->global_res, res);
132 zh->dbaccesslist = 0;
134 zh->reg_name = xstrdup("");
136 zh->num_basenames = 0;
139 zh->approx_limit = DEFAULT_APPROX_LIMIT;
146 zh->shadow_enable = 1;
147 zh->m_staticrank = 0;
148 zh->m_segment_indexing = 0;
150 zh->break_handler_func = 0;
151 zh->break_handler_data = 0;
153 default_encoding = zebra_get_encoding(zh);
156 yaz_iconv_open("UTF-8", default_encoding);
157 if (zh->iconv_to_utf8 == 0)
158 yaz_log(YLOG_WARN, "iconv: %s to UTF-8 unsupported",
160 zh->iconv_from_utf8 =
161 yaz_iconv_open(default_encoding, "UTF-8");
162 if (zh->iconv_to_utf8 == 0)
163 yaz_log(YLOG_WARN, "iconv: UTF-8 to %s unsupported",
166 zh->record_encoding = 0;
168 zebra_mutex_cond_lock(&zs->session_lock);
170 zh->next = zs->sessions;
173 zebra_mutex_cond_unlock(&zs->session_lock);
175 zh->store_data_buf = 0;
177 zh->m_limit = zebra_limit_create(1, 0);
179 zh->nmem_error = nmem_create();
184 ZebraService zebra_start(const char *configName)
186 return zebra_start_res(configName, 0, 0);
189 ZebraService zebra_start_res(const char *configName, Res def_res, Res over_res)
192 char version_str[16];
197 if (!log_level_initialized)
199 log_level = yaz_log_module_level("zebraapi");
200 log_level_initialized = 1;
203 zebra_get_version(version_str, system_str);
205 yaz_log(YLOG_LOG, "zebra_start %s %s", version_str,
206 configName ? configName : "");
208 if ((res = res_open(def_res, over_res)))
210 const char *passwd_plain = 0;
211 const char *passwd_encrypt = 0;
212 const char *dbaccess = 0;
217 ZEBRA_RES ret = res_read_file(res, configName);
223 if (zebra_check_res(res))
225 yaz_log(YLOG_FATAL, "Configuration error(s) for %s",
232 zebra_check_res(res);
235 zh = xmalloc(sizeof(*zh));
236 zh->global_res = res;
241 zebra_mutex_cond_init(&zh->session_lock);
242 passwd_plain = res_get(zh->global_res, "passwd");
243 passwd_encrypt = res_get(zh->global_res, "passwd.c");
244 dbaccess = res_get(zh->global_res, "dbaccess");
246 if (!passwd_plain && !passwd_encrypt)
247 zh->passwd_db = NULL;
250 zh->passwd_db = passwd_db_open();
252 yaz_log(YLOG_WARN|YLOG_ERRNO, "passwd_db_open failed");
256 passwd_db_file_plain(zh->passwd_db, passwd_plain);
258 passwd_db_file_crypt(zh->passwd_db, passwd_encrypt);
265 zh->dbaccess = res_open(NULL, NULL);
266 if (res_read_file(zh->dbaccess, dbaccess) != ZEBRA_OK) {
267 yaz_log(YLOG_FATAL, "Failed to read %s", dbaccess);
272 zh->timing = yaz_timing_create();
273 zh->path_root = res_get(zh->global_res, "root");
274 zh->nmem = nmem_create();
275 zh->record_classes = recTypeClass_create(zh->global_res, zh->nmem);
279 const char *module_path = res_get(res, "modulePath");
281 recTypeClass_load_modules(&zh->record_classes, zh->nmem,
289 void zebra_filter_info(ZebraService zs, void *cd,
290 void(*cb)(void *cd, const char *name))
294 recTypeClass_info(zs->record_classes, cd, cb);
297 void zebra_pidfname(ZebraService zs, char *path)
300 zebra_lock_prefix(zs->global_res, path);
301 strcat(path, "zebrasrv.pid");
304 Dict dict_open_res(BFiles bfs, const char *name, int cache, int rw,
305 int compact_flag, Res res)
307 int page_size = 4096;
308 char resource_str[200];
309 sprintf(resource_str, "dict.%.100s.pagesize", name);
313 if (res_get_int(res, resource_str, &page_size) == ZEBRA_OK)
314 yaz_log(YLOG_LOG, "Using custom dictionary page size %d for %s",
316 return dict_open(bfs, name, cache, rw, compact_flag, page_size);
320 struct zebra_register *zebra_register_open(ZebraService zs, const char *name,
321 int rw, int useshadow, Res res,
322 const char *reg_path)
324 struct zebra_register *reg;
325 int record_compression = REC_COMPRESS_NONE;
326 const char *recordCompression = 0;
327 const char *profilePath;
329 int sort_type = ZEBRA_SORT_TYPE_FLAT;
330 ZEBRA_RES ret = ZEBRA_OK;
334 reg = xmalloc(sizeof(*reg));
337 reg->name = xstrdup(name);
344 yaz_log(YLOG_DEBUG, "zebra_register_open rw=%d useshadow=%d p=%p n=%s rp=%s",
345 rw, useshadow, reg, name, reg_path ? reg_path : "(none)");
347 reg->dh = data1_create();
354 reg->bfs = bfs_create(res_get(res, "register"), reg_path);
357 data1_destroy(reg->dh);
364 if (bf_cache(reg->bfs, res_get(res, "shadow")) == ZEBRA_FAIL)
366 bfs_destroy(reg->bfs);
367 data1_destroy(reg->dh);
374 getcwd(cwd, sizeof(cwd)-1);
375 profilePath = res_get_def(res, "profilePath", 0);
377 data1_set_tabpath(reg->dh, profilePath);
378 data1_set_tabroot(reg->dh, reg_path);
379 reg->recTypes = recTypes_init(zs->record_classes, reg->dh);
382 zebra_maps_open(res, reg_path, profilePath);
383 if (!reg->zebra_maps)
385 recTypes_destroy(reg->recTypes);
386 bfs_destroy(reg->bfs);
387 data1_destroy(reg->dh);
392 reg->rank_classes = NULL;
395 reg->keys = zebra_rec_keys_open();
397 reg->sortKeys = zebra_rec_keys_open();
408 /* installing rank classes */
409 zebraRankInstall(reg, rank_1_class);
410 zebraRankInstall(reg, rank_2_class);
411 zebraRankInstall(reg, rank_similarity_class);
412 zebraRankInstall(reg, rank_static_class);
414 recordCompression = res_get_def(res, "recordCompression", "none");
415 if (!strcmp(recordCompression, "none"))
416 record_compression = REC_COMPRESS_NONE;
417 if (!strcmp(recordCompression, "bzip2"))
418 record_compression = REC_COMPRESS_BZIP2;
421 const char *index_fname = res_get_def(res, "index", "default.idx");
422 if (index_fname && *index_fname && strcmp(index_fname, "none"))
424 if (zebra_maps_read_file(reg->zebra_maps, index_fname) != ZEBRA_OK)
429 zebra_maps_define_default_sort(reg->zebra_maps);
433 if (!(reg->records = rec_open(reg->bfs, rw, record_compression)))
435 yaz_log(YLOG_WARN, "rec_open failed");
440 reg->matchDict = dict_open_res(reg->bfs, GMATCH_DICT, 20, 1, 0, res);
442 if (!(reg->dict = dict_open_res(reg->bfs, FNAME_DICT, 40, rw, 0, res)))
444 yaz_log(YLOG_WARN, "dict_open failed");
449 if (res_get_match(res, "sortindex", "f", "f"))
450 sort_type = ZEBRA_SORT_TYPE_FLAT;
451 else if (res_get_match(res, "sortindex", "i", "f"))
452 sort_type = ZEBRA_SORT_TYPE_ISAMB;
453 else if (res_get_match(res, "sortindex", "m", "f"))
454 sort_type = ZEBRA_SORT_TYPE_MULTI;
457 yaz_log(YLOG_WARN, "bad_value for 'sortindex'");
462 if (!(reg->sort_index = zebra_sort_open(reg->bfs, rw, sort_type)))
464 yaz_log(YLOG_WARN, "zebra_sort_open failed");
467 if (res_get_match(res, "isam", "s", ISAM_DEFAULT))
469 struct ISAMS_M_s isams_m;
470 if (!(reg->isams = isams_open(reg->bfs, FNAME_ISAMS, rw,
471 key_isams_m(res, &isams_m))))
473 yaz_log(YLOG_WARN, "isams_open failed");
477 if (res_get_match(res, "isam", "c", ISAM_DEFAULT))
479 struct ISAMC_M_s isamc_m;
480 if (!(reg->isamc = isamc_open(reg->bfs, FNAME_ISAMC,
481 rw, key_isamc_m(res, &isamc_m))))
483 yaz_log(YLOG_WARN, "isamc_open failed");
487 if (res_get_match(res, "isam", "b", ISAM_DEFAULT))
489 struct ISAMC_M_s isamc_m;
491 if (!(reg->isamb = isamb_open(reg->bfs, "isamb",
492 rw, key_isamc_m(res, &isamc_m), 0)))
494 yaz_log(YLOG_WARN, "isamb_open failed");
498 if (res_get_match(res, "isam", "bc", ISAM_DEFAULT))
500 struct ISAMC_M_s isamc_m;
502 if (!(reg->isamb = isamb_open(reg->bfs, "isamb",
503 rw, key_isamc_m(res, &isamc_m), 1)))
505 yaz_log(YLOG_WARN, "isamb_open failed");
509 if (res_get_match(res, "isam", "null", ISAM_DEFAULT))
511 struct ISAMC_M_s isamc_m;
513 if (!(reg->isamb = isamb_open(reg->bfs, "isamb",
514 rw, key_isamc_m(res, &isamc_m), -1)))
516 yaz_log(YLOG_WARN, "isamb_open failed");
522 reg->zei = zebraExplain_open(reg->records, reg->dh,
524 zebra_extract_explain);
527 yaz_log(YLOG_WARN, "Cannot obtain EXPLAIN information");
534 zebra_register_close(zs, reg);
537 yaz_log(YLOG_DEBUG, "zebra_register_open ok p=%p", reg);
541 ZEBRA_RES zebra_admin_shutdown(ZebraHandle zh)
543 ZEBRA_CHECK_HANDLE(zh);
544 yaz_log(log_level, "zebra_admin_shutdown");
546 zebra_mutex_cond_lock(&zh->service->session_lock);
547 zh->service->stop_flag = 1;
548 zebra_mutex_cond_unlock(&zh->service->session_lock);
552 ZEBRA_RES zebra_admin_start(ZebraHandle zh)
555 ZEBRA_CHECK_HANDLE(zh);
556 yaz_log(log_level, "zebra_admin_start");
558 zebra_mutex_cond_lock(&zs->session_lock);
559 zebra_mutex_cond_unlock(&zs->session_lock);
563 static void zebra_register_close(ZebraService zs, struct zebra_register *reg)
567 yaz_log(YLOG_DEBUG, "zebra_register_close p=%p", reg);
571 zebraExplain_close(reg->zei);
572 dict_close(reg->dict);
574 dict_close(reg->matchDict);
575 zebra_sort_close(reg->sort_index);
577 isams_close(reg->isams);
579 isamc_close(reg->isamc);
581 isamb_close(reg->isamb);
582 rec_close(®->records);
584 recTypes_destroy(reg->recTypes);
585 zebra_maps_close(reg->zebra_maps);
586 zebraRankDestroy(reg);
587 bfs_destroy(reg->bfs);
588 data1_destroy(reg->dh);
590 zebra_rec_keys_close(reg->keys);
591 zebra_rec_keys_close(reg->sortKeys);
593 key_block_destroy(®->key_block);
598 ZEBRA_RES zebra_stop(ZebraService zs)
604 zebra_close(zs->sessions);
607 zebra_mutex_cond_destroy(&zs->session_lock);
610 passwd_db_close(zs->passwd_db);
612 recTypeClass_destroy(zs->record_classes);
613 nmem_destroy(zs->nmem);
614 res_close(zs->global_res);
616 yaz_timing_stop(zs->timing);
617 yaz_log(YLOG_LOG, "zebra_stop: %4.2f %4.2f %4.2f",
618 yaz_timing_get_real(zs->timing),
619 yaz_timing_get_user(zs->timing),
620 yaz_timing_get_sys(zs->timing));
623 yaz_timing_destroy(&zs->timing);
628 ZEBRA_RES zebra_close(ZebraHandle zh)
631 struct zebra_session **sp;
634 yaz_log(log_level, "zebra_close");
635 ZEBRA_CHECK_HANDLE(zh);
640 yaz_log(YLOG_DEBUG, "zebra_close zh=%p", zh);
641 resultSetDestroy(zh, -1, 0, 0);
644 zebra_register_close(zh->service, zh->reg);
646 res_close(zh->session_res);
648 xfree(zh->record_encoding);
650 xfree(zh->dbaccesslist);
652 for (i = 0; i < zh->num_basenames; i++)
653 xfree(zh->basenames[i]);
654 xfree(zh->basenames);
656 if (zh->iconv_to_utf8 != 0)
657 yaz_iconv_close(zh->iconv_to_utf8);
658 if (zh->iconv_from_utf8 != 0)
659 yaz_iconv_close(zh->iconv_from_utf8);
661 zebra_mutex_cond_lock(&zs->session_lock);
662 zebra_lock_destroy(zh->lock_normal);
663 zebra_lock_destroy(zh->lock_shadow);
675 zebra_mutex_cond_unlock(&zs->session_lock);
677 xfree(zh->user_perm);
678 zh->service = 0; /* more likely to trigger an assert */
680 zebra_limit_destroy(zh->m_limit);
682 nmem_destroy(zh->nmem_error);
689 struct map_baseinfo {
695 char **new_basenames;
699 static void zebra_open_res(ZebraHandle zh)
707 sprintf(fname, "%.200s/zebra.cfg", zh->path_reg);
708 zh->res = res_open(zh->session_res, 0);
709 res_read_file(zh->res, fname);
711 else if (*zh->reg_name == 0)
713 zh->res = res_open(zh->session_res, 0);
717 yaz_log(YLOG_WARN, "no register root specified");
718 zh->res = 0; /* no path for register - fail! */
722 static void zebra_close_res(ZebraHandle zh)
730 static void zebra_select_register(ZebraHandle zh, const char *new_reg)
734 if (zh->res && strcmp(zh->reg_name, new_reg) == 0)
738 assert(zh->reg == 0);
739 assert(*zh->reg_name == 0);
745 resultSetInvalidate(zh);
746 zebra_register_close(zh->service, zh->reg);
752 zh->reg_name = xstrdup(new_reg);
756 if (zh->service->path_root)
758 zh->path_reg = xmalloc(strlen(zh->service->path_root) +
759 strlen(zh->reg_name) + 3);
760 strcpy(zh->path_reg, zh->service->path_root);
763 strcat(zh->path_reg, "/");
764 strcat(zh->path_reg, zh->reg_name);
770 zebra_lock_destroy(zh->lock_normal);
774 zebra_lock_destroy(zh->lock_shadow);
780 const char *lock_area = res_get(zh->res, "lockDir");
782 if (!lock_area && zh->path_reg)
783 res_set(zh->res, "lockDir", zh->path_reg);
784 sprintf(fname, "norm.%s.LCK", zh->reg_name);
786 zebra_lock_create(res_get(zh->res, "lockDir"), fname);
788 sprintf(fname, "shadow.%s.LCK", zh->reg_name);
790 zebra_lock_create(res_get(zh->res, "lockDir"), fname);
792 if (!zh->lock_normal || !zh->lock_shadow)
796 zebra_lock_destroy(zh->lock_normal);
801 zebra_lock_destroy(zh->lock_shadow);
810 if (res_get_int(zh->res, "estimatehits", &approx) == ZEBRA_OK)
811 zebra_set_approx_limit(zh, approx);
815 if (res_get_int(zh->res, "staticrank", &zh->m_staticrank) == ZEBRA_OK)
816 yaz_log(YLOG_LOG, "static rank set and is %d", zh->m_staticrank);
820 if (res_get_int(zh->res, "segment", &zh->m_segment_indexing) ==
823 yaz_log(YLOG_DEBUG, "segment indexing set and is %d",
824 zh->m_segment_indexing);
829 void map_basenames_func(void *vp, const char *name, const char *value)
831 struct map_baseinfo *p = (struct map_baseinfo *) vp;
833 char fromdb[128], todb[8][128];
840 sscanf(value, "%127s %127s %127s %127s %127s %127s %127s %127s %127s",
841 fromdb, todb[0], todb[1], todb[2], todb[3], todb[4],
842 todb[5], todb[6], todb[7]);
846 for (i = 0; i<p->num_bases; i++)
847 if (p->basenames[i] && !STRCASECMP(p->basenames[i], fromdb))
850 for (i = 0; i < no; i++)
852 if (p->new_num_bases == p->new_num_max)
854 p->new_basenames[(p->new_num_bases)++] =
855 nmem_strdup(p->mem, todb[i]);
861 int zebra_select_default_database(ZebraHandle zh)
865 /* no database has been selected - so we select based on
866 resource setting (including group)
868 const char *group = res_get(zh->session_res, "group");
869 const char *v = res_get_prefix(zh->session_res,
870 "database", group, "Default");
871 return zebra_select_database(zh, v);
876 void map_basenames(ZebraHandle zh, ODR stream,
877 int *num_bases, char ***basenames)
879 struct map_baseinfo info;
880 struct map_baseinfo *p = &info;
883 yaz_log(log_level, "map_basenames ");
888 info.num_bases = *num_bases;
889 info.basenames = *basenames;
890 info.new_num_max = 128;
891 info.new_num_bases = 0;
892 info.new_basenames = (char **)
893 odr_malloc(stream, sizeof(*info.new_basenames) * info.new_num_max);
894 info.mem = stream->mem;
896 res_trav(zh->session_res, "mapdb", &info, map_basenames_func);
898 for (i = 0; i<p->num_bases; i++)
899 if (p->basenames[i] && p->new_num_bases < p->new_num_max)
901 p->new_basenames[(p->new_num_bases)++] =
902 nmem_strdup(p->mem, p->basenames[i]);
904 *num_bases = info.new_num_bases;
905 *basenames = info.new_basenames;
906 for (i = 0; i<*num_bases; i++)
907 yaz_log(YLOG_DEBUG, "base %s", (*basenames)[i]);
910 ZEBRA_RES zebra_select_database(ZebraHandle zh, const char *basename)
912 ZEBRA_CHECK_HANDLE(zh);
914 yaz_log(log_level, "zebra_select_database %s",basename);
916 return zebra_select_databases(zh, 1, &basename);
919 ZEBRA_RES zebra_select_databases(ZebraHandle zh, int num_bases,
920 const char **basenames)
927 ZEBRA_CHECK_HANDLE(zh);
930 yaz_log(log_level, "zebra_select_databases n=%d [0]=%s",
931 num_bases,basenames[0]);
936 zh->errCode = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
940 /* Check if the user has access to all databases (Seb) */
941 /* You could argue that this should happen later, after we have
942 * determined that the database(s) exist. */
943 if (zh->dbaccesslist) {
944 for (i = 0; i < num_bases; i++) {
945 const char *db = basenames[i];
947 for (p = zh->dbaccesslist; p && *p; p = pp) {
949 if ((pp = strchr(p, '+'))) {
955 if (len == strlen(db) && !strncmp(db, p, len))
959 zh->errCode = YAZ_BIB1_ACCESS_TO_SPECIFIED_DATABASE_DENIED;
965 for (i = 0; i < zh->num_basenames; i++)
966 xfree(zh->basenames[i]);
967 xfree(zh->basenames);
969 zh->num_basenames = num_bases;
970 zh->basenames = xmalloc(zh->num_basenames * sizeof(*zh->basenames));
971 for (i = 0; i < zh->num_basenames; i++)
972 zh->basenames[i] = xstrdup(basenames[i]);
974 cp = strrchr(basenames[0], '/');
977 len = cp - basenames[0];
978 new_reg = xmalloc(len + 1);
979 memcpy(new_reg, basenames[0], len);
983 new_reg = xstrdup("");
984 for (i = 1; i<num_bases; i++)
988 cp1 = strrchr(basenames[i], '/');
993 zh->errCode = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
996 if (len != cp1 - basenames[i] ||
997 memcmp(basenames[i], new_reg, len))
999 zh->errCode = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
1007 zh->errCode = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
1012 zebra_select_register(zh, new_reg);
1016 zh->errCode = YAZ_BIB1_DATABASE_UNAVAILABLE;
1019 if (!zh->lock_normal || !zh->lock_shadow)
1021 zh->errCode = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1027 ZEBRA_RES zebra_set_approx_limit(ZebraHandle zh, zint approx_limit)
1029 if (approx_limit == 0)
1030 approx_limit = DEFAULT_APPROX_LIMIT;
1031 zh->approx_limit = approx_limit;
1035 void zebra_set_partial_result(ZebraHandle zh)
1037 zh->partial_result = 1;
1041 ZEBRA_RES zebra_set_break_handler(ZebraHandle zh,
1042 int (*f)(void *client_data),
1045 zh->break_handler_func = f;
1046 zh->break_handler_data = client_data;
1050 ZEBRA_RES zebra_search_RPN_x(ZebraHandle zh, ODR o, Z_RPNQuery *query,
1051 const char *setname, zint *hits,
1052 int *estimated_hit_count,
1053 int *partial_resultset)
1057 ZEBRA_CHECK_HANDLE(zh);
1063 yaz_log(log_level, "zebra_search_rpn");
1065 zh->partial_result = 0;
1067 if (zebra_begin_read(zh) == ZEBRA_FAIL)
1070 r = resultSetAddRPN(zh, odr_extract_mem(o), query,
1071 zh->num_basenames, zh->basenames, setname,
1072 hits, estimated_hit_count);
1074 *partial_resultset = zh->partial_result;
1079 ZEBRA_RES zebra_search_RPN(ZebraHandle zh, ODR o, Z_RPNQuery *query,
1080 const char *setname, zint *hits)
1082 int estimated_hit_count;
1083 int partial_resultset;
1084 return zebra_search_RPN_x(zh, o, query, setname, hits,
1085 &estimated_hit_count,
1086 &partial_resultset);
1089 ZEBRA_RES zebra_records_retrieve(ZebraHandle zh, ODR stream,
1090 const char *setname,
1091 Z_RecordComposition *comp,
1092 const Odr_oid *input_format, int num_recs,
1093 ZebraRetrievalRecord *recs)
1095 ZebraMetaRecord *poset;
1097 ZEBRA_RES ret = ZEBRA_OK;
1100 ZEBRA_CHECK_HANDLE(zh);
1106 yaz_log(log_level, "zebra_records_retrieve n=%d", num_recs);
1110 zebra_setError(zh, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
1115 if (zebra_begin_read(zh) == ZEBRA_FAIL)
1118 pos_array = (zint *) xmalloc(num_recs * sizeof(*pos_array));
1119 for (i = 0; i<num_recs; i++)
1120 pos_array[i] = recs[i].position;
1121 poset = zebra_meta_records_create(zh, setname, num_recs, pos_array);
1124 yaz_log(YLOG_DEBUG, "zebraPosSetCreate error");
1125 zebra_setError(zh, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
1131 WRBUF addinfo_w = wrbuf_alloc();
1132 for (i = 0; i < num_recs; i++)
1134 recs[i].errCode = 0;
1135 recs[i].errString = 0;
1140 recs[i].sysno = poset[i].sysno;
1143 recs[i].format = yaz_oid_recsyn_sutrs;
1144 recs[i].len = strlen(poset[i].term);
1145 recs[i].buf = poset[i].term;
1146 recs[i].base = poset[i].db;
1148 else if (poset[i].sysno)
1152 zebra_snippets *hit_snippet = zebra_snippets_create();
1154 /* we disable hit snippets for now. It does not work well
1155 and it slows retrieval down a lot */
1157 zebra_snippets_hit_vector(zh, setname, poset[i].sysno,
1160 wrbuf_rewind(addinfo_w);
1162 zebra_record_fetch(zh, setname,
1163 poset[i].sysno, poset[i].score,
1164 stream, input_format, comp,
1165 &recs[i].format, &buf, &len,
1166 &recs[i].base, addinfo_w);
1168 if (wrbuf_len(addinfo_w))
1170 odr_strdup(stream, wrbuf_cstr(addinfo_w));
1174 recs[i].buf = (char*) odr_malloc(stream, len);
1175 memcpy(recs[i].buf, buf, len);
1179 recs[i].score = poset[i].score;
1180 zebra_snippets_destroy(hit_snippet);
1184 /* only need to set it once */
1185 if (pos_array[i] < zh->approx_limit && ret == ZEBRA_OK)
1187 zebra_setError_zint(zh,
1188 YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE,
1195 zebra_meta_records_destroy(zh, poset, num_recs);
1196 wrbuf_destroy(addinfo_w);
1203 ZEBRA_RES zebra_scan_PQF(ZebraHandle zh, ODR stream, const char *query,
1205 int *num_entries, ZebraScanEntry **entries,
1207 const char *setname)
1209 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1210 Z_AttributesPlusTerm *zapt;
1211 Odr_oid *attributeSet;
1214 if (!(zapt = yaz_pqf_scan(pqf_parser, stream, &attributeSet, query)))
1217 zh->errCode = YAZ_BIB1_SCAN_MALFORMED_SCAN;
1221 res = zebra_scan(zh, stream, zapt, yaz_oid_attset_bib_1,
1222 position, num_entries, entries, is_partial,
1225 yaz_pqf_destroy(pqf_parser);
1229 ZEBRA_RES zebra_scan(ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
1230 const Odr_oid *attributeset,
1232 int *num_entries, ZebraScanEntry **entries,
1234 const char *setname)
1238 ZEBRA_CHECK_HANDLE(zh);
1243 assert(num_entries);
1246 yaz_log(log_level, "zebra_scan");
1248 if (zebra_begin_read(zh) == ZEBRA_FAIL)
1255 res = rpn_scan(zh, stream, zapt, attributeset,
1256 zh->num_basenames, zh->basenames, position,
1257 num_entries, entries, is_partial, setname);
1262 ZEBRA_RES zebra_sort(ZebraHandle zh, ODR stream,
1263 int num_input_setnames, const char **input_setnames,
1264 const char *output_setname,
1265 Z_SortKeySpecList *sort_sequence,
1269 ZEBRA_CHECK_HANDLE(zh);
1271 assert(num_input_setnames>0);
1272 assert(input_setnames);
1273 assert(sort_sequence);
1274 assert(sort_status);
1275 yaz_log(log_level, "zebra_sort");
1277 if (zebra_begin_read(zh) == ZEBRA_FAIL)
1279 res = resultSetSort(zh, stream->mem, num_input_setnames, input_setnames,
1280 output_setname, sort_sequence, sort_status);
1285 int zebra_deleteResultSet(ZebraHandle zh, int function,
1286 int num_setnames, char **setnames,
1291 yaz_log(log_level, "zebra_deleteResultSet n=%d", num_setnames);
1293 if (zebra_begin_read(zh))
1294 return Z_DeleteStatus_systemProblemAtTarget;
1297 case Z_DeleteResultSetRequest_list:
1298 assert(num_setnames>0);
1300 resultSetDestroy(zh, num_setnames, setnames, statuses);
1302 case Z_DeleteResultSetRequest_all:
1303 resultSetDestroy(zh, -1, 0, statuses);
1307 status = Z_DeleteStatus_success;
1308 for (i = 0; i<num_setnames; i++)
1309 if (statuses[i] == Z_DeleteStatus_resultSetDidNotExist)
1310 status = statuses[i];
1314 int zebra_errCode(ZebraHandle zh)
1318 yaz_log(log_level, "zebra_errCode: %d",zh->errCode);
1321 yaz_log(log_level, "zebra_errCode: o");
1325 const char *zebra_errString(ZebraHandle zh)
1329 e= diagbib1_str(zh->errCode);
1330 yaz_log(log_level, "zebra_errString: %s",e);
1334 char *zebra_errAdd(ZebraHandle zh)
1339 yaz_log(log_level, "zebra_errAdd: %s",a);
1343 ZEBRA_RES zebra_auth(ZebraHandle zh, const char *user, const char *pass)
1346 const char *astring;
1350 ZEBRA_CHECK_HANDLE(zh);
1354 sprintf(u, "perm.%.30s", user ? user : "anonymous");
1355 p = res_get(zs->global_res, u);
1356 xfree(zh->user_perm);
1357 zh->user_perm = xstrdup(p ? p : "r");
1359 /* Determine database access list */
1360 astring = res_get(zs->dbaccess, user ? user : "anonymous");
1362 zh->dbaccesslist = xstrdup(astring);
1364 zh->dbaccesslist = 0;
1366 /* users that don't require a password .. */
1367 if (zh->user_perm && strchr(zh->user_perm, 'a'))
1370 if (!zs->passwd_db || !passwd_db_auth(zs->passwd_db, user, pass))
1375 ZEBRA_RES zebra_admin_import_begin(ZebraHandle zh, const char *database,
1376 const char *record_type)
1378 yaz_log(log_level, "zebra_admin_import_begin db=%s rt=%s",
1379 database, record_type);
1380 if (zebra_select_database(zh, database) == ZEBRA_FAIL)
1382 return zebra_begin_trans(zh, 1);
1385 ZEBRA_RES zebra_admin_import_end(ZebraHandle zh)
1387 ZEBRA_CHECK_HANDLE(zh);
1388 yaz_log(log_level, "zebra_admin_import_end");
1389 return zebra_end_trans(zh);
1392 ZEBRA_RES zebra_admin_import_segment(ZebraHandle zh, Z_Segment *segment)
1394 ZEBRA_RES res = ZEBRA_OK;
1397 ZEBRA_CHECK_HANDLE(zh);
1398 yaz_log(log_level, "zebra_admin_import_segment");
1400 for (i = 0; i<segment->num_segmentRecords; i++)
1402 Z_NamePlusRecord *npr = segment->segmentRecords[i];
1404 if (npr->which == Z_NamePlusRecord_intermediateFragment)
1406 Z_FragmentSyntax *fragment = npr->u.intermediateFragment;
1407 if (fragment->which == Z_FragmentSyntax_notExternallyTagged)
1409 Odr_oct *oct = fragment->u.notExternallyTagged;
1412 if(zebra_update_record(
1415 0, /* record Type */
1419 (const char *) oct->buf, oct->len) == ZEBRA_FAIL)
1427 int delete_w_handle(const char *info, void *handle)
1429 ZebraHandle zh = (ZebraHandle) handle;
1432 if (*info == sizeof(pos))
1434 memcpy(&pos, info+1, sizeof(pos));
1435 isamb_unlink(zh->reg->isamb, pos);
1440 int delete_w_all_handle(const char *info, void *handle)
1442 ZebraHandle zh = (ZebraHandle) handle;
1445 if (*info == sizeof(pos))
1448 memcpy(&pos, info+1, sizeof(pos));
1449 pt = isamb_pp_open(zh->reg->isamb, pos, 2);
1454 while (isamb_pp_read(pt, &key))
1457 rec = rec_get(zh->reg->records, key.mem[0]);
1458 rec_del(zh->reg->records, &rec);
1463 return delete_w_handle(info, handle);
1466 static int delete_SU_handle(void *handle, int ord,
1467 const char *index_type, const char *string_index,
1468 zinfo_index_category_t cat)
1470 ZebraHandle zh = (ZebraHandle) handle;
1474 yaz_log(YLOG_LOG, "ord=%d index_type=%s index=%s cat=%d", ord,
1475 index_type, string_index, (int) cat);
1477 ord_len = key_SU_encode(ord, ord_buf);
1478 ord_buf[ord_len] = '\0';
1480 assert(zh->reg->isamb);
1481 assert(zh->reg->records);
1482 dict_delete_subtree(zh->reg->dict, ord_buf,
1484 !strcmp(string_index, "_ALLRECORDS") ?
1485 delete_w_all_handle : delete_w_handle);
1489 ZEBRA_RES zebra_drop_database(ZebraHandle zh, const char *db)
1491 ZEBRA_RES ret = ZEBRA_OK;
1493 yaz_log(log_level, "zebra_drop_database %s", db);
1494 ZEBRA_CHECK_HANDLE(zh);
1496 if (zebra_select_database(zh, db) == ZEBRA_FAIL)
1498 if (zebra_begin_trans(zh, 1) == ZEBRA_FAIL)
1503 if (zebraExplain_curDatabase(zh->reg->zei, db))
1505 zebra_setError(zh, YAZ_BIB1_DATABASE_DOES_NOT_EXIST, db);
1510 db_ord = zebraExplain_get_database_ord(zh->reg->zei);
1511 dict_delete_subtree_ord(zh->reg->matchDict, db_ord,
1512 0 /* handle */, 0 /* func */);
1513 zebraExplain_trav_ord(zh->reg->zei, zh, delete_SU_handle);
1514 zebraExplain_removeDatabase(zh->reg->zei, zh);
1515 zebra_remove_file_match(zh);
1520 yaz_log(YLOG_WARN, "drop database only supported for isam:b");
1521 zebra_setError(zh, YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED,
1522 "drop database only supported for isam:b");
1525 if (zebra_end_trans(zh) != ZEBRA_OK)
1527 yaz_log(YLOG_WARN, "zebra_end_trans failed");
1533 ZEBRA_RES zebra_create_database(ZebraHandle zh, const char *db)
1535 yaz_log(log_level, "zebra_create_database %s", db);
1536 ZEBRA_CHECK_HANDLE(zh);
1539 if (zebra_select_database(zh, db) == ZEBRA_FAIL)
1541 if (zebra_begin_trans(zh, 1))
1544 /* announce database */
1545 if (zebraExplain_newDatabase(zh->reg->zei, db, 0
1546 /* explainDatabase */))
1548 if (zebra_end_trans(zh) != ZEBRA_OK)
1550 yaz_log(YLOG_WARN, "zebra_end_trans failed");
1552 zebra_setError(zh, YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED, db);
1555 return zebra_end_trans(zh);
1558 int zebra_string_norm(ZebraHandle zh, const char *index_type,
1559 const char *input_str, int input_len,
1560 char *output_str, int output_len)
1563 zebra_map_t zm = zebra_map_get(zh->reg->zebra_maps, index_type);
1567 yaz_log(log_level, "zebra_string_norm ");
1569 if (!zh->reg->zebra_maps)
1571 wrbuf = zebra_replace(zm, "", input_str, input_len);
1574 if (wrbuf_len(wrbuf) >= output_len)
1576 if (wrbuf_len(wrbuf))
1577 memcpy(output_str, wrbuf_buf(wrbuf), wrbuf_len(wrbuf));
1578 output_str[wrbuf_len(wrbuf)] = '\0';
1579 return wrbuf_len(wrbuf);
1582 /** \brief set register state (state*.LCK)
1583 \param zh Zebra handle
1585 \param seqno sequence number
1588 d=writing to shadow(shadow enabled); writing to register (shadow disabled)
1590 c=commit (writing to register, reading from shadow, shadow mode only)
1592 static void zebra_set_state(ZebraHandle zh, int val, int seqno)
1594 char state_fname[256];
1599 yaz_log(log_level, "zebra_set_state v=%c seq=%d", val, seqno);
1601 sprintf(state_fname, "state.%s.LCK", zh->reg_name);
1602 fname = zebra_mk_fname(res_get(zh->res, "lockDir"), state_fname);
1603 f = fopen(fname, "w");
1605 yaz_log(YLOG_DEBUG, "zebra_set_state: %c %d %ld", val, seqno, p);
1606 fprintf(f, "%c %d %ld\n", val, seqno, p);
1611 static void zebra_get_state(ZebraHandle zh, char *val, int *seqno)
1613 char state_fname[256];
1618 yaz_log(log_level, "zebra_get_state ");
1620 sprintf(state_fname, "state.%s.LCK", zh->reg_name);
1621 fname = zebra_mk_fname(res_get(zh->res, "lockDir"), state_fname);
1622 f = fopen(fname, "r");
1628 fscanf(f, "%c %d", val, seqno);
1634 ZEBRA_RES zebra_begin_read(ZebraHandle zh)
1636 return zebra_begin_trans(zh, 0);
1639 ZEBRA_RES zebra_end_read(ZebraHandle zh)
1641 return zebra_end_trans(zh);
1644 static void read_res_for_transaction(ZebraHandle zh)
1646 const char *group = res_get(zh->res, "group");
1648 /* FIXME - do we still use groups ?? */
1650 zh->m_group = group;
1651 v = res_get_prefix(zh->res, "followLinks", group, "1");
1652 zh->m_follow_links = atoi(v);
1654 zh->m_record_id = res_get_prefix(zh->res, "recordId", group, 0);
1655 zh->m_record_type = res_get_prefix(zh->res, "recordType", group, 0);
1657 v = res_get_prefix(zh->res, "storeKeys", group, "1");
1658 zh->m_store_keys = atoi(v);
1660 v = res_get_prefix(zh->res, "storeData", group, "1");
1661 zh->m_store_data = atoi(v);
1663 v = res_get_prefix(zh->res, "explainDatabase", group, "0");
1664 zh->m_explain_database = atoi(v);
1666 v = res_get_prefix(zh->res, "openRW", group, "1");
1667 zh->m_flag_rw = atoi(v);
1669 v = res_get_prefix(zh->res, "fileVerboseLimit", group, "1000");
1670 zh->m_file_verbose_limit = atoi(v);
1673 ZEBRA_RES zebra_begin_trans(ZebraHandle zh, int rw)
1675 ZEBRA_CHECK_HANDLE(zh);
1676 zebra_select_default_database(zh);
1679 zebra_setError(zh, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
1680 "zebra_begin_trans: no database selected");
1684 yaz_log(log_level, "zebra_begin_trans rw=%d",rw);
1688 if (rw && !strchr(zh->user_perm, 'w'))
1692 YAZ_BIB1_ES_PERMISSION_DENIED_ON_ES_CANNOT_MODIFY_OR_DELETE,
1703 const char *rval = 0;
1708 read_res_for_transaction(zh);
1711 if (zh->trans_no != 1)
1713 zebra_setError(zh, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
1714 "zebra_begin_trans: no write trans within read");
1719 resultSetInvalidate(zh);
1720 zebra_register_close(zh->service, zh->reg);
1722 zh->trans_w_no = zh->trans_no;
1724 zh->records_inserted = 0;
1725 zh->records_updated = 0;
1726 zh->records_deleted = 0;
1727 zh->records_processed = 0;
1728 zh->records_skipped = 0;
1730 #if HAVE_SYS_TIMES_H
1734 if (zh->shadow_enable)
1735 rval = res_get(zh->res, "shadow");
1739 zebra_lock_r(zh->lock_normal);
1740 zebra_lock_w(zh->lock_shadow);
1744 zebra_lock_w(zh->lock_normal);
1745 zebra_lock_w(zh->lock_shadow);
1747 zebra_get_state(zh, &val, &seqno);
1750 /* either we didn't finish commit or shadow is dirty */
1753 yaz_log(YLOG_WARN, "previous transaction did not finish "
1754 "(shadow disabled)");
1756 zebra_unlock(zh->lock_shadow);
1757 zebra_unlock(zh->lock_normal);
1758 if (zebra_commit(zh))
1766 zebra_lock_r(zh->lock_normal);
1767 zebra_lock_w(zh->lock_shadow);
1771 zebra_lock_w(zh->lock_normal);
1772 zebra_lock_w(zh->lock_shadow);
1776 zebra_set_state(zh, 'd', seqno);
1778 zh->reg = zebra_register_open(zh->service, zh->reg_name,
1779 1, rval ? 1 : 0, zh->res,
1782 zh->reg->seqno = seqno;
1785 zebra_set_state(zh, 'o', seqno);
1787 zebra_unlock(zh->lock_shadow);
1788 zebra_unlock(zh->lock_normal);
1793 zebra_setError(zh, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
1794 "zebra_begin_trans: cannot open register");
1795 yaz_log(YLOG_FATAL, "%s", zh->errString);
1798 zebraExplain_curDatabase(zh->reg->zei, zh->basenames[0]);
1808 if (zh->trans_no != 1)
1810 return zebra_flush_reg(zh);
1812 #if HAVE_SYS_TIMES_H
1818 zh->errCode = YAZ_BIB1_DATABASE_UNAVAILABLE;
1821 if (!zh->lock_normal || !zh->lock_shadow)
1824 zh->errCode = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1827 zebra_get_state(zh, &val, &seqno);
1833 else if (seqno != zh->reg->seqno)
1835 yaz_log(YLOG_DEBUG, "reopen seqno cur/old %d/%d",
1836 seqno, zh->reg->seqno);
1839 else if (zh->reg->last_val != val)
1841 yaz_log(YLOG_DEBUG, "reopen last cur/old %d/%d",
1842 val, zh->reg->last_val);
1849 zebra_lock_r(zh->lock_shadow);
1851 zebra_lock_r(zh->lock_normal);
1855 resultSetInvalidate(zh);
1856 zebra_register_close(zh->service, zh->reg);
1858 zh->reg = zebra_register_open(zh->service, zh->reg_name,
1859 0, val == 'c' ? 1 : 0,
1860 zh->res, zh->path_reg);
1863 zebra_unlock(zh->lock_normal);
1864 zebra_unlock(zh->lock_shadow);
1866 zh->errCode = YAZ_BIB1_DATABASE_UNAVAILABLE;
1869 zh->reg->last_val = val;
1870 zh->reg->seqno = seqno;
1872 read_res_for_transaction(zh);
1876 ZEBRA_RES zebra_end_trans(ZebraHandle zh)
1878 ZebraTransactionStatus dummy;
1880 yaz_log(log_level, "zebra_end_trans");
1881 ZEBRA_CHECK_HANDLE(zh);
1882 return zebra_end_transaction(zh, &dummy);
1885 ZEBRA_RES zebra_end_transaction(ZebraHandle zh, ZebraTransactionStatus *status)
1891 ZEBRA_CHECK_HANDLE(zh);
1894 yaz_log(log_level, "zebra_end_transaction");
1896 status->processed = 0;
1897 status->inserted = 0;
1898 status->updated = 0;
1899 status->deleted = 0;
1903 if (!zh->res || !zh->reg)
1905 zebra_setError(zh, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
1906 "zebra_end_trans: no open transaction");
1909 if (zh->trans_no != zh->trans_w_no)
1912 if (zh->trans_no != 0)
1915 /* release read lock */
1917 zebra_unlock(zh->lock_normal);
1918 zebra_unlock(zh->lock_shadow);
1921 { /* release write lock */
1925 yaz_log(YLOG_DEBUG, "zebra_end_trans");
1926 rval = res_get(zh->res, "shadow");
1928 zebraExplain_runNumberIncrement(zh->reg->zei, 1);
1930 zebra_flush_reg(zh);
1932 resultSetInvalidate(zh);
1934 zebra_register_close(zh->service, zh->reg);
1937 yaz_log(YLOG_LOG, "Records: "ZINT_FORMAT" i/u/d "
1938 ZINT_FORMAT"/"ZINT_FORMAT"/"ZINT_FORMAT,
1939 zh->records_processed, zh->records_inserted,
1940 zh->records_updated, zh->records_deleted);
1942 status->processed = zh->records_processed;
1943 status->inserted = zh->records_inserted;
1944 status->updated = zh->records_updated;
1945 status->deleted = zh->records_deleted;
1947 zebra_get_state(zh, &val, &seqno);
1950 BFiles bfs = bfs_create(rval, zh->path_reg);
1951 bf_commitClean(bfs, rval);
1956 zebra_set_state(zh, 'o', seqno);
1957 zebra_unlock(zh->lock_shadow);
1958 zebra_unlock(zh->lock_normal);
1961 #if HAVE_SYS_TIMES_H
1963 yaz_log(log_level, "user/system: %ld/%ld",
1964 (long) (zh->tms2.tms_utime - zh->tms1.tms_utime),
1965 (long) (zh->tms2.tms_stime - zh->tms1.tms_stime));
1967 status->utime = (long) (zh->tms2.tms_utime - zh->tms1.tms_utime);
1968 status->stime = (long) (zh->tms2.tms_stime - zh->tms1.tms_stime);
1973 ZEBRA_RES zebra_repository_update(ZebraHandle zh, const char *path)
1975 return zebra_repository_index(zh, path, action_update);
1978 ZEBRA_RES zebra_repository_delete(ZebraHandle zh, const char *path)
1980 return zebra_repository_index(zh, path, action_delete);
1983 ZEBRA_RES zebra_repository_index(ZebraHandle zh, const char *path,
1984 enum zebra_recctrl_action_t action)
1989 if (action == action_update)
1990 yaz_log(log_level, "updating %s", path);
1991 else if (action == action_delete)
1992 yaz_log(log_level, "deleting %s", path);
1993 else if (action == action_a_delete)
1994 yaz_log(log_level, "attempt deleting %s", path);
1996 yaz_log(log_level, "update action=%d", (int) action);
1998 if (zh->m_record_id && !strcmp(zh->m_record_id, "file"))
1999 return zebra_update_file_match(zh, path);
2001 return zebra_update_from_path(zh, path, action);
2004 ZEBRA_RES zebra_repository_show(ZebraHandle zh, const char *path)
2008 yaz_log(log_level, "zebra_repository_show");
2009 repositoryShow(zh, path);
2013 static ZEBRA_RES zebra_commit_ex(ZebraHandle zh, int clean_only)
2019 ZEBRA_RES res = ZEBRA_OK;
2023 yaz_log(log_level, "zebra_commit_ex clean_only=%d", clean_only);
2024 zebra_select_default_database(zh);
2027 zh->errCode = YAZ_BIB1_DATABASE_UNAVAILABLE;
2030 rval = res_get(zh->res, "shadow");
2033 yaz_log(YLOG_WARN, "Cannot perform commit - No shadow area defined");
2037 zebra_lock_w(zh->lock_normal);
2038 zebra_lock_r(zh->lock_shadow);
2040 bfs = bfs_create(res_get(zh->res, "register"), zh->path_reg);
2043 zebra_unlock(zh->lock_shadow);
2044 zebra_unlock(zh->lock_normal);
2047 zebra_get_state(zh, &val, &seqno);
2051 /* shadow area is dirty and so we must throw it away */
2052 yaz_log(YLOG_WARN, "previous transaction didn't reach commit");
2055 else if (val == 'c')
2057 /* commit has started. We can not remove it anymore */
2062 bf_cache(bfs, rval);
2063 if (bf_commitExists(bfs))
2066 zebra_set_state(zh, 'd', seqno);
2069 zebra_set_state(zh, 'c', seqno);
2071 yaz_log(log_level, "commit start");
2072 if (bf_commitExec(bfs))
2075 if (res == ZEBRA_OK)
2078 zebra_set_state(zh, 'o', seqno);
2080 zebra_unlock(zh->lock_shadow);
2081 zebra_unlock(zh->lock_normal);
2083 zebra_lock_w(zh->lock_shadow);
2084 bf_commitClean(bfs, rval);
2085 zebra_unlock(zh->lock_shadow);
2089 zebra_unlock(zh->lock_shadow);
2090 zebra_unlock(zh->lock_normal);
2091 yaz_log(YLOG_WARN, "zebra_commit: failed");
2096 zebra_unlock(zh->lock_shadow);
2097 zebra_unlock(zh->lock_normal);
2098 yaz_log(log_level, "nothing to commit");
2105 ZEBRA_RES zebra_clean(ZebraHandle zh)
2107 yaz_log(log_level, "zebra_clean");
2108 ZEBRA_CHECK_HANDLE(zh);
2109 return zebra_commit_ex(zh, 1);
2112 ZEBRA_RES zebra_commit(ZebraHandle zh)
2114 yaz_log(log_level, "zebra_commit");
2115 ZEBRA_CHECK_HANDLE(zh);
2116 return zebra_commit_ex(zh, 0);
2120 ZEBRA_RES zebra_init(ZebraHandle zh)
2125 yaz_log(log_level, "zebra_init");
2127 ZEBRA_CHECK_HANDLE(zh);
2129 zebra_select_default_database(zh);
2132 zebra_setError(zh, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
2133 "cannot select default database");
2136 rval = res_get(zh->res, "shadow");
2138 bfs = bfs_create(res_get(zh->res, "register"), zh->path_reg);
2141 zebra_setError(zh, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, "bfs_create");
2145 bf_cache(bfs, rval);
2149 zebra_set_state(zh, 'o', 0);
2153 ZEBRA_RES zebra_compact(ZebraHandle zh)
2157 yaz_log(log_level, "zebra_compact");
2158 ZEBRA_CHECK_HANDLE(zh);
2161 zh->errCode = YAZ_BIB1_DATABASE_UNAVAILABLE;
2164 bfs = bfs_create(res_get(zh->res, "register"), zh->path_reg);
2170 void zebra_result(ZebraHandle zh, int *code, char **addinfo)
2172 yaz_log(log_level, "zebra_result");
2175 *code = zh->errCode;
2176 *addinfo = zh->errString;
2180 *code = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
2181 *addinfo ="ZebraHandle is NULL";
2185 void zebra_shadow_enable(ZebraHandle zh, int value)
2188 yaz_log(log_level, "zebra_shadow_enable");
2189 zh->shadow_enable = value;
2192 ZEBRA_RES zebra_octet_term_encoding(ZebraHandle zh, const char *encoding)
2194 yaz_log(log_level, "zebra_octet_term_encoding %s", encoding);
2195 ZEBRA_CHECK_HANDLE(zh);
2198 if (zh->iconv_to_utf8 != 0)
2199 yaz_iconv_close(zh->iconv_to_utf8);
2200 if (zh->iconv_from_utf8 != 0)
2201 yaz_iconv_close(zh->iconv_from_utf8);
2204 yaz_iconv_open("UTF-8", encoding);
2205 if (zh->iconv_to_utf8 == 0)
2206 yaz_log(YLOG_WARN, "iconv: %s to UTF-8 unsupported", encoding);
2207 zh->iconv_from_utf8 =
2208 yaz_iconv_open(encoding, "UTF-8");
2209 if (zh->iconv_to_utf8 == 0)
2210 yaz_log(YLOG_WARN, "iconv: UTF-8 to %s unsupported", encoding);
2215 ZEBRA_RES zebra_record_encoding(ZebraHandle zh, const char *encoding)
2217 yaz_log(log_level, "zebra_record_encoding");
2218 ZEBRA_CHECK_HANDLE(zh);
2219 xfree(zh->record_encoding);
2220 zh->record_encoding = 0;
2222 zh->record_encoding = xstrdup(encoding);
2226 void zebra_set_resource(ZebraHandle zh, const char *name, const char *value)
2230 yaz_log(log_level, "zebra_set_resource %s:%s", name, value);
2232 res_set(zh->res, name, value);
2235 const char *zebra_get_resource(ZebraHandle zh,
2236 const char *name, const char *defaultvalue)
2241 v = res_get_def(zh->res, name,(char *)defaultvalue);
2242 yaz_log(log_level, "zebra_get_resource %s:%s", name, v);
2246 /* moved from zebra_api_ext.c by pop */
2247 /* FIXME: Should this really be public??? -Heikki */
2249 int zebra_trans_no(ZebraHandle zh)
2251 yaz_log(log_level, "zebra_trans_no");
2253 return zh->trans_no;
2256 int zebra_get_shadow_enable(ZebraHandle zh)
2258 yaz_log(log_level, "zebra_get_shadow_enable");
2260 return zh->shadow_enable;
2263 void zebra_set_shadow_enable(ZebraHandle zh, int value)
2265 yaz_log(log_level, "zebra_set_shadow_enable %d",value);
2267 zh->shadow_enable = value;
2270 ZEBRA_RES zebra_add_record(ZebraHandle zh,
2271 const char *buf, int buf_size)
2273 return zebra_update_record(zh, action_update,
2274 0 /* record type */,
2281 ZEBRA_RES zebra_update_record(ZebraHandle zh,
2282 enum zebra_recctrl_action_t action,
2283 const char *recordType,
2284 zint *sysno, const char *match,
2286 const char *buf, int buf_size)
2290 ZEBRA_CHECK_HANDLE(zh);
2294 yaz_log(log_level, "zebra_update_record");
2296 yaz_log(log_level, " sysno=" ZINT_FORMAT, *sysno);
2299 buf_size = strlen(buf);
2301 if (zebra_begin_trans(zh, 1) == ZEBRA_FAIL)
2303 res = zebra_buffer_extract_record(zh, buf, buf_size,
2309 if (zebra_end_trans(zh) != ZEBRA_OK)
2311 yaz_log(YLOG_WARN, "zebra_end_trans failed");
2317 /* ---------------------------------------------------------------------------
2321 ZEBRA_RES zebra_search_PQF(ZebraHandle zh, const char *pqf_query,
2322 const char *setname, zint *hits)
2325 ZEBRA_RES res = ZEBRA_OK;
2330 ZEBRA_CHECK_HANDLE(zh);
2332 odr = odr_createmem(ODR_ENCODE);
2337 yaz_log(log_level, "zebra_search_PQF s=%s q=%s", setname, pqf_query);
2339 query = p_query_rpn(odr, pqf_query);
2343 yaz_log(YLOG_WARN, "bad query %s\n", pqf_query);
2344 zh->errCode = YAZ_BIB1_MALFORMED_QUERY;
2348 res = zebra_search_RPN(zh, odr, query, setname, &lhits);
2352 yaz_log(log_level, "Hits: " ZINT_FORMAT, lhits);
2360 /* ---------------------------------------------------------------------------
2361 Sort - a simplified interface, with optional read locks.
2363 int zebra_sort_by_specstr(ZebraHandle zh, ODR stream,
2364 const char *sort_spec,
2365 const char *output_setname,
2366 const char **input_setnames)
2368 int num_input_setnames = 0;
2369 int sort_status = 0;
2370 Z_SortKeySpecList *sort_sequence;
2372 ZEBRA_CHECK_HANDLE(zh);
2375 assert(output_setname);
2376 assert(input_setnames);
2377 sort_sequence = yaz_sort_spec(stream, sort_spec);
2378 yaz_log(log_level, "sort (FIXME) ");
2381 yaz_log(YLOG_WARN, "invalid sort specs '%s'", sort_spec);
2382 zh->errCode = YAZ_BIB1_CANNOT_SORT_ACCORDING_TO_SEQUENCE;
2386 /* we can do this, since the perl typemap code for char** will
2387 put a NULL at the end of list */
2388 while (input_setnames[num_input_setnames]) num_input_setnames++;
2390 if (zebra_begin_read(zh))
2393 resultSetSort(zh, stream->mem, num_input_setnames, input_setnames,
2394 output_setname, sort_sequence, &sort_status);
2400 /* ---------------------------------------------------------------------------
2401 Get BFS for Zebra system (to make alternative storage methods)
2403 struct BFiles_struct *zebra_get_bfs(ZebraHandle zh)
2406 return zh->reg->bfs;
2411 /* ---------------------------------------------------------------------------
2412 Set limit for search/scan
2414 ZEBRA_RES zebra_set_limit(ZebraHandle zh, int complement_flag, zint *ids)
2416 ZEBRA_CHECK_HANDLE(zh);
2417 zebra_limit_destroy(zh->m_limit);
2418 zh->m_limit = zebra_limit_create(complement_flag, ids);
2423 Set Error code + addinfo
2425 void zebra_setError(ZebraHandle zh, int code, const char *addinfo)
2430 nmem_reset(zh->nmem_error);
2431 zh->errString = addinfo ? nmem_strdup(zh->nmem_error, addinfo) : 0;
2434 void zebra_setError_zint(ZebraHandle zh, int code, zint i)
2437 sprintf(vstr, ZINT_FORMAT, i);
2440 nmem_reset(zh->nmem_error);
2441 zh->errString = nmem_strdup(zh->nmem_error, vstr);
2444 void zebra_lock_prefix(Res res, char *path)
2446 const char *lock_dir = res_get_def(res, "lockDir", "");
2448 strcpy(path, lock_dir);
2449 if (*path && path[strlen(path)-1] != '/')
2456 * c-file-style: "Stroustrup"
2457 * indent-tabs-mode: nil
2459 * vim: shiftwidth=4 tabstop=8 expandtab