Using zebra_rec_keys for per-record key store
[idzebra-moved-to-github.git] / index / zebraapi.c
index f87f209..cc7fd51 100644 (file)
@@ -1,4 +1,4 @@
-/* $Id: zebraapi.c,v 1.173 2005-06-02 11:59:53 adam Exp $
+/* $Id: zebraapi.c,v 1.193 2005-10-28 09:22:50 adam Exp $
    Copyright (C) 1995-2005
    Index Data ApS
 
@@ -27,7 +27,8 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 #include <io.h>
 #include <process.h>
 #include <direct.h>
-#else
+#endif
+#if HAVE_UNISTD_H
 #include <unistd.h>
 #endif
 
@@ -38,6 +39,8 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 #include <charmap.h>
 #include <idzebra/api.h>
 
+#define DEFAULT_APPROX_LIMIT 2000000000
+
 /* simple asserts to validate the most essential input args */
 #define ASSERTZH assert(zh && zh->service)
 #define ASSERTZHRES assert(zh && zh->service && zh->res)
@@ -46,8 +49,8 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 static int log_level = 0;
 static int log_level_initialized = 0;
 
-static Res zebra_open_res (ZebraHandle zh);
-static void zebra_close_res (ZebraHandle zh);
+static void zebra_open_res(ZebraHandle zh);
+static void zebra_close_res(ZebraHandle zh);
 
 static void zebra_chdir (ZebraService zs)
 {
@@ -76,14 +79,14 @@ static void zebra_flush_reg (ZebraHandle zh)
     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 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 zebra_open(ZebraService zs, Res res)
 {
     ZebraHandle zh;
     const char *default_encoding;
@@ -108,13 +111,16 @@ ZebraHandle zebra_open (ZebraService zs)
     zh->errCode = 0;
     zh->errString = 0;
     zh->res = 0; 
+    zh->session_res = res_open(zs->global_res, res);
     zh->user_perm = 0;
+    zh->dbaccesslist = 0;
 
     zh->reg_name = xstrdup ("");
     zh->path_reg = 0;
     zh->num_basenames = 0;
     zh->basenames = 0;
 
+    zh->approx_limit = DEFAULT_APPROX_LIMIT;
     zh->trans_no = 0;
     zh->trans_w_no = 0;
 
@@ -122,8 +128,9 @@ ZebraHandle zebra_open (ZebraService zs)
     zh->lock_shadow = 0;
 
     zh->shadow_enable = 1;
+    zh->m_staticrank = 0;
 
-    default_encoding = res_get_def(zs->global_res, "encoding", "ISO-8859-1");
+    default_encoding = res_get_def(zh->session_res, "encoding", "ISO-8859-1");
 
     zh->iconv_to_utf8 =
         yaz_iconv_open ("UTF-8", default_encoding);
@@ -168,20 +175,21 @@ ZebraService zebra_start_res (const char *configName, Res def_res, Res over_res)
         log_level = yaz_log_module_level("zebraapi");
         log_level_initialized = 1;
     }
+    
+    yaz_log(YLOG_LOG, "zebra_start %s %s", ZEBRAVER,
+           configName ? configName : "");
 
-    yaz_log(YLOG_LOG, "zebra_start %s %s",configName, ZEBRAVER);
-    assert(configName);
-
-    if ((res = res_open (configName, def_res, over_res)))
+    if ((res = res_open(def_res, over_res)))
     {
        const char *passwd_plain = 0;
        const char *passwd_encrypt = 0;
+       const char *dbaccess = 0;
         ZebraService zh = xmalloc(sizeof(*zh));
 
-       yaz_log (YLOG_DEBUG, "Read resources `%s'", configName);
-        
+       if (configName)
+           res_read_file(res, configName);
+
         zh->global_res = res;
-        zh->configName = xstrdup(configName);
         zh->sessions = 0;
         
         zebra_chdir (zh);
@@ -189,10 +197,11 @@ ZebraService zebra_start_res (const char *configName, Res def_res, Res over_res)
         zebra_mutex_cond_init (&zh->session_lock);
        passwd_plain = res_get (zh->global_res, "passwd");
        passwd_encrypt = res_get (zh->global_res, "passwd.c");
+       dbaccess = res_get (zh->global_res, "dbaccess");
 
         if (!passwd_plain && !passwd_encrypt)
             zh->passwd_db = NULL;
-        else
+        else 
         {
             zh->passwd_db = passwd_db_open();
             if (!zh->passwd_db)
@@ -205,6 +214,17 @@ ZebraService zebra_start_res (const char *configName, Res def_res, Res over_res)
                    passwd_db_file_crypt(zh->passwd_db, passwd_encrypt);
            }
         }
+
+       if (!dbaccess)
+           zh->dbaccess = NULL;
+       else {
+           zh->dbaccess = res_open(NULL, NULL);
+           if (res_read_file(zh->dbaccess, dbaccess) != ZEBRA_OK) {
+               yaz_log(YLOG_FATAL, "Failed to read %s", dbaccess);
+               return NULL;
+           }
+       }
+
         zh->path_root = res_get (zh->global_res, "root");
        zh->nmem = nmem_create();
        zh->record_classes = recTypeClass_create (zh->global_res, zh->nmem);
@@ -233,26 +253,20 @@ Dict dict_open_res (BFiles bfs, const char *name, int cache, int rw,
 {
     int page_size = 4096;
     char resource_str[200];
-    const char *v;
     sprintf (resource_str, "dict.%.100s.pagesize", name);
     assert(bfs);
     assert(name);
 
-    v = res_get(res, resource_str);
-    if (v)
-    {
-       page_size = atoi(v);
+    if (res_get_int(res, resource_str, &page_size) == ZEBRA_OK)
        yaz_log(YLOG_LOG, "Using custom dictionary page size %d for %s",
                page_size, name);
-    }
     return dict_open(bfs, name, cache, rw, compact_flag, page_size);
 }
 
-
 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 *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;
@@ -312,12 +326,14 @@ struct zebra_register *zebra_register_open (ZebraService zs, const char *name,
 
     reg->key_buf = 0;
 
-    reg->keys.buf_max = 0;
-    reg->keys.buf = 0;
-    reg->keys.codec_handle = iscz1_start();
+    reg->keys = zebra_rec_keys_open();
 
+#if NATTR
+    reg->sortKeys = zebra_rec_keys_open();
+#else
     reg->sortKeys.buf = 0;
     reg->sortKeys.buf_max = 0;
+#endif
 
     reg->records = 0;
     reg->dict = 0;
@@ -331,8 +347,9 @@ struct zebra_register *zebra_register_open (ZebraService zs, const char *name,
     reg->key_file_no = 0;
     reg->ptr_i = 0;
     
-    zebraRankInstall (reg, rank1_class);
-    zebraRankInstall (reg, rankzv_class);
+    zebraRankInstall (reg, rank_1_class);
+    zebraRankInstall (reg, rank_zv_class);
+    zebraRankInstall (reg, rank_static_class);
 
     recordCompression = res_get_def (res, "recordCompression", "none");
     if (!strcmp (recordCompression, "none"))
@@ -478,10 +495,13 @@ static void zebra_register_close (ZebraService zs, struct zebra_register *reg)
     bfs_destroy (reg->bfs);
     data1_destroy (reg->dh);
 
+    zebra_rec_keys_close(reg->keys);
+#if NATTR
+    zebra_rec_keys_close(rec->sortKeys);
+#else
     xfree(reg->sortKeys.buf);
-    xfree(reg->keys.buf);
-    if (reg->keys.codec_handle)
-       iscz1_stop(reg->keys.codec_handle);
+#endif
+
     xfree(reg->key_buf);
     xfree(reg->name);
     xfree(reg);
@@ -506,7 +526,6 @@ ZEBRA_RES zebra_stop(ZebraService zs)
     recTypeClass_destroy(zs->record_classes);
     nmem_destroy(zs->nmem);
     res_close (zs->global_res);
-    xfree(zs->configName);
     xfree(zs);
     return ZEBRA_OK;
 }
@@ -530,9 +549,12 @@ ZEBRA_RES zebra_close (ZebraHandle zh)
     if (zh->reg)
         zebra_register_close (zh->service, zh->reg);
     zebra_close_res (zh);
+    res_close(zh->session_res);
 
     xfree(zh->record_encoding);
 
+    xfree(zh->dbaccesslist);
+
     for (i = 0; i < zh->num_basenames; i++)
         xfree(zh->basenames[i]);
     xfree(zh->basenames);
@@ -580,38 +602,34 @@ struct map_baseinfo {
     int new_num_max;
 };
 
-static Res zebra_open_res (ZebraHandle zh)
+static void 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;
+        sprintf(fname, "%.200s/zebra.cfg", zh->path_reg);
+        zh->res = res_open(zh->session_res, 0);
+       res_read_file(zh->res, fname);
     }
     else if (*zh->reg_name == 0)
     {
-        res = zh->service->global_res;
+        zh->res = res_open(zh->session_res, 0);
     }
     else
     {
         yaz_log (YLOG_WARN, "no register root specified");
-        return 0;  /* no path for register - fail! */
+        zh->res = 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);
+    res_close (zh->res);
     zh->res = 0;
 }
 
@@ -652,7 +670,7 @@ static void zebra_select_register (ZebraHandle zh, const char *new_reg)
             strcat (zh->path_reg, zh->reg_name);
         }
     }
-    zh->res = zebra_open_res (zh);
+    zebra_open_res(zh);
     
     if (zh->lock_normal)
         zebra_lock_destroy (zh->lock_normal);
@@ -665,7 +683,7 @@ static void zebra_select_register (ZebraHandle zh, const char *new_reg)
     if (zh->res)
     {
         char fname[512];
-        const char *lock_area  =res_get (zh->res, "lockDir");
+        const char *lock_area = res_get (zh->res, "lockDir");
         
         if (!lock_area && zh->path_reg)
             res_set (zh->res, "lockDir", zh->path_reg);
@@ -692,6 +710,19 @@ static void zebra_select_register (ZebraHandle zh, const char *new_reg)
            zebra_close_res(zh);
        }
     }
+    if (zh->res)
+    {
+       int approx = 0;
+       if (res_get_int(zh->res, "estimatehits", &approx) == ZEBRA_OK)
+           zebra_set_approx_limit(zh, approx);
+    }
+    if (zh->res)
+    {
+       if (res_get_int(zh->res, "staticrank", &zh->m_staticrank) == ZEBRA_OK)
+           yaz_log(YLOG_LOG, "static rank set and is %d", zh->m_staticrank);
+       else
+           yaz_log(YLOG_LOG, "static rank unset");
+    }
 }
 
 void map_basenames_func (void *vp, const char *name, const char *value)
@@ -733,8 +764,8 @@ int zebra_select_default_database(ZebraHandle zh)
        /* 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,
+       const char *group = res_get(zh->session_res, "group");
+       const char *v = res_get_prefix(zh->session_res,
                                       "database", group, "Default");
        return zebra_select_database(zh, v);
     }
@@ -761,7 +792,7 @@ void map_basenames (ZebraHandle zh, ODR stream,
        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);
+    res_trav (zh->session_res, "mapdb", &info, map_basenames_func);
     
     for (i = 0; i<p->num_bases; i++)
        if (p->basenames[i] && p->new_num_bases < p->new_num_max)
@@ -802,6 +833,32 @@ ZEBRA_RES zebra_select_databases (ZebraHandle zh, int num_bases,
         zh->errCode = YAZ_BIB1_COMBI_OF_SPECIFIED_DATABASES_UNSUPP;
         return ZEBRA_FAIL;
     }
+
+    /* Check if the user has access to all databases (Seb) */
+    /* You could argue that this should happen later, after we have
+     * determined that the database(s) exist. */
+    if (zh->dbaccesslist) {
+       for (i = 0; i < num_bases; i++) {
+           const char *db = basenames[i];
+           char *p, *pp;
+           for (p = zh->dbaccesslist; p && *p; p = pp) {
+               int len;
+               if ((pp = strchr(p, '+'))) {
+                   len = pp - p;
+                   pp++;
+               }
+               else
+                   len = strlen(p);
+               if (len == strlen(db) && !strncmp(db, p, len))
+                   break;
+           }
+           if (!p) {
+               zh->errCode = YAZ_BIB1_ACCESS_TO_SPECIFIED_DATABASE_DENIED;
+               return ZEBRA_FAIL;
+           }
+       }
+    }
+
     for (i = 0; i < zh->num_basenames; i++)
         xfree(zh->basenames[i]);
     xfree(zh->basenames);
@@ -864,6 +921,14 @@ ZEBRA_RES zebra_select_databases (ZebraHandle zh, int num_bases,
     return ZEBRA_OK;
 }
 
+ZEBRA_RES zebra_set_approx_limit(ZebraHandle zh, zint approx_limit)
+{
+    if (approx_limit == 0)
+       approx_limit = DEFAULT_APPROX_LIMIT;
+    zh->approx_limit = approx_limit;
+    return ZEBRA_OK;
+}
+
 ZEBRA_RES zebra_search_RPN(ZebraHandle zh, ODR o, Z_RPNQuery *query,
                           const char *setname, zint *hits)
 {
@@ -944,14 +1009,18 @@ ZEBRA_RES zebra_records_retrieve(ZebraHandle zh, ODR stream,
            {
                char *buf;
                int len;
+               zebra_snippets *hit_snippet = zebra_snippets_create();
 
-               zebra_get_hit_vector(zh, setname, poset[i].sysno);
+               zebra_snippets_hit_vector(zh, setname, poset[i].sysno, 
+                                         hit_snippet);
 
                recs[i].errCode =
                    zebra_record_fetch(zh, poset[i].sysno, poset[i].score,
+                                      hit_snippet,
                                       stream, input_format, comp,
                                       &recs[i].format, &buf, &len,
                                       &recs[i].base, &recs[i].errString);
+               
                recs[i].len = len;
                if (len > 0)
                {
@@ -962,15 +1031,24 @@ ZEBRA_RES zebra_records_retrieve(ZebraHandle zh, ODR stream,
                    recs[i].buf = buf;
                 recs[i].score = poset[i].score;
                 recs[i].sysno = poset[i].sysno;
+               zebra_snippets_destroy(hit_snippet);
            }
            else
            {
-               if (ret == ZEBRA_OK) /* only need to set it once */
+               /* only need to set it once */
+               if (pos_array[i] < zh->approx_limit && ret == ZEBRA_OK)
+               {
                    zebra_setError_zint(zh,
                                        YAZ_BIB1_PRESENT_REQUEST_OUT_OF_RANGE,
                                        pos_array[i]);
-               ret = ZEBRA_FAIL;
-                break;
+                   ret = ZEBRA_FAIL;
+                   break;
+               }
+               recs[i].buf = 0;  /* no record and no error issued */
+               recs[i].len = 0;
+               recs[i].errCode = 0;
+               recs[i].format = VAL_NONE;
+               recs[i].sysno = 0;
            }
        }
        zebra_meta_records_destroy(zh, poset, num_recs);
@@ -983,7 +1061,8 @@ ZEBRA_RES zebra_records_retrieve(ZebraHandle zh, ODR stream,
 ZEBRA_RES zebra_scan_PQF(ZebraHandle zh, ODR stream, const char *query,
                         int *position,
                         int *num_entries, ZebraScanEntry **entries,
-                        int *is_partial)
+                        int *is_partial,
+                        const char *setname)
 {
     YAZ_PQF_Parser pqf_parser = yaz_pqf_create ();
     Z_AttributesPlusTerm *zapt;
@@ -997,7 +1076,8 @@ ZEBRA_RES zebra_scan_PQF(ZebraHandle zh, ODR stream, const char *query,
     }
     else
        res = zebra_scan(zh, stream, zapt, VAL_BIB1,
-                        position, num_entries, entries, is_partial);
+                        position, num_entries, entries, is_partial,
+                        setname);
     yaz_pqf_destroy (pqf_parser);
     return res;
 }
@@ -1006,9 +1086,11 @@ ZEBRA_RES zebra_scan(ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
                     oid_value attributeset,
                     int *position,
                     int *num_entries, ZebraScanEntry **entries,
-                    int *is_partial)
+                    int *is_partial,
+                    const char *setname)
 {
     ZEBRA_RES res;
+    RSET limit_rset = 0;
     ASSERTZH;
     assert(stream);
     assert(zapt);
@@ -1024,9 +1106,21 @@ ZEBRA_RES zebra_scan(ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
        *num_entries = 0;
        return ZEBRA_FAIL;
     }
+    if (setname)
+    {
+       limit_rset = resultSetRef(zh, setname);
+       if (!limit_rset)
+       {
+           zebra_setError(zh, 
+                          YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
+                          setname);
+           zebra_end_read (zh);
+           return ZEBRA_FAIL;
+       }
+    }
     res = rpn_scan (zh, stream, zapt, attributeset,
                    zh->num_basenames, zh->basenames, position,
-                   num_entries, entries, is_partial, 0, 0);
+                   num_entries, entries, is_partial, limit_rset, 0);
     zebra_end_read (zh);
     return res;
 }
@@ -1125,6 +1219,7 @@ void zebra_clearError(ZebraHandle zh)
 ZEBRA_RES zebra_auth (ZebraHandle zh, const char *user, const char *pass)
 {
     const char *p;
+    const char *astring;
     char u[40];
     ZebraService zs;
 
@@ -1137,6 +1232,13 @@ ZEBRA_RES zebra_auth (ZebraHandle zh, const char *user, const char *pass)
     xfree(zh->user_perm);
     zh->user_perm = xstrdup(p ? p : "r");
 
+    /* Determine database access list */
+    astring = res_get(zs->dbaccess, user ? user : "anonymous");
+    if (astring)
+       zh->dbaccesslist = xstrdup(astring);
+    else
+       zh->dbaccesslist = 0;
+
     /* users that don't require a password .. */
     if (zh->user_perm && strchr(zh->user_perm, 'a'))
        return ZEBRA_OK;
@@ -1186,13 +1288,13 @@ ZEBRA_RES zebra_admin_import_segment (ZebraHandle zh, Z_Segment *segment)
                Odr_oct *oct = fragment->u.notExternallyTagged;
                sysno = 0;
                
-               if ( zebra_update_record(zh, 
-                                        0, /* record Type */
-                                        &sysno,
-                                        0, /* match */
-                                        0, /* fname */
-                                        oct->buf, oct->len,
-                                        0) == ZEBRA_FAIL)
+               if (zebra_update_record(zh, 
+                                       0, /* record Type */
+                                       &sysno,
+                                       0, /* match */
+                                       0, /* fname */
+                                       (const char *) oct->buf, oct->len,
+                                       0) == ZEBRA_FAIL)
                    res = ZEBRA_FAIL;
            }
        }
@@ -1570,9 +1672,9 @@ ZEBRA_RES zebra_begin_trans(ZebraHandle zh, int rw)
         }
         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);
+        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
@@ -1651,9 +1753,9 @@ ZEBRA_RES zebra_begin_trans(ZebraHandle zh, int rw)
             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);
+        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);
@@ -1940,7 +2042,7 @@ ZEBRA_RES zebra_octet_term_encoding(ZebraHandle zh, const char *encoding)
 {
     ASSERTZH;
     assert(encoding);
-    yaz_log(log_level, "zebra_octet_term_encoding");
+    yaz_log(log_level, "zebra_octet_term_encoding %s", encoding);
     zebra_clearError(zh);
 
     if (zh->iconv_to_utf8 != 0)
@@ -1988,7 +2090,6 @@ const char *zebra_get_resource(ZebraHandle zh,
     const char *v;
     ASSERTZH;
     assert(name);
-    assert(defaultvalue);
     v = res_get_def (zh->res, name, (char *)defaultvalue);
     zebra_clearError(zh);
     yaz_log(log_level, "zebra_get_resource %s:%s", name, v);