/* $Id: zebraapi.c,v 1.120.2.4 2005/01/23 14:59:42 adam Exp $ Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004 Index Data Aps This file is part of the Zebra server. Zebra is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2, or (at your option) any later version. Zebra is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details. You should have received a copy of the GNU General Public License along with Zebra; see the file LICENSE.zebra. If not, write to the Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ #include #include #ifdef WIN32 #include #include #include #else #include #endif #include #include #include #include #include "index.h" #include #include "zebraapi.h" /* simple asserts to validate the most essential input args */ #define ASSERTZH assert(zh && zh->service) #define ASSERTZHRES assert(zh && zh->service && zh->res) #define ASSERTZS assert(zs) /* A simple log macro */ /* don't break with older yazen that lack log_app2 */ #ifdef LOG_APP2 #define LOG_API LOG_APP2 #else #define LOG_API LOG_DEBUG #endif static Res zebra_open_res (ZebraHandle zh); static void zebra_close_res (ZebraHandle zh); static void zebra_chdir (ZebraService zs) { const char *dir ; ASSERTZS; yaz_log(LOG_API,"zebra_chdir"); dir = res_get (zs->global_res, "chdir"); if (!dir) return; logf (LOG_DEBUG, "chdir %s", dir); #ifdef WIN32 _chdir(dir); #else chdir (dir); #endif } static void zebra_flush_reg (ZebraHandle zh) { ASSERTZH; yaz_log(LOG_API,"zebra_flush_reg"); zh->errCode=0; zebraExplain_flush (zh->reg->zei, zh); extract_flushWriteKeys (zh,1 /* final */); zebra_index_merge (zh ); } static struct zebra_register *zebra_register_open (ZebraService zs, const char *name, int rw, int useshadow, Res res, const char *reg_path); static void zebra_register_close (ZebraService zs, struct zebra_register *reg); ZebraHandle zebra_open (ZebraService zs) { ZebraHandle zh; const char *default_encoding; ASSERTZS; yaz_log(LOG_API,"zebra_open"); if (!zs) return 0; zh = (ZebraHandle) xmalloc (sizeof(*zh)); yaz_log (LOG_DEBUG, "zebra_open zs=%p returns %p", zs, zh); zh->service = zs; zh->reg = 0; /* no register attached yet */ zh->sets = 0; zh->destroyed = 0; zh->errCode = 0; zh->errString = 0; zh->res = 0; zh->user_perm = 0; zh->reg_name = xstrdup (""); zh->path_reg = 0; zh->num_basenames = 0; zh->basenames = 0; zh->trans_no = 0; zh->trans_w_no = 0; zh->lock_normal = 0; zh->lock_shadow = 0; zh->shadow_enable = 1; default_encoding = res_get_def(zs->global_res, "encoding", "ISO-8859-1"); zh->record_encoding = xstrdup (default_encoding); zh->iconv_to_utf8 = yaz_iconv_open ("UTF-8", default_encoding); if (zh->iconv_to_utf8 == 0) yaz_log (LOG_WARN, "iconv: %s to UTF-8 unsupported", default_encoding); zh->iconv_from_utf8 = yaz_iconv_open (default_encoding, "UTF-8"); if (zh->iconv_to_utf8 == 0) yaz_log (LOG_WARN, "iconv: UTF-8 to %s unsupported", default_encoding); zebra_mutex_cond_lock (&zs->session_lock); zh->next = zs->sessions; zs->sessions = zh; zebra_mutex_cond_unlock (&zs->session_lock); return zh; } ZebraService zebra_start (const char *configName) { return zebra_start_res(configName, 0, 0); } ZebraService zebra_start_res (const char *configName, Res def_res, Res over_res) { Res res; yaz_log(LOG_API|LOG_LOG,"zebra_start %s",configName); if ((res = res_open (configName, def_res, over_res))) { ZebraService zh = xmalloc (sizeof(*zh)); yaz_log (LOG_DEBUG, "Read resources `%s'", configName); zh->global_res = res; zh->configName = xstrdup(configName); zh->sessions = 0; zebra_chdir (zh); zebra_mutex_cond_init (&zh->session_lock); if (!res_get (zh->global_res, "passwd")) zh->passwd_db = NULL; else { zh->passwd_db = passwd_db_open (); if (!zh->passwd_db) logf (LOG_WARN|LOG_ERRNO, "passwd_db_open failed"); else passwd_db_file (zh->passwd_db, res_get (zh->global_res, "passwd")); } zh->path_root = res_get (zh->global_res, "root"); return zh; } return 0; } void zebra_pidfname(ZebraService zs, char *path) { zebra_lock_prefix (zs->global_res, path); strcat(path, "zebrasrv.pid"); } static struct zebra_register *zebra_register_open (ZebraService zs, const char *name, int rw, int useshadow, Res res, const char *reg_path) { struct zebra_register *reg; int record_compression = REC_COMPRESS_NONE; const char *recordCompression = 0; const char *profilePath; char cwd[1024]; ASSERTZS; reg = xmalloc (sizeof(*reg)); assert (name); reg->name = xstrdup (name); reg->seqno = 0; reg->last_val = 0; assert (res); yaz_log (LOG_LOG|LOG_API, "zebra_register_open rw = %d useshadow=%d p=%p,n=%s,rp=%s", rw, useshadow, reg, name, reg_path ? reg_path : "(none)"); reg->dh = data1_createx (DATA1_FLAG_XML); if (!reg->dh) return 0; reg->bfs = bfs_create (res_get (res, "register"), reg_path); if (!reg->bfs) { data1_destroy(reg->dh); return 0; } if (useshadow) bf_cache (reg->bfs, res_get (res, "shadow")); getcwd(cwd, sizeof(cwd)-1); profilePath = res_get_def(res, "profilePath", DEFAULT_PROFILE_PATH); yaz_log(LOG_LOG, "profilePath=%s cwd=%s", profilePath, cwd); data1_set_tabpath (reg->dh, profilePath); data1_set_tabroot (reg->dh, reg_path); reg->recTypes = recTypes_init (reg->dh); recTypes_default_handlers (reg->recTypes); reg->zebra_maps = zebra_maps_open (res, reg_path); reg->rank_classes = NULL; reg->key_buf = 0; reg->keys.buf_max = 0; reg->keys.buf = 0; reg->sortKeys.buf = 0; reg->sortKeys.buf_max = 0; reg->records = 0; reg->dict = 0; reg->sortIdx = 0; reg->isams = 0; reg->matchDict = 0; reg->isam = 0; reg->isamc = 0; reg->isamd = 0; reg->isamb = 0; reg->zei = 0; reg->matchDict = 0; reg->key_file_no = 0; reg->ptr_i=0; zebraRankInstall (reg, rank1_class); zebraRankInstall (reg, rankzv_class); zebraRankInstall (reg, rankliv_class); recordCompression = res_get_def (res, "recordCompression", "none"); if (!strcmp (recordCompression, "none")) record_compression = REC_COMPRESS_NONE; if (!strcmp (recordCompression, "bzip2")) record_compression = REC_COMPRESS_BZIP2; if (!(reg->records = rec_open (reg->bfs, rw, record_compression))) { logf (LOG_WARN, "rec_open"); return 0; } if (rw) { reg->matchDict = dict_open (reg->bfs, GMATCH_DICT, 20, 1, 0); } if (!(reg->dict = dict_open (reg->bfs, FNAME_DICT, 40, rw, 0))) { logf (LOG_WARN, "dict_open"); return 0; } if (!(reg->sortIdx = sortIdx_open (reg->bfs, rw))) { logf (LOG_WARN, "sortIdx_open"); return 0; } if (res_get_match (res, "isam", "s", ISAM_DEFAULT)) { struct ISAMS_M_s isams_m; if (!(reg->isams = isams_open (reg->bfs, FNAME_ISAMS, rw, key_isams_m(res, &isams_m)))) { logf (LOG_WARN, "isams_open"); return 0; } } if (res_get_match (res, "isam", "i", ISAM_DEFAULT)) { if (!(reg->isam = is_open (reg->bfs, FNAME_ISAM, key_compare, rw, sizeof (struct it_key), res))) { logf (LOG_WARN, "is_open"); return 0; } } if (res_get_match (res, "isam", "c", ISAM_DEFAULT)) { struct ISAMC_M_s isamc_m; if (!(reg->isamc = isc_open (reg->bfs, FNAME_ISAMC, rw, key_isamc_m(res, &isamc_m)))) { logf (LOG_WARN, "isc_open"); return 0; } } if (res_get_match (res, "isam", "d", ISAM_DEFAULT)) { struct ISAMD_M_s isamd_m; if (!(reg->isamd = isamd_open (reg->bfs, FNAME_ISAMD, rw, key_isamd_m(res, &isamd_m)))) { logf (LOG_WARN, "isamd_open"); return 0; } } if (res_get_match (res, "isam", "b", ISAM_DEFAULT)) { struct ISAMC_M_s isamc_m; if (!(reg->isamb = isamb_open (reg->bfs, "isamb", rw, key_isamc_m(res, &isamc_m), 0))) { logf (LOG_WARN, "isamb_open"); return 0; } } if (res_get_match (res, "isam", "bc", ISAM_DEFAULT)) { struct ISAMC_M_s isamc_m; if (!(reg->isamb = isamb_open (reg->bfs, "isamb", rw, key_isamc_m(res, &isamc_m), 1))) { logf (LOG_WARN, "isamb_open"); return 0; } } if (res_get_match (res, "isam", "null", ISAM_DEFAULT)) { struct ISAMC_M_s isamc_m; if (!(reg->isamb = isamb_open (reg->bfs, "isamb", rw, key_isamc_m(res, &isamc_m), -1))) { logf (LOG_WARN, "isamb_open"); return 0; } } reg->zei = zebraExplain_open (reg->records, reg->dh, res, rw, reg, explain_extract); if (!reg->zei) { logf (LOG_WARN, "Cannot obtain EXPLAIN information"); return 0; } reg->active = 2; yaz_log (LOG_DEBUG, "zebra_register_open ok p=%p", reg); return reg; } int zebra_admin_shutdown (ZebraHandle zh) { ASSERTZH; yaz_log(LOG_API,"zebra_admin_shutdown"); zh->errCode=0; zebra_mutex_cond_lock (&zh->service->session_lock); zh->service->stop_flag = 1; zebra_mutex_cond_unlock (&zh->service->session_lock); return 0; } int zebra_admin_start (ZebraHandle zh) { ZebraService zs; ASSERTZH; yaz_log(LOG_API,"zebra_admin_start"); zh->errCode=0; zs = zh->service; zebra_mutex_cond_lock (&zs->session_lock); zebra_mutex_cond_unlock (&zs->session_lock); return 0; } static void zebra_register_close (ZebraService zs, struct zebra_register *reg) { ASSERTZS; yaz_log(LOG_LOG|LOG_API, "zebra_register_close p=%p", reg); reg->stop_flag = 0; zebra_chdir (zs); if (reg->records) { zebraExplain_close (reg->zei); dict_close (reg->dict); if (reg->matchDict) dict_close (reg->matchDict); sortIdx_close (reg->sortIdx); if (reg->isams) isams_close (reg->isams); if (reg->isam) is_close (reg->isam); if (reg->isamc) isc_close (reg->isamc); if (reg->isamd) isamd_close (reg->isamd); if (reg->isamb) isamb_close (reg->isamb); rec_close (®->records); } recTypes_destroy (reg->recTypes); zebra_maps_close (reg->zebra_maps); zebraRankDestroy (reg); bfs_destroy (reg->bfs); data1_destroy (reg->dh); xfree (reg->sortKeys.buf); xfree (reg->keys.buf); xfree (reg->key_buf); xfree (reg->name); xfree (reg); } int zebra_stop(ZebraService zs) { if (!zs) return 0; yaz_log (LOG_LOG|LOG_API, "zebra_stop"); while (zs->sessions) { zebra_close (zs->sessions); } zebra_mutex_cond_destroy (&zs->session_lock); if (zs->passwd_db) passwd_db_close (zs->passwd_db); res_close (zs->global_res); xfree (zs->configName); xfree (zs); return 0; } int zebra_close (ZebraHandle zh) { ZebraService zs; struct zebra_session **sp; int i; yaz_log(LOG_API,"zebra_close"); if (!zh) return 0; ASSERTZH; zh->errCode=0; zs = zh->service; yaz_log (LOG_DEBUG, "zebra_close zh=%p", zh); resultSetDestroy (zh, -1, 0, 0); if (zh->reg) zebra_register_close (zh->service, zh->reg); zebra_close_res (zh); xfree (zh->record_encoding); for (i = 0; i < zh->num_basenames; i++) xfree (zh->basenames[i]); xfree (zh->basenames); if (zh->iconv_to_utf8 != 0) yaz_iconv_close (zh->iconv_to_utf8); if (zh->iconv_from_utf8 != 0) yaz_iconv_close (zh->iconv_from_utf8); zebra_mutex_cond_lock (&zs->session_lock); zebra_lock_destroy (zh->lock_normal); zebra_lock_destroy (zh->lock_shadow); sp = &zs->sessions; while (1) { assert (*sp); if (*sp == zh) { *sp = (*sp)->next; break; } sp = &(*sp)->next; } zebra_mutex_cond_unlock (&zs->session_lock); xfree (zh->reg_name); xfree (zh->user_perm); zh->service=0; /* more likely to trigger an assert */ xfree (zh->path_reg); xfree (zh); return 0; } struct map_baseinfo { ZebraHandle zh; NMEM mem; int num_bases; char **basenames; int new_num_bases; char **new_basenames; int new_num_max; }; static Res zebra_open_res (ZebraHandle zh) { Res res = 0; char fname[512]; ASSERTZH; zh->errCode=0; if (zh->path_reg) { sprintf (fname, "%.200s/zebra.cfg", zh->path_reg); res = res_open (fname, zh->service->global_res, 0); if (!res) res = zh->service->global_res; } else if (*zh->reg_name == 0) { res = zh->service->global_res; } else { yaz_log (LOG_WARN, "no register root specified"); return 0; /* no path for register - fail! */ } return res; } static void zebra_close_res (ZebraHandle zh) { ASSERTZH; zh->errCode=0; if (zh->res != zh->service->global_res) res_close (zh->res); zh->res = 0; } static int zebra_select_register (ZebraHandle zh, const char *new_reg) { ASSERTZH; zh->errCode=0; if (zh->res && strcmp (zh->reg_name, new_reg) == 0) return 0; if (!zh->res) { assert (zh->reg == 0); assert (*zh->reg_name == 0); } else { if (zh->reg) { resultSetInvalidate (zh); zebra_register_close (zh->service, zh->reg); zh->reg = 0; } zebra_close_res(zh); } xfree (zh->reg_name); zh->reg_name = xstrdup (new_reg); xfree (zh->path_reg); zh->path_reg = 0; if (zh->service->path_root) { zh->path_reg = xmalloc (strlen(zh->service->path_root) + strlen(zh->reg_name) + 3); strcpy (zh->path_reg, zh->service->path_root); if (*zh->reg_name) { strcat (zh->path_reg, "/"); strcat (zh->path_reg, zh->reg_name); } } zh->res = zebra_open_res (zh); if (zh->lock_normal) zebra_lock_destroy (zh->lock_normal); zh->lock_normal = 0; if (zh->lock_shadow) zebra_lock_destroy (zh->lock_shadow); zh->lock_shadow = 0; if (zh->res) { char fname[512]; const char *lock_area =res_get (zh->res, "lockDir"); if (!lock_area && zh->path_reg) res_set (zh->res, "lockDir", zh->path_reg); sprintf (fname, "norm.%s.LCK", zh->reg_name); zh->lock_normal = zebra_lock_create (res_get(zh->res, "lockDir"), fname, 0); sprintf (fname, "shadow.%s.LCK", zh->reg_name); zh->lock_shadow = zebra_lock_create (res_get(zh->res, "lockDir"), fname, 0); } return 1; } void map_basenames_func (void *vp, const char *name, const char *value) { struct map_baseinfo *p = (struct map_baseinfo *) vp; int i, no; char fromdb[128], todb[8][128]; no = sscanf (value, "%127s %127s %127s %127s %127s %127s %127s %127s %127s", fromdb, todb[0], todb[1], todb[2], todb[3], todb[4], todb[5], todb[6], todb[7]); if (no < 2) return ; no--; for (i = 0; inum_bases; i++) if (p->basenames[i] && !STRCASECMP (p->basenames[i], fromdb)) { p->basenames[i] = 0; for (i = 0; i < no; i++) { if (p->new_num_bases == p->new_num_max) return; p->new_basenames[(p->new_num_bases)++] = nmem_strdup (p->mem, todb[i]); } return; } } void map_basenames (ZebraHandle zh, ODR stream, int *num_bases, char ***basenames) { struct map_baseinfo info; struct map_baseinfo *p = &info; int i; ASSERTZH; yaz_log(LOG_API,"map_basenames "); zh->errCode=0; info.zh = zh; info.num_bases = *num_bases; info.basenames = *basenames; info.new_num_max = 128; info.new_num_bases = 0; info.new_basenames = (char **) odr_malloc (stream, sizeof(*info.new_basenames) * info.new_num_max); info.mem = stream->mem; res_trav (zh->service->global_res, "mapdb", &info, map_basenames_func); for (i = 0; inum_bases; i++) if (p->basenames[i] && p->new_num_bases < p->new_num_max) { p->new_basenames[(p->new_num_bases)++] = nmem_strdup (p->mem, p->basenames[i]); } *num_bases = info.new_num_bases; *basenames = info.new_basenames; for (i = 0; i<*num_bases; i++) logf (LOG_LOG, "base %s", (*basenames)[i]); } int zebra_select_default_database(ZebraHandle zh) { if (!zh->res) { /* no database has been selected - so we select based on resource setting (including group) */ const char *group = res_get(zh->service->global_res, "group"); const char *v = res_get_prefix(zh->service->global_res, "database", group, "Default"); zebra_select_database(zh, v); } return 0; } int zebra_select_database (ZebraHandle zh, const char *basename) { ASSERTZH; yaz_log(LOG_API,"zebra_select_database %s",basename); zh->errCode=0; return zebra_select_databases (zh, 1, &basename); } int zebra_select_databases (ZebraHandle zh, int num_bases, const char **basenames) { int i; const char *cp; int len = 0; char *new_reg = 0; ASSERTZH; yaz_log(LOG_API,"zebra_select_databases n=%d [0]=%s", num_bases,basenames[0]); zh->errCode=0; if (num_bases < 1) { zh->errCode = 23; return -1; } for (i = 0; i < zh->num_basenames; i++) xfree (zh->basenames[i]); xfree (zh->basenames); zh->num_basenames = num_bases; zh->basenames = xmalloc (zh->num_basenames * sizeof(*zh->basenames)); for (i = 0; i < zh->num_basenames; i++) zh->basenames[i] = xstrdup (basenames[i]); cp = strrchr(basenames[0], '/'); if (cp) { len = cp - basenames[0]; new_reg = xmalloc (len + 1); memcpy (new_reg, basenames[0], len); new_reg[len] = '\0'; } else new_reg = xstrdup (""); for (i = 1; ierrCode = 23; return -1; } if (len != cp1 - basenames[i] || memcmp (basenames[i], new_reg, len)) { zh->errCode = 23; return -1; } } else { if (cp1) { zh->errCode = 23; return -1; } } } zebra_select_register (zh, new_reg); xfree (new_reg); if (!zh->res) { zh->errCode = 109; return -1; } if (!zh->lock_normal || !zh->lock_shadow) { zh->errCode = 2; return -1; } return 0; } int zebra_search_RPN (ZebraHandle zh, ODR o, Z_RPNQuery *query, const char *setname, int *hits) { ASSERTZH; yaz_log(LOG_API,"zebra_search_rpn"); zh->errCode=0; zh->hits = 0; *hits = 0; if (zebra_begin_read (zh)) return 1; zebra_livcode_transform(zh, query); resultSetAddRPN (zh, odr_extract_mem(o), query, zh->num_basenames, zh->basenames, setname); zebra_end_read (zh); *hits = zh->hits; return 0; } int zebra_records_retrieve (ZebraHandle zh, ODR stream, const char *setname, Z_RecordComposition *comp, oid_value input_format, int num_recs, ZebraRetrievalRecord *recs) { ZebraPosSet poset; int i, *pos_array, ret = 0; ASSERTZH; yaz_log(LOG_API,"zebra_records_retrieve n=%d",num_recs); zh->errCode=0; if (!zh->res) { zh->errCode = 30; zh->errString = odr_strdup (stream, setname); return -1; } zh->errCode = 0; if (zebra_begin_read (zh)) return -1; pos_array = (int *) xmalloc (num_recs * sizeof(*pos_array)); for (i = 0; ierrCode = 30; zh->errString = nmem_strdup (stream->mem, setname); ret = -1; } else { for (i = 0; ierrCode = 13; zh->errString = odr_strdup (stream, num_str); ret = -1; break; } } zebraPosSetDestroy (zh, poset, num_recs); } zebra_end_read (zh); xfree (pos_array); return ret; } int zebra_scan (ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt, oid_value attributeset, int *position, int *num_entries, ZebraScanEntry **entries, int *is_partial) { ASSERTZH; yaz_log(LOG_API,"zebra_scan"); zh->errCode=0; if (zebra_begin_read (zh)) { *entries = 0; *num_entries = 0; return 1; } rpn_scan (zh, stream, zapt, attributeset, zh->num_basenames, zh->basenames, position, num_entries, entries, is_partial, 0, 0); zebra_end_read (zh); return 0; } int zebra_sort (ZebraHandle zh, ODR stream, int num_input_setnames, const char **input_setnames, const char *output_setname, Z_SortKeySpecList *sort_sequence, int *sort_status) { ASSERTZH; yaz_log(LOG_API,"zebra_sort"); zh->errCode=0; if (zebra_begin_read (zh)) return 1; resultSetSort (zh, stream->mem, num_input_setnames, input_setnames, output_setname, sort_sequence, sort_status); zebra_end_read(zh); return 0; } int zebra_deleleResultSet(ZebraHandle zh, int function, int num_setnames, char **setnames, int *statuses) { int i, status; ASSERTZH; yaz_log(LOG_API,"zebra_deleleResultSet n=%d",num_setnames); zh->errCode=0; if (zebra_begin_read(zh)) return Z_DeleteStatus_systemProblemAtTarget; switch (function) { case Z_DeleteResultSetRequest_list: resultSetDestroy (zh, num_setnames, setnames, statuses); break; case Z_DeleteResultSetRequest_all: resultSetDestroy (zh, -1, 0, statuses); break; } zebra_end_read (zh); status = Z_DeleteStatus_success; for (i = 0; ierrCode); return zh->errCode; } yaz_log(LOG_API,"zebra_errCode: o"); return 0; } const char *zebra_errString (ZebraHandle zh) { const char *e=""; if (zh) e= diagbib1_str (zh->errCode); yaz_log(LOG_API,"zebra_errString: %s",e); return e; } char *zebra_errAdd (ZebraHandle zh) { char *a=""; if (zh) a= zh->errString; yaz_log(LOG_API,"zebra_errAdd: %s",a); return a; } void zebra_clearError(ZebraHandle zh) { if (zh) { zh->errCode=0; zh->errString=""; } } int zebra_auth (ZebraHandle zh, const char *user, const char *pass) { const char *p; char u[40]; ZebraService zs; ASSERTZH; zh->errCode=0; zs= zh->service; sprintf(u, "perm.%.30s", user ? user : "anonymous"); p = res_get(zs->global_res, u); xfree (zh->user_perm); zh->user_perm = xstrdup(p ? p : "r"); /* users that don't require a password .. */ if (zh->user_perm && strchr(zh->user_perm, 'a')) return 0; if (!zs->passwd_db || !passwd_db_auth (zs->passwd_db, user, pass)) return 0; return 1; } int zebra_admin_import_begin (ZebraHandle zh, const char *database, const char *record_type) { ASSERTZH; yaz_log(LOG_API,"zebra_admin_import_begin db=%s rt=%s", database, record_type); zh->errCode=0; if (zebra_select_database(zh, database)) return 1; if (zebra_begin_trans (zh, 1)) return 1; return 0; } int zebra_admin_import_end (ZebraHandle zh) { ASSERTZH; yaz_log(LOG_API,"zebra_admin_import_end"); zh->errCode=0; zebra_end_trans (zh); return 0; } int zebra_admin_import_segment (ZebraHandle zh, Z_Segment *segment) { int sysno; int i; ASSERTZH; yaz_log(LOG_API,"zebra_admin_import_segment"); zh->errCode=0; for (i = 0; inum_segmentRecords; i++) { Z_NamePlusRecord *npr = segment->segmentRecords[i]; printf ("--------------%d--------------------\n", i); if (npr->which == Z_NamePlusRecord_intermediateFragment) { Z_FragmentSyntax *fragment = npr->u.intermediateFragment; if (fragment->which == Z_FragmentSyntax_notExternallyTagged) { Odr_oct *oct = fragment->u.notExternallyTagged; printf ("%.*s", (oct->len > 100 ? 100 : oct->len) , oct->buf); sysno = 0; zebra_update_record(zh, 0, /* record Type */ &sysno, 0, /* match */ 0, /* fname */ oct->buf, oct->len, 0); } } } return 0; } int zebra_admin_exchange_record (ZebraHandle zh, const char *rec_buf, size_t rec_len, const char *recid_buf, size_t recid_len, int action) /* 1 = insert. Fail it already exists */ /* 2 = replace. Fail it does not exist */ /* 3 = delete. Fail if does not exist */ /* 4 = update. Insert/replace */ { int sysno = 0; char *rinfo = 0; char recid_z[256]; ASSERTZH; yaz_log(LOG_API,"zebra_admin_exchange_record ac=%d", action); zh->errCode=0; if (!recid_buf || recid_len <= 0 || recid_len >= sizeof(recid_z)) return -1; memcpy (recid_z, recid_buf, recid_len); recid_z[recid_len] = 0; if (zebra_begin_trans(zh, 1)) return -1; rinfo = dict_lookup (zh->reg->matchDict, recid_z); if (rinfo) { if (action == 1) /* fail if insert */ { zebra_end_trans(zh); return -1; } memcpy (&sysno, rinfo+1, sizeof(sysno)); } else { if (action == 2 || action == 3) /* fail if delete or update */ { zebra_end_trans(zh); return -1; } action = 1; /* make it an insert (if it's an update).. */ } buffer_extract_record (zh, rec_buf, rec_len, action == 3 ? 1 : 0 /* delete flag */, 0, /* test mode */ 0, /* recordType */ &sysno, 0, /* match */ 0, /* fname */ 0, /* force update */ 1 /* allow update */ ); if (action == 1) { dict_insert (zh->reg->matchDict, recid_z, sizeof(sysno), &sysno); } else if (action == 3) { dict_delete (zh->reg->matchDict, recid_z); } zebra_end_trans(zh); return 0; } int delete_w_handle(const char *info, void *handle) { ZebraHandle zh = (ZebraHandle) handle; ISAMC_P pos; if (*info == sizeof(pos)) { memcpy (&pos, info+1, sizeof(pos)); isamb_unlink(zh->reg->isamb, pos); } return 0; } static int delete_SU_handle(void *handle, int ord) { ZebraHandle zh = (ZebraHandle) handle; char ord_buf[20]; int ord_len; ord_len = key_SU_encode (ord, ord_buf); ord_buf[ord_len] = '\0'; assert (zh->reg->isamb); dict_delete_subtree(zh->reg->dict, ord_buf, zh, delete_w_handle); return 0; } int zebra_drop_database (ZebraHandle zh, const char *database) { int ret = 0; ASSERTZH; yaz_log(LOG_API,"zebra_drop_database"); zh->errCode = 0; if (zebra_select_database (zh, database)) return -1; if (zebra_begin_trans (zh, 1)) return -1; if (zh->reg->isamb) { zebraExplain_curDatabase (zh->reg->zei, database); zebraExplain_trav_ord(zh->reg->zei, zh, delete_SU_handle); zebraExplain_removeDatabase(zh->reg->zei, zh); } else { yaz_log(LOG_WARN, "drop database only supported for isam:b"); ret = -1; } zebra_end_trans (zh); return ret; } int zebra_create_database (ZebraHandle zh, const char *database) { ASSERTZH; yaz_log(LOG_API,"zebra_create_database"); zh->errCode=0; if (zebra_select_database (zh, database)) return -1; if (zebra_begin_trans (zh, 1)) return -1; /* announce database */ if (zebraExplain_newDatabase (zh->reg->zei, database, 0 /* explainDatabase */)) { zebra_end_trans (zh); zh->errCode = 224; zh->errString = "database already exist"; return -1; } zebra_end_trans (zh); return 0; } int zebra_string_norm (ZebraHandle zh, unsigned reg_id, const char *input_str, int input_len, char *output_str, int output_len) { WRBUF wrbuf; ASSERTZH; yaz_log(LOG_API,"zebra_string_norm "); zh->errCode=0; if (!zh->reg->zebra_maps) return -1; wrbuf = zebra_replace(zh->reg->zebra_maps, reg_id, "", input_str, input_len); if (!wrbuf) return -2; if (wrbuf_len(wrbuf) >= output_len) return -3; if (wrbuf_len(wrbuf)) memcpy (output_str, wrbuf_buf(wrbuf), wrbuf_len(wrbuf)); output_str[wrbuf_len(wrbuf)] = '\0'; return wrbuf_len(wrbuf); } int zebra_set_state (ZebraHandle zh, int val, int seqno) { char state_fname[256]; char *fname; long p = getpid(); FILE *f; ASSERTZH; yaz_log(LOG_API,"zebra_set_state v=%d seq=%d", val, seqno); zh->errCode=0; sprintf (state_fname, "state.%s.LCK", zh->reg_name); fname = zebra_mk_fname (res_get(zh->res, "lockDir"), state_fname); f = fopen (fname, "w"); yaz_log (LOG_DEBUG, "%c %d %ld", val, seqno, p); fprintf (f, "%c %d %ld\n", val, seqno, p); fclose (f); xfree (fname); return 0; } int zebra_get_state (ZebraHandle zh, char *val, int *seqno) { char state_fname[256]; char *fname; FILE *f; ASSERTZH; yaz_log(LOG_API,"zebra_get_state "); zh->errCode=0; sprintf (state_fname, "state.%s.LCK", zh->reg_name); fname = zebra_mk_fname (res_get(zh->res, "lockDir"), state_fname); f = fopen (fname, "r"); *val = 'o'; *seqno = 0; if (f) { fscanf (f, "%c %d", val, seqno); fclose (f); } xfree (fname); return 0; } int zebra_begin_read (ZebraHandle zh) { return zebra_begin_trans(zh, 0); } int zebra_end_read (ZebraHandle zh) { return zebra_end_trans(zh); } static void read_res_for_transaction(ZebraHandle zh) { const char *group = res_get(zh->res, "group"); const char *v; zh->m_group = group; v = res_get_prefix(zh->res, "followLinks", group, "1"); zh->m_follow_links = atoi(v); zh->m_record_id = res_get_prefix(zh->res, "recordId", group, 0); zh->m_record_type = res_get_prefix(zh->res, "recordType", group, 0); v = res_get_prefix(zh->res, "storeKeys", group, "1"); zh->m_store_keys = atoi(v); v = res_get_prefix(zh->res, "storeData", group, "1"); zh->m_store_data = atoi(v); v = res_get_prefix(zh->res, "explainDatabase", group, "0"); zh->m_explain_database = atoi(v); v = res_get_prefix(zh->res, "openRW", group, "1"); zh->m_flag_rw = atoi(v); v = res_get_prefix(zh->res, "fileVerboseLimit", group, "100000"); zh->m_file_verbose_limit = atoi(v); } int zebra_begin_trans (ZebraHandle zh, int rw) { zebra_select_default_database(zh); if (!zh->res) { zh->errCode = 2; zh->errString = "zebra_begin_trans: no database selected"; return -1; } ASSERTZHRES; yaz_log(LOG_API,"zebra_begin_trans rw=%d",rw); if (zh->user_perm) { if (rw && !strchr(zh->user_perm, 'w')) { zh->errCode = 223; zh->errString = 0; return -1; } } assert (zh->res); if (rw) { int pass; int seqno = 0; char val = '?'; const char *rval = 0; (zh->trans_no++); if (zh->trans_w_no) { read_res_for_transaction(zh); return 0; } if (zh->trans_no != 1) { zh->errCode = 2; zh->errString = "zebra_begin_trans: write trans not allowed within read trans"; return -1; } if (zh->reg) { resultSetInvalidate (zh); zebra_register_close (zh->service, zh->reg); } zh->trans_w_no = zh->trans_no; zh->errCode=0; zh->records_inserted = 0; zh->records_updated = 0; zh->records_deleted = 0; zh->records_processed = 0; #if HAVE_SYS_TIMES_H times (&zh->tms1); #endif /* lock */ if (zh->shadow_enable) rval = res_get (zh->res, "shadow"); for (pass = 0; pass < 2; pass++) { if (rval) { zebra_lock_r (zh->lock_normal); zebra_lock_w (zh->lock_shadow); } else { zebra_lock_w (zh->lock_normal); zebra_lock_w (zh->lock_shadow); } zebra_get_state (zh, &val, &seqno); if (val == 'c') { yaz_log (LOG_LOG, "previous transaction didn't finish commit"); zebra_unlock (zh->lock_shadow); zebra_unlock (zh->lock_normal); zebra_commit (zh); continue; } else if (val == 'd') { if (rval) { BFiles bfs = bfs_create (res_get (zh->res, "shadow"), zh->path_reg); yaz_log (LOG_LOG, "previous transaction didn't reach commit"); bf_commitClean (bfs, rval); bfs_destroy (bfs); } else { yaz_log (LOG_WARN, "your previous transaction didn't finish"); } } break; } if (pass == 2) { yaz_log (LOG_FATAL, "zebra_begin_trans couldn't finish commit"); abort(); return -1; } zebra_set_state (zh, 'd', seqno); zh->reg = zebra_register_open (zh->service, zh->reg_name, 1, rval ? 1 : 0, zh->res, zh->path_reg); if (zh->reg) zh->reg->seqno = seqno; else { zebra_set_state (zh, 'o', seqno); zebra_unlock (zh->lock_shadow); zebra_unlock (zh->lock_normal); zh->trans_no--; zh->trans_w_no = 0; zh->errCode = 2; zh->errString = "zebra_begin_trans: cannot open register"; yaz_log(LOG_FATAL, zh->errString); return -1; } } else { int dirty = 0; char val; int seqno; (zh->trans_no)++; if (zh->trans_no != 1) { zebra_flush_reg (zh); return 0; } zh->errCode=0; #if HAVE_SYS_TIMES_H times (&zh->tms1); #endif if (!zh->res) { (zh->trans_no)--; zh->errCode = 109; return -1; } if (!zh->lock_normal || !zh->lock_shadow) { (zh->trans_no)--; zh->errCode = 2; return -1; } zebra_get_state (zh, &val, &seqno); if (val == 'd') val = 'o'; if (!zh->reg) dirty = 1; else if (seqno != zh->reg->seqno) { yaz_log (LOG_LOG, "reopen seqno cur/old %d/%d", seqno, zh->reg->seqno); dirty = 1; } else if (zh->reg->last_val != val) { yaz_log (LOG_LOG, "reopen last cur/old %d/%d", val, zh->reg->last_val); dirty = 1; } if (!dirty) return 0; if (val == 'c') zebra_lock_r (zh->lock_shadow); else zebra_lock_r (zh->lock_normal); if (zh->reg) { resultSetInvalidate (zh); zebra_register_close (zh->service, zh->reg); } zh->reg = zebra_register_open (zh->service, zh->reg_name, 0, val == 'c' ? 1 : 0, zh->res, zh->path_reg); if (!zh->reg) { zebra_unlock (zh->lock_normal); zebra_unlock (zh->lock_shadow); zh->trans_no--; zh->errCode = 109; return -1; } zh->reg->last_val = val; zh->reg->seqno = seqno; } read_res_for_transaction(zh); return 0; } int zebra_end_trans (ZebraHandle zh) { ZebraTransactionStatus dummy; yaz_log(LOG_API,"zebra_end_trans"); return zebra_end_transaction(zh, &dummy); } int zebra_end_transaction (ZebraHandle zh, ZebraTransactionStatus *status) { char val; int seqno; const char *rval; ASSERTZH; yaz_log(LOG_API,"zebra_end_transaction"); status->processed = 0; status->inserted = 0; status->updated = 0; status->deleted = 0; status->utime = 0; status->stime = 0; if (!zh->res || !zh->reg) { zh->errCode = 2; zh->errString = "zebra_end_trans: no open transaction"; return -1; } if (zh->trans_no != zh->trans_w_no) { zh->trans_no--; if (zh->trans_no != 0) return 0; /* release read lock */ zebra_unlock (zh->lock_normal); zebra_unlock (zh->lock_shadow); } else { /* release write lock */ zh->trans_no--; zh->trans_w_no = 0; yaz_log (LOG_LOG, "zebra_end_trans"); rval = res_get (zh->res, "shadow"); zebraExplain_runNumberIncrement (zh->reg->zei, 1); zebra_flush_reg (zh); resultSetInvalidate (zh); zebra_register_close (zh->service, zh->reg); zh->reg = 0; yaz_log (LOG_LOG, "Records: %7d i/u/d %d/%d/%d", zh->records_processed, zh->records_inserted, zh->records_updated, zh->records_deleted); status->processed = zh->records_processed; status->inserted = zh->records_inserted; status->updated = zh->records_updated; status->deleted = zh->records_deleted; zebra_get_state (zh, &val, &seqno); if (val != 'd') { BFiles bfs = bfs_create (rval, zh->path_reg); yaz_log (LOG_LOG, "deleting shadow stuff val=%c", val); bf_commitClean (bfs, rval); bfs_destroy (bfs); } if (!rval) seqno++; zebra_set_state (zh, 'o', seqno); zebra_unlock (zh->lock_shadow); zebra_unlock (zh->lock_normal); } #if HAVE_SYS_TIMES_H times (&zh->tms2); logf (LOG_LOG, "user/system: %ld/%ld", (long) (zh->tms2.tms_utime - zh->tms1.tms_utime), (long) (zh->tms2.tms_stime - zh->tms1.tms_stime)); status->utime = (long) (zh->tms2.tms_utime - zh->tms1.tms_utime); status->stime = (long) (zh->tms2.tms_stime - zh->tms1.tms_stime); #endif return 0; } int zebra_repository_update (ZebraHandle zh, const char *path) { ASSERTZH; zh->errCode=0; logf (LOG_LOG|LOG_API, "updating %s", path); repositoryUpdate (zh, path); return zh->errCode; } int zebra_repository_delete (ZebraHandle zh, const char *path) { ASSERTZH; zh->errCode=0; logf (LOG_LOG|LOG_API, "deleting %s", path); repositoryDelete (zh, path); return zh->errCode; } int zebra_repository_show (ZebraHandle zh, const char *path) { ASSERTZH; yaz_log(LOG_API,"zebra_repository_show"); zh->errCode=0; repositoryShow (zh, path); return zh->errCode; } static int zebra_commit_ex (ZebraHandle zh, int clean_only) { int seqno; char val; const char *rval; BFiles bfs; ASSERTZH; zh->errCode=0; zebra_select_default_database(zh); if (!zh->res) { zh->errCode = 109; return -1; } rval = res_get (zh->res, "shadow"); if (!rval) { logf (LOG_WARN, "Cannot perform commit"); logf (LOG_WARN, "No shadow area defined"); return 0; } zebra_lock_w (zh->lock_normal); zebra_lock_r (zh->lock_shadow); bfs = bfs_create (res_get (zh->res, "register"), zh->path_reg); zebra_get_state (zh, &val, &seqno); if (rval && *rval) bf_cache (bfs, rval); if (bf_commitExists (bfs)) { if (clean_only) zebra_set_state (zh, 'd', seqno); else { zebra_set_state (zh, 'c', seqno); logf (LOG_LOG, "commit start"); bf_commitExec (bfs); #ifndef WIN32 sync (); #endif } logf (LOG_LOG, "commit clean"); bf_commitClean (bfs, rval); seqno++; zebra_set_state (zh, 'o', seqno); } else { logf (LOG_LOG, "nothing to commit"); } bfs_destroy (bfs); zebra_unlock (zh->lock_shadow); zebra_unlock (zh->lock_normal); return 0; } int zebra_clean (ZebraHandle zh) { yaz_log(LOG_API,"zebra_clean"); return zebra_commit_ex(zh, 1); } int zebra_commit (ZebraHandle zh) { yaz_log(LOG_API,"zebra_commit"); return zebra_commit_ex(zh, 0); } int zebra_init (ZebraHandle zh) { const char *rval; BFiles bfs = 0; ASSERTZH; yaz_log(LOG_API,"zebra_init"); zh->errCode=0; zebra_select_default_database(zh); if (!zh->res) { zh->errCode = 109; return -1; } rval = res_get (zh->res, "shadow"); bfs = bfs_create (res_get (zh->res, "register"), zh->path_reg); if (!bfs) return -1; if (rval && *rval) bf_cache (bfs, rval); bf_reset (bfs); bfs_destroy (bfs); zebra_set_state (zh, 'o', 0); return 0; } int zebra_compact (ZebraHandle zh) { BFiles bfs; ASSERTZH; yaz_log(LOG_API,"zebra_compact"); zh->errCode=0; if (!zh->res) { zh->errCode = 109; return -1; } bfs = bfs_create (res_get (zh->res, "register"), zh->path_reg); inv_compact (bfs); bfs_destroy (bfs); return 0; } int zebra_result (ZebraHandle zh, int *code, char **addinfo) { ASSERTZH; yaz_log(LOG_API,"zebra_result"); *code = zh->errCode; *addinfo = zh->errString; return 0; } int zebra_shadow_enable (ZebraHandle zh, int value) { ASSERTZH; yaz_log(LOG_API,"zebra_shadow_enable"); zh->errCode=0; zh->shadow_enable = value; return 0; } int zebra_record_encoding (ZebraHandle zh, const char *encoding) { ASSERTZH; yaz_log(LOG_API,"zebra_record_encoding"); zh->errCode=0; xfree (zh->record_encoding); /* * Fixme! * Something about charset aliases. Oleg??? */ if (zh->iconv_to_utf8 != 0) yaz_iconv_close(zh->iconv_to_utf8); if (zh->iconv_from_utf8 != 0) yaz_iconv_close(zh->iconv_from_utf8); zh->record_encoding = xstrdup (encoding); logf(LOG_DEBUG, "Reset record encoding: %s", encoding); zh->iconv_to_utf8 = yaz_iconv_open ("UTF-8", encoding); if (zh->iconv_to_utf8 == 0) yaz_log (LOG_WARN, "iconv: %s to UTF-8 unsupported", encoding); zh->iconv_from_utf8 = yaz_iconv_open (encoding, "UTF-8"); if (zh->iconv_to_utf8 == 0) yaz_log (LOG_WARN, "iconv: UTF-8 to %s unsupported", encoding); return 0; } int zebra_set_resource(ZebraHandle zh, const char *name, const char *value) { ASSERTZH; yaz_log(LOG_API,"zebra_set_resource %s:%s",name,value); zh->errCode=0; res_set(zh->res, name, value); return 0; } const char *zebra_get_resource(ZebraHandle zh, const char *name, const char *defaultvalue) { const char *v; ASSERTZH; v= res_get_def( zh->res, name, (char *)defaultvalue); zh->errCode=0; yaz_log(LOG_API,"zebra_get_resource %s:%s",name,v); return v; } /* moved from zebra_api_ext.c by pop */ /* FIXME: Should this really be public??? -Heikki */ int zebra_trans_no (ZebraHandle zh) { ASSERTZH; yaz_log(LOG_API,"zebra_trans_no"); return zh->trans_no; } int zebra_get_shadow_enable (ZebraHandle zh) { yaz_log(LOG_API,"zebra_get_shadow_enable"); return (zh->shadow_enable); } int zebra_set_shadow_enable (ZebraHandle zh, int value) { yaz_log(LOG_API,"zebra_set_shadow_enable %d",value); zh->shadow_enable = value; return 0; } /* almost the same as zebra_records_retrieve ... but how did it work? I mean for multiple records ??? CHECK ??? */ void api_records_retrieve (ZebraHandle zh, ODR stream, const char *setname, Z_RecordComposition *comp, oid_value input_format, int num_recs, ZebraRetrievalRecord *recs) { ZebraPosSet poset; int i, *pos_array; yaz_log(LOG_API,"api_records_retrieve s=%s n=%d",setname,num_recs); if (!zh->res) { zh->errCode = 30; zh->errString = odr_strdup (stream, setname); return; } zh->errCode = 0; if (zebra_begin_read (zh)) return; pos_array = (int *) xmalloc (num_recs * sizeof(*pos_array)); for (i = 0; ierrCode = 30; zh->errString = nmem_strdup (stream->mem, setname); } else { for (i = 0; ierrCode = 13; zh->errString = odr_strdup (stream, num_str); break; } } zebraPosSetDestroy (zh, poset, num_recs); } zebra_end_read (zh); xfree (pos_array); } /* --------------------------------------------------------------------------- Record insert(=update), delete If sysno is provided, then it's used to identify the record. If not, and match_criteria is provided, then sysno is guessed If not, and a record is provided, then sysno is got from there NOTE: Now returns 0 at success and updates sysno, which is an int* 20-jun-2003 Heikki */ int zebra_add_record(ZebraHandle zh, const char *buf, int buf_size) { int sysno = 0; return zebra_update_record(zh, 0, &sysno, 0, 0, buf, buf_size, 0); } int zebra_insert_record (ZebraHandle zh, const char *recordType, int *sysno, const char *match, const char *fname, const char *buf, int buf_size, int force_update) { int res; yaz_log(LOG_API,"zebra_insert_record sysno=%d", *sysno); if (buf_size < 1) buf_size = strlen(buf); if (zebra_begin_trans(zh, 1)) return 1; res = buffer_extract_record (zh, buf, buf_size, 0, /* delete_flag */ 0, /* test_mode */ recordType, sysno, match, fname, 0, 0); /* allow_update */ zebra_end_trans(zh); return res; } int zebra_update_record (ZebraHandle zh, const char *recordType, int* sysno, const char *match, const char *fname, const char *buf, int buf_size, int force_update) { int res; yaz_log(LOG_API,"zebra_update_record sysno=%d", *sysno); if (buf_size < 1) buf_size = strlen(buf); if (zebra_begin_trans(zh, 1)) return 1; res = buffer_extract_record (zh, buf, buf_size, 0, /* delete_flag */ 0, /* test_mode */ recordType, sysno, match, fname, force_update, 1); /* allow_update */ yaz_log(LOG_LOG, "zebra_update_record returned res=%d", res); zebra_end_trans(zh); return res; } int zebra_delete_record (ZebraHandle zh, const char *recordType, int *sysno, const char *match, const char *fname, const char *buf, int buf_size, int force_update) { int res; yaz_log(LOG_API,"zebra_delete_record sysno=%d", *sysno); if (buf_size < 1) buf_size = strlen(buf); if (zebra_begin_trans(zh, 1)) return 1; res = buffer_extract_record (zh, buf, buf_size, 1, /* delete_flag */ 0, /* test_mode */ recordType, sysno, match,fname, force_update, 1); /* allow_update */ zebra_end_trans(zh); return res; } /* --------------------------------------------------------------------------- Searching */ int zebra_search_PQF (ZebraHandle zh, const char *pqf_query, const char *setname, int *numhits) { int hits = 0; int res=-1; Z_RPNQuery *query; ODR odr = odr_createmem(ODR_ENCODE); yaz_log(LOG_API,"zebra_search_PQF s=%s q=%s",setname, pqf_query); query = p_query_rpn (odr, PROTO_Z3950, pqf_query); if (!query) yaz_log (LOG_WARN, "bad query %s\n", pqf_query); else res=zebra_search_RPN (zh, odr, query, setname, &hits); odr_destroy(odr); yaz_log(LOG_API,"Hits: %d",hits); if (numhits) *numhits=hits; return res; } /* --------------------------------------------------------------------------- Sort - a simplified interface, with optional read locks. FIXME - This is a horrible name, will conflict with half the applications */ int zebra_sort_by_specstr (ZebraHandle zh, ODR stream, const char *sort_spec, const char *output_setname, const char **input_setnames) { int num_input_setnames = 0; int sort_status = 0; Z_SortKeySpecList *sort_sequence = yaz_sort_spec (stream, sort_spec); yaz_log(LOG_API,"sort (FIXME) "); if (!sort_sequence) { logf(LOG_WARN,"invalid sort specs '%s'", sort_spec); zh->errCode = 207; return -1; } /* we can do this, since the perl typemap code for char** will put a NULL at the end of list */ while (input_setnames[num_input_setnames]) num_input_setnames++; if (zebra_begin_read (zh)) return -1; resultSetSort (zh, stream->mem, num_input_setnames, input_setnames, output_setname, sort_sequence, &sort_status); zebra_end_read(zh); return sort_status; }