index/zebraapi.c

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