index/zebraapi.c

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