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