1 /* $Id: zebraapi.c,v 1.222 2006-06-13 12:02:12 adam Exp $
2 Copyright (C) 1995-2006
5 This file is part of the Zebra server.
7 Zebra is free software; you can redistribute it and/or modify it under
8 the terms of the GNU General Public License as published by the Free
9 Software Foundation; either version 2, or (at your option) any later
12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
17 You should have received a copy of the GNU General Public License
18 along with Zebra; see the file LICENSE.zebra. If not, write to the
19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
35 #include <yaz/diagbib1.h>
36 #include <yaz/pquery.h>
37 #include <yaz/sortspec.h>
42 #include <idzebra/api.h>
44 #define DEFAULT_APPROX_LIMIT 2000000000
46 /* simple asserts to validate the most essential input args */
47 #define ASSERTZH assert(zh && zh->service)
48 #define ASSERTZHRES assert(zh && zh->service && zh->res)
49 #define ASSERTZS assert(zs)
51 static int log_level = 0;
52 static int log_level_initialized = 0;
54 static void zebra_open_res(ZebraHandle zh);
55 static void zebra_close_res(ZebraHandle zh);
57 static ZEBRA_RES zebra_check_handle(ZebraHandle zh)
64 #define ZEBRA_CHECK_HANDLE(zh) if (zebra_check_handle(zh) != ZEBRA_OK) return ZEBRA_FAIL
66 static void zebra_chdir (ZebraService zs)
70 yaz_log(log_level, "zebra_chdir");
71 dir = res_get (zs->global_res, "chdir");
74 yaz_log (YLOG_DEBUG, "chdir %s", dir);
82 static ZEBRA_RES zebra_flush_reg (ZebraHandle zh)
84 ZEBRA_CHECK_HANDLE(zh);
85 yaz_log(log_level, "zebra_flush_reg");
86 zebraExplain_flush (zh->reg->zei, zh);
88 extract_flushWriteKeys (zh, 1 /* final */);
89 zebra_index_merge (zh );
93 static struct zebra_register *zebra_register_open(ZebraService zs,
95 int rw, int useshadow,
97 const char *reg_path);
98 static void zebra_register_close(ZebraService zs, struct zebra_register *reg);
100 ZebraHandle zebra_open(ZebraService zs, Res res)
103 const char *default_encoding;
104 if (!log_level_initialized)
106 log_level = yaz_log_module_level("zebraapi");
107 log_level_initialized = 1;
110 yaz_log(log_level, "zebra_open");
115 zh = (ZebraHandle) xmalloc(sizeof(*zh));
116 yaz_log (YLOG_DEBUG, "zebra_open zs=%p returns %p", zs, zh);
119 zh->reg = 0; /* no register attached yet */
125 zh->session_res = res_open(zs->global_res, res);
127 zh->dbaccesslist = 0;
129 zh->reg_name = xstrdup ("");
131 zh->num_basenames = 0;
134 zh->approx_limit = DEFAULT_APPROX_LIMIT;
141 zh->shadow_enable = 1;
142 zh->m_staticrank = 0;
144 default_encoding = res_get_def(zh->session_res, "encoding", "ISO-8859-1");
147 yaz_iconv_open ("UTF-8", default_encoding);
148 if (zh->iconv_to_utf8 == 0)
149 yaz_log (YLOG_WARN, "iconv: %s to UTF-8 unsupported",
151 zh->iconv_from_utf8 =
152 yaz_iconv_open (default_encoding, "UTF-8");
153 if (zh->iconv_to_utf8 == 0)
154 yaz_log (YLOG_WARN, "iconv: UTF-8 to %s unsupported",
157 zh->record_encoding = 0;
159 zebra_mutex_cond_lock (&zs->session_lock);
161 zh->next = zs->sessions;
164 zebra_mutex_cond_unlock (&zs->session_lock);
166 zh->store_data_buf = 0;
168 zh->m_limit = zebra_limit_create(1, 0);
170 zh->nmem_error = nmem_create();
175 ZebraService zebra_start (const char *configName)
177 return zebra_start_res(configName, 0, 0);
180 ZebraService zebra_start_res (const char *configName, Res def_res, Res over_res)
184 if (!log_level_initialized)
186 log_level = yaz_log_module_level("zebraapi");
187 log_level_initialized = 1;
190 yaz_log(YLOG_LOG, "zebra_start %s %s", ZEBRAVER,
191 configName ? configName : "");
193 if ((res = res_open(def_res, over_res)))
195 const char *passwd_plain = 0;
196 const char *passwd_encrypt = 0;
197 const char *dbaccess = 0;
202 ZEBRA_RES ret = res_read_file(res, configName);
209 zh = xmalloc(sizeof(*zh));
210 zh->global_res = res;
215 zebra_mutex_cond_init (&zh->session_lock);
216 passwd_plain = res_get (zh->global_res, "passwd");
217 passwd_encrypt = res_get (zh->global_res, "passwd.c");
218 dbaccess = res_get (zh->global_res, "dbaccess");
220 if (!passwd_plain && !passwd_encrypt)
221 zh->passwd_db = NULL;
224 zh->passwd_db = passwd_db_open();
226 yaz_log (YLOG_WARN|YLOG_ERRNO, "passwd_db_open failed");
230 passwd_db_file_plain(zh->passwd_db, passwd_plain);
232 passwd_db_file_crypt(zh->passwd_db, passwd_encrypt);
239 zh->dbaccess = res_open(NULL, NULL);
240 if (res_read_file(zh->dbaccess, dbaccess) != ZEBRA_OK) {
241 yaz_log(YLOG_FATAL, "Failed to read %s", dbaccess);
246 zh->path_root = res_get (zh->global_res, "root");
247 zh->nmem = nmem_create();
248 zh->record_classes = recTypeClass_create (zh->global_res, zh->nmem);
252 const char *module_path = res_get(res, "modulePath");
254 recTypeClass_load_modules(&zh->record_classes, zh->nmem,
262 void zebra_filter_info(ZebraService zs, void *cd,
263 void (*cb)(void *cd, const char *name))
267 recTypeClass_info(zs->record_classes, cd, cb);
270 void zebra_pidfname(ZebraService zs, char *path)
273 zebra_lock_prefix (zs->global_res, path);
274 strcat(path, "zebrasrv.pid");
277 Dict dict_open_res (BFiles bfs, const char *name, int cache, int rw,
278 int compact_flag, Res res)
280 int page_size = 4096;
281 char resource_str[200];
282 sprintf (resource_str, "dict.%.100s.pagesize", name);
286 if (res_get_int(res, resource_str, &page_size) == ZEBRA_OK)
287 yaz_log(YLOG_LOG, "Using custom dictionary page size %d for %s",
289 return dict_open(bfs, name, cache, rw, compact_flag, page_size);
293 struct zebra_register *zebra_register_open(ZebraService zs, const char *name,
294 int rw, int useshadow, Res res,
295 const char *reg_path)
297 struct zebra_register *reg;
298 int record_compression = REC_COMPRESS_NONE;
299 const char *recordCompression = 0;
300 const char *profilePath;
302 ZEBRA_RES ret = ZEBRA_OK;
306 reg = xmalloc(sizeof(*reg));
309 reg->name = xstrdup (name);
316 yaz_log (YLOG_DEBUG, "zebra_register_open rw=%d useshadow=%d p=%p n=%s rp=%s",
317 rw, useshadow, reg, name, reg_path ? reg_path : "(none)");
319 reg->dh = data1_create();
326 reg->bfs = bfs_create (res_get (res, "register"), reg_path);
329 data1_destroy(reg->dh);
336 if (bf_cache (reg->bfs, res_get (res, "shadow")) == ZEBRA_FAIL)
338 bfs_destroy(reg->bfs);
339 data1_destroy(reg->dh);
346 getcwd(cwd, sizeof(cwd)-1);
347 profilePath = res_get_def(res, "profilePath", DEFAULT_PROFILE_PATH);
348 yaz_log(YLOG_DEBUG, "profilePath=%s cwd=%s", profilePath, cwd);
350 data1_set_tabpath (reg->dh, profilePath);
351 data1_set_tabroot (reg->dh, reg_path);
352 reg->recTypes = recTypes_init (zs->record_classes, reg->dh);
355 zebra_maps_open(res, reg_path, profilePath);
356 if (!reg->zebra_maps)
358 recTypes_destroy(reg->recTypes);
359 bfs_destroy(reg->bfs);
360 data1_destroy(reg->dh);
365 reg->rank_classes = NULL;
369 reg->keys = zebra_rec_keys_open();
371 reg->sortKeys = zebra_rec_keys_open();
381 reg->key_file_no = 0;
384 /* installing rank classes */
385 zebraRankInstall (reg, rank_1_class);
386 zebraRankInstall (reg, rank_similarity_class);
387 zebraRankInstall (reg, rank_static_class);
389 recordCompression = res_get_def (res, "recordCompression", "none");
390 if (!strcmp (recordCompression, "none"))
391 record_compression = REC_COMPRESS_NONE;
392 if (!strcmp (recordCompression, "bzip2"))
393 record_compression = REC_COMPRESS_BZIP2;
397 const char *index_fname = res_get_def(res, "index", "default.idx");
398 if (index_fname && *index_fname)
400 if (zebra_maps_read_file(reg->zebra_maps, index_fname) != ZEBRA_OK)
405 if (!(reg->records = rec_open (reg->bfs, rw, record_compression)))
407 yaz_log (YLOG_WARN, "rec_open failed");
412 reg->matchDict = dict_open_res (reg->bfs, GMATCH_DICT, 20, 1, 0, res);
414 if (!(reg->dict = dict_open_res (reg->bfs, FNAME_DICT, 40, rw, 0, res)))
416 yaz_log (YLOG_WARN, "dict_open failed");
419 if (!(reg->sortIdx = sortIdx_open (reg->bfs, rw)))
421 yaz_log (YLOG_WARN, "sortIdx_open failed");
424 if (res_get_match (res, "isam", "s", ISAM_DEFAULT))
426 struct ISAMS_M_s isams_m;
427 if (!(reg->isams = isams_open (reg->bfs, FNAME_ISAMS, rw,
428 key_isams_m(res, &isams_m))))
430 yaz_log (YLOG_WARN, "isams_open failed");
434 if (res_get_match (res, "isam", "c", ISAM_DEFAULT))
436 struct ISAMC_M_s isamc_m;
437 if (!(reg->isamc = isamc_open (reg->bfs, FNAME_ISAMC,
438 rw, key_isamc_m(res, &isamc_m))))
440 yaz_log (YLOG_WARN, "isamc_open failed");
444 if (res_get_match (res, "isam", "b", ISAM_DEFAULT))
446 struct ISAMC_M_s isamc_m;
448 if (!(reg->isamb = isamb_open (reg->bfs, "isamb",
449 rw, key_isamc_m(res, &isamc_m), 0)))
451 yaz_log (YLOG_WARN, "isamb_open failed");
455 if (res_get_match (res, "isam", "bc", ISAM_DEFAULT))
457 struct ISAMC_M_s isamc_m;
459 if (!(reg->isamb = isamb_open (reg->bfs, "isamb",
460 rw, key_isamc_m(res, &isamc_m), 1)))
462 yaz_log (YLOG_WARN, "isamb_open failed");
466 if (res_get_match (res, "isam", "null", ISAM_DEFAULT))
468 struct ISAMC_M_s isamc_m;
470 if (!(reg->isamb = isamb_open (reg->bfs, "isamb",
471 rw, key_isamc_m(res, &isamc_m), -1)))
473 yaz_log (YLOG_WARN, "isamb_open failed");
479 reg->zei = zebraExplain_open(reg->records, reg->dh,
481 zebra_extract_explain);
484 yaz_log (YLOG_WARN, "Cannot obtain EXPLAIN information");
491 zebra_register_close(zs, reg);
494 yaz_log (YLOG_DEBUG, "zebra_register_open ok p=%p", reg);
498 ZEBRA_RES zebra_admin_shutdown (ZebraHandle zh)
500 ZEBRA_CHECK_HANDLE(zh);
501 yaz_log(log_level, "zebra_admin_shutdown");
503 zebra_mutex_cond_lock (&zh->service->session_lock);
504 zh->service->stop_flag = 1;
505 zebra_mutex_cond_unlock (&zh->service->session_lock);
509 ZEBRA_RES zebra_admin_start (ZebraHandle zh)
512 ZEBRA_CHECK_HANDLE(zh);
513 yaz_log(log_level, "zebra_admin_start");
515 zebra_mutex_cond_lock (&zs->session_lock);
516 zebra_mutex_cond_unlock (&zs->session_lock);
520 static void zebra_register_close(ZebraService zs, struct zebra_register *reg)
524 yaz_log(YLOG_DEBUG, "zebra_register_close p=%p", reg);
528 zebraExplain_close (reg->zei);
529 dict_close (reg->dict);
531 dict_close (reg->matchDict);
532 sortIdx_close (reg->sortIdx);
534 isams_close (reg->isams);
536 isamc_close (reg->isamc);
538 isamb_close (reg->isamb);
539 rec_close (®->records);
541 recTypes_destroy (reg->recTypes);
542 zebra_maps_close (reg->zebra_maps);
543 zebraRankDestroy (reg);
544 bfs_destroy (reg->bfs);
545 data1_destroy (reg->dh);
547 zebra_rec_keys_close(reg->keys);
548 zebra_rec_keys_close(reg->sortKeys);
555 ZEBRA_RES zebra_stop(ZebraService zs)
559 yaz_log (log_level, "zebra_stop");
563 zebra_close (zs->sessions);
566 zebra_mutex_cond_destroy (&zs->session_lock);
569 passwd_db_close (zs->passwd_db);
571 recTypeClass_destroy(zs->record_classes);
572 nmem_destroy(zs->nmem);
573 res_close (zs->global_res);
578 ZEBRA_RES zebra_close(ZebraHandle zh)
581 struct zebra_session **sp;
584 yaz_log(log_level, "zebra_close");
585 ZEBRA_CHECK_HANDLE(zh);
590 yaz_log (YLOG_DEBUG, "zebra_close zh=%p", zh);
591 resultSetDestroy (zh, -1, 0, 0);
594 zebra_register_close(zh->service, zh->reg);
595 zebra_close_res (zh);
596 res_close(zh->session_res);
598 xfree(zh->record_encoding);
600 xfree(zh->dbaccesslist);
602 for (i = 0; i < zh->num_basenames; i++)
603 xfree(zh->basenames[i]);
604 xfree(zh->basenames);
606 if (zh->iconv_to_utf8 != 0)
607 yaz_iconv_close (zh->iconv_to_utf8);
608 if (zh->iconv_from_utf8 != 0)
609 yaz_iconv_close (zh->iconv_from_utf8);
611 zebra_mutex_cond_lock (&zs->session_lock);
612 zebra_lock_destroy (zh->lock_normal);
613 zebra_lock_destroy (zh->lock_shadow);
625 zebra_mutex_cond_unlock (&zs->session_lock);
627 xfree(zh->user_perm);
628 zh->service = 0; /* more likely to trigger an assert */
630 zebra_limit_destroy(zh->m_limit);
632 nmem_destroy(zh->nmem_error);
639 struct map_baseinfo {
645 char **new_basenames;
649 static void zebra_open_res(ZebraHandle zh)
657 sprintf(fname, "%.200s/zebra.cfg", zh->path_reg);
658 zh->res = res_open(zh->session_res, 0);
659 res_read_file(zh->res, fname);
661 else if (*zh->reg_name == 0)
663 zh->res = res_open(zh->session_res, 0);
667 yaz_log (YLOG_WARN, "no register root specified");
668 zh->res = 0; /* no path for register - fail! */
672 static void zebra_close_res (ZebraHandle zh)
680 static void zebra_select_register (ZebraHandle zh, const char *new_reg)
684 if (zh->res && strcmp (zh->reg_name, new_reg) == 0)
688 assert (zh->reg == 0);
689 assert (*zh->reg_name == 0);
695 resultSetInvalidate (zh);
696 zebra_register_close(zh->service, zh->reg);
702 zh->reg_name = xstrdup (new_reg);
706 if (zh->service->path_root)
708 zh->path_reg = xmalloc(strlen(zh->service->path_root) +
709 strlen(zh->reg_name) + 3);
710 strcpy (zh->path_reg, zh->service->path_root);
713 strcat (zh->path_reg, "/");
714 strcat (zh->path_reg, zh->reg_name);
720 zebra_lock_destroy (zh->lock_normal);
724 zebra_lock_destroy (zh->lock_shadow);
730 const char *lock_area = res_get (zh->res, "lockDir");
732 if (!lock_area && zh->path_reg)
733 res_set (zh->res, "lockDir", zh->path_reg);
734 sprintf (fname, "norm.%s.LCK", zh->reg_name);
736 zebra_lock_create (res_get(zh->res, "lockDir"), fname);
738 sprintf (fname, "shadow.%s.LCK", zh->reg_name);
740 zebra_lock_create (res_get(zh->res, "lockDir"), fname);
742 if (!zh->lock_normal || !zh->lock_shadow)
746 zebra_lock_destroy(zh->lock_normal);
751 zebra_lock_destroy(zh->lock_shadow);
760 if (res_get_int(zh->res, "estimatehits", &approx) == ZEBRA_OK)
761 zebra_set_approx_limit(zh, approx);
765 if (res_get_int(zh->res, "staticrank", &zh->m_staticrank) == ZEBRA_OK)
766 yaz_log(YLOG_LOG, "static rank set and is %d", zh->m_staticrank);
770 void map_basenames_func (void *vp, const char *name, const char *value)
772 struct map_baseinfo *p = (struct map_baseinfo *) vp;
774 char fromdb[128], todb[8][128];
781 sscanf (value, "%127s %127s %127s %127s %127s %127s %127s %127s %127s",
782 fromdb, todb[0], todb[1], todb[2], todb[3], todb[4],
783 todb[5], todb[6], todb[7]);
787 for (i = 0; i<p->num_bases; i++)
788 if (p->basenames[i] && !STRCASECMP (p->basenames[i], fromdb))
791 for (i = 0; i < no; i++)
793 if (p->new_num_bases == p->new_num_max)
795 p->new_basenames[(p->new_num_bases)++] =
796 nmem_strdup (p->mem, todb[i]);
802 int zebra_select_default_database(ZebraHandle zh)
806 /* no database has been selected - so we select based on
807 resource setting (including group)
809 const char *group = res_get(zh->session_res, "group");
810 const char *v = res_get_prefix(zh->session_res,
811 "database", group, "Default");
812 return zebra_select_database(zh, v);
817 void map_basenames (ZebraHandle zh, ODR stream,
818 int *num_bases, char ***basenames)
820 struct map_baseinfo info;
821 struct map_baseinfo *p = &info;
824 yaz_log(log_level, "map_basenames ");
829 info.num_bases = *num_bases;
830 info.basenames = *basenames;
831 info.new_num_max = 128;
832 info.new_num_bases = 0;
833 info.new_basenames = (char **)
834 odr_malloc (stream, sizeof(*info.new_basenames) * info.new_num_max);
835 info.mem = stream->mem;
837 res_trav (zh->session_res, "mapdb", &info, map_basenames_func);
839 for (i = 0; i<p->num_bases; i++)
840 if (p->basenames[i] && p->new_num_bases < p->new_num_max)
842 p->new_basenames[(p->new_num_bases)++] =
843 nmem_strdup (p->mem, p->basenames[i]);
845 *num_bases = info.new_num_bases;
846 *basenames = info.new_basenames;
847 for (i = 0; i<*num_bases; i++)
848 yaz_log (YLOG_DEBUG, "base %s", (*basenames)[i]);
851 ZEBRA_RES zebra_select_database (ZebraHandle zh, const char *basename)
853 ZEBRA_CHECK_HANDLE(zh);
855 yaz_log(log_level, "zebra_select_database %s",basename);
857 return zebra_select_databases (zh, 1, &basename);
860 ZEBRA_RES zebra_select_databases (ZebraHandle zh, int num_bases,
861 const char **basenames)
868 ZEBRA_CHECK_HANDLE(zh);
871 yaz_log(log_level, "zebra_select_databases n=%d [0]=%s",
872 num_bases,basenames[0]);
877 zh->errCode = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
881 /* Check if the user has access to all databases (Seb) */
882 /* You could argue that this should happen later, after we have
883 * determined that the database(s) exist. */
884 if (zh->dbaccesslist) {
885 for (i = 0; i < num_bases; i++) {
886 const char *db = basenames[i];
888 for (p = zh->dbaccesslist; p && *p; p = pp) {
890 if ((pp = strchr(p, '+'))) {
896 if (len == strlen(db) && !strncmp(db, p, len))
900 zh->errCode = YAZ_BIB1_ACCESS_TO_SPECIFIED_DATABASE_DENIED;
906 for (i = 0; i < zh->num_basenames; i++)
907 xfree(zh->basenames[i]);
908 xfree(zh->basenames);
910 zh->num_basenames = num_bases;
911 zh->basenames = xmalloc(zh->num_basenames * sizeof(*zh->basenames));
912 for (i = 0; i < zh->num_basenames; i++)
913 zh->basenames[i] = xstrdup (basenames[i]);
915 cp = strrchr(basenames[0], '/');
918 len = cp - basenames[0];
919 new_reg = xmalloc(len + 1);
920 memcpy (new_reg, basenames[0], len);
924 new_reg = xstrdup ("");
925 for (i = 1; i<num_bases; i++)
929 cp1 = strrchr (basenames[i], '/');
934 zh->errCode = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
937 if (len != cp1 - basenames[i] ||
938 memcmp (basenames[i], new_reg, len))
940 zh->errCode = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
948 zh->errCode = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
953 zebra_select_register (zh, new_reg);
957 zh->errCode = YAZ_BIB1_DATABASE_UNAVAILABLE;
960 if (!zh->lock_normal || !zh->lock_shadow)
962 zh->errCode = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
968 ZEBRA_RES zebra_set_approx_limit(ZebraHandle zh, zint approx_limit)
970 if (approx_limit == 0)
971 approx_limit = DEFAULT_APPROX_LIMIT;
972 zh->approx_limit = approx_limit;
976 ZEBRA_RES zebra_search_RPN(ZebraHandle zh, ODR o, Z_RPNQuery *query,
977 const char *setname, zint *hits)
981 ZEBRA_CHECK_HANDLE(zh);
987 yaz_log(log_level, "zebra_search_rpn");
991 if (zebra_begin_read(zh) == ZEBRA_FAIL)
994 r = resultSetAddRPN(zh, odr_extract_mem(o), query,
995 zh->num_basenames, zh->basenames, setname);
1001 ZEBRA_RES zebra_records_retrieve(ZebraHandle zh, ODR stream,
1002 const char *setname,
1003 Z_RecordComposition *comp,
1004 oid_value input_format, int num_recs,
1005 ZebraRetrievalRecord *recs)
1007 ZebraMetaRecord *poset;
1009 ZEBRA_RES ret = ZEBRA_OK;
1012 ZEBRA_CHECK_HANDLE(zh);
1018 yaz_log(log_level, "zebra_records_retrieve n=%d", num_recs);
1022 zebra_setError(zh, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
1027 if (zebra_begin_read (zh) == ZEBRA_FAIL)
1030 pos_array = (zint *) xmalloc(num_recs * sizeof(*pos_array));
1031 for (i = 0; i<num_recs; i++)
1032 pos_array[i] = recs[i].position;
1033 poset = zebra_meta_records_create(zh, setname, num_recs, pos_array);
1036 yaz_log (YLOG_DEBUG, "zebraPosSetCreate error");
1037 zebra_setError(zh, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
1043 for (i = 0; i<num_recs; i++)
1047 recs[i].errCode = 0;
1048 recs[i].format = VAL_SUTRS;
1049 recs[i].len = strlen(poset[i].term);
1050 recs[i].buf = poset[i].term;
1051 recs[i].base = poset[i].db;
1053 else if (poset[i].sysno)
1057 zebra_snippets *hit_snippet = zebra_snippets_create();
1059 zebra_snippets_hit_vector(zh, setname, poset[i].sysno,
1063 zebra_record_fetch(zh, poset[i].sysno, poset[i].score,
1065 stream, input_format, comp,
1066 &recs[i].format, &buf, &len,
1067 &recs[i].base, &recs[i].errString);
1072 recs[i].buf = (char*) odr_malloc(stream, len);
1073 memcpy(recs[i].buf, buf, len);
1077 recs[i].score = poset[i].score;
1078 recs[i].sysno = poset[i].sysno;
1079 zebra_snippets_destroy(hit_snippet);
1083 /* only need to set it once */
1084 if (pos_array[i] < zh->approx_limit && ret == ZEBRA_OK)
1086 zebra_setError_zint(zh,
1087 YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE,
1092 recs[i].buf = 0; /* no record and no error issued */
1094 recs[i].errCode = 0;
1095 recs[i].format = VAL_NONE;
1099 zebra_meta_records_destroy(zh, poset, num_recs);
1101 zebra_end_read (zh);
1106 ZEBRA_RES zebra_scan_PQF(ZebraHandle zh, ODR stream, const char *query,
1108 int *num_entries, ZebraScanEntry **entries,
1110 const char *setname)
1112 YAZ_PQF_Parser pqf_parser = yaz_pqf_create ();
1113 Z_AttributesPlusTerm *zapt;
1117 if (!(zapt = yaz_pqf_scan(pqf_parser, stream, &attributeSet, query)))
1120 zh->errCode = YAZ_BIB1_SCAN_MALFORMED_SCAN;
1123 res = zebra_scan(zh, stream, zapt, VAL_BIB1,
1124 position, num_entries, entries, is_partial,
1126 yaz_pqf_destroy (pqf_parser);
1130 ZEBRA_RES zebra_scan(ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
1131 oid_value attributeset,
1133 int *num_entries, ZebraScanEntry **entries,
1135 const char *setname)
1138 RSET limit_rset = 0;
1140 ZEBRA_CHECK_HANDLE(zh);
1145 assert(num_entries);
1148 yaz_log(log_level, "zebra_scan");
1150 if (zebra_begin_read (zh) == ZEBRA_FAIL)
1158 limit_rset = resultSetRef(zh, setname);
1162 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
1164 zebra_end_read (zh);
1168 res = rpn_scan (zh, stream, zapt, attributeset,
1169 zh->num_basenames, zh->basenames, position,
1170 num_entries, entries, is_partial, limit_rset, 0);
1171 zebra_end_read (zh);
1175 ZEBRA_RES zebra_sort (ZebraHandle zh, ODR stream,
1176 int num_input_setnames, const char **input_setnames,
1177 const char *output_setname,
1178 Z_SortKeySpecList *sort_sequence,
1182 ZEBRA_CHECK_HANDLE(zh);
1184 assert(num_input_setnames>0);
1185 assert(input_setnames);
1186 assert(sort_sequence);
1187 assert(sort_status);
1188 yaz_log(log_level, "zebra_sort");
1190 if (zebra_begin_read(zh) == ZEBRA_FAIL)
1192 res = resultSetSort(zh, stream->mem, num_input_setnames, input_setnames,
1193 output_setname, sort_sequence, sort_status);
1198 int zebra_deleteResultSet(ZebraHandle zh, int function,
1199 int num_setnames, char **setnames,
1205 yaz_log(log_level, "zebra_deleteResultSet n=%d",num_setnames);
1207 if (zebra_begin_read(zh))
1208 return Z_DeleteStatus_systemProblemAtTarget;
1211 case Z_DeleteResultSetRequest_list:
1212 assert(num_setnames>0);
1214 resultSetDestroy (zh, num_setnames, setnames, statuses);
1216 case Z_DeleteResultSetRequest_all:
1217 resultSetDestroy (zh, -1, 0, statuses);
1220 zebra_end_read (zh);
1221 status = Z_DeleteStatus_success;
1222 for (i = 0; i<num_setnames; i++)
1223 if (statuses[i] == Z_DeleteStatus_resultSetDidNotExist)
1224 status = statuses[i];
1228 int zebra_errCode (ZebraHandle zh)
1232 yaz_log(log_level, "zebra_errCode: %d",zh->errCode);
1235 yaz_log(log_level, "zebra_errCode: o");
1239 const char *zebra_errString (ZebraHandle zh)
1243 e= diagbib1_str (zh->errCode);
1244 yaz_log(log_level, "zebra_errString: %s",e);
1248 char *zebra_errAdd (ZebraHandle zh)
1253 yaz_log(log_level, "zebra_errAdd: %s",a);
1257 ZEBRA_RES zebra_auth (ZebraHandle zh, const char *user, const char *pass)
1260 const char *astring;
1264 ZEBRA_CHECK_HANDLE(zh);
1268 sprintf(u, "perm.%.30s", user ? user : "anonymous");
1269 p = res_get(zs->global_res, u);
1270 xfree(zh->user_perm);
1271 zh->user_perm = xstrdup(p ? p : "r");
1273 /* Determine database access list */
1274 astring = res_get(zs->dbaccess, user ? user : "anonymous");
1276 zh->dbaccesslist = xstrdup(astring);
1278 zh->dbaccesslist = 0;
1280 /* users that don't require a password .. */
1281 if (zh->user_perm && strchr(zh->user_perm, 'a'))
1284 if (!zs->passwd_db || !passwd_db_auth (zs->passwd_db, user, pass))
1289 ZEBRA_RES zebra_admin_import_begin (ZebraHandle zh, const char *database,
1290 const char *record_type)
1292 yaz_log(log_level, "zebra_admin_import_begin db=%s rt=%s",
1293 database, record_type);
1294 if (zebra_select_database(zh, database) == ZEBRA_FAIL)
1296 return zebra_begin_trans(zh, 1);
1299 ZEBRA_RES zebra_admin_import_end (ZebraHandle zh)
1301 ZEBRA_CHECK_HANDLE(zh);
1302 yaz_log(log_level, "zebra_admin_import_end");
1303 return zebra_end_trans(zh);
1306 ZEBRA_RES zebra_admin_import_segment (ZebraHandle zh, Z_Segment *segment)
1308 ZEBRA_RES res = ZEBRA_OK;
1311 ZEBRA_CHECK_HANDLE(zh);
1312 yaz_log(log_level, "zebra_admin_import_segment");
1314 for (i = 0; i<segment->num_segmentRecords; i++)
1316 Z_NamePlusRecord *npr = segment->segmentRecords[i];
1318 if (npr->which == Z_NamePlusRecord_intermediateFragment)
1320 Z_FragmentSyntax *fragment = npr->u.intermediateFragment;
1321 if (fragment->which == Z_FragmentSyntax_notExternallyTagged)
1323 Odr_oct *oct = fragment->u.notExternallyTagged;
1326 if (zebra_update_record(zh,
1327 0, /* record Type */
1331 (const char *) oct->buf, oct->len,
1340 ZEBRA_RES zebra_admin_exchange_record(ZebraHandle zh,
1341 const char *rec_buf,
1343 const char *recid_buf, size_t recid_len,
1345 /* 1 = insert. Fail it already exists */
1346 /* 2 = replace. Fail it does not exist */
1347 /* 3 = delete. Fail if does not exist */
1348 /* 4 = update. Insert/replace */
1355 ZEBRA_CHECK_HANDLE(zh);
1356 assert(action>0 && action <=4);
1359 yaz_log(log_level, "zebra_admin_exchange_record ac=%d", action);
1361 if (!recid_buf || recid_len <= 0 || recid_len >= sizeof(recid_z))
1363 zebra_setError(zh, YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED,
1364 "no record ID or empty record ID");
1368 memcpy (recid_z, recid_buf, recid_len);
1369 recid_z[recid_len] = 0;
1371 if (zebra_begin_trans(zh, 1) == ZEBRA_FAIL)
1374 db_ord = zebraExplain_get_database_ord(zh->reg->zei);
1375 rinfo = dict_lookup_ord(zh->reg->matchDict, db_ord, recid_z);
1378 if (action == 1) /* fail if insert */
1380 if (zebra_end_trans(zh) != ZEBRA_OK)
1381 yaz_log(YLOG_WARN, "zebra_end_trans failed");
1382 zebra_setError(zh, YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED,
1383 "Cannot insert record: already exist");
1387 memcpy (&sysno, rinfo+1, sizeof(sysno));
1391 if (action == 2 || action == 3) /* fail if delete or update */
1393 if (zebra_end_trans(zh) != ZEBRA_OK)
1394 yaz_log(YLOG_WARN, "zebra_end_trans failed");
1395 zebra_setError(zh, YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED,
1396 "Cannot delete/update record: does not exist");
1399 action = 1; /* make it an insert (if it's an update).. */
1401 res = zebra_buffer_extract_record(zh, rec_buf, rec_len,
1402 action == 3 ? 1 : 0 /* delete flag */,
1408 0, /* force update */
1409 1 /* allow update */
1411 if (res == ZEBRA_FAIL)
1413 zebra_setError(zh, YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED,
1414 "Unable to parse record");
1418 dict_insert_ord(zh->reg->matchDict, db_ord, recid_z,
1419 sizeof(sysno), &sysno);
1421 else if (action == 3)
1423 dict_delete_ord(zh->reg->matchDict, db_ord, recid_z);
1425 if (zebra_end_trans(zh) != ZEBRA_OK)
1427 yaz_log(YLOG_WARN, "zebra_end_trans failed");
1433 int delete_w_handle(const char *info, void *handle)
1435 ZebraHandle zh = (ZebraHandle) handle;
1439 if (*info == sizeof(pos))
1441 memcpy (&pos, info+1, sizeof(pos));
1442 isamb_unlink(zh->reg->isamb, pos);
1447 static int delete_SU_handle(void *handle, int ord)
1449 ZebraHandle zh = (ZebraHandle) handle;
1453 ord_len = key_SU_encode (ord, ord_buf);
1454 ord_buf[ord_len] = '\0';
1456 assert (zh->reg->isamb);
1457 dict_delete_subtree(zh->reg->dict, ord_buf,
1458 zh, delete_w_handle);
1462 ZEBRA_RES zebra_drop_database(ZebraHandle zh, const char *db)
1464 ZEBRA_RES ret = ZEBRA_OK;
1466 yaz_log(log_level, "zebra_drop_database %s", db);
1467 ZEBRA_CHECK_HANDLE(zh);
1469 if (zebra_select_database (zh, db) == ZEBRA_FAIL)
1471 if (zebra_begin_trans (zh, 1) == ZEBRA_FAIL)
1476 zebraExplain_curDatabase (zh->reg->zei, db);
1477 db_ord = zebraExplain_get_database_ord(zh->reg->zei);
1478 dict_delete_subtree_ord(zh->reg->matchDict, db_ord,
1479 0 /* handle */, 0 /* func */);
1480 zebraExplain_trav_ord(zh->reg->zei, zh, delete_SU_handle);
1481 zebraExplain_removeDatabase(zh->reg->zei, zh);
1485 yaz_log(YLOG_WARN, "drop database only supported for isam:b");
1486 zebra_setError(zh, YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED,
1487 "drop database only supported for isam:b");
1490 if (zebra_end_trans (zh) != ZEBRA_OK)
1492 yaz_log(YLOG_WARN, "zebra_end_trans failed");
1498 ZEBRA_RES zebra_create_database (ZebraHandle zh, const char *db)
1500 yaz_log(log_level, "zebra_create_database %s", db);
1501 ZEBRA_CHECK_HANDLE(zh);
1504 if (zebra_select_database (zh, db) == ZEBRA_FAIL)
1506 if (zebra_begin_trans (zh, 1))
1509 /* announce database */
1510 if (zebraExplain_newDatabase (zh->reg->zei, db, 0
1511 /* explainDatabase */))
1513 if (zebra_end_trans (zh) != ZEBRA_OK)
1515 yaz_log(YLOG_WARN, "zebra_end_trans failed");
1517 zebra_setError(zh, YAZ_BIB1_ES_IMMEDIATE_EXECUTION_FAILED, db);
1520 return zebra_end_trans (zh);
1523 int zebra_string_norm (ZebraHandle zh, unsigned reg_id,
1524 const char *input_str, int input_len,
1525 char *output_str, int output_len)
1531 yaz_log(log_level, "zebra_string_norm ");
1533 if (!zh->reg->zebra_maps)
1535 wrbuf = zebra_replace(zh->reg->zebra_maps, reg_id, "",
1536 input_str, input_len);
1539 if (wrbuf_len(wrbuf) >= output_len)
1541 if (wrbuf_len(wrbuf))
1542 memcpy (output_str, wrbuf_buf(wrbuf), wrbuf_len(wrbuf));
1543 output_str[wrbuf_len(wrbuf)] = '\0';
1544 return wrbuf_len(wrbuf);
1547 static void zebra_set_state (ZebraHandle zh, int val, int seqno)
1549 char state_fname[256];
1554 yaz_log(log_level, "zebra_set_state v=%d seq=%d", val, seqno);
1556 sprintf (state_fname, "state.%s.LCK", zh->reg_name);
1557 fname = zebra_mk_fname (res_get(zh->res, "lockDir"), state_fname);
1558 f = fopen (fname, "w");
1560 yaz_log (YLOG_DEBUG, "zebra_set_state: %c %d %ld", val, seqno, p);
1561 fprintf (f, "%c %d %ld\n", val, seqno, p);
1566 static void zebra_get_state (ZebraHandle zh, char *val, int *seqno)
1568 char state_fname[256];
1573 yaz_log(log_level, "zebra_get_state ");
1575 sprintf (state_fname, "state.%s.LCK", zh->reg_name);
1576 fname = zebra_mk_fname (res_get(zh->res, "lockDir"), state_fname);
1577 f = fopen (fname, "r");
1583 fscanf (f, "%c %d", val, seqno);
1589 ZEBRA_RES zebra_begin_read (ZebraHandle zh)
1591 return zebra_begin_trans(zh, 0);
1594 ZEBRA_RES zebra_end_read (ZebraHandle zh)
1596 return zebra_end_trans(zh);
1599 static void read_res_for_transaction(ZebraHandle zh)
1601 const char *group = res_get(zh->res, "group");
1603 /* FIXME - do we still use groups ?? */
1605 zh->m_group = group;
1606 v = res_get_prefix(zh->res, "followLinks", group, "1");
1607 zh->m_follow_links = atoi(v);
1609 zh->m_record_id = res_get_prefix(zh->res, "recordId", group, 0);
1610 zh->m_record_type = res_get_prefix(zh->res, "recordType", group, 0);
1612 v = res_get_prefix(zh->res, "storeKeys", group, "1");
1613 zh->m_store_keys = atoi(v);
1615 v = res_get_prefix(zh->res, "storeData", group, "1");
1616 zh->m_store_data = atoi(v);
1618 v = res_get_prefix(zh->res, "explainDatabase", group, "0");
1619 zh->m_explain_database = atoi(v);
1621 v = res_get_prefix(zh->res, "openRW", group, "1");
1622 zh->m_flag_rw = atoi(v);
1624 v = res_get_prefix(zh->res, "fileVerboseLimit", group, "100000");
1625 zh->m_file_verbose_limit = atoi(v);
1628 ZEBRA_RES zebra_begin_trans(ZebraHandle zh, int rw)
1630 ZEBRA_CHECK_HANDLE(zh);
1631 zebra_select_default_database(zh);
1634 zebra_setError(zh, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
1635 "zebra_begin_trans: no database selected");
1639 yaz_log(log_level, "zebra_begin_trans rw=%d",rw);
1643 if (rw && !strchr(zh->user_perm, 'w'))
1647 YAZ_BIB1_ES_PERMISSION_DENIED_ON_ES_CANNOT_MODIFY_OR_DELETE,
1659 const char *rval = 0;
1664 read_res_for_transaction(zh);
1667 if (zh->trans_no != 1)
1669 zebra_setError(zh, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
1670 "zebra_begin_trans: no write trans within read");
1675 resultSetInvalidate (zh);
1676 zebra_register_close(zh->service, zh->reg);
1678 zh->trans_w_no = zh->trans_no;
1680 zh->records_inserted = 0;
1681 zh->records_updated = 0;
1682 zh->records_deleted = 0;
1683 zh->records_processed = 0;
1685 #if HAVE_SYS_TIMES_H
1689 if (zh->shadow_enable)
1690 rval = res_get (zh->res, "shadow");
1692 for (pass = 0; pass < 2; pass++)
1696 zebra_lock_r (zh->lock_normal);
1697 zebra_lock_w (zh->lock_shadow);
1701 zebra_lock_w (zh->lock_normal);
1702 zebra_lock_w (zh->lock_shadow);
1705 zebra_get_state (zh, &val, &seqno);
1708 yaz_log (YLOG_WARN, "previous transaction didn't finish commit");
1709 zebra_unlock (zh->lock_shadow);
1710 zebra_unlock (zh->lock_normal);
1714 else if (val == 'd')
1718 BFiles bfs = bfs_create (res_get (zh->res, "shadow"),
1720 yaz_log (YLOG_WARN, "previous transaction didn't reach commit");
1721 bf_commitClean (bfs, rval);
1726 yaz_log (YLOG_WARN, "your previous transaction didn't finish");
1733 yaz_log (YLOG_FATAL, "zebra_begin_trans couldn't finish commit");
1737 zebra_set_state (zh, 'd', seqno);
1739 zh->reg = zebra_register_open(zh->service, zh->reg_name,
1740 1, rval ? 1 : 0, zh->res,
1743 zh->reg->seqno = seqno;
1746 zebra_set_state (zh, 'o', seqno);
1748 zebra_unlock (zh->lock_shadow);
1749 zebra_unlock (zh->lock_normal);
1754 zebra_setError(zh, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
1755 "zebra_begin_trans: cannot open register");
1756 yaz_log(YLOG_FATAL, "%s", zh->errString);
1759 zebraExplain_curDatabase(zh->reg->zei, zh->basenames[0]);
1769 if (zh->trans_no != 1)
1771 return zebra_flush_reg (zh);
1773 #if HAVE_SYS_TIMES_H
1779 zh->errCode = YAZ_BIB1_DATABASE_UNAVAILABLE;
1782 if (!zh->lock_normal || !zh->lock_shadow)
1785 zh->errCode = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
1788 zebra_get_state (zh, &val, &seqno);
1794 else if (seqno != zh->reg->seqno)
1796 yaz_log (YLOG_DEBUG, "reopen seqno cur/old %d/%d",
1797 seqno, zh->reg->seqno);
1800 else if (zh->reg->last_val != val)
1802 yaz_log (YLOG_DEBUG, "reopen last cur/old %d/%d",
1803 val, zh->reg->last_val);
1810 zebra_lock_r (zh->lock_shadow);
1812 zebra_lock_r (zh->lock_normal);
1816 resultSetInvalidate (zh);
1817 zebra_register_close(zh->service, zh->reg);
1819 zh->reg = zebra_register_open(zh->service, zh->reg_name,
1820 0, val == 'c' ? 1 : 0,
1821 zh->res, zh->path_reg);
1824 zebra_unlock (zh->lock_normal);
1825 zebra_unlock (zh->lock_shadow);
1827 zh->errCode = YAZ_BIB1_DATABASE_UNAVAILABLE;
1830 zh->reg->last_val = val;
1831 zh->reg->seqno = seqno;
1833 read_res_for_transaction(zh);
1837 ZEBRA_RES zebra_end_trans (ZebraHandle zh)
1839 ZebraTransactionStatus dummy;
1841 yaz_log(log_level, "zebra_end_trans");
1842 ZEBRA_CHECK_HANDLE(zh);
1843 return zebra_end_transaction(zh, &dummy);
1846 ZEBRA_RES zebra_end_transaction (ZebraHandle zh, ZebraTransactionStatus *status)
1852 ZEBRA_CHECK_HANDLE(zh);
1855 yaz_log(log_level, "zebra_end_transaction");
1857 status->processed = 0;
1858 status->inserted = 0;
1859 status->updated = 0;
1860 status->deleted = 0;
1864 if (!zh->res || !zh->reg)
1866 zebra_setError(zh, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
1867 "zebra_end_trans: no open transaction");
1870 if (zh->trans_no != zh->trans_w_no)
1873 if (zh->trans_no != 0)
1876 /* release read lock */
1878 zebra_unlock (zh->lock_normal);
1879 zebra_unlock (zh->lock_shadow);
1882 { /* release write lock */
1886 yaz_log (YLOG_DEBUG, "zebra_end_trans");
1887 rval = res_get (zh->res, "shadow");
1889 zebraExplain_runNumberIncrement (zh->reg->zei, 1);
1891 zebra_flush_reg (zh);
1893 resultSetInvalidate (zh);
1895 zebra_register_close(zh->service, zh->reg);
1898 yaz_log (YLOG_LOG, "Records: "ZINT_FORMAT" i/u/d "
1899 ZINT_FORMAT"/"ZINT_FORMAT"/"ZINT_FORMAT,
1900 zh->records_processed, zh->records_inserted,
1901 zh->records_updated, zh->records_deleted);
1903 status->processed = zh->records_processed;
1904 status->inserted = zh->records_inserted;
1905 status->updated = zh->records_updated;
1906 status->deleted = zh->records_deleted;
1908 zebra_get_state (zh, &val, &seqno);
1911 BFiles bfs = bfs_create (rval, zh->path_reg);
1912 yaz_log (YLOG_DEBUG, "deleting shadow val=%c", val);
1913 bf_commitClean (bfs, rval);
1918 zebra_set_state (zh, 'o', seqno);
1920 zebra_unlock (zh->lock_shadow);
1921 zebra_unlock (zh->lock_normal);
1924 #if HAVE_SYS_TIMES_H
1926 yaz_log (log_level, "user/system: %ld/%ld",
1927 (long) (zh->tms2.tms_utime - zh->tms1.tms_utime),
1928 (long) (zh->tms2.tms_stime - zh->tms1.tms_stime));
1930 status->utime = (long) (zh->tms2.tms_utime - zh->tms1.tms_utime);
1931 status->stime = (long) (zh->tms2.tms_stime - zh->tms1.tms_stime);
1936 ZEBRA_RES zebra_repository_update(ZebraHandle zh, const char *path)
1940 yaz_log (log_level, "updating %s", path);
1942 if (zh->m_record_id && !strcmp (zh->m_record_id, "file"))
1943 return zebra_update_file_match(zh, path);
1945 return zebra_update_from_path(zh, path);
1948 ZEBRA_RES zebra_repository_delete(ZebraHandle zh, const char *path)
1952 yaz_log (log_level, "deleting %s", path);
1953 return zebra_delete_from_path(zh, path);
1956 ZEBRA_RES zebra_repository_show(ZebraHandle zh, const char *path)
1960 yaz_log(log_level, "zebra_repository_show");
1961 repositoryShow (zh, path);
1965 static ZEBRA_RES zebra_commit_ex(ZebraHandle zh, int clean_only)
1973 zebra_select_default_database(zh);
1976 zh->errCode = YAZ_BIB1_DATABASE_UNAVAILABLE;
1979 rval = res_get (zh->res, "shadow");
1982 yaz_log (YLOG_WARN, "Cannot perform commit - No shadow area defined");
1986 zebra_lock_w (zh->lock_normal);
1987 zebra_lock_r (zh->lock_shadow);
1989 bfs = bfs_create (res_get (zh->res, "register"), zh->path_reg);
1992 zebra_unlock(zh->lock_shadow);
1993 zebra_unlock(zh->lock_normal);
1996 zebra_get_state (zh, &val, &seqno);
1999 bf_cache (bfs, rval);
2000 if (bf_commitExists (bfs))
2003 zebra_set_state (zh, 'd', seqno);
2006 zebra_set_state (zh, 'c', seqno);
2008 yaz_log (YLOG_DEBUG, "commit start");
2009 bf_commitExec (bfs);
2015 zebra_set_state (zh, 'o', seqno);
2017 zebra_unlock (zh->lock_shadow);
2018 zebra_unlock (zh->lock_normal);
2020 zebra_lock_w(zh->lock_shadow);
2021 bf_commitClean (bfs, rval);
2022 zebra_unlock (zh->lock_normal);
2026 zebra_unlock(zh->lock_shadow);
2027 zebra_unlock(zh->lock_normal);
2028 yaz_log (log_level, "nothing to commit");
2035 ZEBRA_RES zebra_clean(ZebraHandle zh)
2037 yaz_log(log_level, "zebra_clean");
2038 ZEBRA_CHECK_HANDLE(zh);
2039 return zebra_commit_ex(zh, 1);
2042 ZEBRA_RES zebra_commit(ZebraHandle zh)
2044 yaz_log(log_level, "zebra_commit");
2045 ZEBRA_CHECK_HANDLE(zh);
2046 return zebra_commit_ex(zh, 0);
2050 ZEBRA_RES zebra_init(ZebraHandle zh)
2055 yaz_log(log_level, "zebra_init");
2057 ZEBRA_CHECK_HANDLE(zh);
2059 zebra_select_default_database(zh);
2062 zebra_setError(zh, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR,
2063 "cannot select default database");
2066 rval = res_get (zh->res, "shadow");
2068 bfs = bfs_create (res_get (zh->res, "register"), zh->path_reg);
2071 zebra_setError(zh, YAZ_BIB1_TEMPORARY_SYSTEM_ERROR, "bfs_create");
2075 bf_cache (bfs, rval);
2079 zebra_set_state (zh, 'o', 0);
2083 ZEBRA_RES zebra_compact(ZebraHandle zh)
2087 yaz_log(log_level, "zebra_compact");
2088 ZEBRA_CHECK_HANDLE(zh);
2091 zh->errCode = YAZ_BIB1_DATABASE_UNAVAILABLE;
2094 bfs = bfs_create (res_get (zh->res, "register"), zh->path_reg);
2100 void zebra_result(ZebraHandle zh, int *code, char **addinfo)
2102 yaz_log(log_level, "zebra_result");
2105 *code = zh->errCode;
2106 *addinfo = zh->errString;
2110 *code = YAZ_BIB1_TEMPORARY_SYSTEM_ERROR;
2111 *addinfo ="ZebraHandle is NULL";
2115 void zebra_shadow_enable(ZebraHandle zh, int value)
2118 yaz_log(log_level, "zebra_shadow_enable");
2119 zh->shadow_enable = value;
2122 ZEBRA_RES zebra_octet_term_encoding(ZebraHandle zh, const char *encoding)
2124 yaz_log(log_level, "zebra_octet_term_encoding %s", encoding);
2125 ZEBRA_CHECK_HANDLE(zh);
2128 if (zh->iconv_to_utf8 != 0)
2129 yaz_iconv_close(zh->iconv_to_utf8);
2130 if (zh->iconv_from_utf8 != 0)
2131 yaz_iconv_close(zh->iconv_from_utf8);
2134 yaz_iconv_open ("UTF-8", encoding);
2135 if (zh->iconv_to_utf8 == 0)
2136 yaz_log (YLOG_WARN, "iconv: %s to UTF-8 unsupported", encoding);
2137 zh->iconv_from_utf8 =
2138 yaz_iconv_open (encoding, "UTF-8");
2139 if (zh->iconv_to_utf8 == 0)
2140 yaz_log (YLOG_WARN, "iconv: UTF-8 to %s unsupported", encoding);
2145 ZEBRA_RES zebra_record_encoding (ZebraHandle zh, const char *encoding)
2147 yaz_log(log_level, "zebra_record_encoding");
2148 ZEBRA_CHECK_HANDLE(zh);
2149 xfree(zh->record_encoding);
2150 zh->record_encoding = 0;
2152 zh->record_encoding = xstrdup (encoding);
2156 void zebra_set_resource(ZebraHandle zh, const char *name, const char *value)
2160 yaz_log(log_level, "zebra_set_resource %s:%s", name, value);
2162 res_set(zh->res, name, value);
2165 const char *zebra_get_resource(ZebraHandle zh,
2166 const char *name, const char *defaultvalue)
2171 v = res_get_def (zh->res, name, (char *)defaultvalue);
2172 yaz_log(log_level, "zebra_get_resource %s:%s", name, v);
2176 /* moved from zebra_api_ext.c by pop */
2177 /* FIXME: Should this really be public??? -Heikki */
2179 int zebra_trans_no (ZebraHandle zh)
2181 yaz_log(log_level, "zebra_trans_no");
2183 return zh->trans_no;
2186 int zebra_get_shadow_enable (ZebraHandle zh)
2188 yaz_log(log_level, "zebra_get_shadow_enable");
2190 return zh->shadow_enable;
2193 void zebra_set_shadow_enable (ZebraHandle zh, int value)
2195 yaz_log(log_level, "zebra_set_shadow_enable %d",value);
2197 zh->shadow_enable = value;
2200 ZEBRA_RES zebra_add_record(ZebraHandle zh,
2201 const char *buf, int buf_size)
2203 return zebra_update_record(zh, 0, 0 /* sysno */, 0, 0, buf, buf_size, 0);
2206 ZEBRA_RES zebra_insert_record(ZebraHandle zh,
2207 const char *recordType,
2208 SYSNO *sysno, const char *match,
2210 const char *buf, int buf_size, int force_update)
2216 yaz_log(log_level, "zebra_insert_record sysno=" ZINT_FORMAT, *sysno);
2219 buf_size = strlen(buf);
2221 if (zebra_begin_trans(zh, 1) == ZEBRA_FAIL)
2223 res = zebra_buffer_extract_record(zh, buf, buf_size,
2224 0, /* delete_flag */
2230 0); /* allow_update */
2231 if (zebra_end_trans(zh) != ZEBRA_OK)
2233 yaz_log(YLOG_WARN, "zebra_end_trans failed");
2239 ZEBRA_RES zebra_update_record (ZebraHandle zh,
2240 const char *recordType,
2241 SYSNO* sysno, const char *match,
2243 const char *buf, int buf_size,
2248 ZEBRA_CHECK_HANDLE(zh);
2252 yaz_log(log_level, "zebra_update_record");
2254 yaz_log(log_level, " sysno=" ZINT_FORMAT, *sysno);
2256 if (buf_size < 1) buf_size = strlen(buf);
2258 if (zebra_begin_trans(zh, 1) == ZEBRA_FAIL)
2260 res = zebra_buffer_extract_record(zh, buf, buf_size,
2261 0, /* delete_flag */
2267 1); /* allow_update */
2268 if (zebra_end_trans(zh) != ZEBRA_OK)
2270 yaz_log(YLOG_WARN, "zebra_end_trans failed");
2276 ZEBRA_RES zebra_delete_record (ZebraHandle zh,
2277 const char *recordType,
2278 SYSNO *sysno, const char *match,
2280 const char *buf, int buf_size,
2285 ZEBRA_CHECK_HANDLE(zh);
2288 yaz_log(log_level, "zebra_delete_record");
2290 yaz_log(log_level, " sysno=" ZINT_FORMAT, *sysno);
2292 if (buf_size < 1) buf_size = strlen(buf);
2294 if (zebra_begin_trans(zh, 1) == ZEBRA_FAIL)
2296 res = zebra_buffer_extract_record(zh, buf, buf_size,
2297 1, /* delete_flag */
2303 1); /* allow_update */
2304 if (zebra_end_trans(zh) != ZEBRA_OK)
2306 yaz_log(YLOG_WARN, "zebra_end_trans failed");
2312 /* ---------------------------------------------------------------------------
2316 ZEBRA_RES zebra_search_PQF(ZebraHandle zh, const char *pqf_query,
2317 const char *setname, zint *hits)
2320 ZEBRA_RES res = ZEBRA_OK;
2324 ZEBRA_CHECK_HANDLE(zh);
2326 odr = odr_createmem(ODR_ENCODE);
2331 yaz_log(log_level, "zebra_search_PQF s=%s q=%s", setname, pqf_query);
2333 query = p_query_rpn (odr, PROTO_Z3950, pqf_query);
2337 yaz_log (YLOG_WARN, "bad query %s\n", pqf_query);
2338 zh->errCode = YAZ_BIB1_MALFORMED_QUERY;
2342 res = zebra_search_RPN(zh, odr, query, setname, &lhits);
2346 yaz_log(log_level, "Hits: " ZINT_FORMAT, lhits);
2354 /* ---------------------------------------------------------------------------
2355 Sort - a simplified interface, with optional read locks.
2357 int zebra_sort_by_specstr (ZebraHandle zh, ODR stream,
2358 const char *sort_spec,
2359 const char *output_setname,
2360 const char **input_setnames)
2362 int num_input_setnames = 0;
2363 int sort_status = 0;
2364 Z_SortKeySpecList *sort_sequence;
2366 ZEBRA_CHECK_HANDLE(zh);
2369 assert(output_setname);
2370 assert(input_setnames);
2371 sort_sequence = yaz_sort_spec (stream, sort_spec);
2372 yaz_log(log_level, "sort (FIXME) ");
2375 yaz_log(YLOG_WARN, "invalid sort specs '%s'", sort_spec);
2376 zh->errCode = YAZ_BIB1_CANNOT_SORT_ACCORDING_TO_SEQUENCE;
2380 /* we can do this, since the perl typemap code for char** will
2381 put a NULL at the end of list */
2382 while (input_setnames[num_input_setnames]) num_input_setnames++;
2384 if (zebra_begin_read (zh))
2387 resultSetSort (zh, stream->mem, num_input_setnames, input_setnames,
2388 output_setname, sort_sequence, &sort_status);
2394 /* ---------------------------------------------------------------------------
2395 Get BFS for Zebra system (to make alternative storage methods)
2397 struct BFiles_struct *zebra_get_bfs(ZebraHandle zh)
2400 return zh->reg->bfs;
2405 /* ---------------------------------------------------------------------------
2406 Set limit for search/scan
2408 ZEBRA_RES zebra_set_limit(ZebraHandle zh, int complement_flag, zint *ids)
2410 ZEBRA_CHECK_HANDLE(zh);
2411 zebra_limit_destroy(zh->m_limit);
2412 zh->m_limit = zebra_limit_create(complement_flag, ids);
2417 Set Error code + addinfo
2419 void zebra_setError(ZebraHandle zh, int code, const char *addinfo)
2424 nmem_reset(zh->nmem_error);
2425 zh->errString = addinfo ? nmem_strdup(zh->nmem_error, addinfo) : 0;
2428 void zebra_setError_zint(ZebraHandle zh, int code, zint i)
2431 sprintf(vstr, ZINT_FORMAT, i);
2434 nmem_reset(zh->nmem_error);
2435 zh->errString = nmem_strdup(zh->nmem_error, vstr);
2438 void zebra_lock_prefix (Res res, char *path)
2440 const char *lock_dir = res_get_def (res, "lockDir", "");
2442 strcpy (path, lock_dir);
2443 if (*path && path[strlen(path)-1] != '/')
2450 * indent-tabs-mode: nil
2452 * vim: shiftwidth=4 tabstop=8 expandtab