index/zsets.c

   1 /* $Id: zsets.c,v 1.98 2006-01-19 13:31:08 adam Exp $
   2    Copyright (C) 1995-2005
   3    Index Data ApS
   4
   5 This file is part of the Zebra server.
   6
   7 Zebra is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 2, or (at your option) any later
  10 version.
  11
  12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with Zebra; see the file LICENSE.zebra.  If not, write to the
  19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
  20 02111-1307, USA.
  21 */
  22
  23
  24 #include <stdio.h>
  25 #include <assert.h>
  26 #ifdef WIN32
  27 #include <io.h>
  28 #else
  29 #include <unistd.h>
  30 #endif
  31
  32 #include "index.h"
  33 #include <yaz/diagbib1.h>
  34 #include <rset.h>
  35
  36 #define SORT_IDX_ENTRYSIZE 64
  37 #define ZSET_SORT_MAX_LEVEL 3
  38
  39 struct zebra_set_term_entry {
  40     int reg_type;
  41     char *db;
  42     int set;
  43     int use;
  44     char *term;
  45 };
  46
  47 struct zebra_set {
  48     char *name;
  49     RSET rset;
  50     NMEM nmem;
  51     NMEM rset_nmem; /* for creating the rsets in */
  52     zint hits;
  53     int num_bases;
  54     char **basenames;
  55     Z_RPNQuery *rpn;
  56     Z_SortKeySpecList *sortSpec;
  57     struct zset_sort_info *sort_info;
  58     struct zebra_set_term_entry *term_entries;
  59     int term_entries_max;
  60     struct zebra_set *next;
  61     int locked;
  62
  63     zint cache_position;  /* last position */
  64     RSFD cache_rfd;       /* rfd (NULL if not existing) */
  65     zint cache_psysno;    /* sysno for last position */
  66     zint approx_limit;    /* limit before we do approx */
  67 };
  68
  69 struct zset_sort_entry {
  70     zint sysno;
  71     int score;
  72     char buf[ZSET_SORT_MAX_LEVEL][SORT_IDX_ENTRYSIZE];
  73 };
  74
  75 struct zset_sort_info {
  76     int max_entries;
  77     int num_entries;
  78     struct zset_sort_entry *all_entries;
  79     struct zset_sort_entry **entries;
  80 };
  81
  82 static int log_level_set=0;
  83 static int log_level_sort=0;
  84 static int log_level_searchhits=0;
  85 static int log_level_searchterms=0;
  86 static int log_level_resultsets=0;
  87
  88 static void loglevels()
  89 {
  90     if (log_level_set)
  91         return;
  92     log_level_sort = yaz_log_module_level("sorting");
  93     log_level_searchhits = yaz_log_module_level("searchhits");
  94     log_level_searchterms = yaz_log_module_level("searchterms");
  95     log_level_resultsets = yaz_log_module_level("resultsets");
  96     log_level_set = 1;
  97 }
  98
  99 ZEBRA_RES resultSetSearch(ZebraHandle zh, NMEM nmem, NMEM rset_nmem,
 100                           Z_RPNQuery *rpn, ZebraSet sset)
 101 {
 102     RSET rset = 0;
 103     oident *attrset;
 104     Z_SortKeySpecList *sort_sequence;
 105     int sort_status, i;
 106     ZEBRA_RES res = ZEBRA_OK;
 107
 108     zh->hits = 0;
 109
 110     sort_sequence = (Z_SortKeySpecList *)
 111         nmem_malloc(nmem, sizeof(*sort_sequence));
 112     sort_sequence->num_specs = 10; /* FIXME - Hard-coded number */
 113     sort_sequence->specs = (Z_SortKeySpec **)
 114         nmem_malloc(nmem, sort_sequence->num_specs *
 115                      sizeof(*sort_sequence->specs));
 116     for (i = 0; i<sort_sequence->num_specs; i++)
 117         sort_sequence->specs[i] = 0;
 118
 119     attrset = oid_getentbyoid (rpn->attributeSetId);
 120     res = rpn_search_top(zh, rpn->RPNStructure, attrset->value,
 121                          nmem, rset_nmem,
 122                          sort_sequence,
 123                          sset->num_bases, sset->basenames,
 124                          &rset);
 125     if (res != ZEBRA_OK)
 126     {
 127         sset->rset = 0;
 128         return res;
 129     }
 130     for (i = 0; sort_sequence->specs[i]; i++)
 131         ;
 132     sort_sequence->num_specs = i;
 133     rset->hits_limit = sset->approx_limit;
 134     if (!i)
 135     {
 136         res = resultSetRank (zh, sset, rset, rset_nmem);
 137     }
 138     else
 139     {
 140         res = resultSetSortSingle (zh, nmem, sset, rset,
 141                                    sort_sequence, &sort_status);
 142     }
 143     sset->rset = rset;
 144     return res;
 145 }
 146
 147
 148 ZEBRA_RES resultSetAddRPN (ZebraHandle zh, NMEM m, Z_RPNQuery *rpn,
 149                            int num_bases, char **basenames,
 150                            const char *setname)
 151 {
 152     ZebraSet zebraSet;
 153     int i;
 154     ZEBRA_RES res;
 155
 156     zh->hits = 0;
 157
 158     zebraSet = resultSetAdd(zh, setname, 1);
 159     if (!zebraSet)
 160         return ZEBRA_FAIL;
 161     zebraSet->locked = 1;
 162     zebraSet->rpn = 0;
 163     zebraSet->nmem = m;
 164     zebraSet->rset_nmem = nmem_create();
 165
 166     zebraSet->num_bases = num_bases;
 167     zebraSet->basenames =
 168         nmem_malloc (zebraSet->nmem, num_bases * sizeof(*zebraSet->basenames));
 169     for (i = 0; i<num_bases; i++)
 170         zebraSet->basenames[i] = nmem_strdup(zebraSet->nmem, basenames[i]);
 171
 172     res = resultSetSearch(zh, zebraSet->nmem, zebraSet->rset_nmem,
 173                           rpn, zebraSet);
 174     zh->hits = zebraSet->hits;
 175     if (zebraSet->rset)
 176         zebraSet->rpn = rpn;
 177     zebraSet->locked = 0;
 178     if (!zebraSet->rset)
 179         return ZEBRA_FAIL;
 180     return res;
 181 }
 182
 183 void resultSetAddTerm (ZebraHandle zh, ZebraSet s, int reg_type,
 184                        const char *db, int set,
 185                        int use, const char *term)
 186 {
 187     assert(zh); /* compiler shut up */
 188     if (!s->nmem)
 189         s->nmem = nmem_create ();
 190     if (!s->term_entries)
 191     {
 192         int i;
 193         s->term_entries_max = 1000;
 194         s->term_entries =
 195             nmem_malloc (s->nmem, s->term_entries_max *
 196                          sizeof(*s->term_entries));
 197         for (i = 0; i < s->term_entries_max; i++)
 198             s->term_entries[i].term = 0;
 199     }
 200     if (s->hits < s->term_entries_max)
 201     {
 202         s->term_entries[s->hits].reg_type = reg_type;
 203         s->term_entries[s->hits].db = nmem_strdup (s->nmem, db);
 204         s->term_entries[s->hits].set = set;
 205         s->term_entries[s->hits].use = use;
 206         s->term_entries[s->hits].term = nmem_strdup (s->nmem, term);
 207     }
 208     (s->hits)++;
 209 }
 210
 211 ZebraSet resultSetAdd(ZebraHandle zh, const char *name, int ov)
 212 {
 213     ZebraSet s;
 214     int i;
 215
 216     for (s = zh->sets; s; s = s->next)
 217         if (!strcmp (s->name, name))
 218             break;
 219
 220     if (!log_level_set)
 221         loglevels();
 222     if (s)
 223     {
 224         yaz_log(log_level_resultsets, "updating result set %s", name);
 225         if (!ov || s->locked)
 226             return NULL;
 227         if (s->rset)
 228         {
 229             if (s->cache_rfd)
 230                 rset_close(s->cache_rfd);
 231             rset_delete (s->rset);
 232         }
 233         if (s->rset_nmem)
 234             nmem_destroy (s->rset_nmem);
 235         if (s->nmem)
 236             nmem_destroy (s->nmem);
 237     }
 238     else
 239     {
 240         const char *sort_max_str = zebra_get_resource(zh, "sortmax", "1000");
 241
 242         yaz_log(log_level_resultsets, "adding result set %s", name);
 243         s = (ZebraSet) xmalloc (sizeof(*s));
 244         s->next = zh->sets;
 245         zh->sets = s;
 246         s->name = (char *) xmalloc (strlen(name)+1);
 247         strcpy (s->name, name);
 248
 249         s->sort_info = (struct zset_sort_info *)
 250             xmalloc (sizeof(*s->sort_info));
 251         s->sort_info->max_entries = atoi(sort_max_str);
 252         if (s->sort_info->max_entries < 2)
 253             s->sort_info->max_entries = 2;
 254
 255         s->sort_info->entries = (struct zset_sort_entry **)
 256             xmalloc (sizeof(*s->sort_info->entries) *
 257                      s->sort_info->max_entries);
 258         s->sort_info->all_entries = (struct zset_sort_entry *)
 259             xmalloc (sizeof(*s->sort_info->all_entries) *
 260                      s->sort_info->max_entries);
 261         for (i = 0; i < s->sort_info->max_entries; i++)
 262             s->sort_info->entries[i] = s->sort_info->all_entries + i;
 263     }
 264     s->locked = 0;
 265     s->term_entries = 0;
 266     s->hits = 0;
 267     s->rset = 0;
 268     s->rset_nmem = 0;
 269     s->nmem = 0;
 270     s->rpn = 0;
 271     s->cache_position = 0;
 272     s->cache_rfd = 0;
 273     s->approx_limit = zh->approx_limit;
 274     return s;
 275 }
 276
 277 ZebraSet resultSetGet(ZebraHandle zh, const char *name)
 278 {
 279     ZebraSet s;
 280
 281     for (s = zh->sets; s; s = s->next)
 282         if (!strcmp (s->name, name))
 283         {
 284             if (!s->term_entries && !s->rset && s->rpn)
 285             {
 286                 NMEM nmem = nmem_create ();
 287                 yaz_log(log_level_resultsets, "research %s", name);
 288                 if (!s->rset_nmem)
 289                     s->rset_nmem=nmem_create();
 290                 resultSetSearch(zh, nmem, s->rset_nmem, s->rpn, s);
 291                 if (s->rset && s->sortSpec)
 292                 {
 293                     int sort_status;
 294                     yaz_log(log_level_resultsets, "resort %s", name);
 295                     resultSetSortSingle (zh, nmem, s, s->rset, s->sortSpec,
 296                                          &sort_status);
 297                 }
 298                 nmem_destroy (nmem);
 299             }
 300             return s;
 301         }
 302     return NULL;
 303 }
 304
 305 void resultSetInvalidate (ZebraHandle zh)
 306 {
 307     ZebraSet s = zh->sets;
 308
 309     yaz_log(log_level_resultsets, "invalidating result sets");
 310     for (; s; s = s->next)
 311     {
 312         if (s->rset)
 313         {
 314             if (s->cache_rfd)
 315                 rset_close(s->cache_rfd);
 316             rset_delete (s->rset);
 317         }
 318         s->rset = 0;
 319         s->cache_rfd = 0;
 320         s->cache_position = 0;
 321         if (s->rset_nmem)
 322             nmem_destroy(s->rset_nmem);
 323         s->rset_nmem=0;
 324     }
 325 }
 326
 327 void resultSetDestroy(ZebraHandle zh, int num, char **names,int *statuses)
 328 {
 329     ZebraSet * ss = &zh->sets;
 330     int i;
 331
 332     if (statuses)
 333         for (i = 0; i<num; i++)
 334             statuses[i] = Z_DeleteStatus_resultSetDidNotExist;
 335     while (*ss)
 336     {
 337         int i = -1;
 338         ZebraSet s = *ss;
 339         if (num >= 0)
 340         {
 341             for (i = 0; i<num; i++)
 342                 if (!strcmp (s->name, names[i]))
 343                 {
 344                     if (statuses)
 345                         statuses[i] = Z_DeleteStatus_success;
 346                     i = -1;
 347                     break;
 348                 }
 349         }
 350         if (i < 0)
 351         {
 352             *ss = s->next;
 353
 354             xfree (s->sort_info->all_entries);
 355             xfree (s->sort_info->entries);
 356             xfree (s->sort_info);
 357
 358             if (s->nmem)
 359                 nmem_destroy (s->nmem);
 360             if (s->rset)
 361             {
 362                 if (s->cache_rfd)
 363                     rset_close(s->cache_rfd);
 364                 rset_delete (s->rset);
 365             }
 366             if (s->rset_nmem)
 367                 nmem_destroy(s->rset_nmem);
 368             xfree (s->name);
 369             xfree (s);
 370         }
 371         else
 372             ss = &s->next;
 373     }
 374 }
 375
 376 ZebraMetaRecord *zebra_meta_records_create_range(ZebraHandle zh,
 377                                                  const char *name,
 378                                                  zint start, int num)
 379 {
 380     zint pos_small[10];
 381     zint *pos = pos_small;
 382     ZebraMetaRecord *mr;
 383     int i;
 384
 385     if (num > 10000 || num <= 0)
 386         return 0;
 387
 388     if (num > 10)
 389         pos = xmalloc(sizeof(*pos) * num);
 390
 391     for (i = 0; i<num; i++)
 392         pos[i] = start+i;
 393
 394     mr = zebra_meta_records_create(zh, name, num, pos);
 395
 396     if (num > 10)
 397         xfree(pos);
 398     return mr;
 399 }
 400
 401 ZebraMetaRecord *zebra_meta_records_create(ZebraHandle zh, const char *name,
 402                                            int num, zint *positions)
 403 {
 404     ZebraSet sset;
 405     ZebraMetaRecord *sr = 0;
 406     RSET rset;
 407     int i;
 408     struct zset_sort_info *sort_info;
 409     size_t sysno_mem_index = 0;
 410
 411     if (zh->m_staticrank)
 412         sysno_mem_index = 1;
 413
 414     if (!log_level_set)
 415         loglevels();
 416     if (!(sset = resultSetGet (zh, name)))
 417         return NULL;
 418     if (!(rset = sset->rset))
 419     {
 420         if (!sset->term_entries)
 421             return 0;
 422         sr = (ZebraMetaRecord *) xmalloc (sizeof(*sr) * num);
 423         for (i = 0; i<num; i++)
 424         {
 425             sr[i].sysno = 0;
 426             sr[i].score = -1;
 427             sr[i].term = 0;
 428             sr[i].db = 0;
 429
 430             if (positions[i] <= sset->term_entries_max)
 431             {
 432                 sr[i].term = sset->term_entries[positions[i]-1].term;
 433                 sr[i].db = sset->term_entries[positions[i]-1].db;
 434             }
 435         }
 436     }
 437     else
 438     {
 439         sr = (ZebraMetaRecord *) xmalloc (sizeof(*sr) * num);
 440         for (i = 0; i<num; i++)
 441         {
 442             sr[i].sysno = 0;
 443             sr[i].score = -1;
 444             sr[i].term = 0;
 445             sr[i].db = 0;
 446         }
 447         sort_info = sset->sort_info;
 448         if (sort_info)
 449         {
 450             zint position;
 451
 452             for (i = 0; i<num; i++)
 453             {
 454                 position = positions[i];
 455                 if (position > 0 && position <= sort_info->num_entries)
 456                 {
 457                     yaz_log(log_level_sort, "got pos=" ZINT_FORMAT
 458                             " (sorted)", position);
 459                     sr[i].sysno = sort_info->entries[position-1]->sysno;
 460                     sr[i].score = sort_info->entries[position-1]->score;
 461                 }
 462             }
 463         }
 464         /* did we really get all entries using sort ? */
 465         for (i = 0; i<num; i++)
 466         {
 467             if (!sr[i].sysno)
 468                 break;
 469         }
 470         if (i < num) /* nope, get the rest, unsorted - sorry */
 471         {
 472             zint position = 0;
 473             int num_i = 0;
 474             zint psysno = 0;
 475             RSFD rfd;
 476             struct it_key key;
 477
 478             if (sort_info)
 479                 position = sort_info->num_entries;
 480             while (num_i < num && positions[num_i] <= position)
 481                 num_i++;
 482
 483             if (sset->cache_rfd &&
 484                 num_i < num && positions[num_i] > sset->cache_position)
 485             {
 486                 position = sset->cache_position;
 487                 rfd = sset->cache_rfd;
 488                 psysno = sset->cache_psysno;
 489             }
 490             else
 491             {
 492                 if (sset->cache_rfd)
 493                     rset_close(sset->cache_rfd);
 494                 rfd = rset_open (rset, RSETF_READ);
 495             }
 496             while (num_i < num && rset_read (rfd, &key, 0))
 497             {
 498                 zint this_sys = key.mem[sysno_mem_index];
 499                 if (this_sys != psysno)
 500                 {
 501                     psysno = this_sys;
 502                     if (sort_info)
 503                     {
 504                         /* determine we alreay have this in our set */
 505                         for (i = sort_info->num_entries; --i >= 0; )
 506                             if (psysno == sort_info->entries[i]->sysno)
 507                                 break;
 508                         if (i >= 0)
 509                             continue;
 510                     }
 511                     position++;
 512                     assert (num_i < num);
 513                     if (position == positions[num_i])
 514                     {
 515                         sr[num_i].sysno = psysno;
 516                         yaz_log(log_level_sort, "got pos=" ZINT_FORMAT " (unsorted)", position);
 517                         sr[num_i].score = -1;
 518                         num_i++;
 519                     }
 520                 }
 521             }
 522             sset->cache_position = position;
 523             sset->cache_psysno = psysno;
 524             sset->cache_rfd = rfd;
 525         }
 526     }
 527     return sr;
 528 }
 529
 530 void zebra_meta_records_destroy (ZebraHandle zh, ZebraMetaRecord *records,
 531                                  int num)
 532 {
 533     assert(zh); /* compiler shut up about unused arg */
 534     xfree (records);
 535 }
 536
 537 struct sortKeyInfo {
 538     int relation;
 539     int attrUse;
 540     int numerical;
 541 };
 542
 543 void resultSetInsertSort (ZebraHandle zh, ZebraSet sset,
 544                           struct sortKeyInfo *criteria, int num_criteria,
 545                           zint sysno)
 546 {
 547     struct zset_sort_entry this_entry;
 548     struct zset_sort_entry *new_entry = NULL;
 549     struct zset_sort_info *sort_info = sset->sort_info;
 550     int i, j;
 551
 552     sortIdx_sysno (zh->reg->sortIdx, sysno);
 553     for (i = 0; i<num_criteria; i++)
 554     {
 555         sortIdx_type (zh->reg->sortIdx, criteria[i].attrUse);
 556         sortIdx_read (zh->reg->sortIdx, this_entry.buf[i]);
 557     }
 558     i = sort_info->num_entries;
 559     while (--i >= 0)
 560     {
 561         int rel = 0;
 562         for (j = 0; j<num_criteria; j++)
 563         {
 564             if (criteria[j].numerical)
 565             {
 566                 double diff = atof(this_entry.buf[j]) -
 567                               atof(sort_info->entries[i]->buf[j]);
 568                 rel = 0;
 569                 if (diff > 0.0)
 570                     rel = 1;
 571                 else if (diff < 0.0)
 572                     rel = -1;
 573             }
 574             else
 575             {
 576                 rel = memcmp (this_entry.buf[j], sort_info->entries[i]->buf[j],
 577                           SORT_IDX_ENTRYSIZE);
 578             }
 579             if (rel)
 580                 break;
 581         }
 582         if (!rel)
 583             break;
 584         if (criteria[j].relation == 'A')
 585         {
 586             if (rel > 0)
 587                 break;
 588         }
 589         else if (criteria[j].relation == 'D')
 590         {
 591             if (rel < 0)
 592                 break;
 593         }
 594     }
 595     ++i;
 596     j = sort_info->max_entries;
 597     if (i == j)
 598         return;
 599
 600     if (sort_info->num_entries == j)
 601         --j;
 602     else
 603         j = (sort_info->num_entries)++;
 604     new_entry = sort_info->entries[j];
 605     while (j != i)
 606     {
 607         sort_info->entries[j] = sort_info->entries[j-1];
 608         --j;
 609     }
 610     sort_info->entries[i] = new_entry;
 611     assert (new_entry);
 612     for (i = 0; i<num_criteria; i++)
 613         memcpy (new_entry->buf[i], this_entry.buf[i], SORT_IDX_ENTRYSIZE);
 614     new_entry->sysno = sysno;
 615     new_entry->score = -1;
 616 }
 617
 618 void resultSetInsertRank (ZebraHandle zh, struct zset_sort_info *sort_info,
 619                           zint sysno, int score, int relation)
 620 {
 621     struct zset_sort_entry *new_entry = NULL;
 622     int i, j;
 623     assert(zh); /* compiler shut up about unused arg */
 624
 625     i = sort_info->num_entries;
 626     while (--i >= 0)
 627     {
 628         int rel = 0;
 629
 630         rel = score - sort_info->entries[i]->score;
 631
 632         if (relation == 'D')
 633         {
 634             if (rel >= 0)
 635                 break;
 636         }
 637         else if (relation == 'A')
 638         {
 639             if (rel <= 0)
 640                 break;
 641         }
 642     }
 643     ++i;
 644     j = sort_info->max_entries;
 645     if (i == j)
 646         return;
 647
 648     if (sort_info->num_entries == j)
 649         --j;
 650     else
 651         j = (sort_info->num_entries)++;
 652
 653     new_entry = sort_info->entries[j];
 654     while (j != i)
 655     {
 656         sort_info->entries[j] = sort_info->entries[j-1];
 657         --j;
 658     }
 659     sort_info->entries[i] = new_entry;
 660     assert (new_entry);
 661     new_entry->sysno = sysno;
 662     new_entry->score = score;
 663 }
 664
 665 static Z_RPNQuery *copy_RPNQuery(Z_RPNQuery *src, NMEM nmem)
 666 {
 667     Z_RPNQuery *dst = 0;
 668     ODR encode = odr_createmem(ODR_ENCODE);
 669     ODR decode = odr_createmem(ODR_DECODE);
 670
 671     if (z_RPNQuery(encode, &src, 0, 0))
 672     {
 673         int len;
 674         char *buf = odr_getbuf(encode, &len, 0);
 675
 676         if (buf)
 677         {
 678             odr_setbuf(decode, buf, len, 0);
 679             z_RPNQuery(decode, &dst, 0, 0);
 680         }
 681     }
 682     nmem_transfer(nmem, decode->mem);
 683     odr_destroy(encode);
 684     odr_destroy(decode);
 685     return dst;
 686 }
 687
 688 static Z_SortKeySpecList *copy_SortKeySpecList(Z_SortKeySpecList *src, NMEM nmem)
 689 {
 690     Z_SortKeySpecList *dst = 0;
 691     ODR encode = odr_createmem(ODR_ENCODE);
 692     ODR decode = odr_createmem(ODR_DECODE);
 693
 694     if (z_SortKeySpecList(encode, &src, 0, 0))
 695     {
 696         int len;
 697         char *buf = odr_getbuf(encode, &len, 0);
 698
 699         if (buf)
 700         {
 701             odr_setbuf(decode, buf, len, 0);
 702             z_SortKeySpecList(decode, &dst, 0, 0);
 703         }
 704     }
 705     nmem_transfer(nmem, decode->mem);
 706     odr_destroy(encode);
 707     odr_destroy(decode);
 708     return dst;
 709 }
 710
 711 ZebraSet resultSetClone(ZebraHandle zh, const char *setname,
 712                         ZebraSet rset)
 713 {
 714     ZebraSet nset;
 715     int i;
 716
 717     nset = resultSetAdd(zh, setname, 1);
 718     if (!nset)
 719         return 0;
 720
 721     nset->nmem = nmem_create();
 722
 723     nset->num_bases = rset->num_bases;
 724     nset->basenames =
 725         nmem_malloc (nset->nmem, nset->num_bases * sizeof(*rset->basenames));
 726     for (i = 0; i<rset->num_bases; i++)
 727         nset->basenames[i] = nmem_strdup(nset->nmem, rset->basenames[i]);
 728
 729     if (rset->rset)
 730         nset->rset = rset_dup(rset->rset);
 731     if (rset->rpn)
 732         nset->rpn = copy_RPNQuery(rset->rpn, nset->nmem);
 733     return nset;
 734 }
 735
 736 ZEBRA_RES resultSetSort(ZebraHandle zh, NMEM nmem,
 737                         int num_input_setnames, const char **input_setnames,
 738                         const char *output_setname,
 739                         Z_SortKeySpecList *sort_sequence, int *sort_status)
 740 {
 741     ZebraSet sset;
 742     RSET rset;
 743
 744     if (num_input_setnames == 0)
 745     {
 746         zebra_setError(zh, YAZ_BIB1_NO_RESULT_SET_NAME_SUPPLIED_ON_SORT, 0);
 747         return ZEBRA_FAIL;
 748     }
 749     if (num_input_setnames > 1)
 750     {
 751         zebra_setError(zh, YAZ_BIB1_SORT_TOO_MANY_INPUT_RESULTS, 0);
 752         return ZEBRA_FAIL;
 753     }
 754     if (!log_level_set)
 755         loglevels();
 756     yaz_log(log_level_sort, "result set sort input=%s output=%s",
 757           *input_setnames, output_setname);
 758     sset = resultSetGet (zh, input_setnames[0]);
 759     if (!sset)
 760     {
 761         zebra_setError(zh, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
 762                        input_setnames[0]);
 763         return ZEBRA_FAIL;
 764     }
 765     if (!(rset = sset->rset))
 766     {
 767         zebra_setError(zh, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
 768                        input_setnames[0]);
 769         return ZEBRA_FAIL;
 770     }
 771     if (strcmp (output_setname, input_setnames[0]))
 772         sset = resultSetClone(zh, output_setname, sset);
 773     sset->sortSpec = copy_SortKeySpecList(sort_sequence, sset->nmem);
 774     return resultSetSortSingle (zh, nmem, sset, rset, sort_sequence,
 775                                 sort_status);
 776 }
 777
 778 ZEBRA_RES resultSetSortSingle(ZebraHandle zh, NMEM nmem,
 779                               ZebraSet sset, RSET rset,
 780                               Z_SortKeySpecList *sort_sequence,
 781                               int *sort_status)
 782 {
 783     int i;
 784     int n = 0;
 785     zint kno = 0;
 786     zint psysno = 0;
 787     struct it_key key;
 788     struct sortKeyInfo sort_criteria[3];
 789     int num_criteria;
 790     RSFD rfd;
 791     TERMID termid;
 792     TERMID *terms;
 793     int numTerms = 0;
 794     size_t sysno_mem_index = 0;
 795
 796     if (zh->m_staticrank)
 797         sysno_mem_index = 1;
 798
 799
 800     assert(nmem); /* compiler shut up about unused param */
 801     sset->sort_info->num_entries = 0;
 802
 803     rset_getterms(rset, 0, 0, &n);
 804     terms = (TERMID *) nmem_malloc(nmem, sizeof(*terms)*n);
 805     rset_getterms(rset, terms, n, &numTerms);
 806
 807     sset->hits = 0;
 808     num_criteria = sort_sequence->num_specs;
 809     if (num_criteria > 3)
 810         num_criteria = 3;
 811     for (i = 0; i < num_criteria; i++)
 812     {
 813         Z_SortKeySpec *sks = sort_sequence->specs[i];
 814         Z_SortKey *sk;
 815
 816         if (*sks->sortRelation == Z_SortKeySpec_ascending)
 817             sort_criteria[i].relation = 'A';
 818         else if (*sks->sortRelation == Z_SortKeySpec_descending)
 819             sort_criteria[i].relation = 'D';
 820         else
 821         {
 822             zebra_setError(zh, YAZ_BIB1_ILLEGAL_SORT_RELATION, 0);
 823             return ZEBRA_FAIL;
 824         }
 825         if (sks->sortElement->which == Z_SortElement_databaseSpecific)
 826         {
 827             zebra_setError(zh, YAZ_BIB1_DATABASE_SPECIFIC_SORT_UNSUPP, 0);
 828             return ZEBRA_FAIL;
 829         }
 830         else if (sks->sortElement->which != Z_SortElement_generic)
 831         {
 832             zebra_setError(zh, YAZ_BIB1_SORT_ILLEGAL_SORT, 0);
 833             return ZEBRA_FAIL;
 834         }
 835         sk = sks->sortElement->u.generic;
 836         switch (sk->which)
 837         {
 838         case Z_SortKey_sortField:
 839             yaz_log(log_level_sort, "key %d is of type sortField",
 840                     i+1);
 841             zebra_setError(zh, YAZ_BIB1_CANNOT_SORT_ACCORDING_TO_SEQUENCE, 0);
 842             return ZEBRA_FAIL;
 843         case Z_SortKey_elementSpec:
 844             yaz_log(log_level_sort, "key %d is of type elementSpec",
 845                     i+1);
 846             zebra_setError(zh, YAZ_BIB1_CANNOT_SORT_ACCORDING_TO_SEQUENCE, 0);
 847             return ZEBRA_FAIL;
 848         case Z_SortKey_sortAttributes:
 849             yaz_log(log_level_sort, "key %d is of type sortAttributes", i+1);
 850             sort_criteria[i].attrUse =
 851                 zebra_maps_sort (zh->reg->zebra_maps,
 852                                  sk->u.sortAttributes,
 853                                  &sort_criteria[i].numerical);
 854             yaz_log(log_level_sort, "use value = %d", sort_criteria[i].attrUse);
 855             if (sort_criteria[i].attrUse == -1)
 856             {
 857                 zebra_setError(
 858                     zh, YAZ_BIB1_USE_ATTRIBUTE_REQUIRED_BUT_NOT_SUPPLIED, 0);
 859                 return ZEBRA_FAIL;
 860             }
 861             if (sortIdx_type (zh->reg->sortIdx, sort_criteria[i].attrUse))
 862             {
 863                 zebra_setError(
 864                     zh, YAZ_BIB1_CANNOT_SORT_ACCORDING_TO_SEQUENCE, 0);
 865                 return ZEBRA_FAIL;
 866             }
 867             break;
 868         }
 869     }
 870     rfd = rset_open (rset, RSETF_READ);
 871     while (rset_read (rfd, &key, &termid))
 872     {
 873         zint this_sys = key.mem[sysno_mem_index];
 874         if (log_level_searchhits)
 875             key_logdump_txt(log_level_searchhits, &key, termid->name);
 876         kno++;
 877         if (this_sys != psysno)
 878         {
 879             (sset->hits)++;
 880             psysno = this_sys;
 881             resultSetInsertSort (zh, sset,
 882                                  sort_criteria, num_criteria, psysno);
 883         }
 884     }
 885     rset_close (rfd);
 886     yaz_log(log_level_sort, ZINT_FORMAT " keys, " ZINT_FORMAT " sysnos, sort",
 887             kno, sset->hits);
 888     for (i = 0; i < numTerms; i++)
 889         yaz_log(log_level_sort, "term=\"%s\" type=%s count=" ZINT_FORMAT,
 890                  terms[i]->name, terms[i]->flags, terms[i]->rset->hits_count);
 891     *sort_status = Z_SortResponse_success;
 892     return ZEBRA_OK;
 893 }
 894
 895 RSET resultSetRef(ZebraHandle zh, const char *resultSetId)
 896 {
 897     ZebraSet s;
 898
 899     if ((s = resultSetGet (zh, resultSetId)))
 900         return s->rset;
 901     return NULL;
 902 }
 903
 904 ZEBRA_RES resultSetRank(ZebraHandle zh, ZebraSet zebraSet,
 905                         RSET rset, NMEM nmem)
 906 {
 907     struct it_key key;
 908     TERMID termid;
 909     TERMID *terms;
 910     zint kno = 0;
 911     int numTerms = 0;
 912     int n = 0;
 913     int i;
 914     ZebraRankClass rank_class;
 915     struct zset_sort_info *sort_info;
 916     const char *rank_handler_name = res_get_def(zh->res, "rank", "rank-1");
 917     size_t sysno_mem_index = 0;
 918
 919     if (zh->m_staticrank)
 920         sysno_mem_index = 1;
 921
 922     if (!log_level_set)
 923         loglevels();
 924     sort_info = zebraSet->sort_info;
 925     sort_info->num_entries = 0;
 926     zebraSet->hits = 0;
 927     rset_getterms(rset, 0, 0, &n);
 928     terms = (TERMID *) nmem_malloc(nmem, sizeof(*terms)*n);
 929     rset_getterms(rset, terms, n, &numTerms);
 930
 931
 932     rank_class = zebraRankLookup(zh, rank_handler_name);
 933     if (!rank_class)
 934     {
 935         yaz_log(YLOG_WARN, "No such rank handler: %s", rank_handler_name);
 936         zebra_setError(zh, YAZ_BIB1_UNSUPP_SEARCH, "Cannot find rank handler");
 937         return ZEBRA_FAIL;
 938     }
 939     else
 940     {
 941         RSFD rfd = rset_open(rset, RSETF_READ);
 942         struct rank_control *rc = rank_class->control;
 943         double score;
 944         zint count = 0;
 945
 946         void *handle =
 947             (*rc->begin) (zh->reg, rank_class->class_handle, rset, nmem,
 948                           terms, numTerms);
 949         zint psysno = 0;  /* previous doc id / sys no */
 950         zint pstaticrank = 0; /* previous static rank */
 951         int stop_flag = 0;
 952         while (rset_read(rfd, &key, &termid))
 953         {
 954             zint this_sys = key.mem[sysno_mem_index];
 955
 956             zint seqno = key.mem[key.len-1];
 957             kno++;
 958             if (log_level_searchhits)
 959                 key_logdump_txt(log_level_searchhits, &key, termid->name);
 960             if (this_sys != psysno)
 961             {   /* new record .. */
 962                 if (rfd->counted_items > rset->hits_limit)
 963                     break;
 964                 if (psysno)
 965                 {   /* only if we did have a previous record */
 966                     score = (*rc->calc) (handle, psysno, pstaticrank,
 967                                          &stop_flag);
 968                     /* insert the hit. A=Ascending */
 969                     resultSetInsertRank (zh, sort_info, psysno, score, 'A');
 970                     count++;
 971                     if (stop_flag)
 972                         break;
 973                 }
 974                 psysno = this_sys;
 975                 if (zh->m_staticrank)
 976                     pstaticrank = key.mem[0];
 977             }
 978             (*rc->add) (handle, CAST_ZINT_TO_INT(seqno), termid);
 979         }
 980         /* no more items */
 981         if (psysno)
 982         {   /* we had - at least - one record */
 983             score = (*rc->calc)(handle, psysno, pstaticrank, &stop_flag);
 984             /* insert the hit. A=Ascending */
 985             resultSetInsertRank(zh, sort_info, psysno, score, 'A');
 986             count++;
 987         }
 988         (*rc->end) (zh->reg, handle);
 989         rset_close (rfd);
 990     }
 991     zebraSet->hits = rset->hits_count;
 992
 993     yaz_log(log_level_searchterms, ZINT_FORMAT " keys, "
 994             ZINT_FORMAT " sysnos, rank",  kno, zebraSet->hits);
 995     for (i = 0; i < numTerms; i++)
 996     {
 997         yaz_log(log_level_searchterms, "term=\"%s\" type=%s count="
 998                 ZINT_FORMAT,
 999                 terms[i]->name, terms[i]->flags, terms[i]->rset->hits_count);
1000     }
1001     return ZEBRA_OK;
1002 }
1003
1004 ZebraRankClass zebraRankLookup(ZebraHandle zh, const char *name)
1005 {
1006     ZebraRankClass p = zh->reg->rank_classes;
1007     while (p && strcmp (p->control->name, name))
1008         p = p->next;
1009     if (p && !p->init_flag)
1010     {
1011         if (p->control->create)
1012             p->class_handle = (*p->control->create)(zh);
1013         p->init_flag = 1;
1014     }
1015     return p;
1016 }
1017
1018 void zebraRankInstall(struct zebra_register *reg, struct rank_control *ctrl)
1019 {
1020     ZebraRankClass p = (ZebraRankClass) xmalloc (sizeof(*p));
1021     p->control = (struct rank_control *) xmalloc (sizeof(*p->control));
1022     memcpy (p->control, ctrl, sizeof(*p->control));
1023     p->control->name = xstrdup (ctrl->name);
1024     p->init_flag = 0;
1025     p->next = reg->rank_classes;
1026     reg->rank_classes = p;
1027 }
1028
1029 void zebraRankDestroy(struct zebra_register *reg)
1030 {
1031     ZebraRankClass p = reg->rank_classes;
1032     while (p)
1033     {
1034         ZebraRankClass p_next = p->next;
1035         if (p->init_flag && p->control->destroy)
1036             (*p->control->destroy)(reg, p->class_handle);
1037         xfree(p->control->name);
1038         xfree(p->control);
1039         xfree(p);
1040         p = p_next;
1041     }
1042     reg->rank_classes = NULL;
1043 }
1044
1045 static int trav_rset_for_termids(RSET rset, TERMID *termid_array,
1046                                  zint *hits_array, int *approx_array)
1047 {
1048     int no = 0;
1049     int i;
1050     for (i = 0; i<rset->no_children; i++)
1051         no += trav_rset_for_termids(rset->children[i],
1052                                     (termid_array ? termid_array + no : 0),
1053                                     (hits_array ? hits_array + no : 0),
1054                                     (approx_array ? approx_array + no : 0));
1055     if (rset->term)
1056     {
1057         if (termid_array)
1058             termid_array[no] = rset->term;
1059         if (hits_array)
1060             hits_array[no] = rset->hits_count;
1061         if (approx_array)
1062             approx_array[no] = rset->hits_approx;
1063 #if 0
1064         yaz_log(YLOG_LOG, "rset=%p term=%s limit=" ZINT_FORMAT
1065                 " count=" ZINT_FORMAT,
1066                 rset, rset->term->name, rset->hits_limit, rset->hits_count);
1067 #endif
1068         no++;
1069     }
1070     return no;
1071 }
1072
1073 ZEBRA_RES zebra_result_set_term_no(ZebraHandle zh, const char *setname,
1074                                    int *num_terms)
1075 {
1076     ZebraSet sset = resultSetGet(zh, setname);
1077     *num_terms = 0;
1078     if (sset)
1079     {
1080         *num_terms = trav_rset_for_termids(sset->rset, 0, 0, 0);
1081         return ZEBRA_OK;
1082     }
1083     return ZEBRA_FAIL;
1084 }
1085
1086 ZEBRA_RES zebra_result_set_term_info(ZebraHandle zh, const char *setname,
1087                                      int no, zint *count, int *approx,
1088                                      char *termbuf, size_t *termlen,
1089                                      const char **term_ref_id)
1090 {
1091     ZebraSet sset = resultSetGet(zh, setname);
1092     if (sset)
1093     {
1094         int num_terms = trav_rset_for_termids(sset->rset, 0, 0, 0);
1095         if (no >= 0 && no < num_terms)
1096         {
1097             TERMID *term_array = xmalloc(num_terms * sizeof(*term_array));
1098             zint *hits_array = xmalloc(num_terms * sizeof(*hits_array));
1099             int *approx_array = xmalloc(num_terms * sizeof(*approx_array));
1100
1101             trav_rset_for_termids(sset->rset, term_array,
1102                                   hits_array, approx_array);
1103
1104             if (count)
1105                 *count = hits_array[no];
1106             if (approx)
1107                 *approx = approx_array[no];
1108             if (termbuf)
1109             {
1110                 char *inbuf = term_array[no]->name;
1111                 size_t inleft = strlen(inbuf);
1112                 size_t outleft = *termlen - 1;
1113
1114                 if (zh->iconv_from_utf8 != 0)
1115                 {
1116                     char *outbuf = termbuf;
1117                     size_t ret;
1118
1119                     ret = yaz_iconv(zh->iconv_from_utf8, &inbuf, &inleft,
1120                                     &outbuf, &outleft);
1121                     if (ret == (size_t)(-1))
1122                         *termlen = 0;
1123                     else
1124                         *termlen = outbuf - termbuf;
1125                 }
1126                 else
1127                 {
1128                     if (inleft > outleft)
1129                         inleft = outleft;
1130                     *termlen = inleft;
1131                     memcpy(termbuf, inbuf, *termlen);
1132                 }
1133                 termbuf[*termlen] = '\0';
1134             }
1135             if (term_ref_id)
1136                 *term_ref_id = term_array[no]->ref_id;
1137
1138             xfree(term_array);
1139             xfree(hits_array);
1140             xfree(approx_array);
1141             return ZEBRA_OK;
1142         }
1143     }
1144     return ZEBRA_FAIL;
1145 }
1146
1147 ZEBRA_RES zebra_snippets_hit_vector(ZebraHandle zh, const char *setname,
1148                                     zint sysno, zebra_snippets *snippets)
1149 {
1150     ZebraSet sset = resultSetGet(zh, setname);
1151     yaz_log(YLOG_DEBUG, "zebra_get_hit_vector setname=%s zysno=" ZINT_FORMAT,
1152             setname, sysno);
1153     if (!sset)
1154         return ZEBRA_FAIL;
1155     else
1156     {
1157         struct rset_key_control *kc = zebra_key_control_create(zh);
1158         NMEM nmem = nmem_create();
1159         struct it_key key;
1160         RSET rsets[2], rset_comb;
1161         RSET rset_temp = rstemp_create(nmem, kc, kc->scope,
1162                                        res_get (zh->res, "setTmpDir"),0 );
1163
1164         TERMID termid;
1165         RSFD rsfd = rset_open(rset_temp, RSETF_WRITE);
1166
1167         key.mem[0] = sysno;
1168         key.mem[1] = 0;
1169         key.mem[2] = 0;
1170         key.mem[3] = 0;
1171         key.len = 2;
1172         rset_write (rsfd, &key);
1173         rset_close (rsfd);
1174
1175         rsets[0] = rset_temp;
1176         rsets[1] = rset_dup(sset->rset);
1177
1178         rset_comb = rsmulti_and_create(nmem, kc, kc->scope, 2, rsets);
1179
1180         rsfd = rset_open(rset_comb, RSETF_READ);
1181
1182         while (rset_read(rsfd, &key, &termid))
1183         {
1184             if (termid)
1185             {
1186                 struct ord_list *ol;
1187                 for (ol = termid->ol; ol; ol = ol->next)
1188                 {
1189                     zebra_snippets_append(snippets, key.mem[key.len-1],
1190                                           ol->ord, termid->name);
1191                 }
1192             }
1193         }
1194         rset_close(rsfd);
1195
1196         rset_delete(rset_comb);
1197         nmem_destroy(nmem);
1198         kc->dec(kc);
1199     }
1200     return ZEBRA_OK;
1201 }
1202