Generic snippet support. Unlike previous versions of snippet
[idzebra-moved-to-github.git] / index / zsets.c
index 9e95870..cdfc2d2 100644 (file)
@@ -1,6 +1,6 @@
-/* $Id: zsets.c,v 1.76 2005-01-07 14:44:54 adam Exp $
-   Copyright (C) 1995-2005
-   Index Data Aps
+/* $Id: zsets.c,v 1.122 2007-08-21 11:06:47 adam Exp $
+   Copyright (C) 1995-2007
+   Index Data ApS
 
 This file is part of the Zebra server.
 
@@ -15,9 +15,9 @@ 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.
+along with this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
 */
 
 
@@ -30,18 +30,19 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 #endif
 
 #include "index.h"
+#include "rank.h"
+#include <yaz/diagbib1.h>
 #include <rset.h>
 
-#define SORT_IDX_ENTRYSIZE 64
-#define ZSET_SORT_MAX_LEVEL 3
+#define ZSET_SORT_MAX_LEVEL 10
 
 struct zebra_set_term_entry {
     int reg_type;
     char *db;
-    int set;
-    int use;
+    char *index_name;
     char *term;
 };
+
 struct zebra_set {
     char *name;
     RSET rset;
@@ -51,21 +52,23 @@ struct zebra_set {
     int num_bases;
     char **basenames;
     Z_RPNQuery *rpn;
+    Z_SortKeySpecList *sortSpec;
     struct zset_sort_info *sort_info;
     struct zebra_set_term_entry *term_entries;
     int term_entries_max;
     struct zebra_set *next;
     int locked;
+    int estimated_hit_count;
 
     zint cache_position;  /* last position */
     RSFD cache_rfd;       /* rfd (NULL if not existing) */
     zint cache_psysno;    /* sysno for last position */
+    zint approx_limit;    /* limit before we do approx */
 };
 
 struct zset_sort_entry {
     zint sysno;
     int score;
-    char buf[ZSET_SORT_MAX_LEVEL][SORT_IDX_ENTRYSIZE];
 };
 
 struct zset_sort_info {
@@ -76,63 +79,113 @@ struct zset_sort_info {
 };
 
 static int log_level_set=0;
-static int log_level_sorting=0;
+static int log_level_sort=0;
 static int log_level_searchhits=0;
 static int log_level_searchterms=0;
 static int log_level_resultsets=0;
 
-static void loglevels()
+static void loglevels(void)
 {
     if (log_level_set)
         return;
-    log_level_sorting = yaz_log_module_level("sorting");
+    log_level_sort = yaz_log_module_level("sorting");
     log_level_searchhits = yaz_log_module_level("searchhits");
     log_level_searchterms = yaz_log_module_level("searchterms");
     log_level_resultsets = yaz_log_module_level("resultsets");
-    log_level_set=1;
+    log_level_set = 1;
 }
 
-ZebraSet resultSetAddRPN (ZebraHandle zh, NMEM m,
-                          Z_RPNQuery *rpn, int num_bases,
-                          char **basenames, 
-                          const char *setname)
+
+static ZEBRA_RES resultSetSearch(ZebraHandle zh, NMEM nmem, NMEM rset_nmem,
+                                 Z_RPNQuery *rpn, ZebraSet sset)
+{
+    RSET rset = 0;
+    Z_SortKeySpecList *sort_sequence;
+    int sort_status, i;
+    ZEBRA_RES res = ZEBRA_OK;
+
+    sort_sequence = (Z_SortKeySpecList *)
+        nmem_malloc(nmem, sizeof(*sort_sequence));
+    sort_sequence->num_specs = 10; /* FIXME - Hard-coded number */
+    sort_sequence->specs = (Z_SortKeySpec **)
+        nmem_malloc(nmem, sort_sequence->num_specs *
+                     sizeof(*sort_sequence->specs));
+    for (i = 0; i<sort_sequence->num_specs; i++)
+        sort_sequence->specs[i] = 0;
+    
+    rpn_get_top_approx_limit(zh, rpn->RPNStructure, &sset->approx_limit);
+
+    res = rpn_search_top(zh, rpn->RPNStructure, rpn->attributeSetId,
+                        nmem, rset_nmem,
+                        sort_sequence,
+                        sset->num_bases, sset->basenames,
+                        &rset);
+    if (res != ZEBRA_OK)
+    {
+       sset->rset = 0;
+        return res;
+    }
+    for (i = 0; sort_sequence->specs[i]; i++)
+        ;
+    sort_sequence->num_specs = i;
+    rset->hits_limit = sset->approx_limit;
+    if (!i)
+    {
+        res = resultSetRank (zh, sset, rset, rset_nmem);
+    }
+    else
+    {
+        res = resultSetSortSingle (zh, nmem, sset, rset,
+                                  sort_sequence, &sort_status);
+    }
+    sset->rset = rset;
+    return res;
+}
+
+
+ZEBRA_RES resultSetAddRPN(ZebraHandle zh, NMEM m, Z_RPNQuery *rpn,
+                          int num_bases, char **basenames,
+                          const char *setname,
+                          zint *hits, int *estimated_hit_count)
 {
     ZebraSet zebraSet;
     int i;
+    ZEBRA_RES res;
 
-    zh->errCode = 0;
-    zh->errString = NULL;
-    zh->hits = 0;
+    *hits = 0;
+    *estimated_hit_count = 0;
 
-    zebraSet = resultSetAdd (zh, setname, 1);
+    zebraSet = resultSetAdd(zh, setname, 1);
     if (!zebraSet)
-        return 0;
+        return ZEBRA_FAIL;
     zebraSet->locked = 1;
     zebraSet->rpn = 0;
     zebraSet->nmem = m;
-    zebraSet->rset_nmem=nmem_create(); 
+    zebraSet->rset_nmem = nmem_create(); 
 
     zebraSet->num_bases = num_bases;
     zebraSet->basenames = 
         nmem_malloc (zebraSet->nmem, num_bases * sizeof(*zebraSet->basenames));
     for (i = 0; i<num_bases; i++)
-        zebraSet->basenames[i] = nmem_strdup (zebraSet->nmem, basenames[i]);
+        zebraSet->basenames[i] = nmem_strdup(zebraSet->nmem, basenames[i]);
 
+    res = resultSetSearch(zh, zebraSet->nmem, zebraSet->rset_nmem,
+                         rpn, zebraSet);
+    *hits = zebraSet->hits;
+    if (zebraSet->estimated_hit_count)
+        *estimated_hit_count = 1;
 
-    zebraSet->rset = rpn_search (zh, zebraSet->nmem, zebraSet->rset_nmem,
-                                 rpn, zebraSet->num_bases,
-                                 zebraSet->basenames, zebraSet->name,
-                                 zebraSet);
-    zh->hits = zebraSet->hits;
     if (zebraSet->rset)
         zebraSet->rpn = rpn;
     zebraSet->locked = 0;
-    return zebraSet;
+    if (!zebraSet->rset)
+       return ZEBRA_FAIL;
+    return res;
 }
 
-void resultSetAddTerm (ZebraHandle zh, ZebraSet s, int reg_type,
-                       const char *db, int set,
-                       int use, const char *term)
+void resultSetAddTerm(ZebraHandle zh, ZebraSet s, int reg_type,
+                      const char *db, const char *index_name, 
+                      const char *term)
 {
     assert(zh); /* compiler shut up */
     if (!s->nmem)
@@ -151,14 +204,13 @@ void resultSetAddTerm (ZebraHandle zh, ZebraSet s, int reg_type,
     {
         s->term_entries[s->hits].reg_type = reg_type;
         s->term_entries[s->hits].db = nmem_strdup (s->nmem, db);
-        s->term_entries[s->hits].set = set;
-        s->term_entries[s->hits].use = use;
-        s->term_entries[s->hits].term = nmem_strdup (s->nmem, term);
+        s->term_entries[s->hits].index_name = nmem_strdup(s->nmem, index_name);
+        s->term_entries[s->hits].term = nmem_strdup(s->nmem, term);
     }
     (s->hits)++;
 }
 
-ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov)
+ZebraSet resultSetAdd(ZebraHandle zh, const char *name, int ov)
 {
     ZebraSet s;
     int i;
@@ -215,15 +267,18 @@ ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov)
     s->term_entries = 0;
     s->hits = 0;
     s->rset = 0;
-    s->rset_nmem=0;
+    s->rset_nmem = 0;
     s->nmem = 0;
     s->rpn = 0;
+    s->sortSpec = 0;
     s->cache_position = 0;
     s->cache_rfd = 0;
+    s->approx_limit = zh->approx_limit;
+    s->estimated_hit_count = 0;
     return s;
 }
 
-ZebraSet resultSetGet (ZebraHandle zh, const char *name)
+ZebraSet resultSetGet(ZebraHandle zh, const char *name)
 {
     ZebraSet s;
 
@@ -236,9 +291,14 @@ ZebraSet resultSetGet (ZebraHandle zh, const char *name)
                 yaz_log(log_level_resultsets, "research %s", name);
                 if (!s->rset_nmem)
                     s->rset_nmem=nmem_create();
-                s->rset =
-                    rpn_search (zh, nmem, s->rset_nmem, s->rpn, s->num_bases,
-                                s->basenames, s->name, s);
+               resultSetSearch(zh, nmem, s->rset_nmem, s->rpn, s);
+               if (s->rset && s->sortSpec)
+               {
+                   int sort_status;
+                   yaz_log(log_level_resultsets, "resort %s", name);
+                   resultSetSortSingle (zh, nmem, s, s->rset, s->sortSpec,
+                                        &sort_status);
+               }
                 nmem_destroy (nmem);
             }
             return s;
@@ -268,7 +328,7 @@ void resultSetInvalidate (ZebraHandle zh)
     }
 }
 
-void resultSetDestroy (ZebraHandle zh, int num, char **names,int *statuses)
+void resultSetDestroy(ZebraHandle zh, int num, char **names,int *statuses)
 {
     ZebraSet * ss = &zh->sets;
     int i;
@@ -276,8 +336,6 @@ void resultSetDestroy (ZebraHandle zh, int num, char **names,int *statuses)
     if (statuses)
         for (i = 0; i<num; i++)
             statuses[i] = Z_DeleteStatus_resultSetDidNotExist;
-    zh->errCode = 0;
-    zh->errString = NULL;
     while (*ss)
     {
         int i = -1;
@@ -319,9 +377,9 @@ void resultSetDestroy (ZebraHandle zh, int num, char **names,int *statuses)
     }
 }
 
-ZebraMetaRecord *zebra_meta_records_create_range (ZebraHandle zh,
-                                                 const char *name, 
-                                                 zint start, int num)
+ZebraMetaRecord *zebra_meta_records_create_range(ZebraHandle zh,
+                                                const char *name, 
+                                                zint start, int num)
 {
     zint pos_small[10];
     zint *pos = pos_small;
@@ -344,14 +402,18 @@ ZebraMetaRecord *zebra_meta_records_create_range (ZebraHandle zh,
     return mr;
 }
 
-ZebraMetaRecord *zebra_meta_records_create (ZebraHandle zh, const char *name, 
-                                           int num, zint *positions)
+ZebraMetaRecord *zebra_meta_records_create(ZebraHandle zh, const char *name, 
+                                          int num, zint *positions)
 {
     ZebraSet sset;
     ZebraMetaRecord *sr = 0;
     RSET rset;
     int i;
     struct zset_sort_info *sort_info;
+    size_t sysno_mem_index = 0;
+
+    if (zh->m_staticrank)
+       sysno_mem_index = 1;
 
     if (!log_level_set)
         loglevels();
@@ -396,7 +458,7 @@ ZebraMetaRecord *zebra_meta_records_create (ZebraHandle zh, const char *name,
                 position = positions[i];
                 if (position > 0 && position <= sort_info->num_entries)
                 {
-                    yaz_log(log_level_sorting, "got pos=" ZINT_FORMAT
+                    yaz_log(log_level_sort, "got pos=" ZINT_FORMAT
                            " (sorted)", position);
                     sr[i].sysno = sort_info->entries[position-1]->sysno;
                     sr[i].score = sort_info->entries[position-1]->score;
@@ -419,7 +481,7 @@ ZebraMetaRecord *zebra_meta_records_create (ZebraHandle zh, const char *name,
             
             if (sort_info)
                 position = sort_info->num_entries;
-            while (num_i < num && positions[num_i] < position)
+            while (num_i < num && positions[num_i] <= position)
                 num_i++;
            
            if (sset->cache_rfd &&
@@ -437,7 +499,7 @@ ZebraMetaRecord *zebra_meta_records_create (ZebraHandle zh, const char *name,
            }
             while (num_i < num && rset_read (rfd, &key, 0))
             {
-                zint this_sys = key.mem[0];
+                zint this_sys = key.mem[sysno_mem_index];
                 if (this_sys != psysno)
                 {
                     psysno = this_sys;
@@ -455,7 +517,7 @@ ZebraMetaRecord *zebra_meta_records_create (ZebraHandle zh, const char *name,
                     if (position == positions[num_i])
                     {
                         sr[num_i].sysno = psysno;
-                        yaz_log(log_level_sorting, "got pos=" ZINT_FORMAT " (unsorted)", position);
+                        yaz_log(log_level_sort, "got pos=" ZINT_FORMAT " (unsorted)", position);
                         sr[num_i].score = -1;
                         num_i++;
                     }
@@ -478,24 +540,30 @@ void zebra_meta_records_destroy (ZebraHandle zh, ZebraMetaRecord *records,
 
 struct sortKeyInfo {
     int relation;
-    int attrUse;
+    int ord;
     int numerical;
+    int index_type;
 };
 
-void resultSetInsertSort (ZebraHandle zh, ZebraSet sset,
-                          struct sortKeyInfo *criteria, int num_criteria,
-                          zint sysno)
+void resultSetInsertSort(ZebraHandle zh, ZebraSet sset,
+                         struct sortKeyInfo *criteria, int num_criteria,
+                         zint sysno,
+                         char *cmp_buf[], char *tmp_cmp_buf[])
 {
-    struct zset_sort_entry this_entry;
     struct zset_sort_entry *new_entry = NULL;
     struct zset_sort_info *sort_info = sset->sort_info;
     int i, j;
 
-    sortIdx_sysno (zh->reg->sortIdx, sysno);
+    zebra_sort_sysno(zh->reg->sort_index, sysno);
     for (i = 0; i<num_criteria; i++)
     {
-        sortIdx_type (zh->reg->sortIdx, criteria[i].attrUse);
-        sortIdx_read (zh->reg->sortIdx, this_entry.buf[i]);
+        char *this_entry_buf = tmp_cmp_buf[i];
+        memset(this_entry_buf, '\0', SORT_IDX_ENTRYSIZE);
+        if (criteria[i].ord != -1)
+        {
+            zebra_sort_type(zh->reg->sort_index, criteria[i].ord);
+            zebra_sort_read(zh->reg->sort_index, this_entry_buf);
+        }
     }
     i = sort_info->num_entries;
     while (--i >= 0)
@@ -503,20 +571,32 @@ void resultSetInsertSort (ZebraHandle zh, ZebraSet sset,
         int rel = 0;
         for (j = 0; j<num_criteria; j++)
         {
+            char *this_entry_buf = tmp_cmp_buf[j];
+            char *other_entry_buf = 
+                cmp_buf[j] + i * SORT_IDX_ENTRYSIZE;
             if (criteria[j].numerical)
             {
-                double diff = atof(this_entry.buf[j]) -
-                              atof(sort_info->entries[i]->buf[j]);
-                rel = 0;
+                char this_entry_org[1024];
+                char other_entry_org[1024];
+                double diff;
+                int index_type = criteria[j].index_type;
+                zebra_term_untrans(zh, index_type, this_entry_org,
+                                   this_entry_buf);
+                zebra_term_untrans(zh, index_type, other_entry_org,
+                                   other_entry_buf);
+                diff = atof(this_entry_org) - atof(other_entry_org);
+                
                 if (diff > 0.0)
                     rel = 1;
                 else if (diff < 0.0)
                     rel = -1;
+                else
+                    rel = 0;
             }
             else
             {
-                rel = memcmp (this_entry.buf[j], sort_info->entries[i]->buf[j],
-                          SORT_IDX_ENTRYSIZE);
+                rel = memcmp(this_entry_buf, other_entry_buf,
+                             SORT_IDX_ENTRYSIZE);
             }
             if (rel)
                 break;
@@ -546,19 +626,30 @@ void resultSetInsertSort (ZebraHandle zh, ZebraSet sset,
     new_entry = sort_info->entries[j];
     while (j != i)
     {
+        int k;
+        for (k = 0; k<num_criteria; k++)
+        {
+            char *j_buf = cmp_buf[k] + j * SORT_IDX_ENTRYSIZE;
+            char *j_1_buf = cmp_buf[k] + (j-1) * SORT_IDX_ENTRYSIZE;
+            memcpy(j_buf, j_1_buf, SORT_IDX_ENTRYSIZE);
+        }
         sort_info->entries[j] = sort_info->entries[j-1];
         --j;
     }
     sort_info->entries[i] = new_entry;
     assert (new_entry);
     for (i = 0; i<num_criteria; i++)
-        memcpy (new_entry->buf[i], this_entry.buf[i], SORT_IDX_ENTRYSIZE);
+    {
+        char *new_entry_buf = cmp_buf[i] + j * SORT_IDX_ENTRYSIZE;
+        char *this_entry_buf = tmp_cmp_buf[i];
+        memcpy(new_entry_buf, this_entry_buf, SORT_IDX_ENTRYSIZE);
+    }
     new_entry->sysno = sysno;
     new_entry->score = -1;
 }
 
-void resultSetInsertRank (ZebraHandle zh, struct zset_sort_info *sort_info,
-                          zint sysno, int score, int relation)
+void resultSetInsertRank(ZebraHandle zh, struct zset_sort_info *sort_info,
+                         zint sysno, int score, int relation)
 {
     struct zset_sort_entry *new_entry = NULL;
     int i, j;
@@ -604,65 +695,141 @@ void resultSetInsertRank (ZebraHandle zh, struct zset_sort_info *sort_info,
     new_entry->score = score;
 }
 
-void resultSetSort (ZebraHandle zh, NMEM nmem,
-                    int num_input_setnames, const char **input_setnames,
-                    const char *output_setname,
-                    Z_SortKeySpecList *sort_sequence, int *sort_status)
+static Z_RPNQuery *copy_RPNQuery(Z_RPNQuery *src, NMEM nmem)
+{
+    Z_RPNQuery *dst = 0;
+    ODR encode = odr_createmem(ODR_ENCODE);
+    ODR decode = odr_createmem(ODR_DECODE);
+
+    if (z_RPNQuery(encode, &src, 0, 0))
+    {
+       int len;
+       char *buf = odr_getbuf(encode, &len, 0);
+
+       if (buf)
+       {
+           odr_setbuf(decode, buf, len, 0);
+           z_RPNQuery(decode, &dst, 0, 0);
+       }
+    }
+    nmem_transfer(nmem, decode->mem);
+    odr_destroy(encode);
+    odr_destroy(decode);
+    return dst;
+}
+
+static Z_SortKeySpecList *copy_SortKeySpecList(Z_SortKeySpecList *src, NMEM nmem)
+{
+    Z_SortKeySpecList *dst = 0;
+    ODR encode = odr_createmem(ODR_ENCODE);
+    ODR decode = odr_createmem(ODR_DECODE);
+
+    if (z_SortKeySpecList(encode, &src, 0, 0))
+    {
+       int len;
+       char *buf = odr_getbuf(encode, &len, 0);
+
+       if (buf)
+       {
+           odr_setbuf(decode, buf, len, 0);
+           z_SortKeySpecList(decode, &dst, 0, 0);
+       }
+    }
+    nmem_transfer(nmem, decode->mem);
+    odr_destroy(encode);
+    odr_destroy(decode);
+    return dst;
+}
+
+ZebraSet resultSetClone(ZebraHandle zh, const char *setname,
+                       ZebraSet rset)
+{
+    ZebraSet nset;
+    int i;
+
+    nset = resultSetAdd(zh, setname, 1);
+    if (!nset)
+       return 0;
+
+    nset->nmem = nmem_create();
+
+    nset->num_bases = rset->num_bases;
+    nset->basenames = 
+        nmem_malloc (nset->nmem, nset->num_bases * sizeof(*rset->basenames));
+    for (i = 0; i<rset->num_bases; i++)
+        nset->basenames[i] = nmem_strdup(nset->nmem, rset->basenames[i]);
+
+    if (rset->rset)
+       nset->rset = rset_dup(rset->rset);
+    if (rset->rpn)
+       nset->rpn = copy_RPNQuery(rset->rpn, nset->nmem);
+    return nset;
+}
+
+ZEBRA_RES resultSetSort(ZebraHandle zh, NMEM nmem,
+                       int num_input_setnames, const char **input_setnames,
+                       const char *output_setname,
+                       Z_SortKeySpecList *sort_sequence, int *sort_status)
 {
     ZebraSet sset;
     RSET rset;
 
     if (num_input_setnames == 0)
     {
-        zh->errCode = 208;
-        return ;
+       zebra_setError(zh, YAZ_BIB1_NO_RESULT_SET_NAME_SUPPLIED_ON_SORT, 0);
+       return ZEBRA_FAIL;
     }
     if (num_input_setnames > 1)
     {
-        zh->errCode = 230;
-        return;
+        zebra_setError(zh, YAZ_BIB1_SORT_TOO_MANY_INPUT_RESULTS, 0);
+       return ZEBRA_FAIL;
     }
     if (!log_level_set)
         loglevels();
-    yaz_log(log_level_sorting, "result set sort input=%s output=%s",
+    yaz_log(log_level_sort, "result set sort input=%s output=%s",
           *input_setnames, output_setname);
     sset = resultSetGet (zh, input_setnames[0]);
     if (!sset)
     {
-        zh->errCode = 30;
-        zh->errString = nmem_strdup (nmem, input_setnames[0]);
-        return;
+       zebra_setError(zh, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
+                      input_setnames[0]);
+       return ZEBRA_FAIL;
     }
     if (!(rset = sset->rset))
     {
-        zh->errCode = 30;
-        zh->errString = nmem_strdup (nmem, input_setnames[0]);
-        return;
+       zebra_setError(zh, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
+                      input_setnames[0]);
+       return ZEBRA_FAIL;
     }
     if (strcmp (output_setname, input_setnames[0]))
-    {
-        rset = rset_dup (rset);
-        sset = resultSetAdd (zh, output_setname, 1);
-        sset->rset = rset;
-    }
-    resultSetSortSingle (zh, nmem, sset, rset, sort_sequence, sort_status);
+       sset = resultSetClone(zh, output_setname, sset);
+    sset->sortSpec = copy_SortKeySpecList(sort_sequence, sset->nmem);
+    return resultSetSortSingle (zh, nmem, sset, rset, sort_sequence,
+                               sort_status);
 }
 
-void resultSetSortSingle (ZebraHandle zh, NMEM nmem,
-                          ZebraSet sset, RSET rset,
-                          Z_SortKeySpecList *sort_sequence, int *sort_status)
+ZEBRA_RES resultSetSortSingle(ZebraHandle zh, NMEM nmem,
+                             ZebraSet sset, RSET rset,
+                             Z_SortKeySpecList *sort_sequence,
+                             int *sort_status)
 {
     int i;
     int n = 0;
     zint kno = 0;
     zint psysno = 0;
     struct it_key key;
-    struct sortKeyInfo sort_criteria[3];
+    struct sortKeyInfo sort_criteria[ZSET_SORT_MAX_LEVEL];
+    char *cmp_buf[ZSET_SORT_MAX_LEVEL];
+    char *tmp_cmp_buf[ZSET_SORT_MAX_LEVEL];
     int num_criteria;
     RSFD rfd;
     TERMID termid;
     TERMID *terms;
     int numTerms = 0;
+    size_t sysno_mem_index = 0;
+
+    if (zh->m_staticrank)
+       sysno_mem_index = 1;
 
     assert(nmem); /* compiler shut up about unused param */
     sset->sort_info->num_entries = 0;
@@ -673,87 +840,132 @@ void resultSetSortSingle (ZebraHandle zh, NMEM nmem,
 
     sset->hits = 0;
     num_criteria = sort_sequence->num_specs;
-    if (num_criteria > 3)
-        num_criteria = 3;
+    if (num_criteria > ZSET_SORT_MAX_LEVEL)
+        num_criteria = ZSET_SORT_MAX_LEVEL;
     for (i = 0; i < num_criteria; i++)
     {
         Z_SortKeySpec *sks = sort_sequence->specs[i];
         Z_SortKey *sk;
+        ZEBRA_RES res;
 
+        sort_criteria[i].ord = -1;
+        sort_criteria[i].numerical = 0;
+
+        if (sks->which == Z_SortKeySpec_missingValueData)
+        {
+           zebra_setError(zh, YAZ_BIB1_UNSUPP_MISSING_DATA_ACTION, 0);
+            return ZEBRA_FAIL;
+        }
         if (*sks->sortRelation == Z_SortKeySpec_ascending)
             sort_criteria[i].relation = 'A';
         else if (*sks->sortRelation == Z_SortKeySpec_descending)
             sort_criteria[i].relation = 'D';
         else
         {
-            zh->errCode = 214;
-            return;
+           zebra_setError(zh, YAZ_BIB1_ILLEGAL_SORT_RELATION, 0);
+            return ZEBRA_FAIL;
         }
         if (sks->sortElement->which == Z_SortElement_databaseSpecific)
         {
-            zh->errCode = 210;
-            return;
+           zebra_setError(zh, YAZ_BIB1_DATABASE_SPECIFIC_SORT_UNSUPP, 0);
+            return ZEBRA_FAIL;
         }
         else if (sks->sortElement->which != Z_SortElement_generic)
         {
-            zh->errCode = 237;
-            return;
+           zebra_setError(zh, YAZ_BIB1_SORT_ILLEGAL_SORT, 0);
+            return ZEBRA_FAIL;
         }       
         sk = sks->sortElement->u.generic;
         switch (sk->which)
         {
         case Z_SortKey_sortField:
-            yaz_log(log_level_sorting, "Sort: key %d is of type sortField", i+1);
-            zh->errCode = 207;
-            return;
-        case Z_SortKey_elementSpec:
-            yaz_log(log_level_sorting, "Sort: key %d is of type elementSpec", i+1);
-            zh->errCode = 207;
-            return;
-        case Z_SortKey_sortAttributes:
-            yaz_log(log_level_sorting, "Sort: key %d is of type sortAttributes", i+1);
-            sort_criteria[i].attrUse =
-                zebra_maps_sort (zh->reg->zebra_maps,
-                                 sk->u.sortAttributes,
-                                 &sort_criteria[i].numerical);
-            yaz_log(log_level_sorting, "use value = %d", sort_criteria[i].attrUse);
-            if (sort_criteria[i].attrUse == -1)
+            yaz_log(log_level_sort, "key %d is of type sortField",
+                   i+1);
+            sort_criteria[i].numerical = 0;
+            sort_criteria[i].ord = 
+                zebraExplain_lookup_attr_str(zh->reg->zei,
+                                             zinfo_index_category_sort,
+                                             -1, sk->u.sortField);
+            if (sks->which != Z_SortKeySpec_null
+                && sort_criteria[i].ord == -1)
             {
-                zh->errCode = 116;
-                return;
-            }
-            if (sortIdx_type (zh->reg->sortIdx, sort_criteria[i].attrUse))
-            {
-                zh->errCode = 207;
-                return;
+                zebra_setError(zh,
+                               YAZ_BIB1_CANNOT_SORT_ACCORDING_TO_SEQUENCE, 0);
+                return ZEBRA_FAIL;
             }
             break;
+        case Z_SortKey_elementSpec:
+            yaz_log(log_level_sort, "key %d is of type elementSpec",
+                   i+1);
+            zebra_setError(zh, YAZ_BIB1_CANNOT_SORT_ACCORDING_TO_SEQUENCE, 0);
+            return ZEBRA_FAIL;
+        case Z_SortKey_sortAttributes:
+            yaz_log(log_level_sort, "key %d is of type sortAttributes", i+1);
+            res = zebra_sort_get_ord(zh, sk->u.sortAttributes,
+
+                                     &sort_criteria[i].ord,
+                                     &sort_criteria[i].numerical);
+            if (sks->which != Z_SortKeySpec_null && res != ZEBRA_OK)
+                return ZEBRA_FAIL;
+            break;
+        }
+        if (zebraExplain_lookup_ord(zh->reg->zei, sort_criteria[i].ord,
+                                    &sort_criteria[i].index_type,
+                                    0, 0))
+        {
+            zebra_setError(zh, YAZ_BIB1_CANNOT_SORT_ACCORDING_TO_SEQUENCE, 0);
+            return ZEBRA_FAIL;
         }
     }
+    /* allocate space for each cmpare buf + one extra for tmp comparison */
+    for (i = 0; i<num_criteria; i++)
+    {
+        cmp_buf[i] = xmalloc(sset->sort_info->max_entries
+                             * SORT_IDX_ENTRYSIZE);
+        tmp_cmp_buf[i] = xmalloc(SORT_IDX_ENTRYSIZE);
+    }
     rfd = rset_open (rset, RSETF_READ);
     while (rset_read (rfd, &key, &termid))
-      /* FIXME - pass a TERMID *, and use it for something below !! */
     {
-        zint this_sys = key.mem[0];
+        zint this_sys = key.mem[sysno_mem_index];
+       if (log_level_searchhits)
+           key_logdump_txt(log_level_searchhits, &key, termid->name);
        kno++;
         if (this_sys != psysno)
         {
+            if ((sset->hits & 255) == 0 && zh->break_handler_func)
+            {
+                if (zh->break_handler_func(zh->break_handler_data))
+                {
+                    rset_set_hits_limit(rset, 0);
+                    break;
+                }
+            }
             (sset->hits)++;
             psysno = this_sys;
-            resultSetInsertSort (zh, sset,
-                                 sort_criteria, num_criteria, psysno);
+            resultSetInsertSort(zh, sset,
+                                sort_criteria, num_criteria, psysno, cmp_buf,
+                                tmp_cmp_buf);
         }
     }
     rset_close (rfd);
-    yaz_log(log_level_sorting, ZINT_FORMAT " keys, " ZINT_FORMAT " sysnos, sort",
-                   kno, sset->hits);   
+
+    for (i = 0; i<num_criteria; i++)
+    {
+        xfree(cmp_buf[i]);
+        xfree(tmp_cmp_buf[i]);
+    }
+
+    yaz_log(log_level_sort, ZINT_FORMAT " keys, " ZINT_FORMAT " sysnos, sort",
+           kno, sset->hits);   
     for (i = 0; i < numTerms; i++)
-        yaz_log(log_level_sorting, "term=\"%s\" type=%s count=" ZINT_FORMAT,
-                 terms[i]->name, terms[i]->flags, rset_count(terms[i]->rset));
+        yaz_log(log_level_sort, "term=\"%s\" type=%s count=" ZINT_FORMAT,
+                 terms[i]->name, terms[i]->flags, terms[i]->rset->hits_count);
     *sort_status = Z_SortResponse_success;
+    return ZEBRA_OK;
 }
 
-RSET resultSetRef (ZebraHandle zh, const char *resultSetId)
+RSET resultSetRef(ZebraHandle zh, const char *resultSetId)
 {
     ZebraSet s;
 
@@ -762,111 +974,117 @@ RSET resultSetRef (ZebraHandle zh, const char *resultSetId)
     return NULL;
 }
 
-void resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset, NMEM nmem)
+ZEBRA_RES resultSetRank(ZebraHandle zh, ZebraSet zebraSet,
+                       RSET rset, NMEM nmem)
 {
-    zint kno = 0;
     struct it_key key;
-    RSFD rfd;
     TERMID termid;
     TERMID *terms;
+    zint kno = 0;
     int numTerms = 0;
     int n = 0;
     int i;
     ZebraRankClass rank_class;
-    struct rank_control *rc;
     struct zset_sort_info *sort_info;
     const char *rank_handler_name = res_get_def(zh->res, "rank", "rank-1");
-    double cur,tot; 
-    zint est=-2; /* -2 not done, -1 can't do, >0 actual estimate*/
-    zint esthits;
-    double ratio;
+    size_t sysno_mem_index = 0;
+
+    if (zh->m_staticrank)
+       sysno_mem_index = 1;
 
     if (!log_level_set)
         loglevels();
     sort_info = zebraSet->sort_info;
     sort_info->num_entries = 0;
     zebraSet->hits = 0;
+    zebraSet->estimated_hit_count = 0;
     rset_getterms(rset, 0, 0, &n);
     terms = (TERMID *) nmem_malloc(nmem, sizeof(*terms)*n);
     rset_getterms(rset, terms, n, &numTerms);
 
-    rfd = rset_open (rset, RSETF_READ);
-
-    rank_class = zebraRankLookup (zh, rank_handler_name);
+    rank_class = zebraRankLookup(zh, rank_handler_name);
     if (!rank_class)
     {
         yaz_log(YLOG_WARN, "No such rank handler: %s", rank_handler_name);
-        return;
+       zebra_setError(zh, YAZ_BIB1_UNSUPP_SEARCH, "Cannot find rank handler");
+        return ZEBRA_FAIL;
     }
-    rc = rank_class->control;
-
-    if (rset_read (rfd, &key, &termid))
+    else
     {
-        zint psysno = key.mem[0];
-        int score;
-        void *handle =
-            (*rc->begin) (zh->reg, rank_class->class_handle, rset, nmem,
-                          terms, numTerms);
-        (zebraSet->hits)++;
-        esthits = atoi(res_get_def(zh->res, "estimatehits","0"));
-        if (!esthits) 
-            est = -1; /* can not do */
-        do
-        {
-            zint this_sys = key.mem[0]; /* FIXME - assumes scope==2 */
-            zint seqno = key.mem[key.len-1]; /* FIXME - assumes scope==2 */
-            kno++;
-            key_logdump_txt(log_level_searchhits,&key," Got hit");
-            if (this_sys != psysno)
-            {
-                score = (*rc->calc) (handle, psysno);
-
-                resultSetInsertRank (zh, sort_info, psysno, score, 'A');
-                (zebraSet->hits)++;
-                psysno = this_sys;
-            }
-            (*rc->add) (handle, seqno, termid);
-            
-            if ((est==-2) && (zebraSet->hits==esthits))
-            { /* time to estimate the hits */
-                rset_pos(rfd,&cur,&tot); 
-                if (tot>0) {
-                    ratio = cur/tot;
-                    est = (zint)(0.5+zebraSet->hits/ratio);
-                    yaz_log(log_level_searchhits, "Estimating hits (%s) "
-                                  "%0.1f->" ZINT_FORMAT
-                                  "; %0.1f->" ZINT_FORMAT,
-                                  rset->control->desc,
-                                  cur, zebraSet->hits,
-                                  tot, est);
-                    i = 0; /* round to 3 significant digits */
-                    while (est>1000) {
-                        est /= 10;
-                        i++;
+       RSFD rfd = rset_open(rset, RSETF_READ);
+       struct rank_control *rc = rank_class->control;
+       int score;
+       zint count = 0;
+        void *handle = (*rc->begin) (zh->reg, rank_class->class_handle, rset,
+                                     nmem, terms, numTerms);
+       zint psysno = 0;  /* previous doc id / sys no */
+       zint pstaticrank = 0; /* previous static rank */
+       int stop_flag = 0;
+       while (rset_read(rfd, &key, &termid))
+       {
+           zint this_sys = key.mem[sysno_mem_index];
+
+           zint seqno = key.mem[key.len-1];
+           kno++;
+           if (log_level_searchhits)
+               key_logdump_txt(log_level_searchhits, &key, termid->name);
+           if (this_sys != psysno) 
+           {   /* new record .. */
+                if (!(rfd->counted_items & 255) && zh->break_handler_func)
+                {
+                    if (zh->break_handler_func(zh->break_handler_data))
+                    {
+                        yaz_log(YLOG_LOG, "Aborted search");
+                        stop_flag = 1;
                     }
-                    while (i--)
-                       est *= 10;
-                    zebraSet->hits = est;
                 }
-            }
-        }
-        while (rset_read (rfd, &key,&termid) && (est<0) );
-        score = (*rc->calc)(handle, psysno);
-        resultSetInsertRank(zh, sort_info, psysno, score, 'A');
-        (*rc->end) (zh->reg, handle);
+               if (rfd->counted_items > rset->hits_limit)
+                    stop_flag = 1;
+               if (psysno)
+               {   /* only if we did have a previous record */
+                   score = (*rc->calc) (handle, psysno, pstaticrank,
+                                        &stop_flag);
+                   /* insert the hit. A=Ascending */
+                   resultSetInsertRank (zh, sort_info, psysno, score, 'A');
+                   count++;
+               }
+                if (stop_flag)
+                {
+                    zebraSet->estimated_hit_count = 1;
+                    rset_set_hits_limit(rset, 0);
+                    break;
+                }
+               psysno = this_sys;
+               if (zh->m_staticrank)
+                   pstaticrank = key.mem[0];
+           }
+           (*rc->add) (handle, CAST_ZINT_TO_INT(seqno), termid);
+       }
+       /* no more items */
+       if (psysno)
+       {   /* we had - at least - one record */
+           score = (*rc->calc)(handle, psysno, pstaticrank, &stop_flag);
+           /* insert the hit. A=Ascending */
+           resultSetInsertRank(zh, sort_info, psysno, score, 'A');
+           count++;
+       }
+       (*rc->end) (zh->reg, handle);
+       rset_close (rfd);
     }
-    rset_close (rfd);
+    zebraSet->hits = rset->hits_count;
 
-    yaz_log(log_level_searchterms, ZINT_FORMAT " keys, " ZINT_FORMAT " sysnos, rank",
-           kno, zebraSet->hits);
+    yaz_log(log_level_searchterms, ZINT_FORMAT " keys, "
+           ZINT_FORMAT " sysnos, rank",  kno, zebraSet->hits);
     for (i = 0; i < numTerms; i++)
     {
-        yaz_log(log_level_searchterms, "term=\"%s\" type=%s count=" ZINT_FORMAT,
-                 terms[i]->name, terms[i]->flags, rset_count(terms[i]->rset));
+        yaz_log(log_level_searchterms, "term=\"%s\" type=%s count="
+               ZINT_FORMAT,
+               terms[i]->name, terms[i]->flags, terms[i]->rset->hits_count);
     }
+    return ZEBRA_OK;
 }
 
-ZebraRankClass zebraRankLookup (ZebraHandle zh, const char *name)
+ZebraRankClass zebraRankLookup(ZebraHandle zh, const char *name)
 {
     ZebraRankClass p = zh->reg->rank_classes;
     while (p && strcmp (p->control->name, name))
@@ -880,7 +1098,7 @@ ZebraRankClass zebraRankLookup (ZebraHandle zh, const char *name)
     return p;
 }
 
-void zebraRankInstall (struct zebra_register *reg, struct rank_control *ctrl)
+void zebraRankInstall(struct zebra_register *reg, struct rank_control *ctrl)
 {
     ZebraRankClass p = (ZebraRankClass) xmalloc (sizeof(*p));
     p->control = (struct rank_control *) xmalloc (sizeof(*p->control));
@@ -891,7 +1109,7 @@ void zebraRankInstall (struct zebra_register *reg, struct rank_control *ctrl)
     reg->rank_classes = p;
 }
 
-void zebraRankDestroy (struct zebra_register *reg)
+void zebraRankDestroy(struct zebra_register *reg)
 {
     ZebraRankClass p = reg->rank_classes;
     while (p)
@@ -906,3 +1124,174 @@ void zebraRankDestroy (struct zebra_register *reg)
     }
     reg->rank_classes = NULL;
 }
+
+static int trav_rset_for_termids(RSET rset, TERMID *termid_array,
+                                zint *hits_array, int *approx_array)
+{
+    int no = 0;
+    int i;
+    for (i = 0; i<rset->no_children; i++)
+       no += trav_rset_for_termids(rset->children[i],
+                                   (termid_array ? termid_array + no : 0),
+                                   (hits_array ? hits_array + no : 0),
+                                   (approx_array ? approx_array + no : 0));
+    if (rset->term)
+    {
+       if (termid_array)
+           termid_array[no] = rset->term;
+       if (hits_array)
+           hits_array[no] = rset->hits_count;
+       if (approx_array)
+           approx_array[no] = rset->hits_approx;
+#if 0
+       yaz_log(YLOG_LOG, "rset=%p term=%s limit=" ZINT_FORMAT
+               " count=" ZINT_FORMAT,
+               rset, rset->term->name, rset->hits_limit, rset->hits_count);
+#endif
+       no++;
+    }
+    return no;
+}
+
+ZEBRA_RES zebra_result_set_term_no(ZebraHandle zh, const char *setname,
+                                  int *num_terms)
+{
+    ZebraSet sset = resultSetGet(zh, setname);
+    *num_terms = 0;
+    if (sset)
+    {
+       *num_terms = trav_rset_for_termids(sset->rset, 0, 0, 0);
+       return ZEBRA_OK;
+    }
+    return ZEBRA_FAIL;
+}
+
+ZEBRA_RES zebra_result_set_term_info(ZebraHandle zh, const char *setname,
+                                    int no, zint *count, int *approx,
+                                    char *termbuf, size_t *termlen,
+                                    const char **term_ref_id)
+{
+    ZebraSet sset = resultSetGet(zh, setname);
+    if (sset)
+    {
+       int num_terms = trav_rset_for_termids(sset->rset, 0, 0, 0);
+       if (no >= 0 && no < num_terms)
+       {
+           TERMID *term_array = xmalloc(num_terms * sizeof(*term_array));
+           zint *hits_array = xmalloc(num_terms * sizeof(*hits_array));
+           int *approx_array = xmalloc(num_terms * sizeof(*approx_array));
+           
+           trav_rset_for_termids(sset->rset, term_array,
+                                 hits_array, approx_array);
+
+           if (count)
+               *count = hits_array[no];
+           if (approx)
+               *approx = approx_array[no];
+           if (termbuf)
+           {
+               char *inbuf = term_array[no]->name;
+               size_t inleft = strlen(inbuf);
+               size_t outleft = *termlen - 1;
+
+               if (zh->iconv_from_utf8 != 0)
+               {
+                   char *outbuf = termbuf;
+                   size_t ret;
+                   
+                   ret = yaz_iconv(zh->iconv_from_utf8, &inbuf, &inleft,
+                                   &outbuf, &outleft);
+                   if (ret == (size_t)(-1))
+                       *termlen = 0;
+                   else
+                    {
+                       yaz_iconv(zh->iconv_from_utf8, 0, 0, 
+                                  &outbuf, &outleft);
+                       *termlen = outbuf - termbuf;
+                    }
+               }
+               else
+               {
+                   if (inleft > outleft)
+                       inleft = outleft;
+                   *termlen = inleft;
+                   memcpy(termbuf, inbuf, *termlen);
+               }
+               termbuf[*termlen] = '\0';
+           }
+           if (term_ref_id)
+               *term_ref_id = term_array[no]->ref_id;
+
+           xfree(term_array);
+           xfree(hits_array);
+           xfree(approx_array);
+           return ZEBRA_OK;
+       }
+    }
+    return ZEBRA_FAIL;
+}
+
+ZEBRA_RES zebra_snippets_hit_vector(ZebraHandle zh, const char *setname,
+                                   zint sysno, zebra_snippets *snippets)
+{
+    ZebraSet sset = resultSetGet(zh, setname);
+    yaz_log(YLOG_DEBUG, "zebra_get_hit_vector setname=%s zysno=" ZINT_FORMAT,
+           setname, sysno);
+    if (!sset)
+       return ZEBRA_FAIL;
+    else
+    {
+       struct rset_key_control *kc = zebra_key_control_create(zh);
+       NMEM nmem = nmem_create();
+       struct it_key key;
+       RSET rsets[2], rset_comb;
+       RSET rset_temp = rset_create_temp(nmem, kc, kc->scope, 
+                                          res_get (zh->res, "setTmpDir"),0 );
+       
+       TERMID termid;
+       RSFD rsfd = rset_open(rset_temp, RSETF_WRITE);
+       
+       key.mem[0] = sysno;
+       key.mem[1] = 0;
+       key.mem[2] = 0;
+       key.mem[3] = 0;
+       key.len = 2;
+       rset_write (rsfd, &key);
+       rset_close (rsfd);
+
+       rsets[0] = rset_temp;
+       rsets[1] = rset_dup(sset->rset);
+       
+       rset_comb = rset_create_and(nmem, kc, kc->scope, 2, rsets);
+
+       rsfd = rset_open(rset_comb, RSETF_READ);
+
+       while (rset_read(rsfd, &key, &termid))
+       {
+           if (termid)
+           {
+               struct ord_list *ol;
+               for (ol = termid->ol; ol; ol = ol->next)
+               {
+                   zebra_snippets_append(snippets, key.mem[key.len-1], 0,
+                                         ol->ord, termid->name);
+               }
+           }
+       }
+       rset_close(rsfd);
+       
+       rset_delete(rset_comb);
+       nmem_destroy(nmem);
+       kc->dec(kc);
+    }
+    return ZEBRA_OK;
+}
+
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+