1 /* $Id: zebraapi.c,v 1.155 2005-03-17 07:54:23 adam Exp $
2 Copyright (C) 1995-2005
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
34 #include <yaz/diagbib1.h>
35 #include <yaz/pquery.h>
36 #include <yaz/sortspec.h>
39 #include <idzebra/api.h>
41 /* simple asserts to validate the most essential input args */
42 #define ASSERTZH assert(zh && zh->service)
43 #define ASSERTZHRES assert(zh && zh->service && zh->res)
44 #define ASSERTZS assert(zs)
46 static int log_level = 0;
47 static int log_level_initialized = 0;
49 static Res zebra_open_res (ZebraHandle zh);
50 static void zebra_close_res (ZebraHandle zh);
52 static void zebra_chdir (ZebraService zs)
56 yaz_log(log_level, "zebra_chdir");
57 dir = res_get (zs->global_res, "chdir");
60 yaz_log (YLOG_DEBUG, "chdir %s", dir);
68 static void zebra_flush_reg (ZebraHandle zh)
71 yaz_log(log_level, "zebra_flush_reg");
73 zebraExplain_flush (zh->reg->zei, zh);
75 extract_flushWriteKeys (zh, 1 /* final */);
76 zebra_index_merge (zh );
79 static struct zebra_register *zebra_register_open (ZebraService zs,
81 int rw, int useshadow,
83 const char *reg_path);
84 static void zebra_register_close (ZebraService zs, struct zebra_register *reg);
86 ZebraHandle zebra_open (ZebraService zs)
89 const char *default_encoding;
90 if (!log_level_initialized)
92 log_level = yaz_log_module_level("zebraapi");
93 log_level_initialized = 1;
96 yaz_log(log_level, "zebra_open");
101 zh = (ZebraHandle) xmalloc(sizeof(*zh));
102 yaz_log (YLOG_DEBUG, "zebra_open zs=%p returns %p", zs, zh);
105 zh->reg = 0; /* no register attached yet */
113 zh->reg_name = xstrdup ("");
115 zh->num_basenames = 0;
124 zh->shadow_enable = 1;
126 default_encoding = res_get_def(zs->global_res, "encoding", "ISO-8859-1");
129 yaz_iconv_open ("UTF-8", default_encoding);
130 if (zh->iconv_to_utf8 == 0)
131 yaz_log (YLOG_WARN, "iconv: %s to UTF-8 unsupported",
133 zh->iconv_from_utf8 =
134 yaz_iconv_open (default_encoding, "UTF-8");
135 if (zh->iconv_to_utf8 == 0)
136 yaz_log (YLOG_WARN, "iconv: UTF-8 to %s unsupported",
139 zh->record_encoding = 0;
141 zebra_mutex_cond_lock (&zs->session_lock);
143 zh->next = zs->sessions;
146 zebra_mutex_cond_unlock (&zs->session_lock);
151 ZebraService zebra_start (const char *configName)
153 return zebra_start_res(configName, 0, 0);
156 ZebraService zebra_start_res (const char *configName, Res def_res, Res over_res)
160 if (!log_level_initialized)
162 log_level = yaz_log_module_level("zebraapi");
163 log_level_initialized = 1;
166 yaz_log(log_level, "zebra_start %s",configName);
169 if ((res = res_open (configName, def_res, over_res)))
171 ZebraService zh = xmalloc(sizeof(*zh));
173 yaz_log (YLOG_DEBUG, "Read resources `%s'", configName);
175 zh->global_res = res;
176 zh->configName = xstrdup(configName);
181 zebra_mutex_cond_init (&zh->session_lock);
182 if (!res_get (zh->global_res, "passwd"))
183 zh->passwd_db = NULL;
186 zh->passwd_db = passwd_db_open ();
188 yaz_log (YLOG_WARN|YLOG_ERRNO, "passwd_db_open failed");
190 passwd_db_file (zh->passwd_db,
191 res_get (zh->global_res, "passwd"));
193 zh->path_root = res_get (zh->global_res, "root");
194 zh->nmem = nmem_create();
195 zh->record_classes = recTypeClass_create (zh->global_res, zh->nmem);
201 void zebra_filter_info(ZebraService zs, void *cd,
202 void (*cb)(void *cd, const char *name))
206 recTypeClass_info(zs->record_classes, cd, cb);
209 void zebra_pidfname(ZebraService zs, char *path)
212 zebra_lock_prefix (zs->global_res, path);
213 strcat(path, "zebrasrv.pid");
216 Dict dict_open_res (BFiles bfs, const char *name, int cache, int rw,
217 int compact_flag, Res res)
219 int page_size = 4096;
220 char resource_str[200];
222 sprintf (resource_str, "dict.%.100s.pagesize", name);
226 v = res_get(res, resource_str);
230 yaz_log(YLOG_LOG, "Using custom dictionary page size %d for %s",
233 return dict_open(bfs, name, cache, rw, compact_flag, page_size);
238 struct zebra_register *zebra_register_open (ZebraService zs, const char *name,
239 int rw, int useshadow, Res res,
240 const char *reg_path)
242 struct zebra_register *reg;
243 int record_compression = REC_COMPRESS_NONE;
244 const char *recordCompression = 0;
245 const char *profilePath;
250 reg = xmalloc(sizeof(*reg));
253 reg->name = xstrdup (name);
260 yaz_log (YLOG_DEBUG, "zebra_register_open rw=%d useshadow=%d p=%p n=%s rp=%s",
261 rw, useshadow, reg, name, reg_path ? reg_path : "(none)");
263 reg->dh = data1_createx (DATA1_FLAG_XML);
266 reg->bfs = bfs_create (res_get (res, "register"), reg_path);
269 data1_destroy(reg->dh);
273 bf_cache (reg->bfs, res_get (res, "shadow"));
275 getcwd(cwd, sizeof(cwd)-1);
276 profilePath = res_get_def(res, "profilePath", DEFAULT_PROFILE_PATH);
277 yaz_log(YLOG_DEBUG, "profilePath=%s cwd=%s", profilePath, cwd);
279 data1_set_tabpath (reg->dh, profilePath);
280 data1_set_tabroot (reg->dh, reg_path);
281 reg->recTypes = recTypes_init (zs->record_classes, reg->dh);
283 reg->zebra_maps = zebra_maps_open (res, reg_path);
284 reg->rank_classes = NULL;
288 reg->keys.buf_max = 0;
290 reg->keys.codec_handle = iscz1_start();
292 reg->sortKeys.buf = 0;
293 reg->sortKeys.buf_max = 0;
304 reg->key_file_no = 0;
307 zebraRankInstall (reg, rank1_class);
308 zebraRankInstall (reg, rankzv_class);
310 recordCompression = res_get_def (res, "recordCompression", "none");
311 if (!strcmp (recordCompression, "none"))
312 record_compression = REC_COMPRESS_NONE;
313 if (!strcmp (recordCompression, "bzip2"))
314 record_compression = REC_COMPRESS_BZIP2;
316 if (!(reg->records = rec_open (reg->bfs, rw, record_compression)))
318 yaz_log (YLOG_WARN, "rec_open failed");
323 reg->matchDict = dict_open_res (reg->bfs, GMATCH_DICT, 20, 1, 0, res);
325 if (!(reg->dict = dict_open_res (reg->bfs, FNAME_DICT, 40, rw, 0, res)))
327 yaz_log (YLOG_WARN, "dict_open failed");
330 if (!(reg->sortIdx = sortIdx_open (reg->bfs, rw)))
332 yaz_log (YLOG_WARN, "sortIdx_open failed");
335 if (res_get_match (res, "isam", "s", ISAM_DEFAULT))
337 struct ISAMS_M_s isams_m;
338 if (!(reg->isams = isams_open (reg->bfs, FNAME_ISAMS, rw,
339 key_isams_m(res, &isams_m))))
341 yaz_log (YLOG_WARN, "isams_open failed");
345 if (res_get_match (res, "isam", "c", ISAM_DEFAULT))
347 struct ISAMC_M_s isamc_m;
348 if (!(reg->isamc = isc_open (reg->bfs, FNAME_ISAMC,
349 rw, key_isamc_m(res, &isamc_m))))
351 yaz_log (YLOG_WARN, "isc_open failed");
355 if (res_get_match (res, "isam", "b", ISAM_DEFAULT))
357 struct ISAMC_M_s isamc_m;
359 if (!(reg->isamb = isamb_open (reg->bfs, "isamb",
360 rw, key_isamc_m(res, &isamc_m), 0)))
362 yaz_log (YLOG_WARN, "isamb_open failed");
366 if (res_get_match (res, "isam", "bc", ISAM_DEFAULT))
368 struct ISAMC_M_s isamc_m;
370 if (!(reg->isamb = isamb_open (reg->bfs, "isamb",
371 rw, key_isamc_m(res, &isamc_m), 1)))
373 yaz_log (YLOG_WARN, "isamb_open failed");
377 if (res_get_match (res, "isam", "null", ISAM_DEFAULT))
379 struct ISAMC_M_s isamc_m;
381 if (!(reg->isamb = isamb_open (reg->bfs, "isamb",
382 rw, key_isamc_m(res, &isamc_m), -1)))
384 yaz_log (YLOG_WARN, "isamb_open failed");
388 reg->zei = zebraExplain_open (reg->records, reg->dh,
393 yaz_log (YLOG_WARN, "Cannot obtain EXPLAIN information");
397 yaz_log (YLOG_DEBUG, "zebra_register_open ok p=%p", reg);
401 int zebra_admin_shutdown (ZebraHandle zh)
404 yaz_log(log_level, "zebra_admin_shutdown");
407 zebra_mutex_cond_lock (&zh->service->session_lock);
408 zh->service->stop_flag = 1;
409 zebra_mutex_cond_unlock (&zh->service->session_lock);
413 int zebra_admin_start (ZebraHandle zh)
417 yaz_log(log_level, "zebra_admin_start");
420 zebra_mutex_cond_lock (&zs->session_lock);
421 zebra_mutex_cond_unlock (&zs->session_lock);
425 static void zebra_register_close (ZebraService zs, struct zebra_register *reg)
429 yaz_log(YLOG_DEBUG, "zebra_register_close p=%p", reg);
434 zebraExplain_close (reg->zei);
435 dict_close (reg->dict);
437 dict_close (reg->matchDict);
438 sortIdx_close (reg->sortIdx);
440 isams_close (reg->isams);
442 isc_close (reg->isamc);
444 isamb_close (reg->isamb);
445 rec_close (®->records);
448 recTypes_destroy (reg->recTypes);
449 zebra_maps_close (reg->zebra_maps);
450 zebraRankDestroy (reg);
451 bfs_destroy (reg->bfs);
452 data1_destroy (reg->dh);
454 xfree(reg->sortKeys.buf);
455 xfree(reg->keys.buf);
456 if (reg->keys.codec_handle)
457 iscz1_stop(reg->keys.codec_handle);
463 int zebra_stop(ZebraService zs)
467 yaz_log (log_level, "zebra_stop");
471 zebra_close (zs->sessions);
474 zebra_mutex_cond_destroy (&zs->session_lock);
477 passwd_db_close (zs->passwd_db);
479 recTypeClass_destroy(zs->record_classes);
480 nmem_destroy(zs->nmem);
481 res_close (zs->global_res);
482 xfree(zs->configName);
487 int zebra_close (ZebraHandle zh)
490 struct zebra_session **sp;
493 yaz_log(log_level, "zebra_close");
500 yaz_log (YLOG_DEBUG, "zebra_close zh=%p", zh);
501 resultSetDestroy (zh, -1, 0, 0);
504 zebra_register_close (zh->service, zh->reg);
505 zebra_close_res (zh);
507 xfree(zh->record_encoding);
509 for (i = 0; i < zh->num_basenames; i++)
510 xfree(zh->basenames[i]);
511 xfree(zh->basenames);
513 if (zh->iconv_to_utf8 != 0)
514 yaz_iconv_close (zh->iconv_to_utf8);
515 if (zh->iconv_from_utf8 != 0)
516 yaz_iconv_close (zh->iconv_from_utf8);
518 zebra_mutex_cond_lock (&zs->session_lock);
519 zebra_lock_destroy (zh->lock_normal);
520 zebra_lock_destroy (zh->lock_shadow);
532 zebra_mutex_cond_unlock (&zs->session_lock);
534 xfree(zh->user_perm);
535 zh->service = 0; /* more likely to trigger an assert */
541 struct map_baseinfo {
547 char **new_basenames;
551 static Res zebra_open_res (ZebraHandle zh)
560 sprintf (fname, "%.200s/zebra.cfg", zh->path_reg);
561 res = res_open (fname, zh->service->global_res, 0);
563 res = zh->service->global_res;
565 else if (*zh->reg_name == 0)
567 res = zh->service->global_res;
571 yaz_log (YLOG_WARN, "no register root specified");
572 return 0; /* no path for register - fail! */
577 static void zebra_close_res (ZebraHandle zh)
581 if (zh->res != zh->service->global_res)
586 static int zebra_select_register (ZebraHandle zh, const char *new_reg)
590 if (zh->res && strcmp (zh->reg_name, new_reg) == 0)
594 assert (zh->reg == 0);
595 assert (*zh->reg_name == 0);
601 resultSetInvalidate (zh);
602 zebra_register_close (zh->service, zh->reg);
608 zh->reg_name = xstrdup (new_reg);
612 if (zh->service->path_root)
614 zh->path_reg = xmalloc(strlen(zh->service->path_root) +
615 strlen(zh->reg_name) + 3);
616 strcpy (zh->path_reg, zh->service->path_root);
619 strcat (zh->path_reg, "/");
620 strcat (zh->path_reg, zh->reg_name);
623 zh->res = zebra_open_res (zh);
626 zebra_lock_destroy (zh->lock_normal);
630 zebra_lock_destroy (zh->lock_shadow);
636 const char *lock_area =res_get (zh->res, "lockDir");
638 if (!lock_area && zh->path_reg)
639 res_set (zh->res, "lockDir", zh->path_reg);
640 sprintf (fname, "norm.%s.LCK", zh->reg_name);
642 zebra_lock_create (res_get(zh->res, "lockDir"), fname, 0);
644 sprintf (fname, "shadow.%s.LCK", zh->reg_name);
646 zebra_lock_create (res_get(zh->res, "lockDir"), fname, 0);
652 void map_basenames_func (void *vp, const char *name, const char *value)
654 struct map_baseinfo *p = (struct map_baseinfo *) vp;
656 char fromdb[128], todb[8][128];
663 sscanf (value, "%127s %127s %127s %127s %127s %127s %127s %127s %127s",
664 fromdb, todb[0], todb[1], todb[2], todb[3], todb[4],
665 todb[5], todb[6], todb[7]);
669 for (i = 0; i<p->num_bases; i++)
670 if (p->basenames[i] && !STRCASECMP (p->basenames[i], fromdb))
673 for (i = 0; i < no; i++)
675 if (p->new_num_bases == p->new_num_max)
677 p->new_basenames[(p->new_num_bases)++] =
678 nmem_strdup (p->mem, todb[i]);
684 int zebra_select_default_database(ZebraHandle zh)
688 /* no database has been selected - so we select based on
689 resource setting (including group)
691 const char *group = res_get(zh->service->global_res, "group");
692 const char *v = res_get_prefix(zh->service->global_res,
693 "database", group, "Default");
694 zebra_select_database(zh, v);
699 void map_basenames (ZebraHandle zh, ODR stream,
700 int *num_bases, char ***basenames)
702 struct map_baseinfo info;
703 struct map_baseinfo *p = &info;
706 yaz_log(log_level, "map_basenames ");
713 info.num_bases = *num_bases;
714 info.basenames = *basenames;
715 info.new_num_max = 128;
716 info.new_num_bases = 0;
717 info.new_basenames = (char **)
718 odr_malloc (stream, sizeof(*info.new_basenames) * info.new_num_max);
719 info.mem = stream->mem;
721 res_trav (zh->service->global_res, "mapdb", &info, map_basenames_func);
723 for (i = 0; i<p->num_bases; i++)
724 if (p->basenames[i] && p->new_num_bases < p->new_num_max)
726 p->new_basenames[(p->new_num_bases)++] =
727 nmem_strdup (p->mem, p->basenames[i]);
729 *num_bases = info.new_num_bases;
730 *basenames = info.new_basenames;
731 for (i = 0; i<*num_bases; i++)
732 yaz_log (YLOG_DEBUG, "base %s", (*basenames)[i]);
735 int zebra_select_database (ZebraHandle zh, const char *basename)
738 yaz_log(log_level, "zebra_select_database %s",basename);
741 return zebra_select_databases (zh, 1, &basename);
744 int zebra_select_databases (ZebraHandle zh, int num_bases,
745 const char **basenames)
754 yaz_log(log_level, "zebra_select_databases n=%d [0]=%s",
755 num_bases,basenames[0]);
763 for (i = 0; i < zh->num_basenames; i++)
764 xfree(zh->basenames[i]);
765 xfree(zh->basenames);
767 zh->num_basenames = num_bases;
768 zh->basenames = xmalloc(zh->num_basenames * sizeof(*zh->basenames));
769 for (i = 0; i < zh->num_basenames; i++)
770 zh->basenames[i] = xstrdup (basenames[i]);
772 cp = strrchr(basenames[0], '/');
775 len = cp - basenames[0];
776 new_reg = xmalloc(len + 1);
777 memcpy (new_reg, basenames[0], len);
781 new_reg = xstrdup ("");
782 for (i = 1; i<num_bases; i++)
786 cp1 = strrchr (basenames[i], '/');
794 if (len != cp1 - basenames[i] ||
795 memcmp (basenames[i], new_reg, len))
810 zebra_select_register (zh, new_reg);
817 if (!zh->lock_normal || !zh->lock_shadow)
825 int zebra_search_RPN (ZebraHandle zh, ODR o,
826 Z_RPNQuery *query, const char *setname, zint *hits)
835 yaz_log(log_level, "zebra_search_rpn");
840 if (zebra_begin_read (zh))
843 resultSetAddRPN (zh, odr_extract_mem(o), query,
844 zh->num_basenames, zh->basenames, setname);
847 max = res_get (zh->res, "maxhits");
852 maxhits = INT_MAX; /* properly rounded, to make it look like a limit*/
853 while (maxhits>100) { maxhits/=10; i++;}
854 while (i--) maxhits *= 10;
856 if (zh->hits > maxhits) { /* too large for yaz to handle */
857 yaz_log(YLOG_DEBUG, "limiting hits to "ZINT_FORMAT, maxhits);
865 int zebra_records_retrieve (ZebraHandle zh, ODR stream,
866 const char *setname, Z_RecordComposition *comp,
867 oid_value input_format, int num_recs,
868 ZebraRetrievalRecord *recs)
870 ZebraMetaRecord *poset;
879 yaz_log(log_level, "zebra_records_retrieve n=%d",num_recs);
885 zh->errString = odr_strdup(stream, setname);
891 if (zebra_begin_read (zh))
894 pos_array = (zint *) xmalloc(num_recs * sizeof(*pos_array));
895 for (i = 0; i<num_recs; i++)
896 pos_array[i] = recs[i].position;
897 poset = zebra_meta_records_create(zh, setname, num_recs, pos_array);
900 yaz_log (YLOG_DEBUG, "zebraPosSetCreate error");
902 zh->errString = nmem_strdup (stream->mem, setname);
907 for (i = 0; i<num_recs; i++)
912 recs[i].format = VAL_SUTRS;
913 recs[i].len = strlen(poset[i].term);
914 recs[i].buf = poset[i].term;
915 recs[i].base = poset[i].db;
917 else if (poset[i].sysno)
922 zebra_record_fetch (zh, poset[i].sysno, poset[i].score,
923 stream, input_format, comp,
924 &recs[i].format, &buf, &len,
925 &recs[i].base, &recs[i].errString);
929 recs[i].buf = (char*) odr_malloc(stream, len);
930 memcpy(recs[i].buf, buf, len);
934 recs[i].score = poset[i].score;
935 recs[i].sysno = poset[i].sysno;
941 sprintf (num_str, ZINT_FORMAT, pos_array[i]);
943 zh->errString = odr_strdup (stream, num_str);
948 zebra_meta_records_destroy(zh, poset, num_recs);
955 int zebra_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
956 oid_value attributeset,
957 int *position, int *num_entries, ZebraScanEntry **entries,
967 yaz_log(log_level, "zebra_scan");
969 if (zebra_begin_read (zh))
975 rpn_scan (zh, stream, zapt, attributeset,
976 zh->num_basenames, zh->basenames, position,
977 num_entries, entries, is_partial, 0, 0);
982 int zebra_sort (ZebraHandle zh, ODR stream,
983 int num_input_setnames, const char **input_setnames,
984 const char *output_setname, Z_SortKeySpecList *sort_sequence,
989 assert(num_input_setnames>0);
990 assert(input_setnames);
991 assert(sort_sequence);
993 yaz_log(log_level, "zebra_sort");
995 if (zebra_begin_read (zh))
997 resultSetSort (zh, stream->mem, num_input_setnames, input_setnames,
998 output_setname, sort_sequence, sort_status);
1003 int zebra_deleteResultSet(ZebraHandle zh, int function,
1004 int num_setnames, char **setnames,
1010 yaz_log(log_level, "zebra_deleteResultSet n=%d",num_setnames);
1012 if (zebra_begin_read(zh))
1013 return Z_DeleteStatus_systemProblemAtTarget;
1016 case Z_DeleteResultSetRequest_list:
1017 assert(num_setnames>0);
1019 resultSetDestroy (zh, num_setnames, setnames, statuses);
1021 case Z_DeleteResultSetRequest_all:
1022 resultSetDestroy (zh, -1, 0, statuses);
1025 zebra_end_read (zh);
1026 status = Z_DeleteStatus_success;
1027 for (i = 0; i<num_setnames; i++)
1028 if (statuses[i] == Z_DeleteStatus_resultSetDidNotExist)
1029 status = statuses[i];
1033 int zebra_errCode (ZebraHandle zh)
1037 yaz_log(log_level, "zebra_errCode: %d",zh->errCode);
1040 yaz_log(log_level, "zebra_errCode: o");
1044 const char *zebra_errString (ZebraHandle zh)
1048 e= diagbib1_str (zh->errCode);
1049 yaz_log(log_level, "zebra_errString: %s",e);
1053 char *zebra_errAdd (ZebraHandle zh)
1058 yaz_log(log_level, "zebra_errAdd: %s",a);
1062 void zebra_clearError(ZebraHandle zh)
1071 int zebra_auth (ZebraHandle zh, const char *user, const char *pass)
1081 sprintf(u, "perm.%.30s", user ? user : "anonymous");
1082 p = res_get(zs->global_res, u);
1083 xfree(zh->user_perm);
1084 zh->user_perm = xstrdup(p ? p : "r");
1086 /* users that don't require a password .. */
1087 if (zh->user_perm && strchr(zh->user_perm, 'a'))
1090 if (!zs->passwd_db || !passwd_db_auth (zs->passwd_db, user, pass))
1095 int zebra_admin_import_begin (ZebraHandle zh, const char *database,
1096 const char *record_type)
1099 yaz_log(log_level, "zebra_admin_import_begin db=%s rt=%s",
1100 database, record_type);
1102 if (zebra_select_database(zh, database))
1104 if (zebra_begin_trans (zh, 1))
1109 int zebra_admin_import_end (ZebraHandle zh)
1112 yaz_log(log_level, "zebra_admin_import_end");
1114 zebra_end_trans (zh);
1118 int zebra_admin_import_segment (ZebraHandle zh, Z_Segment *segment)
1123 yaz_log(log_level, "zebra_admin_import_segment");
1125 for (i = 0; i<segment->num_segmentRecords; i++)
1127 Z_NamePlusRecord *npr = segment->segmentRecords[i];
1129 printf ("--------------%d--------------------\n", i);
1130 /* FIXME - What! printing on stdout ??? */
1131 if (npr->which == Z_NamePlusRecord_intermediateFragment)
1133 Z_FragmentSyntax *fragment = npr->u.intermediateFragment;
1134 if (fragment->which == Z_FragmentSyntax_notExternallyTagged)
1136 Odr_oct *oct = fragment->u.notExternallyTagged;
1137 printf ("%.*s", (oct->len > 100 ? 100 : oct->len) ,
1142 zebra_update_record(zh,
1143 0, /* record Type */
1155 int zebra_admin_exchange_record (ZebraHandle zh,
1156 const char *rec_buf,
1158 const char *recid_buf, size_t recid_len,
1160 /* 1 = insert. Fail it already exists */
1161 /* 2 = replace. Fail it does not exist */
1162 /* 3 = delete. Fail if does not exist */
1163 /* 4 = update. Insert/replace */
1169 assert(action>0 && action <=4);
1172 yaz_log(log_level, "zebra_admin_exchange_record ac=%d", action);
1175 if (!recid_buf || recid_len <= 0 || recid_len >= sizeof(recid_z))
1177 memcpy (recid_z, recid_buf, recid_len);
1178 recid_z[recid_len] = 0;
1180 if (zebra_begin_trans(zh, 1))
1183 rinfo = dict_lookup (zh->reg->matchDict, recid_z);
1186 if (action == 1) /* fail if insert */
1188 zebra_end_trans(zh);
1192 memcpy (&sysno, rinfo+1, sizeof(sysno));
1196 if (action == 2 || action == 3) /* fail if delete or update */
1198 zebra_end_trans(zh);
1201 action = 1; /* make it an insert (if it's an update).. */
1203 buffer_extract_record (zh, rec_buf, rec_len,
1204 action == 3 ? 1 : 0 /* delete flag */,
1210 0, /* force update */
1211 1 /* allow update */
1215 dict_insert (zh->reg->matchDict, recid_z, sizeof(sysno), &sysno);
1217 else if (action == 3)
1219 dict_delete (zh->reg->matchDict, recid_z);
1221 zebra_end_trans(zh);
1225 int delete_w_handle(const char *info, void *handle)
1227 ZebraHandle zh = (ZebraHandle) handle;
1231 if (*info == sizeof(pos))
1233 memcpy (&pos, info+1, sizeof(pos));
1234 isamb_unlink(zh->reg->isamb, pos);
1239 static int delete_SU_handle(void *handle, int ord)
1241 ZebraHandle zh = (ZebraHandle) handle;
1245 ord_len = key_SU_encode (ord, ord_buf);
1246 ord_buf[ord_len] = '\0';
1248 assert (zh->reg->isamb);
1249 dict_delete_subtree(zh->reg->dict, ord_buf,
1250 zh, delete_w_handle);
1254 int zebra_drop_database (ZebraHandle zh, const char *database)
1258 yaz_log(log_level, "zebra_drop_database");
1261 if (zebra_select_database (zh, database))
1263 if (zebra_begin_trans (zh, 1))
1267 zebraExplain_curDatabase (zh->reg->zei, database);
1269 zebraExplain_trav_ord(zh->reg->zei, zh, delete_SU_handle);
1270 zebraExplain_removeDatabase(zh->reg->zei, zh);
1274 yaz_log(YLOG_WARN, "drop database only supported for isam:b");
1277 zebra_end_trans (zh);
1281 int zebra_create_database (ZebraHandle zh, const char *database)
1284 yaz_log(log_level, "zebra_create_database %s",database);
1288 if (zebra_select_database (zh, database))
1290 if (zebra_begin_trans (zh, 1))
1293 /* announce database */
1294 if (zebraExplain_newDatabase (zh->reg->zei, database, 0
1295 /* explainDatabase */))
1297 zebra_end_trans (zh);
1299 zh->errString = "database already exist";
1302 zebra_end_trans (zh);
1306 int zebra_string_norm (ZebraHandle zh, unsigned reg_id,
1307 const char *input_str, int input_len,
1308 char *output_str, int output_len)
1314 yaz_log(log_level, "zebra_string_norm ");
1316 if (!zh->reg->zebra_maps)
1318 wrbuf = zebra_replace(zh->reg->zebra_maps, reg_id, "",
1319 input_str, input_len);
1322 if (wrbuf_len(wrbuf) >= output_len)
1324 if (wrbuf_len(wrbuf))
1325 memcpy (output_str, wrbuf_buf(wrbuf), wrbuf_len(wrbuf));
1326 output_str[wrbuf_len(wrbuf)] = '\0';
1327 return wrbuf_len(wrbuf);
1331 int zebra_set_state (ZebraHandle zh, int val, int seqno)
1332 /* FIXME - zint seqno ?? */
1334 char state_fname[256];
1339 yaz_log(log_level, "zebra_set_state v=%d seq=%d", val, seqno);
1342 sprintf (state_fname, "state.%s.LCK", zh->reg_name);
1343 fname = zebra_mk_fname (res_get(zh->res, "lockDir"), state_fname);
1344 f = fopen (fname, "w");
1346 yaz_log (YLOG_DEBUG, "zebra_set_state: %c %d %ld", val, seqno, p);
1347 fprintf (f, "%c %d %ld\n", val, seqno, p);
1353 int zebra_get_state (ZebraHandle zh, char *val, int *seqno)
1355 char state_fname[256];
1360 yaz_log(log_level, "zebra_get_state ");
1362 sprintf (state_fname, "state.%s.LCK", zh->reg_name);
1363 fname = zebra_mk_fname (res_get(zh->res, "lockDir"), state_fname);
1364 f = fopen (fname, "r");
1370 fscanf (f, "%c %d", val, seqno);
1377 int zebra_begin_read (ZebraHandle zh)
1379 return zebra_begin_trans(zh, 0);
1382 int zebra_end_read (ZebraHandle zh)
1384 return zebra_end_trans(zh);
1387 static void read_res_for_transaction(ZebraHandle zh)
1389 const char *group = res_get(zh->res, "group");
1391 /* FIXME - do we still use groups ?? */
1393 zh->m_group = group;
1394 v = res_get_prefix(zh->res, "followLinks", group, "1");
1395 zh->m_follow_links = atoi(v);
1397 zh->m_record_id = res_get_prefix(zh->res, "recordId", group, 0);
1398 zh->m_record_type = res_get_prefix(zh->res, "recordType", group, 0);
1400 v = res_get_prefix(zh->res, "storeKeys", group, "1");
1401 zh->m_store_keys = atoi(v);
1403 v = res_get_prefix(zh->res, "storeData", group, "1");
1404 zh->m_store_data = atoi(v);
1406 v = res_get_prefix(zh->res, "explainDatabase", group, "0");
1407 zh->m_explain_database = atoi(v);
1409 v = res_get_prefix(zh->res, "openRW", group, "1");
1410 zh->m_flag_rw = atoi(v);
1412 v = res_get_prefix(zh->res, "fileVerboseLimit", group, "100000");
1413 zh->m_file_verbose_limit = atoi(v);
1416 int zebra_begin_trans (ZebraHandle zh, int rw)
1419 zebra_select_default_database(zh);
1423 zh->errString = "zebra_begin_trans: no database selected";
1427 yaz_log(log_level, "zebra_begin_trans rw=%d",rw);
1431 if (rw && !strchr(zh->user_perm, 'w'))
1445 const char *rval = 0;
1450 read_res_for_transaction(zh);
1453 if (zh->trans_no != 1)
1456 zh->errString = "zebra_begin_trans: write trans not allowed within read trans";
1461 resultSetInvalidate (zh);
1462 zebra_register_close (zh->service, zh->reg);
1464 zh->trans_w_no = zh->trans_no;
1468 zh->records_inserted = 0;
1469 zh->records_updated = 0;
1470 zh->records_deleted = 0;
1471 zh->records_processed = 0;
1473 #if HAVE_SYS_TIMES_H
1477 if (zh->shadow_enable)
1478 rval = res_get (zh->res, "shadow");
1480 for (pass = 0; pass < 2; pass++)
1484 zebra_lock_r (zh->lock_normal);
1485 zebra_lock_w (zh->lock_shadow);
1489 zebra_lock_w (zh->lock_normal);
1490 zebra_lock_w (zh->lock_shadow);
1493 zebra_get_state (zh, &val, &seqno);
1496 yaz_log (YLOG_WARN, "previous transaction didn't finish commit");
1497 zebra_unlock (zh->lock_shadow);
1498 zebra_unlock (zh->lock_normal);
1502 else if (val == 'd')
1506 BFiles bfs = bfs_create (res_get (zh->res, "shadow"),
1508 yaz_log (YLOG_WARN, "previous transaction didn't reach commit");
1509 bf_commitClean (bfs, rval);
1514 yaz_log (YLOG_WARN, "your previous transaction didn't finish");
1521 yaz_log (YLOG_FATAL, "zebra_begin_trans couldn't finish commit");
1525 zebra_set_state (zh, 'd', seqno);
1527 zh->reg = zebra_register_open (zh->service, zh->reg_name,
1528 1, rval ? 1 : 0, zh->res,
1531 zh->reg->seqno = seqno;
1534 zebra_set_state (zh, 'o', seqno);
1536 zebra_unlock (zh->lock_shadow);
1537 zebra_unlock (zh->lock_normal);
1543 zh->errString = "zebra_begin_trans: cannot open register";
1544 yaz_log(YLOG_FATAL, zh->errString);
1556 if (zh->trans_no != 1)
1558 zebra_flush_reg (zh);
1562 #if HAVE_SYS_TIMES_H
1571 if (!zh->lock_normal || !zh->lock_shadow)
1577 zebra_get_state (zh, &val, &seqno);
1583 else if (seqno != zh->reg->seqno)
1585 yaz_log (YLOG_DEBUG, "reopen seqno cur/old %d/%d",
1586 seqno, zh->reg->seqno);
1589 else if (zh->reg->last_val != val)
1591 yaz_log (YLOG_DEBUG, "reopen last cur/old %d/%d",
1592 val, zh->reg->last_val);
1599 zebra_lock_r (zh->lock_shadow);
1601 zebra_lock_r (zh->lock_normal);
1605 resultSetInvalidate (zh);
1606 zebra_register_close (zh->service, zh->reg);
1608 zh->reg = zebra_register_open (zh->service, zh->reg_name,
1609 0, val == 'c' ? 1 : 0,
1610 zh->res, zh->path_reg);
1613 zebra_unlock (zh->lock_normal);
1614 zebra_unlock (zh->lock_shadow);
1619 zh->reg->last_val = val;
1620 zh->reg->seqno = seqno;
1622 read_res_for_transaction(zh);
1626 int zebra_end_trans (ZebraHandle zh)
1628 ZebraTransactionStatus dummy;
1630 yaz_log(log_level, "zebra_end_trans");
1631 return zebra_end_transaction(zh, &dummy);
1634 int zebra_end_transaction (ZebraHandle zh, ZebraTransactionStatus *status)
1642 yaz_log(log_level, "zebra_end_transaction");
1644 status->processed = 0;
1645 status->inserted = 0;
1646 status->updated = 0;
1647 status->deleted = 0;
1651 if (!zh->res || !zh->reg)
1654 zh->errString = "zebra_end_trans: no open transaction";
1657 if (zh->trans_no != zh->trans_w_no)
1660 if (zh->trans_no != 0)
1663 /* release read lock */
1665 zebra_unlock (zh->lock_normal);
1666 zebra_unlock (zh->lock_shadow);
1669 { /* release write lock */
1673 yaz_log (YLOG_DEBUG, "zebra_end_trans");
1674 rval = res_get (zh->res, "shadow");
1676 zebraExplain_runNumberIncrement (zh->reg->zei, 1);
1678 zebra_flush_reg (zh);
1680 resultSetInvalidate (zh);
1682 zebra_register_close (zh->service, zh->reg);
1685 yaz_log (YLOG_LOG, "Records: "ZINT_FORMAT" i/u/d "
1686 ZINT_FORMAT"/"ZINT_FORMAT"/"ZINT_FORMAT,
1687 zh->records_processed, zh->records_inserted,
1688 zh->records_updated, zh->records_deleted);
1690 status->processed = (int) zh->records_processed;
1691 status->inserted = (int) zh->records_inserted;
1692 status->updated = (int) zh->records_updated;
1693 status->deleted = (int) zh->records_deleted;
1695 zebra_get_state (zh, &val, &seqno);
1698 BFiles bfs = bfs_create (rval, zh->path_reg);
1699 yaz_log (YLOG_DEBUG, "deleting shadow val=%c", val);
1700 bf_commitClean (bfs, rval);
1705 zebra_set_state (zh, 'o', seqno);
1707 zebra_unlock (zh->lock_shadow);
1708 zebra_unlock (zh->lock_normal);
1711 #if HAVE_SYS_TIMES_H
1713 yaz_log (log_level, "user/system: %ld/%ld",
1714 (long) (zh->tms2.tms_utime - zh->tms1.tms_utime),
1715 (long) (zh->tms2.tms_stime - zh->tms1.tms_stime));
1717 status->utime = (long) (zh->tms2.tms_utime - zh->tms1.tms_utime);
1718 status->stime = (long) (zh->tms2.tms_stime - zh->tms1.tms_stime);
1723 int zebra_repository_update (ZebraHandle zh, const char *path)
1728 yaz_log (log_level, "updating %s", path);
1729 repositoryUpdate (zh, path);
1733 int zebra_repository_delete (ZebraHandle zh, const char *path)
1738 yaz_log (log_level, "deleting %s", path);
1739 repositoryDelete (zh, path);
1743 int zebra_repository_show (ZebraHandle zh, const char *path)
1747 yaz_log(log_level, "zebra_repository_show");
1749 repositoryShow (zh, path);
1753 static int zebra_commit_ex (ZebraHandle zh, int clean_only)
1762 zebra_select_default_database(zh);
1768 rval = res_get (zh->res, "shadow");
1771 yaz_log (YLOG_WARN, "Cannot perform commit - No shadow area defined");
1775 zebra_lock_w (zh->lock_normal);
1776 zebra_lock_r (zh->lock_shadow);
1778 bfs = bfs_create (res_get (zh->res, "register"), zh->path_reg);
1780 zebra_get_state (zh, &val, &seqno);
1783 bf_cache (bfs, rval);
1784 if (bf_commitExists (bfs))
1787 zebra_set_state (zh, 'd', seqno);
1790 zebra_set_state (zh, 'c', seqno);
1792 yaz_log (YLOG_DEBUG, "commit start");
1793 bf_commitExec (bfs);
1798 yaz_log (YLOG_DEBUG, "commit clean");
1799 bf_commitClean (bfs, rval);
1801 zebra_set_state (zh, 'o', seqno);
1805 yaz_log (log_level, "nothing to commit");
1809 zebra_unlock (zh->lock_shadow);
1810 zebra_unlock (zh->lock_normal);
1814 int zebra_clean (ZebraHandle zh)
1817 yaz_log(log_level, "zebra_clean");
1818 return zebra_commit_ex(zh, 1);
1821 int zebra_commit (ZebraHandle zh)
1824 yaz_log(log_level, "zebra_commit");
1825 return zebra_commit_ex(zh, 0);
1828 int zebra_init (ZebraHandle zh)
1833 yaz_log(log_level, "zebra_init");
1836 zebra_select_default_database(zh);
1842 rval = res_get (zh->res, "shadow");
1844 bfs = bfs_create (res_get (zh->res, "register"), zh->path_reg);
1848 bf_cache (bfs, rval);
1852 zebra_set_state (zh, 'o', 0);
1856 int zebra_compact (ZebraHandle zh)
1860 yaz_log(log_level, "zebra_compact");
1867 bfs = bfs_create (res_get (zh->res, "register"), zh->path_reg);
1873 int zebra_result (ZebraHandle zh, int *code, char **addinfo)
1876 yaz_log(log_level, "zebra_result");
1877 *code = zh->errCode;
1878 *addinfo = zh->errString;
1882 int zebra_shadow_enable (ZebraHandle zh, int value)
1885 yaz_log(log_level, "zebra_shadow_enable");
1887 zh->shadow_enable = value;
1891 int zebra_octet_term_encoding(ZebraHandle zh, const char *encoding)
1895 yaz_log(log_level, "zebra_octet_term_encoding");
1898 if (zh->iconv_to_utf8 != 0)
1899 yaz_iconv_close(zh->iconv_to_utf8);
1900 if (zh->iconv_from_utf8 != 0)
1901 yaz_iconv_close(zh->iconv_from_utf8);
1904 yaz_iconv_open ("UTF-8", encoding);
1905 if (zh->iconv_to_utf8 == 0)
1906 yaz_log (YLOG_WARN, "iconv: %s to UTF-8 unsupported", encoding);
1907 zh->iconv_from_utf8 =
1908 yaz_iconv_open (encoding, "UTF-8");
1909 if (zh->iconv_to_utf8 == 0)
1910 yaz_log (YLOG_WARN, "iconv: UTF-8 to %s unsupported", encoding);
1915 int zebra_record_encoding (ZebraHandle zh, const char *encoding)
1918 yaz_log(log_level, "zebra_record_encoding");
1920 xfree(zh->record_encoding);
1921 zh->record_encoding = 0;
1923 zh->record_encoding = xstrdup (encoding);
1927 int zebra_set_resource(ZebraHandle zh, const char *name, const char *value)
1932 yaz_log(log_level, "zebra_set_resource %s:%s",name,value);
1934 res_set(zh->res, name, value);
1938 const char *zebra_get_resource(ZebraHandle zh,
1939 const char *name, const char *defaultvalue)
1944 assert(defaultvalue);
1945 v= res_get_def( zh->res, name, (char *)defaultvalue);
1947 yaz_log(log_level, "zebra_get_resource %s:%s",name,v);
1951 /* moved from zebra_api_ext.c by pop */
1952 /* FIXME: Should this really be public??? -Heikki */
1954 int zebra_trans_no (ZebraHandle zh)
1957 yaz_log(log_level, "zebra_trans_no");
1958 return zh->trans_no;
1961 int zebra_get_shadow_enable (ZebraHandle zh)
1964 yaz_log(log_level, "zebra_get_shadow_enable");
1965 return (zh->shadow_enable);
1968 int zebra_set_shadow_enable (ZebraHandle zh, int value)
1971 yaz_log(log_level, "zebra_set_shadow_enable %d",value);
1972 zh->shadow_enable = value;
1976 /* Used by Perl API.. Added the record buffer dup to zebra_records_retrieve
1977 so that it's identicical to the original api_records_retrieve */
1978 void api_records_retrieve (ZebraHandle zh, ODR stream,
1979 const char *setname, Z_RecordComposition *comp,
1980 oid_value input_format, int num_recs,
1981 ZebraRetrievalRecord *recs)
1983 zebra_records_retrieve(zh, stream, setname, comp, input_format,
1987 /* ---------------------------------------------------------------------------
1988 Record insert(=update), delete
1990 If sysno is provided, then it's used to identify the record.
1991 If not, and match_criteria is provided, then sysno is guessed
1992 If not, and a record is provided, then sysno is got from there
1993 NOTE: Now returns 0 at success and updates sysno, which is an int*
1997 int zebra_add_record(ZebraHandle zh,
1998 const char *buf, int buf_size)
2001 return zebra_update_record(zh, 0, &sysno, 0, 0, buf, buf_size, 0);
2004 int zebra_insert_record (ZebraHandle zh,
2005 const char *recordType,
2006 SYSNO *sysno, const char *match, const char *fname,
2007 const char *buf, int buf_size, int force_update)
2013 yaz_log(log_level, "zebra_insert_record sysno=" ZINT_FORMAT, *sysno);
2016 buf_size = strlen(buf);
2018 if (zebra_begin_trans(zh, 1))
2020 res = buffer_extract_record (zh, buf, buf_size,
2021 0, /* delete_flag */
2027 0); /* allow_update */
2028 zebra_end_trans(zh);
2032 int zebra_update_record (ZebraHandle zh,
2033 const char *recordType,
2034 SYSNO* sysno, const char *match, const char *fname,
2035 const char *buf, int buf_size,
2043 yaz_log(log_level, "zebra_update_record sysno=" ZINT_FORMAT, *sysno);
2045 if (buf_size < 1) buf_size = strlen(buf);
2047 if (zebra_begin_trans(zh, 1))
2049 res = buffer_extract_record (zh, buf, buf_size,
2050 0, /* delete_flag */
2056 1); /* allow_update */
2057 zebra_end_trans(zh);
2061 int zebra_delete_record (ZebraHandle zh,
2062 const char *recordType,
2063 SYSNO *sysno, const char *match, const char *fname,
2064 const char *buf, int buf_size,
2071 yaz_log(log_level, "zebra_delete_record sysno=" ZINT_FORMAT, *sysno);
2073 if (buf_size < 1) buf_size = strlen(buf);
2075 if (zebra_begin_trans(zh, 1))
2077 res = buffer_extract_record (zh, buf, buf_size,
2078 1, /* delete_flag */
2084 1); /* allow_update */
2085 zebra_end_trans(zh);
2089 /* ---------------------------------------------------------------------------
2093 int zebra_search_PQF (ZebraHandle zh, const char *pqf_query,
2094 const char *setname, zint *numhits)
2099 ODR odr = odr_createmem(ODR_ENCODE);
2104 yaz_log(log_level, "zebra_search_PQF s=%s q=%s",setname, pqf_query);
2106 query = p_query_rpn (odr, PROTO_Z3950, pqf_query);
2109 yaz_log (YLOG_WARN, "bad query %s\n", pqf_query);
2111 res = zebra_search_RPN (zh, odr, query, setname, &hits);
2115 yaz_log(log_level, "Hits: " ZINT_FORMAT, hits);
2123 /* ---------------------------------------------------------------------------
2124 Sort - a simplified interface, with optional read locks.
2126 int zebra_sort_by_specstr (ZebraHandle zh, ODR stream,
2127 const char *sort_spec,
2128 const char *output_setname,
2129 const char **input_setnames)
2131 int num_input_setnames = 0;
2132 int sort_status = 0;
2133 Z_SortKeySpecList *sort_sequence;
2137 assert(output_setname);
2138 assert(input_setnames);
2139 sort_sequence = yaz_sort_spec (stream, sort_spec);
2140 yaz_log(log_level, "sort (FIXME) ");
2143 yaz_log(YLOG_WARN, "invalid sort specs '%s'", sort_spec);
2148 /* we can do this, since the perl typemap code for char** will
2149 put a NULL at the end of list */
2150 while (input_setnames[num_input_setnames]) num_input_setnames++;
2152 if (zebra_begin_read (zh))
2155 resultSetSort (zh, stream->mem, num_input_setnames, input_setnames,
2156 output_setname, sort_sequence, &sort_status);
2162 struct BFile_struct *zebra_get_bfs(ZebraHandle zh)
2165 return zh->reg->bfs;