index/zebraapi.c

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