1 /* $Id: zebraapi.c,v 1.111 2003-07-07 13:55:37 pop Exp $
2 Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003
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 /* simple asserts to validate the most essential input args */
43 #define ASSERTZH assert(zh && zh->service)
44 #define ASSERTZHRES assert(zh && zh->service && zh->res)
45 #define ASSERTZS assert(zs)
47 /* A simple log macro */
48 /* don't break with older yazen that lack log_app2 */
50 #define LOG_API LOG_APP2
52 #define LOG_API LOG_DEBUG
55 static Res zebra_open_res (ZebraHandle zh);
56 static void zebra_close_res (ZebraHandle zh);
59 static void zebra_chdir (ZebraService zs)
63 yaz_log(LOG_API,"zebra_chdir");
64 dir = res_get (zs->global_res, "chdir");
67 logf (LOG_DEBUG, "chdir %s", dir);
75 static void zebra_flush_reg (ZebraHandle zh)
78 yaz_log(LOG_API,"zebra_flush_reg");
80 zebraExplain_flush (zh->reg->zei, zh);
82 extract_flushWriteKeys (zh);
83 zebra_index_merge (zh);
86 static struct zebra_register *zebra_register_open (ZebraService zs,
88 int rw, int useshadow,
90 const char *reg_path);
91 static void zebra_register_close (ZebraService zs, struct zebra_register *reg);
93 ZebraHandle zebra_open (ZebraService zs)
96 const char *default_encoding;
98 yaz_log(LOG_API,"zebra_open");
103 zh = (ZebraHandle) xmalloc (sizeof(*zh));
104 yaz_log (LOG_DEBUG, "zebra_open zs=%p returns %p", zs, zh);
107 zh->reg = 0; /* no register attached yet */
114 zh->reg_name = xstrdup ("");
116 zh->num_basenames = 0;
125 zh->admin_databaseName = 0;
127 zh->shadow_enable = 1;
129 default_encoding = res_get_def(zs->global_res, "encoding", "ISO-8859-1");
130 zh->record_encoding = xstrdup (default_encoding);
133 yaz_iconv_open ("UTF-8", default_encoding);
134 if (zh->iconv_to_utf8 == 0)
135 yaz_log (LOG_WARN, "iconv: %s to UTF-8 unsupported",
137 zh->iconv_from_utf8 =
138 yaz_iconv_open (default_encoding, "UTF-8");
139 if (zh->iconv_to_utf8 == 0)
140 yaz_log (LOG_WARN, "iconv: UTF-8 to %s unsupported",
143 zebra_mutex_cond_lock (&zs->session_lock);
145 zh->next = zs->sessions;
148 zebra_mutex_cond_unlock (&zs->session_lock);
153 ZebraService zebra_start (const char *configName)
157 yaz_log(LOG_API|LOG_LOG,"zebra_start %s",configName);
159 if ((res = res_open (configName, 0)))
161 ZebraService zh = xmalloc (sizeof(*zh));
163 yaz_log (LOG_DEBUG, "Read resources `%s'", configName);
165 zh->global_res = res;
166 zh->configName = xstrdup(configName);
171 zebra_mutex_cond_init (&zh->session_lock);
172 if (!res_get (zh->global_res, "passwd"))
173 zh->passwd_db = NULL;
176 zh->passwd_db = passwd_db_open ();
178 logf (LOG_WARN|LOG_ERRNO, "passwd_db_open failed");
180 passwd_db_file (zh->passwd_db,
181 res_get (zh->global_res, "passwd"));
183 zh->path_root = res_get (zh->global_res, "root");
190 struct zebra_register *zebra_register_open (ZebraService zs, const char *name,
191 int rw, int useshadow, Res res,
192 const char *reg_path)
194 struct zebra_register *reg;
195 int record_compression = REC_COMPRESS_NONE;
196 char *recordCompression = 0;
200 reg = xmalloc (sizeof(*reg));
203 reg->name = xstrdup (name);
210 yaz_log (LOG_LOG|LOG_API, "zebra_register_open rw = %d useshadow=%d p=%p,n=%s,rp=%s",
211 rw, useshadow, reg, name, reg_path ? reg_path : "(none)");
213 reg->dh = data1_createx (DATA1_FLAG_XML);
216 reg->bfs = bfs_create (res_get (res, "register"), reg_path);
219 data1_destroy(reg->dh);
223 bf_cache (reg->bfs, res_get (res, "shadow"));
224 data1_set_tabpath (reg->dh, res_get_def(res, "profilePath",
225 DEFAULT_PROFILE_PATH));
226 data1_set_tabroot (reg->dh, reg_path);
227 reg->recTypes = recTypes_init (reg->dh);
228 recTypes_default_handlers (reg->recTypes);
230 reg->zebra_maps = zebra_maps_open (res, reg_path);
231 reg->rank_classes = NULL;
235 reg->keys.buf_max = 0;
237 reg->sortKeys.buf = 0;
238 reg->sortKeys.buf_max = 0;
251 reg->key_file_no = 0;
253 zebraRankInstall (reg, rank1_class);
254 zebraRankInstall (reg, rankzv_class);
255 zebraRankInstall (reg, rankliv_class);
257 recordCompression = res_get_def (res, "recordCompression", "none");
258 if (!strcmp (recordCompression, "none"))
259 record_compression = REC_COMPRESS_NONE;
260 if (!strcmp (recordCompression, "bzip2"))
261 record_compression = REC_COMPRESS_BZIP2;
263 if (!(reg->records = rec_open (reg->bfs, rw, record_compression)))
265 logf (LOG_WARN, "rec_open");
270 reg->matchDict = dict_open (reg->bfs, GMATCH_DICT, 20, 1, 0);
272 if (!(reg->dict = dict_open (reg->bfs, FNAME_DICT, 40, rw, 0)))
274 logf (LOG_WARN, "dict_open");
277 if (!(reg->sortIdx = sortIdx_open (reg->bfs, rw)))
279 logf (LOG_WARN, "sortIdx_open");
282 if (res_get_match (res, "isam", "s", ISAM_DEFAULT))
284 struct ISAMS_M_s isams_m;
285 if (!(reg->isams = isams_open (reg->bfs, FNAME_ISAMS, rw,
286 key_isams_m(res, &isams_m))))
288 logf (LOG_WARN, "isams_open");
292 if (res_get_match (res, "isam", "i", ISAM_DEFAULT))
294 if (!(reg->isam = is_open (reg->bfs, FNAME_ISAM, key_compare, rw,
295 sizeof (struct it_key), res)))
297 logf (LOG_WARN, "is_open");
301 if (res_get_match (res, "isam", "c", ISAM_DEFAULT))
303 struct ISAMC_M_s isamc_m;
304 if (!(reg->isamc = isc_open (reg->bfs, FNAME_ISAMC,
305 rw, key_isamc_m(res, &isamc_m))))
307 logf (LOG_WARN, "isc_open");
311 if (res_get_match (res, "isam", "d", ISAM_DEFAULT))
313 struct ISAMD_M_s isamd_m;
315 if (!(reg->isamd = isamd_open (reg->bfs, FNAME_ISAMD,
316 rw, key_isamd_m(res, &isamd_m))))
318 logf (LOG_WARN, "isamd_open");
322 if (res_get_match (res, "isam", "b", ISAM_DEFAULT))
324 struct ISAMC_M_s isamc_m;
326 if (!(reg->isamb = isamb_open (reg->bfs, "isamb",
327 rw, key_isamc_m(res, &isamc_m), 0)))
329 logf (LOG_WARN, "isamb_open");
333 if (res_get_match (res, "isam", "bc", ISAM_DEFAULT))
335 struct ISAMC_M_s isamc_m;
337 if (!(reg->isamb = isamb_open (reg->bfs, "isamb",
338 rw, key_isamc_m(res, &isamc_m), 1)))
340 logf (LOG_WARN, "isamb_open");
344 if (res_get_match (res, "isam", "null", ISAM_DEFAULT))
346 struct ISAMC_M_s isamc_m;
348 if (!(reg->isamb = isamb_open (reg->bfs, "isamb",
349 rw, key_isamc_m(res, &isamc_m), -1)))
351 logf (LOG_WARN, "isamb_open");
355 reg->zei = zebraExplain_open (reg->records, reg->dh,
360 logf (LOG_WARN, "Cannot obtain EXPLAIN information");
364 yaz_log (LOG_DEBUG, "zebra_register_open ok p=%p", reg);
368 int zebra_admin_shutdown (ZebraHandle zh)
371 yaz_log(LOG_API,"zebra_admin_shutdown");
374 zebra_mutex_cond_lock (&zh->service->session_lock);
375 zh->service->stop_flag = 1;
376 zebra_mutex_cond_unlock (&zh->service->session_lock);
380 int zebra_admin_start (ZebraHandle zh)
384 yaz_log(LOG_API,"zebra_admin_start");
387 zebra_mutex_cond_lock (&zs->session_lock);
388 zebra_mutex_cond_unlock (&zs->session_lock);
392 static void zebra_register_close (ZebraService zs, struct zebra_register *reg)
395 yaz_log(LOG_LOG|LOG_API, "zebra_register_close p=%p", reg);
400 zebraExplain_close (reg->zei);
401 dict_close (reg->dict);
403 dict_close (reg->matchDict);
404 sortIdx_close (reg->sortIdx);
406 isams_close (reg->isams);
408 is_close (reg->isam);
410 isc_close (reg->isamc);
412 isamd_close (reg->isamd);
414 isamb_close (reg->isamb);
415 rec_close (®->records);
418 recTypes_destroy (reg->recTypes);
419 zebra_maps_close (reg->zebra_maps);
420 zebraRankDestroy (reg);
421 bfs_destroy (reg->bfs);
422 data1_destroy (reg->dh);
424 xfree (reg->sortKeys.buf);
425 xfree (reg->keys.buf);
427 xfree (reg->key_buf);
432 int zebra_stop(ZebraService zs)
436 yaz_log (LOG_LOG|LOG_API, "zebra_stop");
440 zebra_close (zs->sessions);
443 zebra_mutex_cond_destroy (&zs->session_lock);
446 passwd_db_close (zs->passwd_db);
448 res_close (zs->global_res);
449 xfree (zs->configName);
450 xfree (zs->path_root);
455 int zebra_close (ZebraHandle zh)
458 struct zebra_session **sp;
461 yaz_log(LOG_API,"zebra_close");
468 yaz_log (LOG_DEBUG, "zebra_close zh=%p", zh);
469 resultSetDestroy (zh, -1, 0, 0);
472 zebra_register_close (zh->service, zh->reg);
473 zebra_close_res (zh);
475 xfree (zh->record_encoding);
477 for (i = 0; i < zh->num_basenames; i++)
478 xfree (zh->basenames[i]);
479 xfree (zh->basenames);
481 if (zh->iconv_to_utf8 != 0)
482 yaz_iconv_close (zh->iconv_to_utf8);
483 if (zh->iconv_from_utf8 != 0)
484 yaz_iconv_close (zh->iconv_from_utf8);
486 xfree (zh->admin_databaseName);
487 zebra_mutex_cond_lock (&zs->session_lock);
488 zebra_lock_destroy (zh->lock_normal);
489 zebra_lock_destroy (zh->lock_shadow);
501 zebra_mutex_cond_unlock (&zs->session_lock);
502 xfree (zh->reg_name);
503 zh->service=0; /* more likely to trigger an assert */
508 struct map_baseinfo {
514 char **new_basenames;
518 static Res zebra_open_res (ZebraHandle zh)
527 sprintf (fname, "%.200s/zebra.cfg", zh->path_reg);
528 res = res_open (fname, zh->service->global_res);
530 res = zh->service->global_res;
532 else if (*zh->reg_name == 0)
534 res = zh->service->global_res;
538 yaz_log (LOG_WARN, "no register root specified");
539 return 0; /* no path for register - fail! */
544 static void zebra_close_res (ZebraHandle zh)
548 if (zh->res != zh->service->global_res)
553 static int zebra_select_register (ZebraHandle zh, const char *new_reg)
557 if (zh->res && strcmp (zh->reg_name, new_reg) == 0)
561 assert (zh->reg == 0);
562 assert (*zh->reg_name == 0);
568 resultSetInvalidate (zh);
569 zebra_register_close (zh->service, zh->reg);
574 xfree (zh->reg_name);
575 zh->reg_name = xstrdup (new_reg);
577 xfree (zh->path_reg);
579 if (zh->service->path_root)
581 zh->path_reg = xmalloc (strlen(zh->service->path_root) +
582 strlen(zh->reg_name) + 3);
583 strcpy (zh->path_reg, zh->service->path_root);
586 strcat (zh->path_reg, "/");
587 strcat (zh->path_reg, zh->reg_name);
590 zh->res = zebra_open_res (zh);
593 zebra_lock_destroy (zh->lock_normal);
597 zebra_lock_destroy (zh->lock_shadow);
603 const char *lock_area =res_get (zh->res, "lockDir");
605 if (!lock_area && zh->path_reg)
606 res_put (zh->res, "lockDir", zh->path_reg);
607 sprintf (fname, "norm.%s.LCK", zh->reg_name);
609 zebra_lock_create (res_get(zh->res, "lockDir"), fname, 0);
611 sprintf (fname, "shadow.%s.LCK", zh->reg_name);
613 zebra_lock_create (res_get(zh->res, "lockDir"), fname, 0);
619 void map_basenames_func (void *vp, const char *name, const char *value)
621 struct map_baseinfo *p = (struct map_baseinfo *) vp;
623 char fromdb[128], todb[8][128];
626 sscanf (value, "%127s %127s %127s %127s %127s %127s %127s %127s %127s",
627 fromdb, todb[0], todb[1], todb[2], todb[3], todb[4],
628 todb[5], todb[6], todb[7]);
632 for (i = 0; i<p->num_bases; i++)
633 if (p->basenames[i] && !STRCASECMP (p->basenames[i], fromdb))
636 for (i = 0; i < no; i++)
638 if (p->new_num_bases == p->new_num_max)
640 p->new_basenames[(p->new_num_bases)++] =
641 nmem_strdup (p->mem, todb[i]);
647 void map_basenames (ZebraHandle zh, ODR stream,
648 int *num_bases, char ***basenames)
650 struct map_baseinfo info;
651 struct map_baseinfo *p = &info;
654 yaz_log(LOG_API,"map_basenames ");
658 info.num_bases = *num_bases;
659 info.basenames = *basenames;
660 info.new_num_max = 128;
661 info.new_num_bases = 0;
662 info.new_basenames = (char **)
663 odr_malloc (stream, sizeof(*info.new_basenames) * info.new_num_max);
664 info.mem = stream->mem;
666 res_trav (zh->service->global_res, "mapdb", &info, map_basenames_func);
668 for (i = 0; i<p->num_bases; i++)
669 if (p->basenames[i] && p->new_num_bases < p->new_num_max)
671 p->new_basenames[(p->new_num_bases)++] =
672 nmem_strdup (p->mem, p->basenames[i]);
674 *num_bases = info.new_num_bases;
675 *basenames = info.new_basenames;
676 for (i = 0; i<*num_bases; i++)
677 logf (LOG_LOG, "base %s", (*basenames)[i]);
680 int zebra_select_database (ZebraHandle zh, const char *basename)
683 yaz_log(LOG_API,"zebra_select_database %s",basename);
685 return zebra_select_databases (zh, 1, &basename);
688 int zebra_select_databases (ZebraHandle zh, int num_bases,
689 const char **basenames)
696 yaz_log(LOG_API,"zebra_select_databases n=%d [0]=%s",
697 num_bases,basenames[0]);
705 for (i = 0; i < zh->num_basenames; i++)
706 xfree (zh->basenames[i]);
707 xfree (zh->basenames);
709 zh->num_basenames = num_bases;
710 zh->basenames = xmalloc (zh->num_basenames * sizeof(*zh->basenames));
711 for (i = 0; i < zh->num_basenames; i++)
712 zh->basenames[i] = xstrdup (basenames[i]);
714 cp = strrchr(basenames[0], '/');
717 len = cp - basenames[0];
718 new_reg = xmalloc (len + 1);
719 memcpy (new_reg, basenames[0], len);
723 new_reg = xstrdup ("");
724 for (i = 1; i<num_bases; i++)
728 cp1 = strrchr (basenames[i], '/');
736 if (len != cp1 - basenames[i] ||
737 memcmp (basenames[i], new_reg, len))
752 zebra_select_register (zh, new_reg);
759 if (!zh->lock_normal || !zh->lock_shadow)
767 int zebra_search_RPN (ZebraHandle zh, ODR o,
768 Z_RPNQuery *query, const char *setname, int *hits)
771 yaz_log(LOG_API,"zebra_search_rpn");
776 if (zebra_begin_read (zh))
779 zebra_livcode_transform(zh, query);
781 resultSetAddRPN (zh, odr_extract_mem(o), query,
782 zh->num_basenames, zh->basenames, setname);
790 int zebra_records_retrieve (ZebraHandle zh, ODR stream,
791 const char *setname, Z_RecordComposition *comp,
792 oid_value input_format, int num_recs,
793 ZebraRetrievalRecord *recs)
796 int i, *pos_array, ret = 0;
798 yaz_log(LOG_API,"zebra_records_retrieve n=%d",num_recs);
804 zh->errString = odr_strdup (stream, setname);
810 if (zebra_begin_read (zh))
813 pos_array = (int *) xmalloc (num_recs * sizeof(*pos_array));
814 for (i = 0; i<num_recs; i++)
815 pos_array[i] = recs[i].position;
816 poset = zebraPosSetCreate (zh, setname, num_recs, pos_array);
819 logf (LOG_DEBUG, "zebraPosSetCreate error");
821 zh->errString = nmem_strdup (stream->mem, setname);
826 for (i = 0; i<num_recs; i++)
831 recs[i].format = VAL_SUTRS;
832 recs[i].len = strlen(poset[i].term);
833 recs[i].buf = poset[i].term;
834 recs[i].base = poset[i].db;
836 else if (poset[i].sysno)
839 zebra_record_fetch (zh, poset[i].sysno, poset[i].score,
840 stream, input_format, comp,
841 &recs[i].format, &recs[i].buf,
844 recs[i].errString = NULL;
850 sprintf (num_str, "%d", pos_array[i]);
852 zh->errString = odr_strdup (stream, num_str);
857 zebraPosSetDestroy (zh, poset, num_recs);
864 int zebra_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
865 oid_value attributeset,
866 int *position, int *num_entries, ZebraScanEntry **entries,
870 yaz_log(LOG_API,"zebra_scan");
872 if (zebra_begin_read (zh))
878 rpn_scan (zh, stream, zapt, attributeset,
879 zh->num_basenames, zh->basenames, position,
880 num_entries, entries, is_partial, 0, 0);
885 int zebra_sort (ZebraHandle zh, ODR stream,
886 int num_input_setnames, const char **input_setnames,
887 const char *output_setname, Z_SortKeySpecList *sort_sequence,
891 yaz_log(LOG_API,"zebra_sort");
893 if (zebra_begin_read (zh))
895 resultSetSort (zh, stream->mem, num_input_setnames, input_setnames,
896 output_setname, sort_sequence, sort_status);
901 int zebra_deleleResultSet(ZebraHandle zh, int function,
902 int num_setnames, char **setnames,
907 yaz_log(LOG_API,"zebra_deleleResultSet n=%d",num_setnames);
909 if (zebra_begin_read(zh))
910 return Z_DeleteStatus_systemProblemAtTarget;
913 case Z_DeleteRequest_list:
914 resultSetDestroy (zh, num_setnames, setnames, statuses);
916 case Z_DeleteRequest_all:
917 resultSetDestroy (zh, -1, 0, statuses);
921 status = Z_DeleteStatus_success;
922 for (i = 0; i<num_setnames; i++)
923 if (statuses[i] == Z_DeleteStatus_resultSetDidNotExist)
924 status = statuses[i];
928 int zebra_errCode (ZebraHandle zh)
932 yaz_log(LOG_API,"zebra_errCode: %d",zh->errCode);
935 yaz_log(LOG_API,"zebra_errCode: o");
939 const char *zebra_errString (ZebraHandle zh)
943 e= diagbib1_str (zh->errCode);
944 yaz_log(LOG_API,"zebra_errString: %s",e);
948 char *zebra_errAdd (ZebraHandle zh)
953 yaz_log(LOG_API,"zebra_errAdd: %s",a);
957 void zebra_clearError(ZebraHandle zh)
966 int zebra_auth (ZebraHandle zh, const char *user, const char *pass)
970 yaz_log(LOG_API,"zebra_auth u=%s p=%s",user,pass);
973 if (!zs->passwd_db || !passwd_db_auth (zs->passwd_db, user, pass))
975 logf(LOG_APP,"AUTHOK:%s", user?user:"ANONYMOUS");
979 logf(LOG_APP,"AUTHFAIL:%s", user?user:"ANONYMOUS");
983 int zebra_admin_import_begin (ZebraHandle zh, const char *database,
984 const char *record_type)
987 yaz_log(LOG_API,"zebra_admin_import_begin db=%s rt=%s",
988 database, record_type);
990 if (zebra_select_database(zh, database))
992 zebra_begin_trans (zh, 1);
993 xfree (zh->admin_databaseName);
994 zh->admin_databaseName = xstrdup(database);
998 int zebra_admin_import_end (ZebraHandle zh)
1001 yaz_log(LOG_API,"zebra_admin_import_end");
1003 zebra_end_trans (zh);
1007 int zebra_admin_import_segment (ZebraHandle zh, Z_Segment *segment)
1012 yaz_log(LOG_API,"zebra_admin_import_segment");
1014 for (i = 0; i<segment->num_segmentRecords; i++)
1016 Z_NamePlusRecord *npr = segment->segmentRecords[i];
1017 const char *databaseName = npr->databaseName;
1020 databaseName = zh->admin_databaseName;
1021 printf ("--------------%d--------------------\n", i);
1022 if (npr->which == Z_NamePlusRecord_intermediateFragment)
1024 Z_FragmentSyntax *fragment = npr->u.intermediateFragment;
1025 if (fragment->which == Z_FragmentSyntax_notExternallyTagged)
1027 Odr_oct *oct = fragment->u.notExternallyTagged;
1028 printf ("%.*s", (oct->len > 100 ? 100 : oct->len) ,
1032 extract_rec_in_mem (zh, "grs.sgml",
1035 0 /* delete_flag */,
1040 0 /* match criteria */);
1047 int zebra_admin_exchange_record (ZebraHandle zh,
1048 const char *database,
1049 const char *rec_buf,
1051 const char *recid_buf, size_t recid_len,
1058 yaz_log(LOG_API,"zebra_admin_exchange_record db=%s ac=%d",
1062 if (!recid_buf || recid_len <= 0 || recid_len >= sizeof(recid_z))
1064 memcpy (recid_z, recid_buf, recid_len);
1065 recid_z[recid_len] = 0;
1067 zebra_begin_trans(zh,1);
1069 rinfo = dict_lookup (zh->reg->matchDict, recid_z);
1072 if (action == 1) /* fail if insert */
1074 zebra_end_trans(zh);
1078 memcpy (&sysno, rinfo+1, sizeof(sysno));
1082 if (action == 2 || action == 3) /* fail if delete or update */
1084 zebra_end_trans(zh);
1088 extract_rec_in_mem (zh, "grs.sgml", rec_buf, rec_len, database,
1089 action == 3 ? 1 : 0 /* delete flag */,
1090 0, &sysno, 1, 1, 0);
1093 dict_insert (zh->reg->matchDict, recid_z, sizeof(sysno), &sysno);
1095 else if (action == 3)
1097 dict_delete (zh->reg->matchDict, recid_z);
1099 zebra_end_trans(zh);
1103 int delete_w_handle(const char *info, void *handle)
1105 ZebraHandle zh = (ZebraHandle) handle;
1108 if (*info == sizeof(pos))
1110 memcpy (&pos, info+1, sizeof(pos));
1111 isamb_unlink(zh->reg->isamb, pos);
1116 static int delete_SU_handle(void *handle, int ord)
1118 ZebraHandle zh = (ZebraHandle) handle;
1122 ord_len = key_SU_encode (ord, ord_buf);
1123 ord_buf[ord_len] = '\0';
1125 assert (zh->reg->isamb);
1126 dict_delete_subtree(zh->reg->dict, ord_buf,
1127 zh, delete_w_handle);
1131 int zebra_drop_database (ZebraHandle zh, const char *database)
1134 yaz_log(LOG_API,"zebra_drop_database");
1137 if (zebra_select_database (zh, database))
1139 if (zebra_begin_trans (zh, 1))
1143 zebraExplain_curDatabase (zh->reg->zei, database);
1145 zebraExplain_trav_ord(zh->reg->zei, zh, delete_SU_handle);
1146 zebraExplain_removeDatabase(zh->reg->zei, zh);
1148 zebra_end_trans (zh);
1152 int zebra_create_database (ZebraHandle zh, const char *database)
1155 yaz_log(LOG_API,"zebra_create_database");
1158 if (zebra_select_database (zh, database))
1160 if (zebra_begin_trans (zh, 1))
1163 /* announce database */
1164 if (zebraExplain_newDatabase (zh->reg->zei, database, 0
1165 /* explainDatabase */))
1167 zebra_end_trans (zh);
1169 zh->errString = "database already exist";
1172 zebra_end_trans (zh);
1176 int zebra_string_norm (ZebraHandle zh, unsigned reg_id,
1177 const char *input_str, int input_len,
1178 char *output_str, int output_len)
1182 yaz_log(LOG_API,"zebra_string_norm ");
1184 if (!zh->reg->zebra_maps)
1186 wrbuf = zebra_replace(zh->reg->zebra_maps, reg_id, "",
1187 input_str, input_len);
1190 if (wrbuf_len(wrbuf) >= output_len)
1192 if (wrbuf_len(wrbuf))
1193 memcpy (output_str, wrbuf_buf(wrbuf), wrbuf_len(wrbuf));
1194 output_str[wrbuf_len(wrbuf)] = '\0';
1195 return wrbuf_len(wrbuf);
1199 int zebra_set_state (ZebraHandle zh, int val, int seqno)
1201 char state_fname[256];
1206 yaz_log(LOG_API,"zebra_set_state v=%d seq=%d", val, seqno);
1209 sprintf (state_fname, "state.%s.LCK", zh->reg_name);
1210 fname = zebra_mk_fname (res_get(zh->res, "lockDir"), state_fname);
1211 f = fopen (fname, "w");
1213 yaz_log (LOG_DEBUG, "%c %d %ld", val, seqno, p);
1214 fprintf (f, "%c %d %ld\n", val, seqno, p);
1220 int zebra_get_state (ZebraHandle zh, char *val, int *seqno)
1222 char state_fname[256];
1227 yaz_log(LOG_API,"zebra_get_state ");
1229 sprintf (state_fname, "state.%s.LCK", zh->reg_name);
1230 fname = zebra_mk_fname (res_get(zh->res, "lockDir"), state_fname);
1231 f = fopen (fname, "r");
1237 fscanf (f, "%c %d", val, seqno);
1244 int zebra_begin_read (ZebraHandle zh)
1246 return zebra_begin_trans(zh, 0);
1249 int zebra_end_read (ZebraHandle zh)
1251 return zebra_end_trans(zh);
1254 int zebra_begin_trans (ZebraHandle zh, int rw)
1256 yaz_log(LOG_LOG, "zebra_begin_trans rw=%d trans=%d", rw, zh->trans_no);
1260 zh->errString = "zebra_begin_trans: no database selected";
1264 yaz_log(LOG_API,"zebra_begin_trans rw=%d",rw);
1271 const char *rval = 0;
1276 if (zh->trans_no != 1)
1279 zh->errString = "zebra_begin_trans: write trans not allowed within read trans";
1284 resultSetInvalidate (zh);
1285 zebra_register_close (zh->service, zh->reg);
1287 zh->trans_w_no = zh->trans_no;
1291 zh->records_inserted = 0;
1292 zh->records_updated = 0;
1293 zh->records_deleted = 0;
1294 zh->records_processed = 0;
1296 #if HAVE_SYS_TIMES_H
1300 if (zh->shadow_enable)
1301 rval = res_get (zh->res, "shadow");
1303 for (pass = 0; pass < 2; pass++)
1307 zebra_lock_r (zh->lock_normal);
1308 zebra_lock_w (zh->lock_shadow);
1312 zebra_lock_w (zh->lock_normal);
1313 zebra_lock_w (zh->lock_shadow);
1316 zebra_get_state (zh, &val, &seqno);
1319 yaz_log (LOG_LOG, "previous transaction didn't finish commit");
1320 zebra_unlock (zh->lock_shadow);
1321 zebra_unlock (zh->lock_normal);
1325 else if (val == 'd')
1329 BFiles bfs = bfs_create (res_get (zh->res, "shadow"),
1331 yaz_log (LOG_LOG, "previous transaction didn't reach commit");
1332 bf_commitClean (bfs, rval);
1337 yaz_log (LOG_WARN, "your previous transaction didn't finish");
1344 yaz_log (LOG_FATAL, "zebra_begin_trans couldn't finish commit");
1348 zebra_set_state (zh, 'd', seqno);
1350 zh->reg = zebra_register_open (zh->service, zh->reg_name,
1351 1, rval ? 1 : 0, zh->res,
1354 zh->reg->seqno = seqno;
1357 zebra_set_state (zh, 'o', seqno);
1359 zebra_unlock (zh->lock_shadow);
1360 zebra_unlock (zh->lock_normal);
1366 zh->errString = "zebra_begin_trans: cannot open register";
1367 yaz_log(LOG_FATAL, zh->errString);
1379 if (zh->trans_no != 1)
1381 zebra_flush_reg (zh);
1385 #if HAVE_SYS_TIMES_H
1394 if (!zh->lock_normal || !zh->lock_shadow)
1400 zebra_get_state (zh, &val, &seqno);
1406 else if (seqno != zh->reg->seqno)
1408 yaz_log (LOG_LOG, "reopen seqno cur/old %d/%d",
1409 seqno, zh->reg->seqno);
1412 else if (zh->reg->last_val != val)
1414 yaz_log (LOG_LOG, "reopen last cur/old %d/%d",
1415 val, zh->reg->last_val);
1422 zebra_lock_r (zh->lock_shadow);
1424 zebra_lock_r (zh->lock_normal);
1427 zebra_register_close (zh->service, zh->reg);
1428 zh->reg = zebra_register_open (zh->service, zh->reg_name,
1429 0, val == 'c' ? 1 : 0,
1430 zh->res, zh->path_reg);
1433 zebra_unlock (zh->lock_normal);
1434 zebra_unlock (zh->lock_shadow);
1439 zh->reg->last_val = val;
1440 zh->reg->seqno = seqno;
1445 int zebra_end_trans (ZebraHandle zh)
1447 ZebraTransactionStatus dummy;
1448 yaz_log(LOG_API,"zebra_end_trans");
1449 return zebra_end_transaction(zh, &dummy);
1452 int zebra_end_transaction (ZebraHandle zh, ZebraTransactionStatus *status)
1459 yaz_log(LOG_API,"zebra_end_transaction");
1461 status->processed = 0;
1462 status->inserted = 0;
1463 status->updated = 0;
1464 status->deleted = 0;
1468 if (!zh->res || !zh->reg)
1471 zh->errString = "zebra_end_trans: no open transaction";
1474 if (zh->trans_no != zh->trans_w_no)
1477 if (zh->trans_no != 0)
1480 /* release read lock */
1482 zebra_unlock (zh->lock_normal);
1483 zebra_unlock (zh->lock_shadow);
1486 { /* release write lock */
1490 yaz_log (LOG_LOG, "zebra_end_trans");
1491 rval = res_get (zh->res, "shadow");
1493 zebraExplain_runNumberIncrement (zh->reg->zei, 1);
1495 zebra_flush_reg (zh);
1497 resultSetInvalidate (zh);
1499 zebra_register_close (zh->service, zh->reg);
1502 yaz_log (LOG_LOG, "Records: %7d i/u/d %d/%d/%d",
1503 zh->records_processed, zh->records_inserted,
1504 zh->records_updated, zh->records_deleted);
1506 status->processed = zh->records_processed;
1507 status->inserted = zh->records_inserted;
1508 status->updated = zh->records_updated;
1509 status->deleted = zh->records_deleted;
1511 zebra_get_state (zh, &val, &seqno);
1514 BFiles bfs = bfs_create (rval, zh->path_reg);
1515 yaz_log (LOG_LOG, "deleting shadow stuff val=%c", val);
1516 bf_commitClean (bfs, rval);
1521 zebra_set_state (zh, 'o', seqno);
1523 zebra_unlock (zh->lock_shadow);
1524 zebra_unlock (zh->lock_normal);
1527 #if HAVE_SYS_TIMES_H
1529 logf (LOG_LOG, "user/system: %ld/%ld",
1530 (long) (zh->tms2.tms_utime - zh->tms1.tms_utime),
1531 (long) (zh->tms2.tms_stime - zh->tms1.tms_stime));
1533 status->utime = (long) (zh->tms2.tms_utime - zh->tms1.tms_utime);
1534 status->stime = (long) (zh->tms2.tms_stime - zh->tms1.tms_stime);
1539 int zebra_repository_update (ZebraHandle zh)
1543 logf (LOG_LOG|LOG_API, "updating %s", zh->rGroup.path);
1544 repositoryUpdate (zh);
1548 int zebra_repository_delete (ZebraHandle zh)
1552 logf (LOG_LOG|LOG_API, "deleting %s", zh->rGroup.path);
1553 repositoryDelete (zh);
1557 int zebra_repository_show (ZebraHandle zh)
1560 yaz_log(LOG_API,"zebra_repository_show");
1562 repositoryShow (zh);
1566 static int zebra_commit_ex (ZebraHandle zh, int clean_only)
1580 rval = res_get (zh->res, "shadow");
1583 logf (LOG_WARN, "Cannot perform commit");
1584 logf (LOG_WARN, "No shadow area defined");
1588 zebra_lock_w (zh->lock_normal);
1589 zebra_lock_r (zh->lock_shadow);
1591 bfs = bfs_create (res_get (zh->res, "register"), zh->path_reg);
1593 zebra_get_state (zh, &val, &seqno);
1596 bf_cache (bfs, rval);
1597 if (bf_commitExists (bfs))
1600 zebra_set_state (zh, 'd', seqno);
1603 zebra_set_state (zh, 'c', seqno);
1605 logf (LOG_LOG, "commit start");
1606 bf_commitExec (bfs);
1611 logf (LOG_LOG, "commit clean");
1612 bf_commitClean (bfs, rval);
1614 zebra_set_state (zh, 'o', seqno);
1618 logf (LOG_LOG, "nothing to commit");
1622 zebra_unlock (zh->lock_shadow);
1623 zebra_unlock (zh->lock_normal);
1627 int zebra_clean (ZebraHandle zh)
1629 yaz_log(LOG_API,"zebra_clean");
1630 return zebra_commit_ex(zh, 1);
1633 int zebra_commit (ZebraHandle zh)
1635 yaz_log(LOG_API,"zebra_commit");
1636 return zebra_commit_ex(zh, 0);
1639 int zebra_init (ZebraHandle zh)
1644 yaz_log(LOG_API,"zebra_init");
1652 rval = res_get (zh->res, "shadow");
1654 bfs = bfs_create (res_get (zh->service->global_res, "register"),
1657 bf_cache (bfs, rval);
1661 zebra_set_state (zh, 'o', 0);
1665 int zebra_compact (ZebraHandle zh)
1669 yaz_log(LOG_API,"zebra_compact");
1676 bfs = bfs_create (res_get (zh->res, "register"), zh->path_reg);
1682 int zebra_record_insert (ZebraHandle zh, const char *buf, int len, int *sysno)
1686 yaz_log(LOG_API,"zebra_record_insert");
1690 if (zebra_begin_trans (zh, 1))
1692 extract_rec_in_mem (zh, "grs.sgml",
1694 "Default", /* database */
1695 0 /* delete_flag */,
1700 0 /* match criteria */);
1701 if (zebra_end_trans (zh))
1708 int zebra_set_group (ZebraHandle zh, struct recordGroup *rg)
1711 yaz_log(LOG_API,"zebra_set_group");
1713 memcpy (&zh->rGroup, rg, sizeof(*rg));
1717 int zebra_result (ZebraHandle zh, int *code, char **addinfo)
1720 yaz_log(LOG_API,"zebra_result");
1721 *code = zh->errCode;
1722 *addinfo = zh->errString;
1726 int zebra_shadow_enable (ZebraHandle zh, int value)
1729 yaz_log(LOG_API,"zebra_shadow_enable");
1731 zh->shadow_enable = value;
1735 int zebra_record_encoding (ZebraHandle zh, const char *encoding)
1738 yaz_log(LOG_API,"zebra_record_encoding");
1740 xfree (zh->record_encoding);
1744 * Something about charset aliases. Oleg???
1747 if (zh->iconv_to_utf8 != 0)
1748 yaz_iconv_close(zh->iconv_to_utf8);
1749 if (zh->iconv_from_utf8 != 0)
1750 yaz_iconv_close(zh->iconv_from_utf8);
1752 zh->record_encoding = xstrdup (encoding);
1754 logf(LOG_DEBUG, "Reset record encoding: %s", encoding);
1757 yaz_iconv_open ("UTF-8", encoding);
1758 if (zh->iconv_to_utf8 == 0)
1759 yaz_log (LOG_WARN, "iconv: %s to UTF-8 unsupported", encoding);
1760 zh->iconv_from_utf8 =
1761 yaz_iconv_open (encoding, "UTF-8");
1762 if (zh->iconv_to_utf8 == 0)
1763 yaz_log (LOG_WARN, "iconv: UTF-8 to %s unsupported", encoding);
1768 int zebra_set_resource(ZebraHandle zh, const char *name, const char *value)
1771 yaz_log(LOG_API,"zebra_set_resource %s:%s",name,value);
1773 res_put(zh->res, name, value);
1777 const char *zebra_get_resource(ZebraHandle zh,
1778 const char *name, const char *defaultvalue)
1782 v= res_get_def( zh->res, name, (char *)defaultvalue);
1784 yaz_log(LOG_API,"zebra_get_resource %s:%s",name,v);
1788 /* moved from zebra_api_ext.c by pop */
1789 /* FIXME: Should this really be public??? -Heikki */
1791 int zebra_trans_no (ZebraHandle zh)
1794 yaz_log(LOG_API,"zebra_trans_no");
1795 return zh->trans_no;
1798 int zebra_get_shadow_enable (ZebraHandle zh)
1800 yaz_log(LOG_API,"zebra_get_shadow_enable");
1801 return (zh->shadow_enable);
1804 int zebra_set_shadow_enable (ZebraHandle zh, int value)
1806 yaz_log(LOG_API,"zebra_set_shadow_enable %d",value);
1807 zh->shadow_enable = value;
1811 int init_recordGroup (struct recordGroup *rg)
1814 yaz_log(LOG_API,"init_recordGroup");
1815 rg->groupName = NULL;
1816 rg->databaseName = NULL;
1818 rg->recordId = NULL;
1819 rg->recordType = NULL;
1820 rg->flagStoreData = -1;
1821 rg->flagStoreKeys = -1;
1823 rg->databaseNamePath = 0;
1824 rg->explainDatabase = 0;
1825 rg->fileVerboseLimit = 100000;
1826 rg->followLinks = -1;
1831 /* This is from extract.c... it seems useful, when extract_rec_in mem is
1832 called... and in general... Should be moved to somewhere else */
1833 void res_get_recordGroup (ZebraHandle zh,
1834 struct recordGroup *rGroup,
1840 yaz_log(LOG_API,"res_get_recordGroup e=%s",ext);
1841 if (!rGroup->groupName || !*rGroup->groupName)
1844 sprintf (gprefix, "%s.", rGroup->groupName);
1846 /* determine file type - depending on extension */
1847 if (!rGroup->recordType) {
1848 sprintf (ext_res, "%srecordType.%s", gprefix, ext);
1849 if (!(rGroup->recordType = res_get (zh->res, ext_res))) {
1850 sprintf (ext_res, "%srecordType", gprefix);
1851 rGroup->recordType = res_get (zh->res, ext_res);
1854 /* determine match criteria */
1855 if (!rGroup->recordId) {
1856 sprintf (ext_res, "%srecordId.%s", gprefix, ext);
1857 if (!(rGroup->recordId = res_get (zh->res, ext_res))) {
1858 sprintf (ext_res, "%srecordId", gprefix);
1859 rGroup->recordId = res_get (zh->res, ext_res);
1863 /* determine database name */
1864 if (!rGroup->databaseName) {
1865 sprintf (ext_res, "%sdatabase.%s", gprefix, ext);
1866 if (!(rGroup->databaseName = res_get (zh->res, ext_res))) {
1867 sprintf (ext_res, "%sdatabase", gprefix);
1868 rGroup->databaseName = res_get (zh->res, ext_res);
1871 if (!rGroup->databaseName)
1872 rGroup->databaseName = "Default";
1874 /* determine if explain database */
1875 sprintf (ext_res, "%sexplainDatabase", gprefix);
1876 rGroup->explainDatabase =
1877 atoi (res_get_def (zh->res, ext_res, "0"));
1880 if (rGroup->flagStoreData == -1)
1883 sprintf (ext_res, "%sstoreData.%s", gprefix, ext);
1884 if (!(sval = res_get (zh->res, ext_res)))
1886 sprintf (ext_res, "%sstoreData", gprefix);
1887 sval = res_get (zh->res, ext_res);
1890 rGroup->flagStoreData = atoi (sval);
1892 if (rGroup->flagStoreData == -1)
1893 rGroup->flagStoreData = 0;
1896 if (rGroup->flagStoreKeys == -1)
1900 sprintf (ext_res, "%sstoreKeys.%s", gprefix, ext);
1901 sval = res_get (zh->res, ext_res);
1904 sprintf (ext_res, "%sstoreKeys", gprefix);
1905 sval = res_get (zh->res, ext_res);
1908 sval = res_get (zh->res, "storeKeys");
1910 rGroup->flagStoreKeys = atoi (sval);
1912 if (rGroup->flagStoreKeys == -1)
1913 rGroup->flagStoreKeys = 0;
1917 /* almost the same as zebra_records_retrieve ... but how did it work?
1918 I mean for multiple records ??? CHECK ??? */
1919 void api_records_retrieve (ZebraHandle zh, ODR stream,
1920 const char *setname, Z_RecordComposition *comp,
1921 oid_value input_format, int num_recs,
1922 ZebraRetrievalRecord *recs)
1926 yaz_log(LOG_API,"api_records_retrieve s=%s n=%d",setname,num_recs);
1931 zh->errString = odr_strdup (stream, setname);
1937 if (zebra_begin_read (zh))
1940 pos_array = (int *) xmalloc (num_recs * sizeof(*pos_array));
1941 for (i = 0; i<num_recs; i++)
1942 pos_array[i] = recs[i].position;
1943 poset = zebraPosSetCreate (zh, setname, num_recs, pos_array);
1946 logf (LOG_DEBUG, "zebraPosSetCreate error");
1948 zh->errString = nmem_strdup (stream->mem, setname);
1952 for (i = 0; i<num_recs; i++)
1956 recs[i].errCode = 0;
1957 recs[i].format = VAL_SUTRS;
1958 recs[i].len = strlen(poset[i].term);
1959 recs[i].buf = poset[i].term;
1960 recs[i].base = poset[i].db;
1964 else if (poset[i].sysno)
1966 /* changed here ??? CHECK ??? */
1969 zebra_record_fetch (zh, poset[i].sysno, poset[i].score,
1970 stream, input_format, comp,
1975 recs[i].buf = (char *) odr_malloc(stream,recs[i].len);
1976 memcpy(recs[i].buf, b, recs[i].len);
1977 recs[i].errString = 0; /* Hmmm !!! we should get this */
1978 recs[i].sysno = poset[i].sysno;
1979 recs[i].score = poset[i].score;
1985 sprintf (num_str, "%d", pos_array[i]);
1987 zh->errString = odr_strdup (stream, num_str);
1992 zebraPosSetDestroy (zh, poset, num_recs);
1994 zebra_end_read (zh);
1999 /* ---------------------------------------------------------------------------
2000 Record insert(=update), delete
2002 If sysno is provided, then it's used to identify the reocord.
2003 If not, and match_criteria is provided, then sysno is guessed
2004 If not, and a record is provided, then sysno is got from there
2005 NOTE: Now returns 0 at success and updates sysno, which is an int*
2009 int zebra_insert_record (ZebraHandle zh,
2010 struct recordGroup *rGroup,
2011 const char *recordType,
2012 int *sysno, const char *match, const char *fname,
2013 const char *buf, int buf_size,
2014 int force_update) /* This one is ignored */
2018 yaz_log(LOG_API,"zebra_insert_record sysno=%d", *sysno);
2020 if (buf_size < 1) buf_size = strlen(buf);
2022 zebra_begin_trans(zh, 1);
2023 res=bufferExtractRecord (zh, buf, buf_size, rGroup,
2024 0, /* delete_flag */
2030 0); /* allow_update */
2031 zebra_end_trans(zh);
2032 if (res < 0) return (res);
2036 int zebra_update_record (ZebraHandle zh,
2037 struct recordGroup *rGroup,
2038 const char *recordType,
2039 int* sysno, const char *match, const char *fname,
2040 const char *buf, int buf_size,
2045 yaz_log(LOG_API,"zebra_update_record sysno=%d", *sysno);
2047 if (buf_size < 1) buf_size = strlen(buf);
2049 zebra_begin_trans(zh, 1);
2050 res=bufferExtractRecord (zh, buf, buf_size, rGroup,
2051 0, /* delete_flag */
2057 1); /* allow_update */
2058 zebra_end_trans(zh);
2062 int zebra_delete_record (ZebraHandle zh,
2063 struct recordGroup *rGroup,
2064 const char *recordType,
2065 int *sysno, const char *match, const char *fname,
2066 const char *buf, int buf_size,
2070 yaz_log(LOG_API,"zebra_delete_record sysno=%d", *sysno);
2072 if (buf_size < 1) buf_size = strlen(buf);
2074 zebra_begin_trans(zh, 1);
2075 res=bufferExtractRecord (zh, buf, buf_size, rGroup,
2076 1, /* delete_flag */
2082 1); /* allow_update */
2083 zebra_end_trans(zh);
2087 /* ---------------------------------------------------------------------------
2091 int zebra_search_PQF (ZebraHandle zh, const char *pqf_query,
2092 const char *setname, int *numhits)
2097 ODR odr = odr_createmem(ODR_ENCODE);
2099 yaz_log(LOG_API,"zebra_search_PQF s=%s q=%s",setname, pqf_query);
2101 query = p_query_rpn (odr, PROTO_Z3950, pqf_query);
2104 yaz_log (LOG_WARN, "bad query %s\n", pqf_query);
2106 res=zebra_search_RPN (zh, odr, query, setname, &hits);
2110 yaz_log(LOG_API,"Hits: %d",numhits);
2118 /* ---------------------------------------------------------------------------
2119 Sort - a simplified interface, with optional read locks.
2120 FIXME - This is a horrible name, will conflict with half the applications
2122 int zebra_sort_by_specstr (ZebraHandle zh,
2124 const char *sort_spec,
2125 const char *output_setname,
2126 const char **input_setnames)
2128 int num_input_setnames = 0;
2129 int sort_status = 0;
2130 Z_SortKeySpecList *sort_sequence = yaz_sort_spec (stream, sort_spec);
2131 yaz_log(LOG_API,"sort (FIXME) ");
2134 logf(LOG_WARN,"invalid sort specs '%s'", sort_spec);
2139 /* we can do this, since the perl typemap code for char** will
2140 put a NULL at the end of list */
2141 while (input_setnames[num_input_setnames]) num_input_setnames++;
2143 if (zebra_begin_read (zh))
2146 resultSetSort (zh, stream->mem, num_input_setnames, input_setnames,
2147 output_setname, sort_sequence, &sort_status);