index/zebraapi.c

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