index/zebraapi.c

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