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