1 /* $Id: zebraapi.c,v 1.140 2004-11-19 10:27:03 heikki Exp $
2 Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004
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);
53 static void zebra_chdir (ZebraService zs)
57 yaz_log(log_level,"zebra_chdir");
58 dir = res_get (zs->global_res, "chdir");
61 yaz_log (YLOG_DEBUG, "chdir %s", dir);
69 static void zebra_flush_reg (ZebraHandle zh)
72 yaz_log(log_level,"zebra_flush_reg");
74 zebraExplain_flush (zh->reg->zei, zh);
76 extract_flushWriteKeys (zh,1 /* final */);
77 zebra_index_merge (zh );
80 static struct zebra_register *zebra_register_open (ZebraService zs,
82 int rw, int useshadow,
84 const char *reg_path);
85 static void zebra_register_close (ZebraService zs, struct zebra_register *reg);
87 ZebraHandle zebra_open (ZebraService zs)
90 const char *default_encoding;
91 if (!log_level_initialized)
93 log_level=yaz_log_module_level("zebraapi");
94 log_level_initialized=1;
97 yaz_log(log_level,"zebra_open");
102 zh = (ZebraHandle) xmalloc (sizeof(*zh));
103 yaz_log (YLOG_DEBUG, "zebra_open zs=%p returns %p", zs, zh);
106 zh->reg = 0; /* no register attached yet */
114 zh->reg_name = xstrdup ("");
116 zh->num_basenames = 0;
125 zh->shadow_enable = 1;
127 default_encoding = res_get_def(zs->global_res, "encoding", "ISO-8859-1");
128 zh->record_encoding = xstrdup (default_encoding);
131 yaz_iconv_open ("UTF-8", default_encoding);
132 if (zh->iconv_to_utf8 == 0)
133 yaz_log (YLOG_WARN, "iconv: %s to UTF-8 unsupported",
135 zh->iconv_from_utf8 =
136 yaz_iconv_open (default_encoding, "UTF-8");
137 if (zh->iconv_to_utf8 == 0)
138 yaz_log (YLOG_WARN, "iconv: UTF-8 to %s unsupported",
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");
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");
330 if (!(reg->sortIdx = sortIdx_open (reg->bfs, rw)))
332 yaz_log (YLOG_WARN, "sortIdx_open");
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");
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");
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");
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");
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");
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);
458 xfree (reg->key_buf);
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);
533 xfree (zh->reg_name);
534 xfree (zh->user_perm);
535 zh->service=0; /* more likely to trigger an assert */
536 xfree (zh->path_reg);
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);
607 xfree (zh->reg_name);
608 zh->reg_name = xstrdup (new_reg);
610 xfree (zh->path_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 void map_basenames (ZebraHandle zh, ODR stream,
685 int *num_bases, char ***basenames)
687 struct map_baseinfo info;
688 struct map_baseinfo *p = &info;
691 yaz_log(log_level,"map_basenames ");
697 info.num_bases = *num_bases;
698 info.basenames = *basenames;
699 info.new_num_max = 128;
700 info.new_num_bases = 0;
701 info.new_basenames = (char **)
702 odr_malloc (stream, sizeof(*info.new_basenames) * info.new_num_max);
703 info.mem = stream->mem;
705 res_trav (zh->service->global_res, "mapdb", &info, map_basenames_func);
707 for (i = 0; i<p->num_bases; i++)
708 if (p->basenames[i] && p->new_num_bases < p->new_num_max)
710 p->new_basenames[(p->new_num_bases)++] =
711 nmem_strdup (p->mem, p->basenames[i]);
713 *num_bases = info.new_num_bases;
714 *basenames = info.new_basenames;
715 for (i = 0; i<*num_bases; i++)
716 yaz_log (YLOG_DEBUG, "base %s", (*basenames)[i]);
719 int zebra_select_database (ZebraHandle zh, const char *basename)
722 yaz_log(log_level,"zebra_select_database %s",basename);
725 return zebra_select_databases (zh, 1, &basename);
728 int zebra_select_databases (ZebraHandle zh, int num_bases,
729 const char **basenames)
738 yaz_log(log_level,"zebra_select_databases n=%d [0]=%s",
739 num_bases,basenames[0]);
747 for (i = 0; i < zh->num_basenames; i++)
748 xfree (zh->basenames[i]);
749 xfree (zh->basenames);
751 zh->num_basenames = num_bases;
752 zh->basenames = xmalloc (zh->num_basenames * sizeof(*zh->basenames));
753 for (i = 0; i < zh->num_basenames; i++)
754 zh->basenames[i] = xstrdup (basenames[i]);
756 cp = strrchr(basenames[0], '/');
759 len = cp - basenames[0];
760 new_reg = xmalloc (len + 1);
761 memcpy (new_reg, basenames[0], len);
765 new_reg = xstrdup ("");
766 for (i = 1; i<num_bases; i++)
770 cp1 = strrchr (basenames[i], '/');
778 if (len != cp1 - basenames[i] ||
779 memcmp (basenames[i], new_reg, len))
794 zebra_select_register (zh, new_reg);
801 if (!zh->lock_normal || !zh->lock_shadow)
809 int zebra_search_RPN (ZebraHandle zh, ODR o,
810 Z_RPNQuery *query, const char *setname, int *hits)
819 yaz_log(log_level,"zebra_search_rpn");
824 if (zebra_begin_read (zh))
827 resultSetAddRPN (zh, odr_extract_mem(o), query,
828 zh->num_basenames, zh->basenames, setname);
831 max = res_get (zh->res, "maxhits");
836 maxhits=INT_MAX; /* properly rounded, to make it look like a limit*/
837 while (maxhits>100) { maxhits/=10; i++;}
838 while (i--) maxhits *= 10;
840 if (zh->hits > maxhits) { /* too large for yaz to handle */
841 yaz_log(YLOG_DEBUG,"limiting hits to "ZINT_FORMAT, maxhits);
849 int zebra_records_retrieve (ZebraHandle zh, ODR stream,
850 const char *setname, Z_RecordComposition *comp,
851 oid_value input_format, int num_recs,
852 ZebraRetrievalRecord *recs)
855 int i, *pos_array, ret = 0;
862 yaz_log(log_level,"zebra_records_retrieve n=%d",num_recs);
868 zh->errString = odr_strdup (stream, setname);
874 if (zebra_begin_read (zh))
877 pos_array = (int *) xmalloc (num_recs * sizeof(*pos_array));
878 for (i = 0; i<num_recs; i++)
879 pos_array[i] = recs[i].position;
880 poset = zebraPosSetCreate (zh, setname, num_recs, pos_array);
883 yaz_log (YLOG_DEBUG, "zebraPosSetCreate error");
885 zh->errString = nmem_strdup (stream->mem, setname);
890 for (i = 0; i<num_recs; i++)
895 recs[i].format = VAL_SUTRS;
896 recs[i].len = strlen(poset[i].term);
897 recs[i].buf = poset[i].term;
898 recs[i].base = poset[i].db;
900 else if (poset[i].sysno)
903 zebra_record_fetch (zh, poset[i].sysno, poset[i].score,
904 stream, input_format, comp,
905 &recs[i].format, &recs[i].buf,
908 recs[i].errString = NULL;
909 recs[i].score=poset[i].score;
910 recs[i].sysno=poset[i].sysno;
916 sprintf (num_str, "%d", pos_array[i]);
918 zh->errString = odr_strdup (stream, num_str);
923 zebraPosSetDestroy (zh, poset, num_recs);
930 int zebra_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
931 oid_value attributeset,
932 int *position, int *num_entries, ZebraScanEntry **entries,
942 yaz_log(log_level,"zebra_scan");
944 if (zebra_begin_read (zh))
950 rpn_scan (zh, stream, zapt, attributeset,
951 zh->num_basenames, zh->basenames, position,
952 num_entries, entries, is_partial, 0, 0);
957 int zebra_sort (ZebraHandle zh, ODR stream,
958 int num_input_setnames, const char **input_setnames,
959 const char *output_setname, Z_SortKeySpecList *sort_sequence,
964 assert(num_input_setnames>0);
965 assert(input_setnames);
966 assert(sort_sequence);
968 yaz_log(log_level,"zebra_sort");
970 if (zebra_begin_read (zh))
972 resultSetSort (zh, stream->mem, num_input_setnames, input_setnames,
973 output_setname, sort_sequence, sort_status);
978 int zebra_deleleResultSet(ZebraHandle zh, int function,
979 int num_setnames, char **setnames,
984 assert(num_setnames>0);
987 yaz_log(log_level,"zebra_deleleResultSet n=%d",num_setnames);
989 if (zebra_begin_read(zh))
990 return Z_DeleteStatus_systemProblemAtTarget;
993 case Z_DeleteResultSetRequest_list:
994 resultSetDestroy (zh, num_setnames, setnames, statuses);
996 case Z_DeleteResultSetRequest_all:
997 resultSetDestroy (zh, -1, 0, statuses);
1000 zebra_end_read (zh);
1001 status = Z_DeleteStatus_success;
1002 for (i = 0; i<num_setnames; i++)
1003 if (statuses[i] == Z_DeleteStatus_resultSetDidNotExist)
1004 status = statuses[i];
1008 int zebra_errCode (ZebraHandle zh)
1012 yaz_log(log_level,"zebra_errCode: %d",zh->errCode);
1015 yaz_log(log_level,"zebra_errCode: o");
1019 const char *zebra_errString (ZebraHandle zh)
1023 e= diagbib1_str (zh->errCode);
1024 yaz_log(log_level,"zebra_errString: %s",e);
1028 char *zebra_errAdd (ZebraHandle zh)
1033 yaz_log(log_level,"zebra_errAdd: %s",a);
1037 void zebra_clearError(ZebraHandle zh)
1046 int zebra_auth (ZebraHandle zh, const char *user, const char *pass)
1056 sprintf(u, "perm.%.30s", user ? user : "anonymous");
1057 p = res_get(zs->global_res, u);
1058 xfree (zh->user_perm);
1059 zh->user_perm = xstrdup(p ? p : "r");
1061 /* users that don't require a password .. */
1062 if (zh->user_perm && strchr(zh->user_perm, 'a'))
1065 if (!zs->passwd_db || !passwd_db_auth (zs->passwd_db, user, pass))
1070 int zebra_admin_import_begin (ZebraHandle zh, const char *database,
1071 const char *record_type)
1074 yaz_log(log_level,"zebra_admin_import_begin db=%s rt=%s",
1075 database, record_type);
1077 if (zebra_select_database(zh, database))
1079 if (zebra_begin_trans (zh, 1))
1084 int zebra_admin_import_end (ZebraHandle zh)
1087 yaz_log(log_level,"zebra_admin_import_end");
1089 zebra_end_trans (zh);
1093 int zebra_admin_import_segment (ZebraHandle zh, Z_Segment *segment)
1098 yaz_log(log_level,"zebra_admin_import_segment");
1100 for (i = 0; i<segment->num_segmentRecords; i++)
1102 Z_NamePlusRecord *npr = segment->segmentRecords[i];
1104 printf ("--------------%d--------------------\n", i);
1105 /* FIXME - What! printing on stdout ??? */
1106 if (npr->which == Z_NamePlusRecord_intermediateFragment)
1108 Z_FragmentSyntax *fragment = npr->u.intermediateFragment;
1109 if (fragment->which == Z_FragmentSyntax_notExternallyTagged)
1111 Odr_oct *oct = fragment->u.notExternallyTagged;
1112 printf ("%.*s", (oct->len > 100 ? 100 : oct->len) ,
1117 zebra_update_record(zh,
1118 0, /* record Type */
1130 int zebra_admin_exchange_record (ZebraHandle zh,
1131 const char *rec_buf,
1133 const char *recid_buf, size_t recid_len,
1135 /* 1 = insert. Fail it already exists */
1136 /* 2 = replace. Fail it does not exist */
1137 /* 3 = delete. Fail if does not exist */
1138 /* 4 = update. Insert/replace */
1144 assert(action>0 && action <=4);
1147 yaz_log(log_level,"zebra_admin_exchange_record ac=%d", action);
1150 if (!recid_buf || recid_len <= 0 || recid_len >= sizeof(recid_z))
1152 memcpy (recid_z, recid_buf, recid_len);
1153 recid_z[recid_len] = 0;
1155 if (zebra_begin_trans(zh, 1))
1158 rinfo = dict_lookup (zh->reg->matchDict, recid_z);
1161 if (action == 1) /* fail if insert */
1163 zebra_end_trans(zh);
1167 memcpy (&sysno, rinfo+1, sizeof(sysno));
1171 if (action == 2 || action == 3) /* fail if delete or update */
1173 zebra_end_trans(zh);
1176 action = 1; /* make it an insert (if it's an update).. */
1178 buffer_extract_record (zh, rec_buf, rec_len,
1179 action == 3 ? 1 : 0 /* delete flag */,
1185 0, /* force update */
1186 1 /* allow update */
1190 dict_insert (zh->reg->matchDict, recid_z, sizeof(sysno), &sysno);
1192 else if (action == 3)
1194 dict_delete (zh->reg->matchDict, recid_z);
1196 zebra_end_trans(zh);
1200 int delete_w_handle(const char *info, void *handle)
1202 ZebraHandle zh = (ZebraHandle) handle;
1206 if (*info == sizeof(pos))
1208 memcpy (&pos, info+1, sizeof(pos));
1209 isamb_unlink(zh->reg->isamb, pos);
1214 static int delete_SU_handle(void *handle, int ord)
1216 ZebraHandle zh = (ZebraHandle) handle;
1220 ord_len = key_SU_encode (ord, ord_buf);
1221 ord_buf[ord_len] = '\0';
1223 assert (zh->reg->isamb);
1224 dict_delete_subtree(zh->reg->dict, ord_buf,
1225 zh, delete_w_handle);
1229 int zebra_drop_database (ZebraHandle zh, const char *database)
1233 yaz_log(log_level,"zebra_drop_database");
1236 if (zebra_select_database (zh, database))
1238 if (zebra_begin_trans (zh, 1))
1242 zebraExplain_curDatabase (zh->reg->zei, database);
1244 zebraExplain_trav_ord(zh->reg->zei, zh, delete_SU_handle);
1245 zebraExplain_removeDatabase(zh->reg->zei, zh);
1249 yaz_log(YLOG_WARN, "drop database only supported for isam:b");
1252 zebra_end_trans (zh);
1256 int zebra_create_database (ZebraHandle zh, const char *database)
1259 yaz_log(log_level,"zebra_create_database %s",database);
1263 if (zebra_select_database (zh, database))
1265 if (zebra_begin_trans (zh, 1))
1268 /* announce database */
1269 if (zebraExplain_newDatabase (zh->reg->zei, database, 0
1270 /* explainDatabase */))
1272 zebra_end_trans (zh);
1274 zh->errString = "database already exist";
1277 zebra_end_trans (zh);
1281 int zebra_string_norm (ZebraHandle zh, unsigned reg_id,
1282 const char *input_str, int input_len,
1283 char *output_str, int output_len)
1289 yaz_log(log_level,"zebra_string_norm ");
1291 if (!zh->reg->zebra_maps)
1293 wrbuf = zebra_replace(zh->reg->zebra_maps, reg_id, "",
1294 input_str, input_len);
1297 if (wrbuf_len(wrbuf) >= output_len)
1299 if (wrbuf_len(wrbuf))
1300 memcpy (output_str, wrbuf_buf(wrbuf), wrbuf_len(wrbuf));
1301 output_str[wrbuf_len(wrbuf)] = '\0';
1302 return wrbuf_len(wrbuf);
1306 int zebra_set_state (ZebraHandle zh, int val, int seqno)
1307 /* FIXME - zint seqno ?? */
1309 char state_fname[256];
1314 yaz_log(log_level,"zebra_set_state v=%d seq=%d", val, seqno);
1317 sprintf (state_fname, "state.%s.LCK", zh->reg_name);
1318 fname = zebra_mk_fname (res_get(zh->res, "lockDir"), state_fname);
1319 f = fopen (fname, "w");
1321 yaz_log (YLOG_DEBUG, "zebra_set_state: %c %d %ld", val, seqno, p);
1322 fprintf (f, "%c %d %ld\n", val, seqno, p);
1328 int zebra_get_state (ZebraHandle zh, char *val, int *seqno)
1330 char state_fname[256];
1335 yaz_log(log_level,"zebra_get_state ");
1337 sprintf (state_fname, "state.%s.LCK", zh->reg_name);
1338 fname = zebra_mk_fname (res_get(zh->res, "lockDir"), state_fname);
1339 f = fopen (fname, "r");
1345 fscanf (f, "%c %d", val, seqno);
1352 int zebra_begin_read (ZebraHandle zh)
1354 return zebra_begin_trans(zh, 0);
1357 int zebra_end_read (ZebraHandle zh)
1359 return zebra_end_trans(zh);
1362 static void read_res_for_transaction(ZebraHandle zh)
1364 const char *group = res_get(zh->res, "group");
1366 /* FIXME - do we still use groups ?? */
1368 zh->m_group = group;
1369 v = res_get_prefix(zh->res, "followLinks", group, "1");
1370 zh->m_follow_links = atoi(v);
1372 zh->m_record_id = res_get_prefix(zh->res, "recordId", group, 0);
1373 zh->m_record_type = res_get_prefix(zh->res, "recordType", group, 0);
1375 v = res_get_prefix(zh->res, "storeKeys", group, "1");
1376 zh->m_store_keys = atoi(v);
1378 v = res_get_prefix(zh->res, "storeData", group, "1");
1379 zh->m_store_data = atoi(v);
1381 v = res_get_prefix(zh->res, "explainDatabase", group, "0");
1382 zh->m_explain_database = atoi(v);
1384 v = res_get_prefix(zh->res, "openRW", group, "1");
1385 zh->m_flag_rw = atoi(v);
1387 v = res_get_prefix(zh->res, "fileVerboseLimit", group, "100000");
1388 zh->m_file_verbose_limit = atoi(v);
1391 int zebra_begin_trans (ZebraHandle zh, int rw)
1397 zh->errString = "zebra_begin_trans: no database selected";
1401 yaz_log(log_level,"zebra_begin_trans rw=%d",rw);
1405 if (rw && !strchr(zh->user_perm, 'w'))
1419 const char *rval = 0;
1424 read_res_for_transaction(zh);
1427 if (zh->trans_no != 1)
1430 zh->errString = "zebra_begin_trans: write trans not allowed within read trans";
1435 resultSetInvalidate (zh);
1436 zebra_register_close (zh->service, zh->reg);
1438 zh->trans_w_no = zh->trans_no;
1442 zh->records_inserted = 0;
1443 zh->records_updated = 0;
1444 zh->records_deleted = 0;
1445 zh->records_processed = 0;
1447 #if HAVE_SYS_TIMES_H
1451 if (zh->shadow_enable)
1452 rval = res_get (zh->res, "shadow");
1454 for (pass = 0; pass < 2; pass++)
1458 zebra_lock_r (zh->lock_normal);
1459 zebra_lock_w (zh->lock_shadow);
1463 zebra_lock_w (zh->lock_normal);
1464 zebra_lock_w (zh->lock_shadow);
1467 zebra_get_state (zh, &val, &seqno);
1470 yaz_log (YLOG_WARN, "previous transaction didn't finish commit");
1471 zebra_unlock (zh->lock_shadow);
1472 zebra_unlock (zh->lock_normal);
1476 else if (val == 'd')
1480 BFiles bfs = bfs_create (res_get (zh->res, "shadow"),
1482 yaz_log (YLOG_WARN, "previous transaction didn't reach commit");
1483 bf_commitClean (bfs, rval);
1488 yaz_log (YLOG_WARN, "your previous transaction didn't finish");
1495 yaz_log (YLOG_FATAL, "zebra_begin_trans couldn't finish commit");
1499 zebra_set_state (zh, 'd', seqno);
1501 zh->reg = zebra_register_open (zh->service, zh->reg_name,
1502 1, rval ? 1 : 0, zh->res,
1505 zh->reg->seqno = seqno;
1508 zebra_set_state (zh, 'o', seqno);
1510 zebra_unlock (zh->lock_shadow);
1511 zebra_unlock (zh->lock_normal);
1517 zh->errString = "zebra_begin_trans: cannot open register";
1518 yaz_log(YLOG_FATAL, zh->errString);
1530 if (zh->trans_no != 1)
1532 zebra_flush_reg (zh);
1536 #if HAVE_SYS_TIMES_H
1545 if (!zh->lock_normal || !zh->lock_shadow)
1551 zebra_get_state (zh, &val, &seqno);
1557 else if (seqno != zh->reg->seqno)
1559 yaz_log (YLOG_DEBUG, "reopen seqno cur/old %d/%d",
1560 seqno, zh->reg->seqno);
1563 else if (zh->reg->last_val != val)
1565 yaz_log (YLOG_DEBUG, "reopen last cur/old %d/%d",
1566 val, zh->reg->last_val);
1573 zebra_lock_r (zh->lock_shadow);
1575 zebra_lock_r (zh->lock_normal);
1579 resultSetInvalidate (zh);
1580 zebra_register_close (zh->service, zh->reg);
1582 zh->reg = zebra_register_open (zh->service, zh->reg_name,
1583 0, val == 'c' ? 1 : 0,
1584 zh->res, zh->path_reg);
1587 zebra_unlock (zh->lock_normal);
1588 zebra_unlock (zh->lock_shadow);
1593 zh->reg->last_val = val;
1594 zh->reg->seqno = seqno;
1596 read_res_for_transaction(zh);
1600 int zebra_end_trans (ZebraHandle zh)
1602 ZebraTransactionStatus dummy;
1604 yaz_log(log_level,"zebra_end_trans");
1605 return zebra_end_transaction(zh, &dummy);
1608 int zebra_end_transaction (ZebraHandle zh, ZebraTransactionStatus *status)
1616 yaz_log(log_level,"zebra_end_transaction");
1618 status->processed = 0;
1619 status->inserted = 0;
1620 status->updated = 0;
1621 status->deleted = 0;
1625 if (!zh->res || !zh->reg)
1628 zh->errString = "zebra_end_trans: no open transaction";
1631 if (zh->trans_no != zh->trans_w_no)
1634 if (zh->trans_no != 0)
1637 /* release read lock */
1639 zebra_unlock (zh->lock_normal);
1640 zebra_unlock (zh->lock_shadow);
1643 { /* release write lock */
1647 yaz_log (YLOG_DEBUG, "zebra_end_trans");
1648 rval = res_get (zh->res, "shadow");
1650 zebraExplain_runNumberIncrement (zh->reg->zei, 1);
1652 zebra_flush_reg (zh);
1654 resultSetInvalidate (zh);
1656 zebra_register_close (zh->service, zh->reg);
1659 yaz_log (YLOG_LOG, "Records: "ZINT_FORMAT" i/u/d "
1660 ZINT_FORMAT"/"ZINT_FORMAT"/"ZINT_FORMAT,
1661 zh->records_processed, zh->records_inserted,
1662 zh->records_updated, zh->records_deleted);
1664 status->processed = zh->records_processed;
1665 status->inserted = zh->records_inserted;
1666 status->updated = zh->records_updated;
1667 status->deleted = zh->records_deleted;
1669 zebra_get_state (zh, &val, &seqno);
1672 BFiles bfs = bfs_create (rval, zh->path_reg);
1673 yaz_log (YLOG_DEBUG, "deleting shadow val=%c", val);
1674 bf_commitClean (bfs, rval);
1679 zebra_set_state (zh, 'o', seqno);
1681 zebra_unlock (zh->lock_shadow);
1682 zebra_unlock (zh->lock_normal);
1685 #if HAVE_SYS_TIMES_H
1687 yaz_log (YLOG_LOG, "user/system: %ld/%ld",
1688 (long) (zh->tms2.tms_utime - zh->tms1.tms_utime),
1689 (long) (zh->tms2.tms_stime - zh->tms1.tms_stime));
1691 status->utime = (long) (zh->tms2.tms_utime - zh->tms1.tms_utime);
1692 status->stime = (long) (zh->tms2.tms_stime - zh->tms1.tms_stime);
1697 int zebra_repository_update (ZebraHandle zh, const char *path)
1702 yaz_log (log_level, "updating %s", path);
1703 repositoryUpdate (zh, path);
1707 int zebra_repository_delete (ZebraHandle zh, const char *path)
1712 yaz_log (log_level, "deleting %s", path);
1713 repositoryDelete (zh, path);
1717 int zebra_repository_show (ZebraHandle zh, const char *path)
1721 yaz_log(log_level,"zebra_repository_show");
1723 repositoryShow (zh, path);
1727 static int zebra_commit_ex (ZebraHandle zh, int clean_only)
1741 rval = res_get (zh->res, "shadow");
1744 yaz_log (YLOG_WARN, "Cannot perform commit");
1745 yaz_log (YLOG_WARN, "No shadow area defined");
1749 zebra_lock_w (zh->lock_normal);
1750 zebra_lock_r (zh->lock_shadow);
1752 bfs = bfs_create (res_get (zh->res, "register"), zh->path_reg);
1754 zebra_get_state (zh, &val, &seqno);
1757 bf_cache (bfs, rval);
1758 if (bf_commitExists (bfs))
1761 zebra_set_state (zh, 'd', seqno);
1764 zebra_set_state (zh, 'c', seqno);
1766 yaz_log (YLOG_DEBUG, "commit start");
1767 bf_commitExec (bfs);
1772 yaz_log (YLOG_DEBUG, "commit clean");
1773 bf_commitClean (bfs, rval);
1775 zebra_set_state (zh, 'o', seqno);
1779 yaz_log (YLOG_LOG, "nothing to commit");
1783 zebra_unlock (zh->lock_shadow);
1784 zebra_unlock (zh->lock_normal);
1788 int zebra_clean (ZebraHandle zh)
1791 yaz_log(log_level,"zebra_clean");
1792 return zebra_commit_ex(zh, 1);
1795 int zebra_commit (ZebraHandle zh)
1798 yaz_log(log_level,"zebra_commit");
1799 return zebra_commit_ex(zh, 0);
1802 int zebra_init (ZebraHandle zh)
1807 yaz_log(log_level,"zebra_init");
1815 rval = res_get (zh->res, "shadow");
1817 bfs = bfs_create (res_get (zh->service->global_res, "register"),
1822 bf_cache (bfs, rval);
1826 zebra_set_state (zh, 'o', 0);
1830 int zebra_compact (ZebraHandle zh)
1834 yaz_log(log_level,"zebra_compact");
1841 bfs = bfs_create (res_get (zh->res, "register"), zh->path_reg);
1847 int zebra_result (ZebraHandle zh, int *code, char **addinfo)
1850 yaz_log(log_level,"zebra_result");
1851 *code = zh->errCode;
1852 *addinfo = zh->errString;
1856 int zebra_shadow_enable (ZebraHandle zh, int value)
1859 yaz_log(log_level,"zebra_shadow_enable");
1861 zh->shadow_enable = value;
1865 int zebra_record_encoding (ZebraHandle zh, const char *encoding)
1869 yaz_log(log_level,"zebra_record_encoding");
1871 xfree (zh->record_encoding);
1875 * Something about charset aliases. Oleg???
1878 if (zh->iconv_to_utf8 != 0)
1879 yaz_iconv_close(zh->iconv_to_utf8);
1880 if (zh->iconv_from_utf8 != 0)
1881 yaz_iconv_close(zh->iconv_from_utf8);
1883 zh->record_encoding = xstrdup (encoding);
1885 yaz_log(YLOG_DEBUG, "Reset record encoding: %s", encoding);
1888 yaz_iconv_open ("UTF-8", encoding);
1889 if (zh->iconv_to_utf8 == 0)
1890 yaz_log (YLOG_WARN, "iconv: %s to UTF-8 unsupported", encoding);
1891 zh->iconv_from_utf8 =
1892 yaz_iconv_open (encoding, "UTF-8");
1893 if (zh->iconv_to_utf8 == 0)
1894 yaz_log (YLOG_WARN, "iconv: UTF-8 to %s unsupported", encoding);
1899 int zebra_set_resource(ZebraHandle zh, const char *name, const char *value)
1904 yaz_log(log_level,"zebra_set_resource %s:%s",name,value);
1906 res_set(zh->res, name, value);
1910 const char *zebra_get_resource(ZebraHandle zh,
1911 const char *name, const char *defaultvalue)
1916 assert(defaultvalue);
1917 v= res_get_def( zh->res, name, (char *)defaultvalue);
1919 yaz_log(log_level,"zebra_get_resource %s:%s",name,v);
1923 /* moved from zebra_api_ext.c by pop */
1924 /* FIXME: Should this really be public??? -Heikki */
1926 int zebra_trans_no (ZebraHandle zh)
1929 yaz_log(log_level,"zebra_trans_no");
1930 return zh->trans_no;
1933 int zebra_get_shadow_enable (ZebraHandle zh)
1936 yaz_log(log_level,"zebra_get_shadow_enable");
1937 return (zh->shadow_enable);
1940 int zebra_set_shadow_enable (ZebraHandle zh, int value)
1943 yaz_log(log_level,"zebra_set_shadow_enable %d",value);
1944 zh->shadow_enable = value;
1948 /* almost the same as zebra_records_retrieve ... but how did it work?
1949 I mean for multiple records ??? CHECK ??? */
1950 void api_records_retrieve (ZebraHandle zh, ODR stream,
1951 const char *setname, Z_RecordComposition *comp,
1952 oid_value input_format, int num_recs,
1953 ZebraRetrievalRecord *recs)
1963 yaz_log(log_level,"api_records_retrieve s=%s n=%d",setname,num_recs);
1968 zh->errString = odr_strdup (stream, setname);
1974 if (zebra_begin_read (zh))
1977 pos_array = (int *) xmalloc (num_recs * sizeof(*pos_array));
1978 for (i = 0; i<num_recs; i++)
1979 pos_array[i] = recs[i].position;
1980 poset = zebraPosSetCreate (zh, setname, num_recs, pos_array);
1983 yaz_log (YLOG_DEBUG, "zebraPosSetCreate error");
1985 zh->errString = nmem_strdup (stream->mem, setname);
1989 for (i = 0; i<num_recs; i++)
1993 recs[i].errCode = 0;
1994 recs[i].format = VAL_SUTRS;
1995 recs[i].len = strlen(poset[i].term);
1996 recs[i].buf = poset[i].term;
1997 recs[i].base = poset[i].db;
2001 else if (poset[i].sysno)
2003 /* changed here ??? CHECK ??? */
2006 zebra_record_fetch (zh, poset[i].sysno, poset[i].score,
2007 stream, input_format, comp,
2012 recs[i].buf = (char *) odr_malloc(stream,recs[i].len);
2013 memcpy(recs[i].buf, b, recs[i].len);
2014 recs[i].errString = 0; /* Hmmm !!! we should get this */
2015 recs[i].sysno = poset[i].sysno;
2016 recs[i].score = poset[i].score;
2022 sprintf (num_str, "%d", pos_array[i]);
2024 zh->errString = odr_strdup (stream, num_str);
2029 zebraPosSetDestroy (zh, poset, num_recs);
2031 zebra_end_read (zh);
2036 /* ---------------------------------------------------------------------------
2037 Record insert(=update), delete
2039 If sysno is provided, then it's used to identify the record.
2040 If not, and match_criteria is provided, then sysno is guessed
2041 If not, and a record is provided, then sysno is got from there
2042 NOTE: Now returns 0 at success and updates sysno, which is an int*
2046 int zebra_add_record(ZebraHandle zh,
2047 const char *buf, int buf_size)
2050 return zebra_update_record(zh, 0, &sysno, 0, 0, buf, buf_size, 0);
2053 int zebra_insert_record (ZebraHandle zh,
2054 const char *recordType,
2055 SYSNO *sysno, const char *match, const char *fname,
2056 const char *buf, int buf_size, int force_update)
2062 yaz_log(log_level, "zebra_insert_record sysno=" ZINT_FORMAT, *sysno);
2064 if (buf_size < 1) buf_size = strlen(buf);
2066 if (zebra_begin_trans(zh, 1))
2068 res = buffer_extract_record (zh, buf, buf_size,
2069 0, /* delete_flag */
2075 0); /* allow_update */
2076 zebra_end_trans(zh);
2080 int zebra_update_record (ZebraHandle zh,
2081 const char *recordType,
2082 SYSNO* sysno, const char *match, const char *fname,
2083 const char *buf, int buf_size,
2091 yaz_log(log_level, "zebra_update_record sysno=" ZINT_FORMAT, *sysno);
2093 if (buf_size < 1) buf_size = strlen(buf);
2095 if (zebra_begin_trans(zh, 1))
2097 res = buffer_extract_record (zh, buf, buf_size,
2098 0, /* delete_flag */
2104 1); /* allow_update */
2105 zebra_end_trans(zh);
2109 int zebra_delete_record (ZebraHandle zh,
2110 const char *recordType,
2111 SYSNO *sysno, const char *match, const char *fname,
2112 const char *buf, int buf_size,
2119 yaz_log(log_level, "zebra_delete_record sysno=" ZINT_FORMAT, *sysno);
2121 if (buf_size < 1) buf_size = strlen(buf);
2123 if (zebra_begin_trans(zh, 1))
2125 res = buffer_extract_record (zh, buf, buf_size,
2126 1, /* delete_flag */
2132 1); /* allow_update */
2133 zebra_end_trans(zh);
2137 /* ---------------------------------------------------------------------------
2141 int zebra_search_PQF (ZebraHandle zh, const char *pqf_query,
2142 const char *setname, int *numhits)
2147 ODR odr = odr_createmem(ODR_ENCODE);
2152 yaz_log(log_level,"zebra_search_PQF s=%s q=%s",setname, pqf_query);
2154 query = p_query_rpn (odr, PROTO_Z3950, pqf_query);
2157 yaz_log (YLOG_WARN, "bad query %s\n", pqf_query);
2159 res=zebra_search_RPN (zh, odr, query, setname, &hits);
2163 yaz_log(log_level,"Hits: %d",hits);
2171 /* ---------------------------------------------------------------------------
2172 Sort - a simplified interface, with optional read locks.
2174 int zebra_sort_by_specstr (ZebraHandle zh,
2176 const char *sort_spec,
2177 const char *output_setname,
2178 const char **input_setnames)
2180 int num_input_setnames = 0;
2181 int sort_status = 0;
2182 Z_SortKeySpecList *sort_sequence;
2186 assert(output_setname);
2187 assert(input_setnames);
2188 sort_sequence = yaz_sort_spec (stream, sort_spec);
2189 yaz_log(log_level,"sort (FIXME) ");
2192 yaz_log(YLOG_WARN,"invalid sort specs '%s'", sort_spec);
2197 /* we can do this, since the perl typemap code for char** will
2198 put a NULL at the end of list */
2199 while (input_setnames[num_input_setnames]) num_input_setnames++;
2201 if (zebra_begin_read (zh))
2204 resultSetSort (zh, stream->mem, num_input_setnames, input_setnames,
2205 output_setname, sort_sequence, &sort_status);