1 /* This file is part of the Zebra server.
2 Copyright (C) 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
35 #include <yaz/diagbib1.h>
36 #include <yaz/pquery.h>
37 #include <yaz/sortspec.h>
42 #include <idzebra/api.h>
43 #include <yaz/oid_db.h>
45 #define DEFAULT_APPROX_LIMIT 2000000000
47 /* simple asserts to validate the most essential input args */
48 #define ASSERTZH assert(zh && zh->service)
49 #define ASSERTZHRES assert(zh && zh->service && zh->res)
50 #define ASSERTZS assert(zs)
52 static int log_level = 0;
53 static int log_level_initialized = 0;
55 static void zebra_open_res(ZebraHandle zh);
56 static void zebra_close_res(ZebraHandle zh);
58 static ZEBRA_RES zebra_check_handle(ZebraHandle zh)
65 #define ZEBRA_CHECK_HANDLE(zh) if (zebra_check_handle(zh) != ZEBRA_OK) return ZEBRA_FAIL
67 static int zebra_chdir(ZebraService zs)
72 yaz_log(log_level, "zebra_chdir");
73 dir = res_get(zs->global_res, "chdir");
76 yaz_log(YLOG_DEBUG, "chdir %s", dir);
83 yaz_log(YLOG_FATAL|YLOG_ERRNO, "chdir %s", dir);
87 static ZEBRA_RES zebra_flush_reg(ZebraHandle zh)
89 ZEBRA_CHECK_HANDLE(zh);
90 yaz_log(log_level, "zebra_flush_reg");
91 zebraExplain_flush(zh->reg->zei, zh);
93 key_block_flush(zh->reg->key_block, 1);
95 zebra_index_merge(zh);
99 static struct zebra_register *zebra_register_open(ZebraService zs,
101 int rw, int useshadow,
103 const char *reg_path);
104 static void zebra_register_close(ZebraService zs, struct zebra_register *reg);
106 const char *zebra_get_encoding(ZebraHandle zh)
108 assert(zh && zh->session_res);
109 return res_get_def(zh->session_res, "encoding", "ISO-8859-1");
112 ZebraHandle zebra_open(ZebraService zs, Res res)
115 const char *default_encoding;
116 if (!log_level_initialized)
118 log_level = yaz_log_module_level("zebraapi");
119 log_level_initialized = 1;
122 yaz_log(log_level, "zebra_open");
127 zh = (ZebraHandle) xmalloc(sizeof(*zh));
128 yaz_log(YLOG_DEBUG, "zebra_open zs=%p returns %p", zs, zh);
131 zh->reg = 0; /* no register attached yet */
137 zh->session_res = res_open(zs->global_res, res);
139 zh->dbaccesslist = 0;
141 zh->reg_name = xstrdup("");
143 zh->num_basenames = 0;
146 zh->approx_limit = DEFAULT_APPROX_LIMIT;
153 zh->shadow_enable = 1;
154 zh->m_staticrank = 0;
155 zh->m_segment_indexing = 0;
157 zh->break_handler_func = 0;
158 zh->break_handler_data = 0;
160 default_encoding = zebra_get_encoding(zh);
163 yaz_iconv_open("UTF-8", default_encoding);
164 if (zh->iconv_to_utf8 == 0)
165 yaz_log(YLOG_WARN, "iconv: %s to UTF-8 unsupported",
167 zh->iconv_from_utf8 =
168 yaz_iconv_open(default_encoding, "UTF-8");
169 if (zh->iconv_to_utf8 == 0)
170 yaz_log(YLOG_WARN, "iconv: UTF-8 to %s unsupported",
173 zh->record_encoding = 0;
175 zebra_mutex_cond_lock(&zs->session_lock);
177 zh->next = zs->sessions;
180 zebra_mutex_cond_unlock(&zs->session_lock);
182 zh->store_data_buf = 0;
184 zh->m_limit = zebra_limit_create(1, 0);
186 zh->nmem_error = nmem_create();
191 ZebraService zebra_start(const char *configName)
193 return zebra_start_res(configName, 0, 0);
196 ZebraService zebra_start_res(const char *configName, Res def_res, Res over_res)
199 char version_str[16];
204 if (!log_level_initialized)
206 log_level = yaz_log_module_level("zebraapi");
207 log_level_initialized = 1;
212 zebra_get_version(version_str, system_str);
214 yaz_log(YLOG_LOG, "zebra_start %s %s", version_str, system_str);
216 yaz_log(YLOG_LOG, "config %s", configName);
218 yaz_log_xml_errors(0, YLOG_LOG);
220 if ((res = res_open(def_res, over_res)))
222 const char *passwd_plain = 0;
223 const char *passwd_encrypt = 0;
224 const char *dbaccess = 0;
229 ZEBRA_RES ret = res_read_file(res, configName);
235 if (zebra_check_res(res))
237 yaz_log(YLOG_FATAL, "Configuration error(s) for %s",
244 zebra_check_res(res);
247 zh = xmalloc(sizeof(*zh));
248 zh->global_res = res;
257 zebra_mutex_cond_init(&zh->session_lock);
258 passwd_plain = res_get(zh->global_res, "passwd");
259 passwd_encrypt = res_get(zh->global_res, "passwd.c");
260 dbaccess = res_get(zh->global_res, "dbaccess");
262 if (!passwd_plain && !passwd_encrypt)
263 zh->passwd_db = NULL;
266 zh->passwd_db = passwd_db_open();
268 yaz_log(YLOG_WARN|YLOG_ERRNO, "passwd_db_open failed");
272 passwd_db_file_plain(zh->passwd_db, passwd_plain);
274 passwd_db_file_crypt(zh->passwd_db, passwd_encrypt);
281 zh->dbaccess = res_open(NULL, NULL);
282 if (res_read_file(zh->dbaccess, dbaccess) != ZEBRA_OK) {
283 yaz_log(YLOG_FATAL, "Failed to read %s", dbaccess);
288 zh->timing = yaz_timing_create();
289 zh->path_root = res_get(zh->global_res, "root");
290 zh->nmem = nmem_create();
291 zh->record_classes = recTypeClass_create(zh->global_res, zh->nmem);
295 const char *module_path = res_get(res, "modulePath");
297 recTypeClass_load_modules(&zh->record_classes, zh->nmem,
305 void zebra_filter_info(ZebraService zs, void *cd,
306 void(*cb)(void *cd, const char *name))
310 recTypeClass_info(zs->record_classes, cd, cb);
313 void zebra_pidfname(ZebraService zs, char *path)
316 zebra_lock_prefix(zs->global_res, path);
317 strcat(path, "zebrasrv.pid");
320 Dict dict_open_res(BFiles bfs, const char *name, int cache, int rw,
321 int compact_flag, Res res)
323 int page_size = 4096;
324 char resource_str[200];
325 sprintf(resource_str, "dict.%.100s.pagesize", name);
329 if (res_get_int(res, resource_str, &page_size) == ZEBRA_OK)
330 yaz_log(YLOG_LOG, "Using custom dictionary page size %d for %s",
332 return dict_open(bfs, name, cache, rw, compact_flag, page_size);
336 struct zebra_register *zebra_register_open(ZebraService zs, const char *name,
337 int rw, int useshadow, Res res,
338 const char *reg_path)
340 struct zebra_register *reg;
341 int record_compression = REC_COMPRESS_NONE;
342 const char *compression_str = 0;
343 const char *profilePath;
344 int sort_type = ZEBRA_SORT_TYPE_FLAT;
345 ZEBRA_RES ret = ZEBRA_OK;
349 reg = xmalloc(sizeof(*reg));
352 reg->name = xstrdup(name);
359 yaz_log(YLOG_DEBUG, "zebra_register_open rw=%d useshadow=%d p=%p n=%s rp=%s",
360 rw, useshadow, reg, name, reg_path ? reg_path : "(none)");
362 reg->dh = data1_create();
369 reg->bfs = bfs_create(res_get(res, "register"), reg_path);
372 data1_destroy(reg->dh);
379 if (bf_cache(reg->bfs, res_get(res, "shadow")) == ZEBRA_FAIL)
381 bfs_destroy(reg->bfs);
382 data1_destroy(reg->dh);
389 profilePath = res_get_def(res, "profilePath", 0);
391 data1_set_tabpath(reg->dh, profilePath);
392 data1_set_tabroot(reg->dh, reg_path);
393 reg->recTypes = recTypes_init(zs->record_classes, reg->dh);
396 zebra_maps_open(res, reg_path, profilePath);
397 if (!reg->zebra_maps)
399 recTypes_destroy(reg->recTypes);
400 bfs_destroy(reg->bfs);
401 data1_destroy(reg->dh);
406 reg->rank_classes = NULL;
409 reg->keys = zebra_rec_keys_open();
411 reg->sortKeys = zebra_rec_keys_open();
422 /* installing rank classes */
423 zebraRankInstall(reg, rank_1_class);
424 zebraRankInstall(reg, rank_2_class);
425 zebraRankInstall(reg, rank_similarity_class);
426 zebraRankInstall(reg, rank_static_class);
428 compression_str = res_get_def(res, "recordCompression", "none");
429 if (!strcmp(compression_str, "none"))
430 record_compression = REC_COMPRESS_NONE;
431 else if (!strcmp(compression_str, "bzip2"))
432 record_compression = REC_COMPRESS_BZIP2;
433 else if (!strcmp(compression_str, "zlib"))
434 record_compression = REC_COMPRESS_ZLIB;
437 yaz_log(YLOG_FATAL, "invalid recordCompression: %s", compression_str);
441 if (!rec_check_compression_method(record_compression))
443 yaz_log(YLOG_FATAL, "unsupported recordCompression: %s",
449 const char *index_fname = res_get_def(res, "index", "default.idx");
450 if (index_fname && *index_fname && strcmp(index_fname, "none"))
452 if (zebra_maps_read_file(reg->zebra_maps, index_fname) != ZEBRA_OK)
457 zebra_maps_define_default_sort(reg->zebra_maps);
461 if (!(reg->records = rec_open(reg->bfs, rw, record_compression)))
463 yaz_log(YLOG_WARN, "rec_open failed");
468 reg->matchDict = dict_open_res(reg->bfs, GMATCH_DICT, 20, 1, 0, res);
470 if (!(reg->dict = dict_open_res(reg->bfs, FNAME_DICT, 40, rw, 0, res)))
472 yaz_log(YLOG_WARN, "dict_open failed");
477 if (res_get_match(res, "sortindex", "f", "f"))
478 sort_type = ZEBRA_SORT_TYPE_FLAT;
479 else if (res_get_match(res, "sortindex", "i", "f"))
480 sort_type = ZEBRA_SORT_TYPE_ISAMB;
481 else if (res_get_match(res, "sortindex", "m", "f"))
482 sort_type = ZEBRA_SORT_TYPE_MULTI;
485 yaz_log(YLOG_WARN, "bad_value for 'sortindex'");
490 if (!(reg->sort_index = zebra_sort_open(reg->bfs, rw, sort_type)))
492 yaz_log(YLOG_WARN, "zebra_sort_open failed");
495 if (res_get_match(res, "isam", "s", ISAM_DEFAULT))
497 struct ISAMS_M_s isams_m;
498 if (!(reg->isams = isams_open(reg->bfs, FNAME_ISAMS, rw,
499 key_isams_m(res, &isams_m))))
501 yaz_log(YLOG_WARN, "isams_open failed");
505 if (res_get_match(res, "isam", "c", ISAM_DEFAULT))
507 struct ISAMC_M_s isamc_m;
508 if (!(reg->isamc = isamc_open(reg->bfs, FNAME_ISAMC,
509 rw, key_isamc_m(res, &isamc_m))))
511 yaz_log(YLOG_WARN, "isamc_open failed");
515 if (res_get_match(res, "isam", "b", ISAM_DEFAULT))
517 struct ISAMC_M_s isamc_m;
519 if (!(reg->isamb = isamb_open(reg->bfs, "isamb",
520 rw, key_isamc_m(res, &isamc_m), 0)))
522 yaz_log(YLOG_WARN, "isamb_open failed");
526 if (res_get_match(res, "isam", "bc", ISAM_DEFAULT))
528 struct ISAMC_M_s isamc_m;
530 if (!(reg->isamb = isamb_open(reg->bfs, "isamb",
531 rw, key_isamc_m(res, &isamc_m), 1)))
533 yaz_log(YLOG_WARN, "isamb_open failed");
537 if (res_get_match(res, "isam", "null", ISAM_DEFAULT))
539 struct ISAMC_M_s isamc_m;
541 if (!(reg->isamb = isamb_open(reg->bfs, "isamb",
542 rw, key_isamc_m(res, &isamc_m), -1)))
544 yaz_log(YLOG_WARN, "isamb_open failed");
550 reg->zei = zebraExplain_open(reg->records, reg->dh,
552 zebra_extract_explain);
555 yaz_log(YLOG_WARN, "Cannot obtain EXPLAIN information");
562 zebra_register_close(zs, reg);
565 yaz_log(YLOG_DEBUG, "zebra_register_open ok p=%p", reg);
569 ZEBRA_RES zebra_admin_shutdown(ZebraHandle zh)
571 ZEBRA_CHECK_HANDLE(zh);
572 yaz_log(log_level, "zebra_admin_shutdown");
574 zebra_mutex_cond_lock(&zh->service->session_lock);
575 zh->service->stop_flag = 1;
576 zebra_mutex_cond_unlock(&zh->service->session_lock);
580 ZEBRA_RES zebra_admin_start(ZebraHandle zh)
583 ZEBRA_CHECK_HANDLE(zh);
584 yaz_log(log_level, "zebra_admin_start");
586 zebra_mutex_cond_lock(&zs->session_lock);
587 zebra_mutex_cond_unlock(&zs->session_lock);
591 static void zebra_register_close(ZebraService zs, struct zebra_register *reg)
595 yaz_log(YLOG_DEBUG, "zebra_register_close p=%p", reg);
599 zebraExplain_close(reg->zei);
600 dict_close(reg->dict);
602 dict_close(reg->matchDict);
603 zebra_sort_close(reg->sort_index);
605 isams_close(reg->isams);
607 isamc_close(reg->isamc);
609 isamb_close(reg->isamb);
610 rec_close(®->records);
612 recTypes_destroy(reg->recTypes);
613 zebra_maps_close(reg->zebra_maps);
614 zebraRankDestroy(reg);
615 bfs_destroy(reg->bfs);
616 data1_destroy(reg->dh);
618 zebra_rec_keys_close(reg->keys);
619 zebra_rec_keys_close(reg->sortKeys);
621 key_block_destroy(®->key_block);
626 ZEBRA_RES zebra_stop(ZebraService zs)
632 zebra_close(zs->sessions);
635 zebra_mutex_cond_destroy(&zs->session_lock);
638 passwd_db_close(zs->passwd_db);
640 recTypeClass_destroy(zs->record_classes);
641 nmem_destroy(zs->nmem);
642 res_close(zs->global_res);
644 yaz_timing_stop(zs->timing);
645 yaz_log(YLOG_LOG, "zebra_stop: %4.2f %4.2f %4.2f",
646 yaz_timing_get_real(zs->timing),
647 yaz_timing_get_user(zs->timing),
648 yaz_timing_get_sys(zs->timing));
651 yaz_timing_destroy(&zs->timing);
656 ZEBRA_RES zebra_close(ZebraHandle zh)
659 struct zebra_session **sp;
662 yaz_log(log_level, "zebra_close");
663 ZEBRA_CHECK_HANDLE(zh);
668 yaz_log(YLOG_DEBUG, "zebra_close zh=%p", zh);
669 resultSetDestroy(zh, -1, 0, 0);
672 zebra_register_close(zh->service, zh->reg);
674 res_close(zh->session_res);
676 xfree(zh->record_encoding);
678 xfree(zh->dbaccesslist);
680 for (i = 0; i < zh->num_basenames; i++)
681 xfree(zh->basenames[i]);
682 xfree(zh->basenames);
684 if (zh->iconv_to_utf8 != 0)
685 yaz_iconv_close(zh->iconv_to_utf8);
686 if (zh->iconv_from_utf8 != 0)
687 yaz_iconv_close(zh->iconv_from_utf8);
689 zebra_mutex_cond_lock(&zs->session_lock);
690 zebra_lock_destroy(zh->lock_normal);
691 zebra_lock_destroy(zh->lock_shadow);
703 zebra_mutex_cond_unlock(&zs->session_lock);
705 xfree(zh->user_perm);
706 zh->service = 0; /* more likely to trigger an assert */
708 zebra_limit_destroy(zh->m_limit);
710 nmem_destroy(zh->nmem_error);
717 struct map_baseinfo {
723 char **new_basenames;
727 static void zebra_open_res(ZebraHandle zh)
735 sprintf(fname, "%.200s/zebra.cfg", zh->path_reg);
736 zh->res = res_open(zh->session_res, 0);
737 res_read_file(zh->res, fname);
739 else if (*zh->reg_name == 0)
741 zh->res = res_open(zh->session_res, 0);
745 yaz_log(YLOG_WARN, "no register root specified");
746 zh->res = 0; /* no path for register - fail! */
750 static void zebra_close_res(ZebraHandle zh)
758 static void zebra_select_register(ZebraHandle zh, const char *new_reg)
762 if (zh->res && strcmp(zh->reg_name, new_reg) == 0)
766 assert(zh->reg == 0);
767 assert(*zh->reg_name == 0);
773 resultSetInvalidate(zh);
774 zebra_register_close(zh->service, zh->reg);
780 zh->reg_name = xstrdup(new_reg);
784 if (zh->service->path_root)
786 zh->path_reg = xmalloc(strlen(zh->service->path_root) +
787 strlen(zh->reg_name) + 3);
788 strcpy(zh->path_reg, zh->service->path_root);
791 strcat(zh->path_reg, "/");
792 strcat(zh->path_reg, zh->reg_name);
798 zebra_lock_destroy(zh->lock_normal);
802 zebra_lock_destroy(zh->lock_shadow);
808 const char *lock_area = res_get(zh->res, "lockDir");
810 if (!lock_area && zh->path_reg)
811 res_set(zh->res, "lockDir", zh->path_reg);
812 sprintf(fname, "norm.%s.LCK", zh->reg_name);
814 zebra_lock_create(res_get(zh->res, "lockDir"), fname);
816 sprintf(fname, "shadow.%s.LCK", zh->reg_name);
818 zebra_lock_create(res_get(zh->res, "lockDir"), fname);
820 if (!zh->lock_normal || !zh->lock_shadow)
824 zebra_lock_destroy(zh->lock_normal);
829 zebra_lock_destroy(zh->lock_shadow);
838 if (res_get_int(zh->res, "estimatehits", &approx) == ZEBRA_OK)
839 zebra_set_approx_limit(zh, approx);
843 if (res_get_int(zh->res, "staticrank", &zh->m_staticrank) == ZEBRA_OK)
844 yaz_log(YLOG_LOG, "static rank set and is %d", zh->m_staticrank);
848 if (res_get_int(zh->res, "segment", &zh->m_segment_indexing) ==
851 yaz_log(YLOG_DEBUG, "segment indexing set and is %d",
852 zh->m_segment_indexing);
857 void map_basenames_func(void *vp, const char *name, const char *value)
859 struct map_baseinfo *p = (struct map_baseinfo *) vp;
861 char fromdb[128], todb[8][128];
868 sscanf(value, "%127s %127s %127s %127s %127s %127s %127s %127s %127s",
869 fromdb, todb[0], todb[1], todb[2], todb[3], todb[4],
870 todb[5], todb[6], todb[7]);
874 for (i = 0; i<p->num_bases; i++)
875 if (p->basenames[i] && !STRCASECMP(p->basenames[i], fromdb))
878 for (i = 0; i < no; i++)
880 if (p->new_num_bases == p->new_num_max)
882 p->new_basenames[(p->new_num_bases)++] =
883 nmem_strdup(p->mem, todb[i]);
889 int zebra_select_default_database(ZebraHandle zh)
893 /* no database has been selected - so we select based on
894 resource setting (including group)
896 const char *group = res_get(zh->session_res, "group");
897 const char *v = res_get_prefix(zh->session_res,
898 "database", group, "Default");
899 return zebra_select_database(zh, v);
904 void map_basenames(ZebraHandle zh, ODR stream,
905 int *num_bases, char ***basenames)
907 struct map_baseinfo info;
908 struct map_baseinfo *p = &info;
911 yaz_log(log_level, "map_basenames ");
916 info.num_bases = *num_bases;
917 info.basenames = *basenames;
918 info.new_num_max = 128;
919 info.new_num_bases = 0;
920 info.new_basenames = (char **)
921 odr_malloc(stream, sizeof(*info.new_basenames) * info.new_num_max);
922 info.mem = stream->mem;
924 res_trav(zh->session_res, "mapdb", &info, map_basenames_func);
926 for (i = 0; i<p->num_bases; i++)
927 if (p->basenames[i] && p->new_num_bases < p->new_num_max)
929 p->new_basenames[(p->new_num_bases)++] =
930 nmem_strdup(p->mem, p->basenames[i]);
932 *num_bases = info.new_num_bases;
933 *basenames = info.new_basenames;
934 for (i = 0; i<*num_bases; i++)
935 yaz_log(YLOG_DEBUG, "base %s", (*basenames)[i]);
938 ZEBRA_RES zebra_select_database(ZebraHandle zh, const char *basename)
940 ZEBRA_CHECK_HANDLE(zh);
942 yaz_log(log_level, "zebra_select_database %s",basename);
944 return zebra_select_databases(zh, 1, &basename);
947 ZEBRA_RES zebra_select_databases(ZebraHandle zh, int num_bases,
948 const char **basenames)
955 ZEBRA_CHECK_HANDLE(zh);
958 yaz_log(log_level, "zebra_select_databases n=%d [0]=%s",
959 num_bases,basenames[0]);
964 zh->errCode = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
968 /* Check if the user has access to all databases (Seb) */
969 /* You could argue that this should happen later, after we have
970 * determined that the database(s) exist. */
971 if (zh->dbaccesslist) {
972 for (i = 0; i < num_bases; i++) {
973 const char *db = basenames[i];
975 for (p = zh->dbaccesslist; p && *p; p = pp) {
977 if ((pp = strchr(p, '+'))) {
983 if (len == strlen(db) && !strncmp(db, p, len))
987 zh->errCode = YAZ_BIB1_ACCESS_TO_SPECIFIED_DATABASE_DENIED;
993 for (i = 0; i < zh->num_basenames; i++)
994 xfree(zh->basenames[i]);
995 xfree(zh->basenames);
997 zh->num_basenames = num_bases;
998 zh->basenames = xmalloc(zh->num_basenames * sizeof(*zh->basenames));
999 for (i = 0; i < zh->num_basenames; i++)
1000 zh->basenames[i] = xstrdup(basenames[i]);
1002 cp = strrchr(basenames[0], '/');
1005 len = cp - basenames[0];
1006 new_reg = xmalloc(len + 1);
1007 memcpy(new_reg, basenames[0], len);
1008 new_reg[len] = '\0';
1011 new_reg = xstrdup("");
1012 for (i = 1; i<num_bases; i++)
1016 cp1 = strrchr(basenames[i], '/');
1021 zh->errCode = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
1024 if (len != cp1 - basenames[i] ||
1025 memcmp(basenames[i], new_reg, len))
1027 zh->errCode = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
1035 zh->errCode = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
1040 zebra_select_register(zh, new_reg);
1044 zh->errCode = YAZ_BIB1_DATABASE_UNAVAILABLE;
1047 if (!zh->lock_normal || !zh->lock_shadow)
1049 zh->errCode = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1055 ZEBRA_RES zebra_set_approx_limit(ZebraHandle zh, zint approx_limit)
1057 if (approx_limit == 0)
1058 approx_limit = DEFAULT_APPROX_LIMIT;
1059 zh->approx_limit = approx_limit;
1063 void zebra_set_partial_result(ZebraHandle zh)
1065 zh->partial_result = 1;
1069 ZEBRA_RES zebra_set_break_handler(ZebraHandle zh,
1070 int (*f)(void *client_data),
1073 zh->break_handler_func = f;
1074 zh->break_handler_data = client_data;
1078 ZEBRA_RES zebra_search_RPN_x(ZebraHandle zh, ODR o, Z_RPNQuery *query,
1079 const char *setname, zint *hits,
1080 int *estimated_hit_count,
1081 int *partial_resultset)
1085 ZEBRA_CHECK_HANDLE(zh);
1091 yaz_log(log_level, "zebra_search_rpn");
1093 zh->partial_result = 0;
1095 if (zebra_begin_read(zh) == ZEBRA_FAIL)
1098 r = resultSetAddRPN(zh, odr_extract_mem(o), query,
1099 zh->num_basenames, zh->basenames, setname,
1100 hits, estimated_hit_count);
1102 *partial_resultset = zh->partial_result;
1107 ZEBRA_RES zebra_search_RPN(ZebraHandle zh, ODR o, Z_RPNQuery *query,
1108 const char *setname, zint *hits)
1110 int estimated_hit_count;
1111 int partial_resultset;
1112 return zebra_search_RPN_x(zh, o, query, setname, hits,
1113 &estimated_hit_count,
1114 &partial_resultset);
1117 ZEBRA_RES zebra_records_retrieve(ZebraHandle zh, ODR stream,
1118 const char *setname,
1119 Z_RecordComposition *comp,
1120 const Odr_oid *input_format, int num_recs,
1121 ZebraRetrievalRecord *recs)
1123 ZebraMetaRecord *poset;
1125 ZEBRA_RES ret = ZEBRA_OK;
1128 ZEBRA_CHECK_HANDLE(zh);
1134 yaz_log(log_level, "zebra_records_retrieve n=%d", num_recs);
1138 zebra_setError(zh, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
1143 if (zebra_begin_read(zh) == ZEBRA_FAIL)
1146 pos_array = (zint *) xmalloc(num_recs * sizeof(*pos_array));
1147 for (i = 0; i<num_recs; i++)
1148 pos_array[i] = recs[i].position;
1149 poset = zebra_meta_records_create(zh, setname, num_recs, pos_array);
1152 yaz_log(YLOG_DEBUG, "zebraPosSetCreate error");
1153 zebra_setError(zh, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
1159 WRBUF addinfo_w = wrbuf_alloc();
1160 for (i = 0; i < num_recs; i++)
1162 recs[i].errCode = 0;
1163 recs[i].errString = 0;
1168 recs[i].sysno = poset[i].sysno;
1171 recs[i].format = yaz_oid_recsyn_sutrs;
1172 recs[i].len = strlen(poset[i].term);
1173 recs[i].buf = poset[i].term;
1174 recs[i].base = poset[i].db;
1176 else if (poset[i].sysno)
1180 zebra_snippets *hit_snippet = zebra_snippets_create();
1182 /* we disable hit snippets for now. It does not work well
1183 and it slows retrieval down a lot */
1185 zebra_snippets_hit_vector(zh, setname, poset[i].sysno,
1188 wrbuf_rewind(addinfo_w);
1190 zebra_record_fetch(zh, setname,
1191 poset[i].sysno, poset[i].score,
1192 stream, input_format, comp,
1193 &recs[i].format, &buf, &len,
1194 &recs[i].base, addinfo_w);
1196 if (wrbuf_len(addinfo_w))
1198 odr_strdup(stream, wrbuf_cstr(addinfo_w));
1202 recs[i].buf = (char*) odr_malloc(stream, len);
1203 memcpy(recs[i].buf, buf, len);
1207 recs[i].score = poset[i].score;
1208 zebra_snippets_destroy(hit_snippet);
1212 /* only need to set it once */
1213 if (pos_array[i] < zh->approx_limit && ret == ZEBRA_OK)
1215 zebra_setError_zint(zh,
1216 YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE,
1223 zebra_meta_records_destroy(zh, poset, num_recs);
1224 wrbuf_destroy(addinfo_w);
1231 ZEBRA_RES zebra_scan_PQF(ZebraHandle zh, ODR stream, const char *query,
1233 int *num_entries, ZebraScanEntry **entries,
1235 const char *setname)
1237 YAZ_PQF_Parser pqf_parser = yaz_pqf_create();
1238 Z_AttributesPlusTerm *zapt;
1239 Odr_oid *attributeSet;
1242 if (!(zapt = yaz_pqf_scan(pqf_parser, stream, &attributeSet, query)))
1245 zh->errCode = YAZ_BIB1_SCAN_MALFORMED_SCAN;
1249 res = zebra_scan(zh, stream, zapt, yaz_oid_attset_bib_1,
1250 position, num_entries, entries, is_partial,
1253 yaz_pqf_destroy(pqf_parser);
1257 ZEBRA_RES zebra_scan(ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
1258 const Odr_oid *attributeset,
1260 int *num_entries, ZebraScanEntry **entries,
1262 const char *setname)
1266 ZEBRA_CHECK_HANDLE(zh);
1271 assert(num_entries);
1274 yaz_log(log_level, "zebra_scan");
1276 if (zebra_begin_read(zh) == ZEBRA_FAIL)
1283 res = rpn_scan(zh, stream, zapt, attributeset,
1284 zh->num_basenames, zh->basenames, position,
1285 num_entries, entries, is_partial, setname);
1290 ZEBRA_RES zebra_sort(ZebraHandle zh, ODR stream,
1291 int num_input_setnames, const char **input_setnames,
1292 const char *output_setname,
1293 Z_SortKeySpecList *sort_sequence,
1297 ZEBRA_CHECK_HANDLE(zh);
1299 assert(num_input_setnames>0);
1300 assert(input_setnames);
1301 assert(sort_sequence);
1302 assert(sort_status);
1303 yaz_log(log_level, "zebra_sort");
1305 if (zebra_begin_read(zh) == ZEBRA_FAIL)
1307 res = resultSetSort(zh, stream->mem, num_input_setnames, input_setnames,
1308 output_setname, sort_sequence, sort_status);
1313 int zebra_deleteResultSet(ZebraHandle zh, int function,
1314 int num_setnames, char **setnames,
1319 yaz_log(log_level, "zebra_deleteResultSet n=%d", num_setnames);
1321 if (zebra_begin_read(zh))
1322 return Z_DeleteStatus_systemProblemAtTarget;
1325 case Z_DeleteResultSetRequest_list:
1326 assert(num_setnames>0);
1328 resultSetDestroy(zh, num_setnames, setnames, statuses);
1330 case Z_DeleteResultSetRequest_all:
1331 resultSetDestroy(zh, -1, 0, statuses);
1335 status = Z_DeleteStatus_success;
1336 for (i = 0; i<num_setnames; i++)
1337 if (statuses[i] == Z_DeleteStatus_resultSetDidNotExist)
1338 status = statuses[i];
1342 int zebra_errCode(ZebraHandle zh)
1346 yaz_log(log_level, "zebra_errCode: %d",zh->errCode);
1349 yaz_log(log_level, "zebra_errCode: o");
1353 const char *zebra_errString(ZebraHandle zh)
1357 e= diagbib1_str(zh->errCode);
1358 yaz_log(log_level, "zebra_errString: %s",e);
1362 char *zebra_errAdd(ZebraHandle zh)
1367 yaz_log(log_level, "zebra_errAdd: %s",a);
1371 ZEBRA_RES zebra_auth(ZebraHandle zh, const char *user, const char *pass)
1374 const char *astring;
1378 ZEBRA_CHECK_HANDLE(zh);
1382 sprintf(u, "perm.%.30s", user ? user : "anonymous");
1383 p = res_get(zs->global_res, u);
1384 xfree(zh->user_perm);
1385 zh->user_perm = xstrdup(p ? p : "r");
1387 /* Determine database access list */
1388 astring = res_get(zs->dbaccess, user ? user : "anonymous");
1390 zh->dbaccesslist = xstrdup(astring);
1392 zh->dbaccesslist = 0;
1394 /* users that don't require a password .. */
1395 if (zh->user_perm && strchr(zh->user_perm, 'a'))
1398 if (!zs->passwd_db || !passwd_db_auth(zs->passwd_db, user, pass))
1403 ZEBRA_RES zebra_admin_import_begin(ZebraHandle zh, const char *database,
1404 const char *record_type)
1406 yaz_log(log_level, "zebra_admin_import_begin db=%s rt=%s",
1407 database, record_type);
1408 if (zebra_select_database(zh, database) == ZEBRA_FAIL)
1410 return zebra_begin_trans(zh, 1);
1413 ZEBRA_RES zebra_admin_import_end(ZebraHandle zh)
1415 ZEBRA_CHECK_HANDLE(zh);
1416 yaz_log(log_level, "zebra_admin_import_end");
1417 return zebra_end_trans(zh);
1420 ZEBRA_RES zebra_admin_import_segment(ZebraHandle zh, Z_Segment *segment)
1422 ZEBRA_RES res = ZEBRA_OK;
1425 ZEBRA_CHECK_HANDLE(zh);
1426 yaz_log(log_level, "zebra_admin_import_segment");
1428 for (i = 0; i<segment->num_segmentRecords; i++)
1430 Z_NamePlusRecord *npr = segment->segmentRecords[i];
1432 if (npr->which == Z_NamePlusRecord_intermediateFragment)
1434 Z_FragmentSyntax *fragment = npr->u.intermediateFragment;
1435 if (fragment->which == Z_FragmentSyntax_notExternallyTagged)
1437 Odr_oct *oct = fragment->u.notExternallyTagged;
1440 if(zebra_update_record(
1443 0, /* record Type */
1447 (const char *) oct->buf, oct->len) == ZEBRA_FAIL)
1455 int delete_w_handle(const char *info, void *handle)
1457 ZebraHandle zh = (ZebraHandle) handle;
1460 if (*info == sizeof(pos))
1462 memcpy(&pos, info+1, sizeof(pos));
1463 isamb_unlink(zh->reg->isamb, pos);
1468 int delete_w_all_handle(const char *info, void *handle)
1470 ZebraHandle zh = (ZebraHandle) handle;
1473 if (*info == sizeof(pos))
1476 memcpy(&pos, info+1, sizeof(pos));
1477 pt = isamb_pp_open(zh->reg->isamb, pos, 2);
1482 while (isamb_pp_read(pt, &key))
1485 rec = rec_get(zh->reg->records, key.mem[0]);
1486 rec_del(zh->reg->records, &rec);
1491 return delete_w_handle(info, handle);
1494 static int delete_SU_handle(void *handle, int ord,
1495 const char *index_type, const char *string_index,
1496 zinfo_index_category_t cat)
1498 ZebraHandle zh = (ZebraHandle) handle;
1502 yaz_log(YLOG_LOG, "ord=%d index_type=%s index=%s cat=%d", ord,
1503 index_type, string_index, (int) cat);
1505 ord_len = key_SU_encode(ord, ord_buf);
1506 ord_buf[ord_len] = '\0';
1508 assert(zh->reg->isamb);
1509 assert(zh->reg->records);
1510 dict_delete_subtree(zh->reg->dict, ord_buf,
1512 !strcmp(string_index, "_ALLRECORDS") ?
1513 delete_w_all_handle : delete_w_handle);
1517 ZEBRA_RES zebra_drop_database(ZebraHandle zh, const char *db)
1519 ZEBRA_RES ret = ZEBRA_OK;
1521 yaz_log(log_level, "zebra_drop_database %s", db);
1522 ZEBRA_CHECK_HANDLE(zh);
1524 if (zebra_select_database(zh, db) == ZEBRA_FAIL)
1526 if (zebra_begin_trans(zh, 1) == ZEBRA_FAIL)
1531 if (zebraExplain_curDatabase(zh->reg->zei, db))
1533 zebra_setError(zh, YAZ_BIB1_DATABASE_DOES_NOT_EXIST, db);
1538 db_ord = zebraExplain_get_database_ord(zh->reg->zei);
1539 dict_delete_subtree_ord(zh->reg->matchDict, db_ord,
1540 0 /* handle */, 0 /* func */);
1541 zebraExplain_trav_ord(zh->reg->zei, zh, delete_SU_handle);
1542 zebraExplain_removeDatabase(zh->reg->zei, zh);
1543 zebra_remove_file_match(zh);
1548 yaz_log(YLOG_WARN, "drop database only supported for isam:b");
1549 zebra_setError(zh, YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED,
1550 "drop database only supported for isam:b");
1553 if (zebra_end_trans(zh) != ZEBRA_OK)
1555 yaz_log(YLOG_WARN, "zebra_end_trans failed");
1561 ZEBRA_RES zebra_create_database(ZebraHandle zh, const char *db)
1563 yaz_log(log_level, "zebra_create_database %s", db);
1564 ZEBRA_CHECK_HANDLE(zh);
1567 if (zebra_select_database(zh, db) == ZEBRA_FAIL)
1569 if (zebra_begin_trans(zh, 1))
1572 /* announce database */
1573 if (zebraExplain_newDatabase(zh->reg->zei, db, 0
1574 /* explainDatabase */))
1576 if (zebra_end_trans(zh) != ZEBRA_OK)
1578 yaz_log(YLOG_WARN, "zebra_end_trans failed");
1580 zebra_setError(zh, YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED, db);
1583 return zebra_end_trans(zh);
1586 int zebra_string_norm(ZebraHandle zh, const char *index_type,
1587 const char *input_str, int input_len,
1588 char *output_str, int output_len)
1591 zebra_map_t zm = zebra_map_get(zh->reg->zebra_maps, index_type);
1595 yaz_log(log_level, "zebra_string_norm ");
1597 if (!zh->reg->zebra_maps)
1599 wrbuf = zebra_replace(zm, "", input_str, input_len);
1602 if (wrbuf_len(wrbuf) >= output_len)
1604 if (wrbuf_len(wrbuf))
1605 memcpy(output_str, wrbuf_buf(wrbuf), wrbuf_len(wrbuf));
1606 output_str[wrbuf_len(wrbuf)] = '\0';
1607 return wrbuf_len(wrbuf);
1610 /** \brief set register state (state*.LCK)
1611 \param zh Zebra handle
1613 \param seqno sequence number
1616 d=writing to shadow(shadow enabled); writing to register (shadow disabled)
1618 c=commit (writing to register, reading from shadow, shadow mode only)
1620 static void zebra_set_state(ZebraHandle zh, int val, int seqno)
1622 char state_fname[256];
1627 yaz_log(log_level, "zebra_set_state v=%c seq=%d", val, seqno);
1629 sprintf(state_fname, "state.%s.LCK", zh->reg_name);
1630 fname = zebra_mk_fname(res_get(zh->res, "lockDir"), state_fname);
1631 f = fopen(fname, "w");
1634 yaz_log(YLOG_FATAL|YLOG_ERRNO, "open %s w", state_fname);
1637 yaz_log(YLOG_DEBUG, "zebra_set_state: %c %d %ld", val, seqno, p);
1638 fprintf(f, "%c %d %ld\n", val, seqno, p);
1643 static void zebra_get_state(ZebraHandle zh, char *val, int *seqno)
1645 char state_fname[256];
1650 yaz_log(log_level, "zebra_get_state ");
1652 sprintf(state_fname, "state.%s.LCK", zh->reg_name);
1653 fname = zebra_mk_fname(res_get(zh->res, "lockDir"), state_fname);
1654 f = fopen(fname, "r");
1660 if (fscanf(f, "%c %d", val, seqno) != 2)
1662 yaz_log(YLOG_ERRNO|YLOG_WARN, "fscan fail %s",
1670 ZEBRA_RES zebra_begin_read(ZebraHandle zh)
1672 return zebra_begin_trans(zh, 0);
1675 ZEBRA_RES zebra_end_read(ZebraHandle zh)
1677 return zebra_end_trans(zh);
1680 static void read_res_for_transaction(ZebraHandle zh)
1682 const char *group = res_get(zh->res, "group");
1684 /* FIXME - do we still use groups ?? */
1686 zh->m_group = group;
1687 v = res_get_prefix(zh->res, "followLinks", group, "1");
1688 zh->m_follow_links = atoi(v);
1690 zh->m_record_id = res_get_prefix(zh->res, "recordId", group, 0);
1691 zh->m_record_type = res_get_prefix(zh->res, "recordType", group, 0);
1693 v = res_get_prefix(zh->res, "storeKeys", group, "1");
1694 zh->m_store_keys = atoi(v);
1696 v = res_get_prefix(zh->res, "storeData", group, "1");
1697 zh->m_store_data = atoi(v);
1699 v = res_get_prefix(zh->res, "explainDatabase", group, "0");
1700 zh->m_explain_database = atoi(v);
1702 v = res_get_prefix(zh->res, "openRW", group, "1");
1703 zh->m_flag_rw = atoi(v);
1705 v = res_get_prefix(zh->res, "fileVerboseLimit", group, "1000");
1706 zh->m_file_verbose_limit = atoi(v);
1709 ZEBRA_RES zebra_begin_trans(ZebraHandle zh, int rw)
1711 ZEBRA_CHECK_HANDLE(zh);
1712 zebra_select_default_database(zh);
1715 zebra_setError(zh, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
1716 "zebra_begin_trans: no database selected");
1720 yaz_log(log_level, "zebra_begin_trans rw=%d",rw);
1724 if (rw && !strchr(zh->user_perm, 'w'))
1728 YAZ_BIB1_ES_PERMISSION_DENIED_ON_ES_CANNOT_MODIFY_OR_DELETE,
1739 const char *rval = 0;
1744 read_res_for_transaction(zh);
1747 if (zh->trans_no != 1)
1749 zebra_setError(zh, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
1750 "zebra_begin_trans: no write trans within read");
1755 resultSetInvalidate(zh);
1756 zebra_register_close(zh->service, zh->reg);
1758 zh->trans_w_no = zh->trans_no;
1760 zh->records_inserted = 0;
1761 zh->records_updated = 0;
1762 zh->records_deleted = 0;
1763 zh->records_processed = 0;
1764 zh->records_skipped = 0;
1766 #if HAVE_SYS_TIMES_H
1770 if (zh->shadow_enable)
1771 rval = res_get(zh->res, "shadow");
1775 zebra_lock_r(zh->lock_normal);
1776 zebra_lock_w(zh->lock_shadow);
1780 zebra_lock_w(zh->lock_normal);
1781 zebra_lock_w(zh->lock_shadow);
1783 zebra_get_state(zh, &val, &seqno);
1786 /* either we didn't finish commit or shadow is dirty */
1789 yaz_log(YLOG_WARN, "previous transaction did not finish "
1790 "(shadow disabled)");
1792 zebra_unlock(zh->lock_shadow);
1793 zebra_unlock(zh->lock_normal);
1794 if (zebra_commit(zh))
1802 zebra_lock_r(zh->lock_normal);
1803 zebra_lock_w(zh->lock_shadow);
1807 zebra_lock_w(zh->lock_normal);
1808 zebra_lock_w(zh->lock_shadow);
1812 zebra_set_state(zh, 'd', seqno);
1814 zh->reg = zebra_register_open(zh->service, zh->reg_name,
1815 1, rval ? 1 : 0, zh->res,
1819 zebra_unlock(zh->lock_shadow);
1820 zebra_unlock(zh->lock_normal);
1825 zebra_setError(zh, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
1826 "zebra_begin_trans: cannot open register");
1827 yaz_log(YLOG_FATAL, "%s", zh->errString);
1830 zh->reg->seqno = seqno;
1831 zebraExplain_curDatabase(zh->reg->zei, zh->basenames[0]);
1841 if (zh->trans_no != 1)
1843 return zebra_flush_reg(zh);
1845 #if HAVE_SYS_TIMES_H
1851 zh->errCode = YAZ_BIB1_DATABASE_UNAVAILABLE;
1854 if (!zh->lock_normal || !zh->lock_shadow)
1857 zh->errCode = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1860 zebra_get_state(zh, &val, &seqno);
1866 else if (seqno != zh->reg->seqno)
1868 yaz_log(YLOG_DEBUG, "reopen seqno cur/old %d/%d",
1869 seqno, zh->reg->seqno);
1872 else if (zh->reg->last_val != val)
1874 yaz_log(YLOG_DEBUG, "reopen last cur/old %d/%d",
1875 val, zh->reg->last_val);
1882 zebra_lock_r(zh->lock_shadow);
1884 zebra_lock_r(zh->lock_normal);
1888 resultSetInvalidate(zh);
1889 zebra_register_close(zh->service, zh->reg);
1891 zh->reg = zebra_register_open(zh->service, zh->reg_name,
1892 0, val == 'c' ? 1 : 0,
1893 zh->res, zh->path_reg);
1896 zebra_unlock(zh->lock_normal);
1897 zebra_unlock(zh->lock_shadow);
1899 zh->errCode = YAZ_BIB1_DATABASE_UNAVAILABLE;
1902 zh->reg->last_val = val;
1903 zh->reg->seqno = seqno;
1905 read_res_for_transaction(zh);
1909 ZEBRA_RES zebra_end_trans(ZebraHandle zh)
1911 ZebraTransactionStatus dummy;
1913 yaz_log(log_level, "zebra_end_trans");
1914 ZEBRA_CHECK_HANDLE(zh);
1915 return zebra_end_transaction(zh, &dummy);
1918 ZEBRA_RES zebra_end_transaction(ZebraHandle zh, ZebraTransactionStatus *status)
1924 ZEBRA_CHECK_HANDLE(zh);
1927 yaz_log(log_level, "zebra_end_transaction");
1929 status->processed = 0;
1930 status->inserted = 0;
1931 status->updated = 0;
1932 status->deleted = 0;
1936 if (!zh->res || !zh->reg)
1938 zebra_setError(zh, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
1939 "zebra_end_trans: no open transaction");
1942 if (zh->trans_no != zh->trans_w_no)
1945 if (zh->trans_no != 0)
1948 /* release read lock */
1950 zebra_unlock(zh->lock_normal);
1951 zebra_unlock(zh->lock_shadow);
1954 { /* release write lock */
1958 yaz_log(YLOG_DEBUG, "zebra_end_trans");
1959 rval = res_get(zh->res, "shadow");
1961 zebraExplain_runNumberIncrement(zh->reg->zei, 1);
1963 zebra_flush_reg(zh);
1965 resultSetInvalidate(zh);
1967 zebra_register_close(zh->service, zh->reg);
1970 yaz_log(YLOG_LOG, "Records: "ZINT_FORMAT" i/u/d "
1971 ZINT_FORMAT"/"ZINT_FORMAT"/"ZINT_FORMAT,
1972 zh->records_processed, zh->records_inserted,
1973 zh->records_updated, zh->records_deleted);
1975 status->processed = zh->records_processed;
1976 status->inserted = zh->records_inserted;
1977 status->updated = zh->records_updated;
1978 status->deleted = zh->records_deleted;
1980 zebra_get_state(zh, &val, &seqno);
1983 BFiles bfs = bfs_create(rval, zh->path_reg);
1984 bf_commitClean(bfs, rval);
1989 zebra_set_state(zh, 'o', seqno);
1990 zebra_unlock(zh->lock_shadow);
1991 zebra_unlock(zh->lock_normal);
1994 #if HAVE_SYS_TIMES_H
1996 yaz_log(log_level, "user/system: %ld/%ld",
1997 (long) (zh->tms2.tms_utime - zh->tms1.tms_utime),
1998 (long) (zh->tms2.tms_stime - zh->tms1.tms_stime));
2000 status->utime = (long) (zh->tms2.tms_utime - zh->tms1.tms_utime);
2001 status->stime = (long) (zh->tms2.tms_stime - zh->tms1.tms_stime);
2006 ZEBRA_RES zebra_repository_update(ZebraHandle zh, const char *path)
2008 return zebra_repository_index(zh, path, action_update);
2011 ZEBRA_RES zebra_repository_delete(ZebraHandle zh, const char *path)
2013 return zebra_repository_index(zh, path, action_delete);
2016 ZEBRA_RES zebra_repository_index(ZebraHandle zh, const char *path,
2017 enum zebra_recctrl_action_t action)
2022 if (action == action_update)
2023 yaz_log(log_level, "updating %s", path);
2024 else if (action == action_delete)
2025 yaz_log(log_level, "deleting %s", path);
2026 else if (action == action_a_delete)
2027 yaz_log(log_level, "attempt deleting %s", path);
2029 yaz_log(log_level, "update action=%d", (int) action);
2031 if (zh->m_record_id && !strcmp(zh->m_record_id, "file"))
2032 return zebra_update_file_match(zh, path);
2034 return zebra_update_from_path(zh, path, action);
2037 ZEBRA_RES zebra_repository_show(ZebraHandle zh, const char *path)
2041 yaz_log(log_level, "zebra_repository_show");
2042 repositoryShow(zh, path);
2046 static ZEBRA_RES zebra_commit_ex(ZebraHandle zh, int clean_only)
2052 ZEBRA_RES res = ZEBRA_OK;
2056 yaz_log(log_level, "zebra_commit_ex clean_only=%d", clean_only);
2057 zebra_select_default_database(zh);
2060 zh->errCode = YAZ_BIB1_DATABASE_UNAVAILABLE;
2063 rval = res_get(zh->res, "shadow");
2066 yaz_log(YLOG_WARN, "Cannot perform commit - No shadow area defined");
2070 zebra_lock_w(zh->lock_normal);
2071 zebra_lock_r(zh->lock_shadow);
2073 bfs = bfs_create(res_get(zh->res, "register"), zh->path_reg);
2076 zebra_unlock(zh->lock_shadow);
2077 zebra_unlock(zh->lock_normal);
2080 zebra_get_state(zh, &val, &seqno);
2084 /* shadow area is dirty and so we must throw it away */
2085 yaz_log(YLOG_WARN, "previous transaction didn't reach commit");
2088 else if (val == 'c')
2090 /* commit has started. We can not remove it anymore */
2095 bf_cache(bfs, rval);
2096 if (bf_commitExists(bfs))
2099 zebra_set_state(zh, 'd', seqno);
2102 zebra_set_state(zh, 'c', seqno);
2104 yaz_log(log_level, "commit start");
2105 if (bf_commitExec(bfs))
2108 if (res == ZEBRA_OK)
2111 zebra_set_state(zh, 'o', seqno);
2113 zebra_unlock(zh->lock_shadow);
2114 zebra_unlock(zh->lock_normal);
2116 zebra_lock_w(zh->lock_shadow);
2117 bf_commitClean(bfs, rval);
2118 zebra_unlock(zh->lock_shadow);
2122 zebra_unlock(zh->lock_shadow);
2123 zebra_unlock(zh->lock_normal);
2124 yaz_log(YLOG_WARN, "zebra_commit: failed");
2129 zebra_unlock(zh->lock_shadow);
2130 zebra_unlock(zh->lock_normal);
2131 yaz_log(log_level, "nothing to commit");
2138 ZEBRA_RES zebra_clean(ZebraHandle zh)
2140 yaz_log(log_level, "zebra_clean");
2141 ZEBRA_CHECK_HANDLE(zh);
2142 return zebra_commit_ex(zh, 1);
2145 ZEBRA_RES zebra_commit(ZebraHandle zh)
2147 yaz_log(log_level, "zebra_commit");
2148 ZEBRA_CHECK_HANDLE(zh);
2149 return zebra_commit_ex(zh, 0);
2153 ZEBRA_RES zebra_init(ZebraHandle zh)
2158 yaz_log(log_level, "zebra_init");
2160 ZEBRA_CHECK_HANDLE(zh);
2162 zebra_select_default_database(zh);
2165 zebra_setError(zh, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
2166 "cannot select default database");
2169 rval = res_get(zh->res, "shadow");
2171 bfs = bfs_create(res_get(zh->res, "register"), zh->path_reg);
2174 zebra_setError(zh, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, "bfs_create");
2178 bf_cache(bfs, rval);
2182 zebra_set_state(zh, 'o', 0);
2186 ZEBRA_RES zebra_compact(ZebraHandle zh)
2190 yaz_log(log_level, "zebra_compact");
2191 ZEBRA_CHECK_HANDLE(zh);
2194 zh->errCode = YAZ_BIB1_DATABASE_UNAVAILABLE;
2197 bfs = bfs_create(res_get(zh->res, "register"), zh->path_reg);
2203 #define ZEBRA_CHECK_DICT 1
2204 #define ZEBRA_CHECK_ISAM 2
2206 static ZEBRA_RES zebra_record_check(ZebraHandle zh, Record rec,
2207 zint *no_keys, int message_limit,
2209 zint *no_long_dict_entries,
2210 zint *no_failed_dict_lookups,
2211 zint *no_invalid_keys,
2212 zint *no_invalid_dict_infos,
2213 zint *no_invalid_isam_entries)
2215 ZEBRA_RES res = ZEBRA_OK;
2216 zebra_rec_keys_t keys = zebra_rec_keys_open();
2217 zebra_rec_keys_set_buf(keys, rec->info[recInfo_delKeys],
2218 rec->size[recInfo_delKeys], 0);
2221 if (!zebra_rec_keys_rewind(keys))
2229 struct it_key key_in;
2230 NMEM nmem = nmem_create();
2232 while (zebra_rec_keys_read(keys, &str, &slen, &key_in))
2235 int ord = CAST_ZINT_TO_INT(key_in.mem[0]);
2236 char ord_buf[IT_MAX_WORD+20];
2237 int ord_len = key_SU_encode(ord, ord_buf);
2242 if (key_in.len < 2 || key_in.len > IT_KEY_LEVEL_MAX)
2245 (*no_invalid_keys)++;
2246 if (*no_invalid_keys <= message_limit)
2249 yaz_log(YLOG_WARN, "Record " ZINT_FORMAT
2250 ": unexpected key length %d",
2251 rec->sysno, key_in.len);
2254 if (ord_len + slen >= sizeof(ord_buf)-1)
2257 (*no_long_dict_entries)++;
2258 if (*no_long_dict_entries <= message_limit)
2261 /* so bad it can not fit into our ord_buf */
2262 yaz_log(YLOG_WARN, "Record " ZINT_FORMAT
2263 ": long dictionary entry %d + %d",
2264 rec->sysno, ord_len, (int) slen);
2268 memcpy(ord_buf + ord_len, str, slen);
2269 ord_buf[ord_len + slen] = '\0';
2270 if (slen > IT_MAX_WORD || ord_len > 4)
2273 (*no_long_dict_entries)++;
2274 if (*no_long_dict_entries <= message_limit)
2277 yaz_log(YLOG_WARN, "Record " ZINT_FORMAT
2278 ": long dictionary entry %d + %d",
2279 rec->sysno, (int) ord_len, (int) slen);
2282 if ((flags & ZEBRA_CHECK_DICT) == 0)
2284 info = dict_lookup(zh->reg->dict, ord_buf);
2288 (*no_failed_dict_lookups)++;
2289 if (*no_failed_dict_lookups <= message_limit)
2292 yaz_log(YLOG_WARN, "Record " ZINT_FORMAT
2293 ": term do not exist in dictionary", rec->sysno);
2296 else if (flags & ZEBRA_CHECK_ISAM)
2300 if (*info != sizeof(pos))
2303 (*no_invalid_dict_infos)++;
2304 if (*no_invalid_dict_infos <= message_limit)
2307 yaz_log(YLOG_WARN, "Record " ZINT_FORMAT
2308 ": long dictionary entry %d + %d",
2309 rec->sysno, (int) ord_len, (int) slen);
2315 memcpy(&pos, info+1, sizeof(pos));
2318 ISAMB_PP ispt = isamb_pp_open(zh->reg->isamb, pos,
2323 (*no_invalid_isam_entries)++;
2324 if (*no_invalid_isam_entries <= message_limit)
2327 yaz_log(YLOG_WARN, "Record " ZINT_FORMAT
2328 ": isamb_pp_open entry " ZINT_FORMAT
2333 else if (zh->m_staticrank)
2335 isamb_pp_close(ispt);
2339 struct it_key until_key;
2340 struct it_key isam_key;
2344 until_key.len = key_in.len - 1;
2345 for (i = 0; i < until_key.len; i++)
2346 until_key.mem[i] = key_in.mem[i+1];
2348 if (until_key.mem[0] == 0)
2349 until_key.mem[0] = rec->sysno;
2350 r = isamb_pp_forward(ispt, &isam_key, &until_key);
2354 (*no_invalid_isam_entries)++;
2355 if (*no_invalid_isam_entries <= message_limit)
2358 yaz_log(YLOG_WARN, "Record " ZINT_FORMAT
2359 ": isamb_pp_forward " ZINT_FORMAT
2360 " returned no entry",
2366 int cmp = key_compare(&until_key, &isam_key);
2370 (*no_invalid_isam_entries)++;
2371 if (*no_invalid_isam_entries
2375 yaz_log(YLOG_WARN, "Record "
2377 ": isamb_pp_forward "
2379 " returned different entry",
2382 key_logdump_txt(YLOG_LOG,
2386 key_logdump_txt(YLOG_LOG,
2393 isamb_pp_close(ispt);
2401 zebra_it_key_str_dump(zh, &key_in, str,
2402 slen, nmem, YLOG_LOG);
2408 zebra_rec_keys_close(keys);
2412 ZEBRA_RES zebra_register_check(ZebraHandle zh, const char *spec)
2414 ZEBRA_RES res = ZEBRA_FAIL;
2417 if (!spec || *spec == '\0'
2418 || !strcmp(spec, "dict") || !strcmp(spec, "default"))
2419 flags = ZEBRA_CHECK_DICT;
2420 else if (!strcmp(spec, "isam") || !strcmp(spec, "full"))
2421 flags = ZEBRA_CHECK_DICT|ZEBRA_CHECK_ISAM;
2422 else if (!strcmp(spec, "quick"))
2426 yaz_log(YLOG_WARN, "Unknown check spec: %s", spec);
2430 yaz_log(YLOG_LOG, "zebra_register_check begin flags=%u", flags);
2431 if (zebra_begin_read(zh) == ZEBRA_OK)
2433 zint no_records_total = 0;
2434 zint no_records_fail = 0;
2435 zint total_keys = 0;
2436 int message_limit = zh->m_file_verbose_limit;
2440 Record rec = rec_get_root(zh->reg->records);
2442 zint no_long_dict_entries = 0;
2443 zint no_failed_dict_lookups = 0;
2444 zint no_invalid_keys = 0;
2445 zint no_invalid_dict_infos = 0;
2446 zint no_invalid_isam_entries = 0;
2454 if (zebra_record_check(zh, rec, &no_keys, message_limit,
2456 &no_long_dict_entries,
2457 &no_failed_dict_lookups,
2459 &no_invalid_dict_infos,
2460 &no_invalid_isam_entries
2468 r1 = rec_get_next(zh->reg->records, rec);
2472 total_keys += no_keys;
2474 yaz_log(YLOG_LOG, "records total: " ZINT_FORMAT,
2476 yaz_log(YLOG_LOG, "records fail: " ZINT_FORMAT,
2478 yaz_log(YLOG_LOG, "total keys: " ZINT_FORMAT,
2480 yaz_log(YLOG_LOG, "long dict entries: " ZINT_FORMAT,
2481 no_long_dict_entries);
2482 if (flags & ZEBRA_CHECK_DICT)
2484 yaz_log(YLOG_LOG, "failed dict lookups: " ZINT_FORMAT,
2485 no_failed_dict_lookups);
2486 yaz_log(YLOG_LOG, "invalid dict infos: " ZINT_FORMAT,
2487 no_invalid_dict_infos);
2489 if (flags & ZEBRA_CHECK_ISAM)
2490 yaz_log(YLOG_LOG, "invalid isam entries: " ZINT_FORMAT,
2491 no_invalid_isam_entries);
2495 yaz_log(YLOG_LOG, "zebra_register_check end ret=%d", res);
2499 void zebra_result(ZebraHandle zh, int *code, char **addinfo)
2501 yaz_log(log_level, "zebra_result");
2504 *code = zh->errCode;
2505 *addinfo = zh->errString;
2509 *code = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
2510 *addinfo ="ZebraHandle is NULL";
2514 void zebra_shadow_enable(ZebraHandle zh, int value)
2517 yaz_log(log_level, "zebra_shadow_enable");
2518 zh->shadow_enable = value;
2521 ZEBRA_RES zebra_octet_term_encoding(ZebraHandle zh, const char *encoding)
2523 yaz_log(log_level, "zebra_octet_term_encoding %s", encoding);
2524 ZEBRA_CHECK_HANDLE(zh);
2527 if (zh->iconv_to_utf8 != 0)
2528 yaz_iconv_close(zh->iconv_to_utf8);
2529 if (zh->iconv_from_utf8 != 0)
2530 yaz_iconv_close(zh->iconv_from_utf8);
2533 yaz_iconv_open("UTF-8", encoding);
2534 if (zh->iconv_to_utf8 == 0)
2535 yaz_log(YLOG_WARN, "iconv: %s to UTF-8 unsupported", encoding);
2536 zh->iconv_from_utf8 =
2537 yaz_iconv_open(encoding, "UTF-8");
2538 if (zh->iconv_to_utf8 == 0)
2539 yaz_log(YLOG_WARN, "iconv: UTF-8 to %s unsupported", encoding);
2544 ZEBRA_RES zebra_record_encoding(ZebraHandle zh, const char *encoding)
2546 yaz_log(log_level, "zebra_record_encoding");
2547 ZEBRA_CHECK_HANDLE(zh);
2548 xfree(zh->record_encoding);
2549 zh->record_encoding = 0;
2551 zh->record_encoding = xstrdup(encoding);
2555 void zebra_set_resource(ZebraHandle zh, const char *name, const char *value)
2559 yaz_log(log_level, "zebra_set_resource %s:%s", name, value);
2561 res_set(zh->res, name, value);
2564 const char *zebra_get_resource(ZebraHandle zh,
2565 const char *name, const char *defaultvalue)
2570 v = res_get_def(zh->res, name,(char *)defaultvalue);
2571 yaz_log(log_level, "zebra_get_resource %s:%s", name, v);
2575 /* moved from zebra_api_ext.c by pop */
2576 /* FIXME: Should this really be public??? -Heikki */
2578 int zebra_trans_no(ZebraHandle zh)
2580 yaz_log(log_level, "zebra_trans_no");
2582 return zh->trans_no;
2585 int zebra_get_shadow_enable(ZebraHandle zh)
2587 yaz_log(log_level, "zebra_get_shadow_enable");
2589 return zh->shadow_enable;
2592 void zebra_set_shadow_enable(ZebraHandle zh, int value)
2594 yaz_log(log_level, "zebra_set_shadow_enable %d",value);
2596 zh->shadow_enable = value;
2599 ZEBRA_RES zebra_add_record(ZebraHandle zh,
2600 const char *buf, int buf_size)
2602 return zebra_update_record(zh, action_update,
2603 0 /* record type */,
2610 ZEBRA_RES zebra_update_record(ZebraHandle zh,
2611 enum zebra_recctrl_action_t action,
2612 const char *recordType,
2613 zint *sysno, const char *match,
2615 const char *buf, int buf_size)
2619 ZEBRA_CHECK_HANDLE(zh);
2623 yaz_log(log_level, "zebra_update_record");
2625 yaz_log(log_level, " sysno=" ZINT_FORMAT, *sysno);
2628 buf_size = strlen(buf);
2630 if (zebra_begin_trans(zh, 1) == ZEBRA_FAIL)
2632 res = zebra_buffer_extract_record(zh, buf, buf_size,
2638 if (zebra_end_trans(zh) != ZEBRA_OK)
2640 yaz_log(YLOG_WARN, "zebra_end_trans failed");
2646 /* ---------------------------------------------------------------------------
2650 ZEBRA_RES zebra_search_PQF(ZebraHandle zh, const char *pqf_query,
2651 const char *setname, zint *hits)
2654 ZEBRA_RES res = ZEBRA_OK;
2659 ZEBRA_CHECK_HANDLE(zh);
2661 odr = odr_createmem(ODR_ENCODE);
2666 yaz_log(log_level, "zebra_search_PQF s=%s q=%s", setname, pqf_query);
2668 query = p_query_rpn(odr, pqf_query);
2672 yaz_log(YLOG_WARN, "bad query %s\n", pqf_query);
2673 zh->errCode = YAZ_BIB1_MALFORMED_QUERY;
2677 res = zebra_search_RPN(zh, odr, query, setname, &lhits);
2681 yaz_log(log_level, "Hits: " ZINT_FORMAT, lhits);
2689 /* ---------------------------------------------------------------------------
2690 Sort - a simplified interface, with optional read locks.
2692 int zebra_sort_by_specstr(ZebraHandle zh, ODR stream,
2693 const char *sort_spec,
2694 const char *output_setname,
2695 const char **input_setnames)
2697 int num_input_setnames = 0;
2698 int sort_status = 0;
2699 Z_SortKeySpecList *sort_sequence;
2701 ZEBRA_CHECK_HANDLE(zh);
2704 assert(output_setname);
2705 assert(input_setnames);
2706 sort_sequence = yaz_sort_spec(stream, sort_spec);
2707 yaz_log(log_level, "sort (FIXME) ");
2710 yaz_log(YLOG_WARN, "invalid sort specs '%s'", sort_spec);
2711 zh->errCode = YAZ_BIB1_CANNOT_SORT_ACCORDING_TO_SEQUENCE;
2715 /* we can do this, since the perl typemap code for char** will
2716 put a NULL at the end of list */
2717 while (input_setnames[num_input_setnames]) num_input_setnames++;
2719 if (zebra_begin_read(zh))
2722 resultSetSort(zh, stream->mem, num_input_setnames, input_setnames,
2723 output_setname, sort_sequence, &sort_status);
2729 /* ---------------------------------------------------------------------------
2730 Get BFS for Zebra system (to make alternative storage methods)
2732 struct BFiles_struct *zebra_get_bfs(ZebraHandle zh)
2735 return zh->reg->bfs;
2740 /* ---------------------------------------------------------------------------
2741 Set limit for search/scan
2743 ZEBRA_RES zebra_set_limit(ZebraHandle zh, int complement_flag, zint *ids)
2745 ZEBRA_CHECK_HANDLE(zh);
2746 zebra_limit_destroy(zh->m_limit);
2747 zh->m_limit = zebra_limit_create(complement_flag, ids);
2752 Set Error code + addinfo
2754 void zebra_setError(ZebraHandle zh, int code, const char *addinfo)
2759 nmem_reset(zh->nmem_error);
2760 zh->errString = addinfo ? nmem_strdup(zh->nmem_error, addinfo) : 0;
2763 void zebra_setError_zint(ZebraHandle zh, int code, zint i)
2766 sprintf(vstr, ZINT_FORMAT, i);
2769 nmem_reset(zh->nmem_error);
2770 zh->errString = nmem_strdup(zh->nmem_error, vstr);
2773 void zebra_lock_prefix(Res res, char *path)
2775 const char *lock_dir = res_get_def(res, "lockDir", "");
2777 strcpy(path, lock_dir);
2778 if (*path && path[strlen(path)-1] != '/')
2785 * c-file-style: "Stroustrup"
2786 * indent-tabs-mode: nil
2788 * vim: shiftwidth=4 tabstop=8 expandtab