Doxygen comments
[idzebra-moved-to-github.git] / index / zebraapi.c
1 /* $Id: zebraapi.c,v 1.150 2005-01-21 19:07:25 adam Exp $
2    Copyright (C) 1995-2005
3    Index Data ApS
4
5 This file is part of the Zebra server.
6
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
10 version.
11
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
15 for more details.
16
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
20 02111-1307, USA.
21 */
22
23 #include <assert.h>
24 #include <stdio.h>
25 #include <limits.h>
26 #ifdef WIN32
27 #include <io.h>
28 #include <process.h>
29 #include <direct.h>
30 #else
31 #include <unistd.h>
32 #endif
33
34 #include <yaz/diagbib1.h>
35 #include <yaz/pquery.h>
36 #include <yaz/sortspec.h>
37 #include "index.h"
38 #include <charmap.h>
39 #include <idzebra/api.h>
40
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)
45
46 static int log_level = 0;
47 static int log_level_initialized = 0;
48
49 static Res zebra_open_res (ZebraHandle zh);
50 static void zebra_close_res (ZebraHandle zh);
51
52 static void zebra_chdir (ZebraService zs)
53 {
54     const char *dir ;
55     ASSERTZS;
56     yaz_log(log_level, "zebra_chdir");
57     dir = res_get (zs->global_res, "chdir");
58     if (!dir)
59         return;
60     yaz_log (YLOG_DEBUG, "chdir %s", dir);
61 #ifdef WIN32
62     _chdir(dir);
63 #else
64     chdir (dir);
65 #endif
66 }
67
68 static void zebra_flush_reg (ZebraHandle zh)
69 {
70     ASSERTZH;
71     yaz_log(log_level, "zebra_flush_reg");
72     zh->errCode = 0;
73     zebraExplain_flush (zh->reg->zei, zh);
74     
75     extract_flushWriteKeys (zh, 1 /* final */);
76     zebra_index_merge (zh );
77 }
78
79 static struct zebra_register *zebra_register_open (ZebraService zs, 
80                                                    const char *name,
81                                                    int rw, int useshadow,
82                                                    Res res,
83                                                    const char *reg_path);
84 static void zebra_register_close (ZebraService zs, struct zebra_register *reg);
85
86 ZebraHandle zebra_open (ZebraService zs)
87 {
88     ZebraHandle zh;
89     const char *default_encoding;
90     if (!log_level_initialized)
91     {
92         log_level = yaz_log_module_level("zebraapi");
93         log_level_initialized = 1;
94     }
95
96     yaz_log(log_level, "zebra_open");
97
98     if (!zs)
99         return 0;
100
101     zh = (ZebraHandle) xmalloc(sizeof(*zh));
102     yaz_log (YLOG_DEBUG, "zebra_open zs=%p returns %p", zs, zh);
103
104     zh->service = zs;
105     zh->reg = 0;          /* no register attached yet */
106     zh->sets = 0;
107     zh->destroyed = 0;
108     zh->errCode = 0;
109     zh->errString = 0;
110     zh->res = 0; 
111     zh->user_perm = 0;
112
113     zh->reg_name = xstrdup ("");
114     zh->path_reg = 0;
115     zh->num_basenames = 0;
116     zh->basenames = 0;
117
118     zh->trans_no = 0;
119     zh->trans_w_no = 0;
120
121     zh->lock_normal = 0;
122     zh->lock_shadow = 0;
123
124     zh->shadow_enable = 1;
125
126     default_encoding = res_get_def(zs->global_res, "encoding", "ISO-8859-1");
127
128     zh->iconv_to_utf8 =
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",
132            default_encoding);
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",
137            default_encoding);
138
139     zh->record_encoding = 0;
140
141     zebra_mutex_cond_lock (&zs->session_lock);
142
143     zh->next = zs->sessions;
144     zs->sessions = zh;
145
146     zebra_mutex_cond_unlock (&zs->session_lock);
147
148     return zh;
149 }
150
151 ZebraService zebra_start (const char *configName)
152 {
153     return zebra_start_res(configName, 0, 0);
154 }
155
156 ZebraService zebra_start_res (const char *configName, Res def_res, Res over_res)
157 {
158     Res res;
159
160     if (!log_level_initialized)
161     {
162         log_level = yaz_log_module_level("zebraapi");
163         log_level_initialized = 1;
164     }
165
166     yaz_log(log_level, "zebra_start %s",configName);
167     assert(configName);
168
169     if ((res = res_open (configName, def_res, over_res)))
170     {
171         ZebraService zh = xmalloc(sizeof(*zh));
172
173         yaz_log (YLOG_DEBUG, "Read resources `%s'", configName);
174         
175         zh->global_res = res;
176         zh->configName = xstrdup(configName);
177         zh->sessions = 0;
178         
179         zebra_chdir (zh);
180         
181         zebra_mutex_cond_init (&zh->session_lock);
182         if (!res_get (zh->global_res, "passwd"))
183             zh->passwd_db = NULL;
184         else
185         {
186             zh->passwd_db = passwd_db_open ();
187             if (!zh->passwd_db)
188                 yaz_log (YLOG_WARN|YLOG_ERRNO, "passwd_db_open failed");
189             else
190                 passwd_db_file (zh->passwd_db,
191                                 res_get (zh->global_res, "passwd"));
192         }
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);
196         return zh;
197     }
198     return 0;
199 }
200
201 void zebra_filter_info(ZebraService zs, void *cd,
202                         void (*cb)(void *cd, const char *name))
203 {
204     ASSERTZS;
205     assert(cb);
206     recTypeClass_info(zs->record_classes, cd, cb);
207 }
208
209 void zebra_pidfname(ZebraService zs, char *path)
210 {
211     ASSERTZS;
212     zebra_lock_prefix (zs->global_res, path);
213     strcat(path, "zebrasrv.pid");
214 }
215
216 Dict dict_open_res (BFiles bfs, const char *name, int cache, int rw,
217                     int compact_flag, Res res)
218 {
219     int page_size = 4096;
220     char resource_str[200];
221     const char *v;
222     sprintf (resource_str, "dict.%.100s.pagesize", name);
223     assert(bfs);
224     assert(name);
225
226     v = res_get(res, resource_str);
227     if (v)
228     {
229         page_size = atoi(v);
230         yaz_log(YLOG_LOG, "Using custom dictionary page size %d for %s",
231                 page_size, name);
232     }
233     return dict_open(bfs, name, cache, rw, compact_flag, page_size);
234 }
235
236
237 static
238 struct zebra_register *zebra_register_open (ZebraService zs, const char *name,
239                                             int rw, int useshadow, Res res,
240                                             const char *reg_path)
241 {
242     struct zebra_register *reg;
243     int record_compression = REC_COMPRESS_NONE;
244     const char *recordCompression = 0;
245     const char *profilePath;
246     char cwd[1024];
247
248     ASSERTZS;
249     
250     reg = xmalloc(sizeof(*reg));
251
252     assert (name);
253     reg->name = xstrdup (name);
254
255     reg->seqno = 0;
256     reg->last_val = 0;
257
258     assert (res);
259
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)");
262     
263     reg->dh = data1_createx (DATA1_FLAG_XML);
264     if (!reg->dh)
265         return 0;
266     reg->bfs = bfs_create (res_get (res, "register"), reg_path);
267     if (!reg->bfs)
268     {
269         data1_destroy(reg->dh);
270         return 0;
271     }
272     if (useshadow)
273         bf_cache (reg->bfs, res_get (res, "shadow"));
274
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);
278
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);
282
283     reg->zebra_maps = zebra_maps_open (res, reg_path);
284     reg->rank_classes = NULL;
285
286     reg->key_buf = 0;
287
288     reg->keys.buf_max = 0;
289     reg->keys.buf = 0;
290     reg->keys.codec_handle = iscz1_start();
291
292     reg->sortKeys.buf = 0;
293     reg->sortKeys.buf_max = 0;
294
295     reg->records = 0;
296     reg->dict = 0;
297     reg->sortIdx = 0;
298     reg->isams = 0;
299     reg->matchDict = 0;
300     reg->isamc = 0;
301     reg->isamb = 0;
302     reg->zei = 0;
303     reg->matchDict = 0;
304     reg->key_file_no = 0;
305     reg->ptr_i = 0;
306     
307     zebraRankInstall (reg, rank1_class);
308     zebraRankInstall (reg, rankzv_class);
309
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;
315
316     if (!(reg->records = rec_open (reg->bfs, rw, record_compression)))
317     {
318         yaz_log (YLOG_WARN, "rec_open failed");
319         return 0;
320     }
321     if (rw)
322     {
323         reg->matchDict = dict_open_res (reg->bfs, GMATCH_DICT, 20, 1, 0, res);
324     }
325     if (!(reg->dict = dict_open_res (reg->bfs, FNAME_DICT, 40, rw, 0, res)))
326     {
327         yaz_log (YLOG_WARN, "dict_open failed");
328         return 0;
329     }
330     if (!(reg->sortIdx = sortIdx_open (reg->bfs, rw)))
331     {
332         yaz_log (YLOG_WARN, "sortIdx_open failed");
333         return 0;
334     }
335     if (res_get_match (res, "isam", "s", ISAM_DEFAULT))
336     {
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))))
340         {
341             yaz_log (YLOG_WARN, "isams_open failed");
342             return 0;
343         }
344     }
345     if (res_get_match (res, "isam", "c", ISAM_DEFAULT))
346     {
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))))
350         {
351             yaz_log (YLOG_WARN, "isc_open failed");
352             return 0;
353         }
354     }
355     if (res_get_match (res, "isam", "b", ISAM_DEFAULT))
356     {
357         struct ISAMC_M_s isamc_m;
358         
359         if (!(reg->isamb = isamb_open (reg->bfs, "isamb",
360                                        rw, key_isamc_m(res, &isamc_m), 0)))
361         {
362             yaz_log (YLOG_WARN, "isamb_open failed");
363             return 0;
364         }
365     }
366     if (res_get_match (res, "isam", "bc", ISAM_DEFAULT))
367     {
368         struct ISAMC_M_s isamc_m;
369         
370         if (!(reg->isamb = isamb_open (reg->bfs, "isamb",
371                                        rw, key_isamc_m(res, &isamc_m), 1)))
372         {
373             yaz_log (YLOG_WARN, "isamb_open failed");
374             return 0;
375         }
376     }
377     if (res_get_match (res, "isam", "null", ISAM_DEFAULT))
378     {
379         struct ISAMC_M_s isamc_m;
380         
381         if (!(reg->isamb = isamb_open (reg->bfs, "isamb",
382                                        rw, key_isamc_m(res, &isamc_m), -1)))
383         {
384             yaz_log (YLOG_WARN, "isamb_open failed");
385             return 0;
386         }
387     }
388     reg->zei = zebraExplain_open (reg->records, reg->dh,
389                                   res, rw, reg,
390                                   explain_extract);
391     if (!reg->zei)
392     {
393         yaz_log (YLOG_WARN, "Cannot obtain EXPLAIN information");
394         return 0;
395     }
396     reg->active = 2;
397     yaz_log (YLOG_DEBUG, "zebra_register_open ok p=%p", reg);
398     return reg;
399 }
400
401 int zebra_admin_shutdown (ZebraHandle zh)
402 {
403     ASSERTZH;
404     yaz_log(log_level, "zebra_admin_shutdown");
405     zh->errCode = 0;
406
407     zebra_mutex_cond_lock (&zh->service->session_lock);
408     zh->service->stop_flag = 1;
409     zebra_mutex_cond_unlock (&zh->service->session_lock);
410     return 0;
411 }
412
413 int zebra_admin_start (ZebraHandle zh)
414 {
415     ZebraService zs;
416     ASSERTZH;
417     yaz_log(log_level, "zebra_admin_start");
418     zh->errCode = 0;
419     zs = zh->service;
420     zebra_mutex_cond_lock (&zs->session_lock);
421     zebra_mutex_cond_unlock (&zs->session_lock);
422     return 0;
423 }
424
425 static void zebra_register_close (ZebraService zs, struct zebra_register *reg)
426 {
427     ASSERTZS;
428     assert(reg);
429     yaz_log(YLOG_DEBUG, "zebra_register_close p=%p", reg);
430     reg->stop_flag = 0;
431     zebra_chdir (zs);
432     if (reg->records)
433     {
434         zebraExplain_close (reg->zei);
435         dict_close (reg->dict);
436         if (reg->matchDict)
437             dict_close (reg->matchDict);
438         sortIdx_close (reg->sortIdx);
439         if (reg->isams)
440             isams_close (reg->isams);
441         if (reg->isamc)
442             isc_close (reg->isamc);
443         if (reg->isamb)
444             isamb_close (reg->isamb);
445         rec_close (&reg->records);
446     }
447
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);
453
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);
459     xfree(reg->name);
460     xfree(reg);
461 }
462
463 int zebra_stop(ZebraService zs)
464 {
465     if (!zs)
466         return 0;
467     yaz_log (log_level, "zebra_stop");
468
469     while (zs->sessions)
470     {
471         zebra_close (zs->sessions);
472     }
473         
474     zebra_mutex_cond_destroy (&zs->session_lock);
475
476     if (zs->passwd_db)
477         passwd_db_close (zs->passwd_db);
478
479     recTypeClass_destroy(zs->record_classes);
480     nmem_destroy(zs->nmem);
481     res_close (zs->global_res);
482     xfree(zs->configName);
483     xfree(zs);
484     return 0;
485 }
486
487 int zebra_close (ZebraHandle zh)
488 {
489     ZebraService zs;
490     struct zebra_session **sp;
491     int i;
492
493     yaz_log(log_level, "zebra_close");
494     if (!zh)
495         return 0;
496     ASSERTZH;
497     zh->errCode = 0;
498     
499     zs = zh->service;
500     yaz_log (YLOG_DEBUG, "zebra_close zh=%p", zh);
501     resultSetDestroy (zh, -1, 0, 0);
502
503     if (zh->reg)
504         zebra_register_close (zh->service, zh->reg);
505     zebra_close_res (zh);
506
507     xfree(zh->record_encoding);
508
509     for (i = 0; i < zh->num_basenames; i++)
510         xfree(zh->basenames[i]);
511     xfree(zh->basenames);
512
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);
517
518     zebra_mutex_cond_lock (&zs->session_lock);
519     zebra_lock_destroy (zh->lock_normal);
520     zebra_lock_destroy (zh->lock_shadow);
521     sp = &zs->sessions;
522     while (1)
523     {
524         assert (*sp);
525         if (*sp == zh)
526         {
527             *sp = (*sp)->next;
528             break;
529         }
530         sp = &(*sp)->next;
531     }
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);
537     xfree(zh);
538     return 0;
539 }
540
541 struct map_baseinfo {
542     ZebraHandle zh;
543     NMEM mem;
544     int num_bases;
545     char **basenames;
546     int new_num_bases;
547     char **new_basenames;
548     int new_num_max;
549 };
550
551 static Res zebra_open_res (ZebraHandle zh)
552 {
553     Res res = 0;
554     char fname[512];
555     ASSERTZH;
556     zh->errCode = 0;
557
558     if (zh->path_reg)
559     {
560         sprintf (fname, "%.200s/zebra.cfg", zh->path_reg);
561         res = res_open (fname, zh->service->global_res, 0);
562         if (!res)
563             res = zh->service->global_res;
564     }
565     else if (*zh->reg_name == 0)
566     {
567         res = zh->service->global_res;
568     }
569     else
570     {
571         yaz_log (YLOG_WARN, "no register root specified");
572         return 0;  /* no path for register - fail! */
573     }
574     return res;
575 }
576
577 static void zebra_close_res (ZebraHandle zh)
578 {
579     ASSERTZH;
580     zh->errCode = 0;
581     if (zh->res != zh->service->global_res)
582         res_close (zh->res);
583     zh->res = 0;
584 }
585
586 static int zebra_select_register (ZebraHandle zh, const char *new_reg)
587 {
588     ASSERTZH;
589     zh->errCode = 0;
590     if (zh->res && strcmp (zh->reg_name, new_reg) == 0)
591         return 0;
592     if (!zh->res)
593     {
594         assert (zh->reg == 0);
595         assert (*zh->reg_name == 0);
596     }
597     else
598     {
599         if (zh->reg)
600         {
601             resultSetInvalidate (zh);
602             zebra_register_close (zh->service, zh->reg);
603             zh->reg = 0;
604         }
605         zebra_close_res(zh);
606     }
607     xfree(zh->reg_name);
608     zh->reg_name = xstrdup (new_reg);
609
610     xfree(zh->path_reg);
611     zh->path_reg = 0;
612     if (zh->service->path_root)
613     {
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);
617         if (*zh->reg_name)
618         {
619             strcat (zh->path_reg, "/");
620             strcat (zh->path_reg, zh->reg_name);
621         }
622     }
623     zh->res = zebra_open_res (zh);
624     
625     if (zh->lock_normal)
626         zebra_lock_destroy (zh->lock_normal);
627     zh->lock_normal = 0;
628
629     if (zh->lock_shadow)
630         zebra_lock_destroy (zh->lock_shadow);
631     zh->lock_shadow = 0;
632
633     if (zh->res)
634     {
635         char fname[512];
636         const char *lock_area  =res_get (zh->res, "lockDir");
637         
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);
641         zh->lock_normal =
642             zebra_lock_create (res_get(zh->res, "lockDir"), fname, 0);
643         
644         sprintf (fname, "shadow.%s.LCK", zh->reg_name);
645         zh->lock_shadow =
646             zebra_lock_create (res_get(zh->res, "lockDir"), fname, 0);
647
648     }
649     return 1;
650 }
651
652 void map_basenames_func (void *vp, const char *name, const char *value)
653 {
654     struct map_baseinfo *p = (struct map_baseinfo *) vp;
655     int i, no;
656     char fromdb[128], todb[8][128];
657
658     assert(value);
659     assert(name);
660     assert(vp);
661     
662     no =
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]);
666     if (no < 2)
667         return ;
668     no--;
669     for (i = 0; i<p->num_bases; i++)
670         if (p->basenames[i] && !STRCASECMP (p->basenames[i], fromdb))
671         {
672             p->basenames[i] = 0;
673             for (i = 0; i < no; i++)
674             {
675                 if (p->new_num_bases == p->new_num_max)
676                     return;
677                 p->new_basenames[(p->new_num_bases)++] = 
678                     nmem_strdup (p->mem, todb[i]);
679             }
680             return;
681         }
682 }
683
684 void map_basenames (ZebraHandle zh, ODR stream,
685                     int *num_bases, char ***basenames)
686 {
687     struct map_baseinfo info;
688     struct map_baseinfo *p = &info;
689     int i;
690     ASSERTZH;
691     yaz_log(log_level, "map_basenames ");
692     assert(stream);
693
694     zh->errCode = 0;
695
696     info.zh = zh;
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;
704
705     res_trav (zh->service->global_res, "mapdb", &info, map_basenames_func);
706     
707     for (i = 0; i<p->num_bases; i++)
708         if (p->basenames[i] && p->new_num_bases < p->new_num_max)
709         {
710             p->new_basenames[(p->new_num_bases)++] = 
711                 nmem_strdup (p->mem, p->basenames[i]);
712         }
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]);
717 }
718
719 int zebra_select_database (ZebraHandle zh, const char *basename)
720 {
721     ASSERTZH;
722     yaz_log(log_level, "zebra_select_database %s",basename);
723     assert(basename);
724     zh->errCode = 0;
725     return zebra_select_databases (zh, 1, &basename);
726 }
727
728 int zebra_select_databases (ZebraHandle zh, int num_bases,
729                             const char **basenames)
730 {
731     int i;
732     const char *cp;
733     int len = 0;
734     char *new_reg = 0;
735     ASSERTZH;
736     assert(basenames);
737
738     yaz_log(log_level, "zebra_select_databases n=%d [0]=%s",
739                     num_bases,basenames[0]);
740     zh->errCode = 0;
741     
742     if (num_bases < 1)
743     {
744         zh->errCode = 23;
745         return -1;
746     }
747     for (i = 0; i < zh->num_basenames; i++)
748         xfree(zh->basenames[i]);
749     xfree(zh->basenames);
750     
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]);
755
756     cp = strrchr(basenames[0], '/');
757     if (cp)
758     {
759         len = cp - basenames[0];
760         new_reg = xmalloc(len + 1);
761         memcpy (new_reg, basenames[0], len);
762         new_reg[len] = '\0';
763     }
764     else
765         new_reg = xstrdup ("");
766     for (i = 1; i<num_bases; i++)
767     {
768         const char *cp1;
769
770         cp1 = strrchr (basenames[i], '/');
771         if (cp)
772         {
773             if (!cp1)
774             {
775                 zh->errCode = 23;
776                 return -1;
777             }
778             if (len != cp1 - basenames[i] ||
779                 memcmp (basenames[i], new_reg, len))
780             {
781                 zh->errCode = 23;
782                 return -1;
783             }
784         }
785         else
786         {
787             if (cp1)
788             {
789                 zh->errCode = 23;
790                 return -1;
791             }
792         }
793     }
794     zebra_select_register (zh, new_reg);
795     xfree(new_reg);
796     if (!zh->res)
797     {
798         zh->errCode = 109;
799         return -1;
800     }
801     if (!zh->lock_normal || !zh->lock_shadow)
802     {
803         zh->errCode = 2;
804         return -1;
805     }
806     return 0;
807 }
808
809 int zebra_search_RPN (ZebraHandle zh, ODR o,
810                        Z_RPNQuery *query, const char *setname, int *hits)
811 {
812     const char *max;
813     zint maxhits;
814     ASSERTZH;
815     assert(o);
816     assert(query);
817     assert(hits);
818     assert(setname);
819     yaz_log(log_level, "zebra_search_rpn");
820     zh->errCode = 0;
821     zh->hits = 0;
822     *hits = 0;
823
824     if (zebra_begin_read (zh))
825         return 1;
826
827     resultSetAddRPN (zh, odr_extract_mem(o), query, 
828                      zh->num_basenames, zh->basenames, setname);
829
830     zebra_end_read (zh);
831     max = res_get (zh->res, "maxhits");
832     if (max)
833         maxhits = atoi(max);
834     else {
835         int i = 0; 
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;
839     }
840     if (zh->hits > maxhits) { /* too large for yaz to handle */
841         yaz_log(YLOG_DEBUG, "limiting hits to "ZINT_FORMAT, maxhits);
842         *hits = maxhits;  
843     }
844     else
845         *hits = zh->hits;
846     return 0;
847 }
848
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)
853 {
854     ZebraMetaRecord *poset;
855     int i, ret = 0;
856     zint *pos_array;
857     ASSERTZH;
858     assert(stream);
859     assert(setname);
860     assert(recs);
861     assert(num_recs>0);
862
863     yaz_log(log_level, "zebra_records_retrieve n=%d",num_recs);
864     zh->errCode = 0;
865
866     if (!zh->res)
867     {
868         zh->errCode = 30;
869         zh->errString = odr_strdup(stream, setname);
870         return -1;
871     }
872     
873     zh->errCode = 0;
874
875     if (zebra_begin_read (zh))
876         return -1;
877
878     pos_array = (zint *) xmalloc(num_recs * sizeof(*pos_array));
879     for (i = 0; i<num_recs; i++)
880         pos_array[i] = recs[i].position;
881     poset = zebra_meta_records_create(zh, setname, num_recs, pos_array);
882     if (!poset)
883     {
884         yaz_log (YLOG_DEBUG, "zebraPosSetCreate error");
885         zh->errCode = 30;
886         zh->errString = nmem_strdup (stream->mem, setname);
887         ret = -1;
888     }
889     else
890     {
891         for (i = 0; i<num_recs; i++)
892         {
893             if (poset[i].term)
894             {
895                 recs[i].errCode = 0;
896                 recs[i].format = VAL_SUTRS;
897                 recs[i].len = strlen(poset[i].term);
898                 recs[i].buf = poset[i].term;
899                 recs[i].base = poset[i].db;
900             }
901             else if (poset[i].sysno)
902             {
903                 char *buf;
904                 int len;
905                 recs[i].errCode =
906                     zebra_record_fetch (zh, poset[i].sysno, poset[i].score,
907                                         stream, input_format, comp,
908                                         &recs[i].format, &buf, &len,
909                                         &recs[i].base, &recs[i].errString);
910                 recs[i].len = len;
911                 if (len > 0)
912                 {
913                     recs[i].buf = (char*) odr_malloc(stream, len);
914                     memcpy(recs[i].buf, buf, len);
915                 }
916                 else
917                     recs[i].buf = buf;
918                 recs[i].score = poset[i].score;
919                 recs[i].sysno = poset[i].sysno;
920             }
921             else
922             {
923                 char num_str[20];
924
925                 sprintf (num_str, ZINT_FORMAT, pos_array[i]);   
926                 zh->errCode = 13;
927                 zh->errString = odr_strdup (stream, num_str);
928                 ret = -1;
929                 break;
930             }
931         }
932         zebra_meta_records_destroy(zh, poset, num_recs);
933     }
934     zebra_end_read (zh);
935     xfree(pos_array);
936     return ret;
937 }
938
939 int zebra_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
940                  oid_value attributeset,
941                  int *position, int *num_entries, ZebraScanEntry **entries,
942                  int *is_partial)
943 {
944     ASSERTZH;
945     assert(stream);
946     assert(zapt);
947     assert(position);
948     assert(num_entries);
949     assert(is_partial);
950     assert(entries);
951     yaz_log(log_level, "zebra_scan");
952     zh->errCode = 0;
953     if (zebra_begin_read (zh))
954     {
955         *entries = 0;
956         *num_entries = 0;
957         return 1;
958     }
959     rpn_scan (zh, stream, zapt, attributeset,
960               zh->num_basenames, zh->basenames, position,
961               num_entries, entries, is_partial, 0, 0);
962     zebra_end_read (zh);
963     return 0;
964 }
965
966 int zebra_sort (ZebraHandle zh, ODR stream,
967                  int num_input_setnames, const char **input_setnames,
968                  const char *output_setname, Z_SortKeySpecList *sort_sequence,
969                  int *sort_status)
970 {
971     ASSERTZH;
972     assert(stream);
973     assert(num_input_setnames>0);
974     assert(input_setnames);
975     assert(sort_sequence);
976     assert(sort_status);
977     yaz_log(log_level, "zebra_sort");
978     zh->errCode = 0;
979     if (zebra_begin_read (zh))
980         return 1;
981     resultSetSort (zh, stream->mem, num_input_setnames, input_setnames,
982                    output_setname, sort_sequence, sort_status);
983     zebra_end_read(zh);
984     return 0;
985 }
986
987 int zebra_deleteResultSet(ZebraHandle zh, int function,
988                           int num_setnames, char **setnames,
989                           int *statuses)
990 {
991     int i, status;
992     ASSERTZH;
993     assert(statuses);
994     yaz_log(log_level, "zebra_deleleResultSet n=%d",num_setnames);
995     zh->errCode = 0;
996     if (zebra_begin_read(zh))
997         return Z_DeleteStatus_systemProblemAtTarget;
998     switch (function)
999     {
1000     case Z_DeleteResultSetRequest_list:
1001         assert(num_setnames>0);
1002         assert(setnames);
1003         resultSetDestroy (zh, num_setnames, setnames, statuses);
1004         break;
1005     case Z_DeleteResultSetRequest_all:
1006         resultSetDestroy (zh, -1, 0, statuses);
1007         break;
1008     }
1009     zebra_end_read (zh);
1010     status = Z_DeleteStatus_success;
1011     for (i = 0; i<num_setnames; i++)
1012         if (statuses[i] == Z_DeleteStatus_resultSetDidNotExist)
1013             status = statuses[i];
1014     return status;
1015 }
1016
1017 int zebra_errCode (ZebraHandle zh)
1018 {
1019     if (zh)
1020     {
1021         yaz_log(log_level, "zebra_errCode: %d",zh->errCode);
1022         return zh->errCode;
1023     }
1024     yaz_log(log_level, "zebra_errCode: o");
1025     return 0; 
1026 }
1027
1028 const char *zebra_errString (ZebraHandle zh)
1029 {
1030     const char *e="";
1031     if (zh)
1032         e= diagbib1_str (zh->errCode);
1033     yaz_log(log_level, "zebra_errString: %s",e);
1034     return e;
1035 }
1036
1037 char *zebra_errAdd (ZebraHandle zh)
1038 {
1039     char *a="";
1040     if (zh)
1041         a= zh->errString;
1042     yaz_log(log_level, "zebra_errAdd: %s",a);
1043     return a;
1044 }
1045
1046 void zebra_clearError(ZebraHandle zh)
1047 {
1048     if (zh)
1049     {
1050         zh->errCode = 0;
1051         zh->errString="";
1052     }
1053 }
1054
1055 int zebra_auth (ZebraHandle zh, const char *user, const char *pass)
1056 {
1057     const char *p;
1058     char u[40];
1059     ZebraService zs;
1060
1061     ASSERTZH;
1062     zh->errCode = 0;
1063     zs= zh->service;
1064     
1065     sprintf(u, "perm.%.30s", user ? user : "anonymous");
1066     p = res_get(zs->global_res, u);
1067     xfree(zh->user_perm);
1068     zh->user_perm = xstrdup(p ? p : "r");
1069
1070     /* users that don't require a password .. */
1071     if (zh->user_perm && strchr(zh->user_perm, 'a'))
1072         return 0;
1073     
1074     if (!zs->passwd_db || !passwd_db_auth (zs->passwd_db, user, pass))
1075         return 0;
1076     return 1;
1077 }
1078
1079 int zebra_admin_import_begin (ZebraHandle zh, const char *database,
1080                                const char *record_type)
1081 {
1082     ASSERTZH;
1083     yaz_log(log_level, "zebra_admin_import_begin db=%s rt=%s", 
1084                      database, record_type);
1085     zh->errCode = 0;
1086     if (zebra_select_database(zh, database))
1087         return 1;
1088     if (zebra_begin_trans (zh, 1))
1089         return 1;
1090     return 0;
1091 }
1092
1093 int zebra_admin_import_end (ZebraHandle zh)
1094 {
1095     ASSERTZH;
1096     yaz_log(log_level, "zebra_admin_import_end");
1097     zh->errCode = 0;
1098     zebra_end_trans (zh);
1099     return 0;
1100 }
1101
1102 int zebra_admin_import_segment (ZebraHandle zh, Z_Segment *segment)
1103 {
1104     SYSNO sysno;
1105     int i;
1106     ASSERTZH;
1107     yaz_log(log_level, "zebra_admin_import_segment");
1108     zh->errCode = 0;
1109     for (i = 0; i<segment->num_segmentRecords; i++)
1110     {
1111         Z_NamePlusRecord *npr = segment->segmentRecords[i];
1112
1113         printf ("--------------%d--------------------\n", i);
1114         /* FIXME - What! printing on stdout ??? */
1115         if (npr->which == Z_NamePlusRecord_intermediateFragment)
1116         {
1117             Z_FragmentSyntax *fragment = npr->u.intermediateFragment;
1118             if (fragment->which == Z_FragmentSyntax_notExternallyTagged)
1119             {
1120                 Odr_oct *oct = fragment->u.notExternallyTagged;
1121                 printf ("%.*s", (oct->len > 100 ? 100 : oct->len) ,
1122                         oct->buf);
1123                 
1124                 sysno = 0;
1125                 
1126                 zebra_update_record(zh, 
1127                                     0, /* record Type */
1128                                     &sysno,
1129                                     0, /* match */
1130                                     0, /* fname */
1131                                     oct->buf, oct->len,
1132                                     0);
1133             }
1134         }
1135     }
1136     return 0;
1137 }
1138
1139 int zebra_admin_exchange_record (ZebraHandle zh,
1140                                  const char *rec_buf,
1141                                  size_t rec_len,
1142                                  const char *recid_buf, size_t recid_len,
1143                                  int action)
1144     /* 1 = insert. Fail it already exists */
1145     /* 2 = replace. Fail it does not exist */
1146     /* 3 = delete. Fail if does not exist */
1147     /* 4 = update. Insert/replace */
1148 {
1149     SYSNO sysno = 0;
1150     char *rinfo = 0;
1151     char recid_z[256];
1152     ASSERTZH;
1153     assert(action>0 && action <=4);
1154     assert(rec_buf);
1155
1156     yaz_log(log_level, "zebra_admin_exchange_record ac=%d", action);
1157     zh->errCode = 0;
1158
1159     if (!recid_buf || recid_len <= 0 || recid_len >= sizeof(recid_z))
1160         return -1;
1161     memcpy (recid_z, recid_buf, recid_len);
1162     recid_z[recid_len] = 0;
1163
1164     if (zebra_begin_trans(zh, 1))
1165         return -1;
1166
1167     rinfo = dict_lookup (zh->reg->matchDict, recid_z);
1168     if (rinfo)
1169     {
1170         if (action == 1)  /* fail if insert */
1171         {
1172              zebra_end_trans(zh);
1173              return -1;
1174         }
1175
1176         memcpy (&sysno, rinfo+1, sizeof(sysno));
1177     }
1178     else
1179     {
1180         if (action == 2 || action == 3) /* fail if delete or update */
1181         {
1182             zebra_end_trans(zh);
1183             return -1;
1184         }
1185         action = 1;  /* make it an insert (if it's an update).. */
1186     }
1187     buffer_extract_record (zh, rec_buf, rec_len,
1188                            action == 3 ? 1 : 0 /* delete flag */,
1189                            0, /* test mode */
1190                            0, /* recordType */
1191                            &sysno, 
1192                            0, /* match */
1193                            0, /* fname */
1194                            0, /* force update */
1195                            1  /* allow update */
1196         );
1197     if (action == 1)
1198     {
1199         dict_insert (zh->reg->matchDict, recid_z, sizeof(sysno), &sysno);
1200     }
1201     else if (action == 3)
1202     {
1203         dict_delete (zh->reg->matchDict, recid_z);
1204     }
1205     zebra_end_trans(zh);
1206     return 0;
1207 }
1208
1209 int delete_w_handle(const char *info, void *handle)
1210 {
1211     ZebraHandle zh = (ZebraHandle) handle;
1212     ISAMC_P pos;
1213     ASSERTZH;
1214
1215     if (*info == sizeof(pos))
1216     {
1217         memcpy (&pos, info+1, sizeof(pos));
1218         isamb_unlink(zh->reg->isamb, pos);
1219     }
1220     return 0;
1221 }
1222
1223 static int delete_SU_handle(void *handle, int ord)
1224 {
1225     ZebraHandle zh = (ZebraHandle) handle;
1226     char ord_buf[20];
1227     int ord_len;
1228
1229     ord_len = key_SU_encode (ord, ord_buf);
1230     ord_buf[ord_len] = '\0';
1231
1232     assert (zh->reg->isamb);
1233     dict_delete_subtree(zh->reg->dict, ord_buf,
1234                         zh, delete_w_handle);
1235     return 0;
1236 }
1237
1238 int zebra_drop_database  (ZebraHandle zh, const char *database)
1239 {
1240     int ret = 0;
1241     ASSERTZH;
1242     yaz_log(log_level, "zebra_drop_database");
1243     zh->errCode = 0;
1244
1245     if (zebra_select_database (zh, database))
1246         return -1;
1247     if (zebra_begin_trans (zh, 1))
1248         return -1;
1249     if (zh->reg->isamb)
1250     {
1251         zebraExplain_curDatabase (zh->reg->zei, database);
1252         
1253         zebraExplain_trav_ord(zh->reg->zei, zh, delete_SU_handle);
1254         zebraExplain_removeDatabase(zh->reg->zei, zh);
1255     }
1256     else
1257     {
1258         yaz_log(YLOG_WARN, "drop database only supported for isam:b");
1259         ret = -1;
1260     }
1261     zebra_end_trans (zh);
1262     return ret;
1263 }
1264
1265 int zebra_create_database (ZebraHandle zh, const char *database)
1266 {
1267     ASSERTZH;
1268     yaz_log(log_level, "zebra_create_database %s",database);
1269     assert(database);
1270     zh->errCode = 0;
1271
1272     if (zebra_select_database (zh, database))
1273         return -1;
1274     if (zebra_begin_trans (zh, 1))
1275         return -1;
1276
1277     /* announce database */
1278     if (zebraExplain_newDatabase (zh->reg->zei, database, 0 
1279                                   /* explainDatabase */))
1280     {
1281         zebra_end_trans (zh);
1282         zh->errCode = 224;
1283         zh->errString = "database already exist";
1284         return -1;
1285     }
1286     zebra_end_trans (zh);
1287     return 0;
1288 }
1289
1290 int zebra_string_norm (ZebraHandle zh, unsigned reg_id,
1291                        const char *input_str, int input_len,
1292                        char *output_str, int output_len)
1293 {
1294     WRBUF wrbuf;
1295     ASSERTZH;
1296     assert(input_str);
1297     assert(output_str);
1298     yaz_log(log_level, "zebra_string_norm ");
1299     zh->errCode = 0;
1300     if (!zh->reg->zebra_maps)
1301         return -1;
1302     wrbuf = zebra_replace(zh->reg->zebra_maps, reg_id, "",
1303                           input_str, input_len);
1304     if (!wrbuf)
1305         return -2;
1306     if (wrbuf_len(wrbuf) >= output_len)
1307         return -3;
1308     if (wrbuf_len(wrbuf))
1309         memcpy (output_str, wrbuf_buf(wrbuf), wrbuf_len(wrbuf));
1310     output_str[wrbuf_len(wrbuf)] = '\0';
1311     return wrbuf_len(wrbuf);
1312 }
1313
1314
1315 int zebra_set_state (ZebraHandle zh, int val, int seqno)
1316     /* FIXME - zint seqno ?? */
1317 {
1318     char state_fname[256];
1319     char *fname;
1320     long p = getpid();
1321     FILE *f;
1322     ASSERTZH;
1323     yaz_log(log_level, "zebra_set_state v=%d seq=%d", val, seqno);
1324     zh->errCode = 0;
1325
1326     sprintf (state_fname, "state.%s.LCK", zh->reg_name);
1327     fname = zebra_mk_fname (res_get(zh->res, "lockDir"), state_fname);
1328     f = fopen (fname, "w");
1329
1330     yaz_log (YLOG_DEBUG, "zebra_set_state: %c %d %ld", val, seqno, p);
1331     fprintf (f, "%c %d %ld\n", val, seqno, p);
1332     fclose (f);
1333     xfree(fname);
1334     return 0;
1335 }
1336
1337 int zebra_get_state (ZebraHandle zh, char *val, int *seqno)
1338 {
1339     char state_fname[256];
1340     char *fname;
1341     FILE *f;
1342
1343     ASSERTZH;
1344     yaz_log(log_level, "zebra_get_state ");
1345     zh->errCode = 0;
1346     sprintf (state_fname, "state.%s.LCK", zh->reg_name);
1347     fname = zebra_mk_fname (res_get(zh->res, "lockDir"), state_fname);
1348     f = fopen (fname, "r");
1349     *val = 'o';
1350     *seqno = 0;
1351
1352     if (f)
1353     {
1354         fscanf (f, "%c %d", val, seqno);
1355         fclose (f);
1356     }
1357     xfree(fname);
1358     return 0;
1359 }
1360
1361 int zebra_begin_read (ZebraHandle zh)
1362 {
1363     return zebra_begin_trans(zh, 0);
1364 }
1365
1366 int zebra_end_read (ZebraHandle zh)
1367 {
1368     return zebra_end_trans(zh);
1369 }
1370
1371 static void read_res_for_transaction(ZebraHandle zh)
1372 {
1373     const char *group = res_get(zh->res, "group");
1374     const char *v;
1375     /* FIXME - do we still use groups ?? */
1376     
1377     zh->m_group = group;
1378     v = res_get_prefix(zh->res, "followLinks", group, "1");
1379     zh->m_follow_links = atoi(v);
1380
1381     zh->m_record_id = res_get_prefix(zh->res, "recordId", group, 0);
1382     zh->m_record_type = res_get_prefix(zh->res, "recordType", group, 0);
1383
1384     v = res_get_prefix(zh->res, "storeKeys", group, "1");
1385     zh->m_store_keys = atoi(v);
1386
1387     v = res_get_prefix(zh->res, "storeData", group, "1");
1388     zh->m_store_data = atoi(v);
1389
1390     v = res_get_prefix(zh->res, "explainDatabase", group, "0");
1391     zh->m_explain_database = atoi(v);
1392
1393     v = res_get_prefix(zh->res, "openRW", group, "1");
1394     zh->m_flag_rw = atoi(v);
1395
1396     v = res_get_prefix(zh->res, "fileVerboseLimit", group, "100000");
1397     zh->m_file_verbose_limit = atoi(v);
1398 }
1399
1400 int zebra_begin_trans (ZebraHandle zh, int rw)
1401 {
1402     ASSERTZH;
1403     if (!zh->res)
1404     {
1405         /* no database has been selected - so we select based on
1406            resource setting (including group)
1407         */
1408         const char *group = res_get(zh->service->global_res, "group");
1409         const char *v = res_get_prefix(zh->service->global_res,
1410                                        "database", group, "Default");
1411         zebra_select_database(zh, v);
1412     }
1413     if (!zh->res)
1414     {
1415         zh->errCode = 2;
1416         zh->errString = "zebra_begin_trans: no database selected";
1417         return -1;
1418     }
1419     ASSERTZHRES;
1420     yaz_log(log_level, "zebra_begin_trans rw=%d",rw);
1421
1422     if (zh->user_perm)
1423     {
1424         if (rw && !strchr(zh->user_perm, 'w'))
1425         {
1426             zh->errCode = 223;
1427             zh->errString = 0;
1428             return -1;
1429         }
1430     }
1431
1432     assert (zh->res);
1433     if (rw)
1434     {
1435         int pass;
1436         int seqno = 0;
1437         char val = '?';
1438         const char *rval = 0;
1439         
1440         (zh->trans_no++);
1441         if (zh->trans_w_no)
1442         {
1443             read_res_for_transaction(zh);
1444             return 0;
1445         }
1446         if (zh->trans_no != 1)
1447         {
1448             zh->errCode = 2;
1449             zh->errString = "zebra_begin_trans: write trans not allowed within read trans";
1450             return -1;
1451         }
1452         if (zh->reg)
1453         {
1454             resultSetInvalidate (zh);
1455             zebra_register_close (zh->service, zh->reg);
1456         }
1457         zh->trans_w_no = zh->trans_no;
1458
1459         zh->errCode = 0;
1460         
1461         zh->records_inserted = 0;
1462         zh->records_updated = 0;
1463         zh->records_deleted = 0;
1464         zh->records_processed = 0;
1465         
1466 #if HAVE_SYS_TIMES_H
1467         times (&zh->tms1);
1468 #endif
1469         /* lock */
1470         if (zh->shadow_enable)
1471             rval = res_get (zh->res, "shadow");
1472         
1473         for (pass = 0; pass < 2; pass++)
1474         {
1475             if (rval)
1476             {
1477                 zebra_lock_r (zh->lock_normal);
1478                 zebra_lock_w (zh->lock_shadow);
1479             }
1480             else
1481             {
1482                 zebra_lock_w (zh->lock_normal);
1483                 zebra_lock_w (zh->lock_shadow);
1484             }
1485             
1486             zebra_get_state (zh, &val, &seqno);
1487             if (val == 'c')
1488             {
1489                 yaz_log (YLOG_WARN, "previous transaction didn't finish commit");
1490                 zebra_unlock (zh->lock_shadow);
1491                 zebra_unlock (zh->lock_normal);
1492                 zebra_commit (zh);
1493                 continue;
1494             }
1495             else if (val == 'd')
1496             {
1497                 if (rval)
1498                 {
1499                     BFiles bfs = bfs_create (res_get (zh->res, "shadow"),
1500                                              zh->path_reg);
1501                     yaz_log (YLOG_WARN, "previous transaction didn't reach commit");
1502                     bf_commitClean (bfs, rval);
1503                     bfs_destroy (bfs);
1504             }
1505                 else
1506                 {
1507                     yaz_log (YLOG_WARN, "your previous transaction didn't finish");
1508                 }
1509             }
1510             break;
1511         }
1512         if (pass == 2)
1513         {
1514             yaz_log (YLOG_FATAL, "zebra_begin_trans couldn't finish commit");
1515             abort();
1516             return -1;
1517         }
1518         zebra_set_state (zh, 'd', seqno);
1519         
1520         zh->reg = zebra_register_open (zh->service, zh->reg_name,
1521                                        1, rval ? 1 : 0, zh->res,
1522                                        zh->path_reg);
1523         if (zh->reg)
1524             zh->reg->seqno = seqno;
1525         else
1526         {
1527             zebra_set_state (zh, 'o', seqno);
1528             
1529             zebra_unlock (zh->lock_shadow);
1530             zebra_unlock (zh->lock_normal);
1531
1532             zh->trans_no--;
1533             zh->trans_w_no = 0;
1534
1535             zh->errCode = 2;
1536             zh->errString = "zebra_begin_trans: cannot open register";
1537             yaz_log(YLOG_FATAL, zh->errString);
1538             return -1;
1539         }
1540     }
1541     else
1542     {
1543         int dirty = 0;
1544         char val;
1545         int seqno;
1546         
1547         (zh->trans_no)++;
1548         
1549         if (zh->trans_no != 1)
1550         {
1551             zebra_flush_reg (zh);
1552             return 0;
1553         }
1554         zh->errCode = 0;
1555 #if HAVE_SYS_TIMES_H
1556         times (&zh->tms1);
1557 #endif
1558         if (!zh->res)
1559         {
1560             (zh->trans_no)--;
1561             zh->errCode = 109;
1562             return -1;
1563         }
1564         if (!zh->lock_normal || !zh->lock_shadow)
1565         {
1566             (zh->trans_no)--;
1567             zh->errCode = 2;
1568             return -1;
1569         }
1570         zebra_get_state (zh, &val, &seqno);
1571         if (val == 'd')
1572             val = 'o';
1573         
1574         if (!zh->reg)
1575             dirty = 1;
1576         else if (seqno != zh->reg->seqno)
1577         {
1578             yaz_log (YLOG_DEBUG, "reopen seqno cur/old %d/%d",
1579                      seqno, zh->reg->seqno);
1580             dirty = 1;
1581         }
1582         else if (zh->reg->last_val != val)
1583         {
1584             yaz_log (YLOG_DEBUG, "reopen last cur/old %d/%d",
1585                      val, zh->reg->last_val);
1586             dirty = 1;
1587         }
1588         if (!dirty)
1589             return 0;
1590         
1591         if (val == 'c')
1592             zebra_lock_r (zh->lock_shadow);
1593         else
1594             zebra_lock_r (zh->lock_normal);
1595         
1596         if (zh->reg)
1597         {
1598             resultSetInvalidate (zh);
1599             zebra_register_close (zh->service, zh->reg);
1600         }
1601         zh->reg = zebra_register_open (zh->service, zh->reg_name,
1602                                        0, val == 'c' ? 1 : 0,
1603                                        zh->res, zh->path_reg);
1604         if (!zh->reg)
1605         {
1606             zebra_unlock (zh->lock_normal);
1607             zebra_unlock (zh->lock_shadow);
1608             zh->trans_no--;
1609             zh->errCode = 109;
1610             return -1;
1611         }
1612         zh->reg->last_val = val;
1613         zh->reg->seqno = seqno;
1614     }
1615     read_res_for_transaction(zh);
1616     return 0;
1617 }
1618
1619 int zebra_end_trans (ZebraHandle zh)
1620 {
1621     ZebraTransactionStatus dummy;
1622     ASSERTZH;
1623     yaz_log(log_level, "zebra_end_trans");
1624     return zebra_end_transaction(zh, &dummy);
1625 }
1626
1627 int zebra_end_transaction (ZebraHandle zh, ZebraTransactionStatus *status)
1628 {
1629     char val;
1630     int seqno;
1631     const char *rval;
1632
1633     ASSERTZH;
1634     assert(status);
1635     yaz_log(log_level, "zebra_end_transaction");
1636
1637     status->processed = 0;
1638     status->inserted  = 0;
1639     status->updated   = 0;
1640     status->deleted   = 0;
1641     status->utime     = 0;
1642     status->stime     = 0;
1643
1644     if (!zh->res || !zh->reg)
1645     {
1646         zh->errCode = 2;
1647         zh->errString = "zebra_end_trans: no open transaction";
1648         return -1;
1649     }
1650     if (zh->trans_no != zh->trans_w_no)
1651     {
1652         zh->trans_no--;
1653         if (zh->trans_no != 0)
1654             return 0;
1655
1656         /* release read lock */
1657
1658         zebra_unlock (zh->lock_normal);
1659         zebra_unlock (zh->lock_shadow);
1660     }
1661     else
1662     {   /* release write lock */
1663         zh->trans_no--;
1664         zh->trans_w_no = 0;
1665         
1666         yaz_log (YLOG_DEBUG, "zebra_end_trans");
1667         rval = res_get (zh->res, "shadow");
1668         
1669         zebraExplain_runNumberIncrement (zh->reg->zei, 1);
1670         
1671         zebra_flush_reg (zh);
1672         
1673         resultSetInvalidate (zh);
1674
1675         zebra_register_close (zh->service, zh->reg);
1676         zh->reg = 0;
1677         
1678         yaz_log (YLOG_LOG, "Records: "ZINT_FORMAT" i/u/d "
1679                         ZINT_FORMAT"/"ZINT_FORMAT"/"ZINT_FORMAT, 
1680                  zh->records_processed, zh->records_inserted,
1681                  zh->records_updated, zh->records_deleted);
1682         
1683         status->processed = zh->records_processed;
1684         status->inserted = zh->records_inserted;
1685         status->updated = zh->records_updated;
1686         status->deleted = zh->records_deleted;
1687         
1688         zebra_get_state (zh, &val, &seqno);
1689         if (val != 'd')
1690         {
1691             BFiles bfs = bfs_create (rval, zh->path_reg);
1692             yaz_log (YLOG_DEBUG, "deleting shadow val=%c", val);
1693             bf_commitClean (bfs, rval);
1694             bfs_destroy (bfs);
1695         }
1696         if (!rval)
1697             seqno++;
1698         zebra_set_state (zh, 'o', seqno);
1699         
1700         zebra_unlock (zh->lock_shadow);
1701         zebra_unlock (zh->lock_normal);
1702         
1703     }
1704 #if HAVE_SYS_TIMES_H
1705     times (&zh->tms2);
1706     yaz_log (log_level, "user/system: %ld/%ld",
1707           (long) (zh->tms2.tms_utime - zh->tms1.tms_utime),
1708           (long) (zh->tms2.tms_stime - zh->tms1.tms_stime));
1709     
1710     status->utime = (long) (zh->tms2.tms_utime - zh->tms1.tms_utime);
1711     status->stime = (long) (zh->tms2.tms_stime - zh->tms1.tms_stime);
1712 #endif
1713     return 0;
1714 }
1715
1716 int zebra_repository_update (ZebraHandle zh, const char *path)
1717 {
1718     ASSERTZH;
1719     assert(path);
1720     zh->errCode = 0;
1721     yaz_log (log_level, "updating %s", path);
1722     repositoryUpdate (zh, path);
1723     return zh->errCode;
1724 }
1725
1726 int zebra_repository_delete (ZebraHandle zh, const char *path)
1727 {
1728     ASSERTZH;
1729     assert(path);
1730     zh->errCode = 0;
1731     yaz_log (log_level, "deleting %s", path);
1732     repositoryDelete (zh, path);
1733     return zh->errCode;
1734 }
1735
1736 int zebra_repository_show (ZebraHandle zh, const char *path)
1737 {
1738     ASSERTZH;
1739     assert(path);
1740     yaz_log(log_level, "zebra_repository_show");
1741     zh->errCode = 0;
1742     repositoryShow (zh, path);
1743     return zh->errCode;
1744 }
1745
1746 static int zebra_commit_ex (ZebraHandle zh, int clean_only)
1747 {
1748     int seqno;
1749     char val;
1750     const char *rval;
1751     BFiles bfs;
1752     ASSERTZH;
1753     zh->errCode = 0;
1754
1755     if (!zh->res)
1756     {
1757         zh->errCode = 109;
1758         return -1;
1759     }
1760     rval = res_get (zh->res, "shadow");    
1761     if (!rval)
1762     {
1763         yaz_log (YLOG_WARN, "Cannot perform commit - No shadow area defined");
1764         return 0;
1765     }
1766
1767     zebra_lock_w (zh->lock_normal);
1768     zebra_lock_r (zh->lock_shadow);
1769
1770     bfs = bfs_create (res_get (zh->res, "register"), zh->path_reg);
1771
1772     zebra_get_state (zh, &val, &seqno);
1773
1774     if (rval && *rval)
1775         bf_cache (bfs, rval);
1776     if (bf_commitExists (bfs))
1777     {
1778         if (clean_only)
1779             zebra_set_state (zh, 'd', seqno);
1780         else
1781         {
1782             zebra_set_state (zh, 'c', seqno);
1783             
1784             yaz_log (YLOG_DEBUG, "commit start");
1785             bf_commitExec (bfs);
1786 #ifndef WIN32
1787             sync ();
1788 #endif
1789         }
1790         yaz_log (YLOG_DEBUG, "commit clean");
1791         bf_commitClean (bfs, rval);
1792         seqno++;
1793         zebra_set_state (zh, 'o', seqno);
1794     }
1795     else
1796     {
1797         yaz_log (log_level, "nothing to commit");
1798     }
1799     bfs_destroy (bfs);
1800
1801     zebra_unlock (zh->lock_shadow);
1802     zebra_unlock (zh->lock_normal);
1803     return 0;
1804 }
1805
1806 int zebra_clean (ZebraHandle zh)
1807 {
1808     ASSERTZH;
1809     yaz_log(log_level, "zebra_clean");
1810     return zebra_commit_ex(zh, 1);
1811 }
1812
1813 int zebra_commit (ZebraHandle zh)
1814 {
1815     ASSERTZH;
1816     yaz_log(log_level, "zebra_commit");
1817     return zebra_commit_ex(zh, 0);
1818 }
1819
1820 int zebra_init (ZebraHandle zh)
1821 {
1822     const char *rval;
1823     BFiles bfs = 0;
1824     ASSERTZH;
1825     yaz_log(log_level, "zebra_init");
1826     zh->errCode = 0;
1827
1828     if (!zh->res)
1829     {
1830         zh->errCode = 109;
1831         return -1;
1832     }
1833     rval = res_get (zh->res, "shadow");
1834
1835     bfs = bfs_create (res_get (zh->service->global_res, "register"),
1836                       zh->path_reg);
1837     if (!bfs)
1838         return -1;
1839     if (rval && *rval)
1840         bf_cache (bfs, rval);
1841     
1842     bf_reset (bfs);
1843     bfs_destroy (bfs);
1844     zebra_set_state (zh, 'o', 0);
1845     return 0;
1846 }
1847
1848 int zebra_compact (ZebraHandle zh)
1849 {
1850     BFiles bfs;
1851     ASSERTZH;
1852     yaz_log(log_level, "zebra_compact");
1853     zh->errCode = 0;
1854     if (!zh->res)
1855     {
1856         zh->errCode = 109;
1857         return -1;
1858     }
1859     bfs = bfs_create (res_get (zh->res, "register"), zh->path_reg);
1860     inv_compact (bfs);
1861     bfs_destroy (bfs);
1862     return 0;
1863 }
1864
1865 int zebra_result (ZebraHandle zh, int *code, char **addinfo)
1866 {
1867     ASSERTZH;
1868     yaz_log(log_level, "zebra_result");
1869     *code = zh->errCode;
1870     *addinfo = zh->errString;
1871     return 0;
1872 }
1873
1874 int zebra_shadow_enable (ZebraHandle zh, int value)
1875 {
1876     ASSERTZH;
1877     yaz_log(log_level, "zebra_shadow_enable");
1878     zh->errCode = 0;
1879     zh->shadow_enable = value;
1880     return 0;
1881 }
1882
1883 int zebra_octet_term_encoding(ZebraHandle zh, const char *encoding)
1884 {
1885     ASSERTZH;
1886     assert(encoding);
1887     yaz_log(log_level, "zebra_octet_term_encoding");
1888     zh->errCode = 0;
1889
1890     if (zh->iconv_to_utf8 != 0)
1891         yaz_iconv_close(zh->iconv_to_utf8);
1892     if (zh->iconv_from_utf8 != 0)
1893         yaz_iconv_close(zh->iconv_from_utf8);
1894     
1895     zh->iconv_to_utf8 =
1896         yaz_iconv_open ("UTF-8", encoding);
1897     if (zh->iconv_to_utf8 == 0)
1898         yaz_log (YLOG_WARN, "iconv: %s to UTF-8 unsupported", encoding);
1899     zh->iconv_from_utf8 =
1900         yaz_iconv_open (encoding, "UTF-8");
1901     if (zh->iconv_to_utf8 == 0)
1902         yaz_log (YLOG_WARN, "iconv: UTF-8 to %s unsupported", encoding);
1903
1904     return 0;
1905 }
1906
1907 int zebra_record_encoding (ZebraHandle zh, const char *encoding)
1908 {
1909     ASSERTZH;
1910     yaz_log(log_level, "zebra_record_encoding");
1911     zh->errCode = 0;
1912     xfree(zh->record_encoding);
1913     zh->record_encoding = 0;
1914     if (encoding)
1915         zh->record_encoding = xstrdup (encoding);
1916     return 0;
1917 }
1918
1919 int zebra_set_resource(ZebraHandle zh, const char *name, const char *value)
1920 {
1921     ASSERTZH;
1922     assert(name);
1923     assert(value);
1924     yaz_log(log_level, "zebra_set_resource %s:%s",name,value);
1925     zh->errCode = 0;
1926     res_set(zh->res, name, value);
1927     return 0;
1928 }
1929
1930 const char *zebra_get_resource(ZebraHandle zh,
1931                                const char *name, const char *defaultvalue)
1932 {
1933     const char *v;
1934     ASSERTZH;
1935     assert(name);
1936     assert(defaultvalue);
1937     v= res_get_def( zh->res, name, (char *)defaultvalue);
1938     zh->errCode = 0;
1939     yaz_log(log_level, "zebra_get_resource %s:%s",name,v);
1940     return v;
1941 }
1942
1943 /* moved from zebra_api_ext.c by pop */
1944 /* FIXME: Should this really be public??? -Heikki */
1945
1946 int zebra_trans_no (ZebraHandle zh)
1947 {
1948     ASSERTZH;
1949     yaz_log(log_level, "zebra_trans_no");
1950     return zh->trans_no;
1951 }
1952
1953 int zebra_get_shadow_enable (ZebraHandle zh)
1954 {
1955     ASSERTZH;
1956     yaz_log(log_level, "zebra_get_shadow_enable");
1957     return (zh->shadow_enable);
1958 }
1959
1960 int zebra_set_shadow_enable (ZebraHandle zh, int value)
1961 {
1962     ASSERTZH;
1963     yaz_log(log_level, "zebra_set_shadow_enable %d",value);
1964     zh->shadow_enable = value;
1965     return 0;
1966 }
1967
1968 /* Used by Perl API.. Added the record buffer dup to zebra_records_retrieve
1969    so that it's identicical to the original api_records_retrieve */
1970 void api_records_retrieve (ZebraHandle zh, ODR stream,
1971                            const char *setname, Z_RecordComposition *comp,
1972                            oid_value input_format, int num_recs,
1973                            ZebraRetrievalRecord *recs)
1974 {
1975     zebra_records_retrieve(zh, stream, setname, comp, input_format,
1976                            num_recs, recs);
1977 }
1978
1979 /* ---------------------------------------------------------------------------
1980   Record insert(=update), delete 
1981
1982   If sysno is provided, then it's used to identify the record.
1983   If not, and match_criteria is provided, then sysno is guessed
1984   If not, and a record is provided, then sysno is got from there
1985 NOTE: Now returns 0 at success and updates sysno, which is an int*
1986   20-jun-2003 Heikki
1987 */
1988
1989 int zebra_add_record(ZebraHandle zh,
1990                      const char *buf, int buf_size)
1991 {
1992     SYSNO sysno = 0;
1993     return zebra_update_record(zh, 0, &sysno, 0, 0, buf, buf_size, 0);
1994 }
1995
1996 int zebra_insert_record (ZebraHandle zh, 
1997                          const char *recordType,
1998                          SYSNO *sysno, const char *match, const char *fname,
1999                          const char *buf, int buf_size, int force_update)
2000 {
2001     int res;
2002     ASSERTZH;
2003     assert(sysno);
2004     assert(buf);
2005     yaz_log(log_level, "zebra_insert_record sysno=" ZINT_FORMAT, *sysno);
2006
2007     if (buf_size < 1)
2008         buf_size = strlen(buf);
2009
2010     if (zebra_begin_trans(zh, 1))
2011         return 1;
2012     res = buffer_extract_record (zh, buf, buf_size, 
2013                                  0, /* delete_flag  */
2014                                  0, /* test_mode */
2015                                  recordType,
2016                                  sysno,   
2017                                  match, fname,
2018                                  0, 
2019                                  0); /* allow_update */
2020     zebra_end_trans(zh); 
2021     return res; 
2022 }
2023
2024 int zebra_update_record (ZebraHandle zh, 
2025                          const char *recordType,
2026                          SYSNO* sysno, const char *match, const char *fname,
2027                          const char *buf, int buf_size,
2028                          int force_update)
2029 {
2030     int res;
2031     ASSERTZH;
2032     assert(sysno);
2033     assert(buf);
2034
2035     yaz_log(log_level, "zebra_update_record sysno=" ZINT_FORMAT, *sysno);
2036
2037     if (buf_size < 1) buf_size = strlen(buf);
2038
2039     if (zebra_begin_trans(zh, 1))
2040         return 1;
2041     res = buffer_extract_record (zh, buf, buf_size, 
2042                                  0, /* delete_flag */
2043                                  0, /* test_mode */
2044                                  recordType,
2045                                  sysno,   
2046                                  match, fname,
2047                                  force_update, 
2048                                  1); /* allow_update */
2049     zebra_end_trans(zh); 
2050     return res; 
2051 }
2052
2053 int zebra_delete_record (ZebraHandle zh, 
2054                          const char *recordType,
2055                          SYSNO *sysno, const char *match, const char *fname,
2056                          const char *buf, int buf_size,
2057                          int force_update) 
2058 {
2059     int res;
2060     ASSERTZH;
2061     assert(sysno);
2062     assert(buf);
2063     yaz_log(log_level, "zebra_delete_record sysno=" ZINT_FORMAT, *sysno);
2064
2065     if (buf_size < 1) buf_size = strlen(buf);
2066
2067     if (zebra_begin_trans(zh, 1))
2068         return 1;
2069     res = buffer_extract_record (zh, buf, buf_size,
2070                                  1, /* delete_flag */
2071                                  0, /* test_mode */
2072                                  recordType,
2073                                  sysno,
2074                                  match,fname,
2075                                  force_update,
2076                                  1); /* allow_update */
2077     zebra_end_trans(zh);
2078     return res;   
2079 }
2080
2081 /* ---------------------------------------------------------------------------
2082   Searching 
2083 */
2084
2085 int zebra_search_PQF (ZebraHandle zh, const char *pqf_query,
2086                       const char *setname, int *numhits)
2087 {
2088     int hits = 0;
2089     int res = -1;
2090     Z_RPNQuery *query;
2091     ODR odr = odr_createmem(ODR_ENCODE);
2092     ASSERTZH;
2093     assert(pqf_query);
2094     assert(setname);
2095
2096     yaz_log(log_level, "zebra_search_PQF s=%s q=%s",setname, pqf_query);
2097     
2098     query = p_query_rpn (odr, PROTO_Z3950, pqf_query);
2099     
2100     if (!query)
2101         yaz_log (YLOG_WARN, "bad query %s\n", pqf_query);
2102     else
2103         res = zebra_search_RPN (zh, odr, query, setname, &hits);
2104     
2105     odr_destroy(odr);
2106
2107     yaz_log(log_level, "Hits: %d",hits);
2108
2109     if (numhits)
2110         *numhits = hits;
2111
2112     return res;
2113 }
2114
2115 /* ---------------------------------------------------------------------------
2116   Sort - a simplified interface, with optional read locks.
2117 */
2118 int zebra_sort_by_specstr (ZebraHandle zh, ODR stream,
2119                            const char *sort_spec,
2120                            const char *output_setname,
2121                            const char **input_setnames) 
2122 {
2123     int num_input_setnames = 0;
2124     int sort_status = 0;
2125     Z_SortKeySpecList *sort_sequence;
2126     ASSERTZH;
2127     assert(stream);
2128     assert(sort_spec);
2129     assert(output_setname);
2130     assert(input_setnames);
2131     sort_sequence = yaz_sort_spec (stream, sort_spec);
2132     yaz_log(log_level, "sort (FIXME) ");
2133     if (!sort_sequence)
2134     {
2135         yaz_log(YLOG_WARN, "invalid sort specs '%s'", sort_spec);
2136         zh->errCode = 207;
2137         return -1;
2138     }
2139     
2140     /* we can do this, since the perl typemap code for char** will 
2141        put a NULL at the end of list */
2142     while (input_setnames[num_input_setnames]) num_input_setnames++;
2143
2144     if (zebra_begin_read (zh))
2145         return -1;
2146     
2147     resultSetSort (zh, stream->mem, num_input_setnames, input_setnames,
2148                    output_setname, sort_sequence, &sort_status);
2149     
2150     zebra_end_read(zh);
2151     return sort_status;
2152 }
2153