1 /* $Id: zsets.c,v 1.57 2004-08-20 14:44:46 heikki Exp $
2 Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004
5 This file is part of the Zebra server.
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
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
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
35 #define SORT_IDX_ENTRYSIZE 64
36 #define ZSET_SORT_MAX_LEVEL 3
38 struct zebra_set_term_entry {
53 struct zset_sort_info *sort_info;
54 struct zebra_set_term_entry *term_entries;
56 struct zebra_set *next;
60 struct zset_sort_entry {
63 char buf[ZSET_SORT_MAX_LEVEL][SORT_IDX_ENTRYSIZE];
66 struct zset_sort_info {
69 struct zset_sort_entry *all_entries;
70 struct zset_sort_entry **entries;
73 ZebraSet resultSetAddRPN (ZebraHandle zh, NMEM m,
74 Z_RPNQuery *rpn, int num_bases,
85 zebraSet = resultSetAdd (zh, setname, 1);
92 zebraSet->num_bases = num_bases;
94 nmem_malloc (zebraSet->nmem, num_bases * sizeof(*zebraSet->basenames));
95 for (i = 0; i<num_bases; i++)
96 zebraSet->basenames[i] = nmem_strdup (zebraSet->nmem, basenames[i]);
99 zebraSet->rset = rpn_search (zh, zebraSet->nmem, rpn,
101 zebraSet->basenames, zebraSet->name,
103 zh->hits = zebraSet->hits;
106 zebraSet->locked = 0;
110 void resultSetAddTerm (ZebraHandle zh, ZebraSet s, int reg_type,
111 const char *db, int set,
112 int use, const char *term)
114 assert(zh); /* compiler shut up */
116 s->nmem = nmem_create ();
117 if (!s->term_entries)
120 s->term_entries_max = 1000;
122 nmem_malloc (s->nmem, s->term_entries_max *
123 sizeof(*s->term_entries));
124 for (i = 0; i < s->term_entries_max; i++)
125 s->term_entries[i].term = 0;
127 if (s->hits < s->term_entries_max)
129 s->term_entries[s->hits].reg_type = reg_type;
130 s->term_entries[s->hits].db = nmem_strdup (s->nmem, db);
131 s->term_entries[s->hits].set = set;
132 s->term_entries[s->hits].use = use;
133 s->term_entries[s->hits].term = nmem_strdup (s->nmem, term);
138 #if 0 /* FIXME - Delete this, we don't count terms no more */
139 int zebra_resultSetTerms (ZebraHandle zh, const char *setname,
141 int *type, char *out, size_t *len)
143 ZebraSet s = resultSetGet (zh, setname);
150 no_max = s->rset->no_rset_terms;
151 if (no < 0 || no >= no_max)
154 *count = s->rset->rset_terms[no]->count;
156 *type = s->rset->rset_terms[no]->type;
160 char *inbuf = s->rset->rset_terms[no]->name;
161 size_t inleft = strlen(inbuf);
162 size_t outleft = *len - 1;
165 if (zh->iconv_from_utf8 != 0)
170 ret = yaz_iconv(zh->iconv_from_utf8, &inbuf, &inleft,
172 if (ret == (size_t)(-1))
180 if (inleft > outleft)
183 memcpy (out, inbuf, *len);
192 ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov)
197 for (s = zh->sets; s; s = s->next)
198 if (!strcmp (s->name, name))
202 yaz_log (LOG_DEBUG, "updating result set %s", name);
203 if (!ov || s->locked)
206 rset_delete (s->rset);
208 nmem_destroy (s->nmem);
212 const char *sort_max_str = zebra_get_resource(zh, "sortmax", "1000");
214 yaz_log (LOG_DEBUG, "adding result set %s", name);
215 s = (ZebraSet) xmalloc (sizeof(*s));
218 s->name = (char *) xmalloc (strlen(name)+1);
219 strcpy (s->name, name);
221 s->sort_info = (struct zset_sort_info *)
222 xmalloc (sizeof(*s->sort_info));
223 s->sort_info->max_entries = atoi(sort_max_str);
224 if (s->sort_info->max_entries < 2)
225 s->sort_info->max_entries = 2;
227 s->sort_info->entries = (struct zset_sort_entry **)
228 xmalloc (sizeof(*s->sort_info->entries) *
229 s->sort_info->max_entries);
230 s->sort_info->all_entries = (struct zset_sort_entry *)
231 xmalloc (sizeof(*s->sort_info->all_entries) *
232 s->sort_info->max_entries);
233 for (i = 0; i < s->sort_info->max_entries; i++)
234 s->sort_info->entries[i] = s->sort_info->all_entries + i;
245 ZebraSet resultSetGet (ZebraHandle zh, const char *name)
249 for (s = zh->sets; s; s = s->next)
250 if (!strcmp (s->name, name))
252 if (!s->term_entries && !s->rset && s->rpn)
254 NMEM nmem = nmem_create ();
255 yaz_log (LOG_LOG, "research %s", name);
257 rpn_search (zh, nmem, s->rpn, s->num_bases,
258 s->basenames, s->name, s);
266 void resultSetInvalidate (ZebraHandle zh)
268 ZebraSet s = zh->sets;
270 for (; s; s = s->next)
273 rset_delete (s->rset);
278 void resultSetDestroy (ZebraHandle zh, int num, char **names,int *statuses)
280 ZebraSet * ss = &zh->sets;
284 for (i = 0; i<num; i++)
285 statuses[i] = Z_DeleteStatus_resultSetDidNotExist;
287 zh->errString = NULL;
294 for (i = 0; i<num; i++)
295 if (!strcmp (s->name, names[i]))
298 statuses[i] = Z_DeleteStatus_success;
307 xfree (s->sort_info->all_entries);
308 xfree (s->sort_info->entries);
309 xfree (s->sort_info);
312 nmem_destroy (s->nmem);
314 rset_delete (s->rset);
323 ZebraPosSet zebraPosSetCreate (ZebraHandle zh, const char *name,
324 int num, int *positions)
330 struct zset_sort_info *sort_info;
332 if (!(sset = resultSetGet (zh, name)))
334 if (!(rset = sset->rset))
336 if (!sset->term_entries)
338 sr = (ZebraPosSet) xmalloc (sizeof(*sr) * num);
339 for (i = 0; i<num; i++)
346 if (positions[i] <= sset->term_entries_max)
348 sr[i].term = sset->term_entries[positions[i]-1].term;
349 sr[i].db = sset->term_entries[positions[i]-1].db;
355 sr = (ZebraPosSet) xmalloc (sizeof(*sr) * num);
356 for (i = 0; i<num; i++)
363 sort_info = sset->sort_info;
368 for (i = 0; i<num; i++)
370 position = positions[i];
371 if (position > 0 && position <= sort_info->num_entries)
373 yaz_log (LOG_DEBUG, "got pos=%d (sorted)", position);
374 sr[i].sysno = sort_info->entries[position-1]->sysno;
375 sr[i].score = sort_info->entries[position-1]->score;
379 /* did we really get all entries using sort ? */
380 for (i = 0; i<num; i++)
385 if (i < num) /* nope, get the rest, unsorted - sorry */
394 position = sort_info->num_entries;
395 while (num_i < num && positions[num_i] < position)
397 rfd = rset_open (rset, RSETF_READ);
398 while (num_i < num && rset_read (rset, rfd, &key))
401 zint this_sys = key.mem[0];
403 zint this_sys = key.sysno;
405 if (this_sys != psysno)
410 /* determine we alreay have this in our set */
411 for (i = sort_info->num_entries; --i >= 0; )
412 if (psysno == sort_info->entries[i]->sysno)
418 assert (num_i < num);
419 if (position == positions[num_i])
421 sr[num_i].sysno = psysno;
422 yaz_log (LOG_DEBUG, "got pos=%d (unsorted)", position);
423 sr[num_i].score = -1;
428 rset_close (rset, rfd);
434 void zebraPosSetDestroy (ZebraHandle zh, ZebraPosSet records, int num)
436 assert(zh); /* compiler shut up about unused arg */
446 void resultSetInsertSort (ZebraHandle zh, ZebraSet sset,
447 struct sortKeyInfo *criteria, int num_criteria,
450 struct zset_sort_entry this_entry;
451 struct zset_sort_entry *new_entry = NULL;
452 struct zset_sort_info *sort_info = sset->sort_info;
455 sortIdx_sysno (zh->reg->sortIdx, sysno);
456 for (i = 0; i<num_criteria; i++)
458 sortIdx_type (zh->reg->sortIdx, criteria[i].attrUse);
459 sortIdx_read (zh->reg->sortIdx, this_entry.buf[i]);
461 i = sort_info->num_entries;
465 for (j = 0; j<num_criteria; j++)
467 if (criteria[j].numerical)
469 double diff = atof(this_entry.buf[j]) -
470 atof(sort_info->entries[i]->buf[j]);
479 rel = memcmp (this_entry.buf[j], sort_info->entries[i]->buf[j],
487 if (criteria[j].relation == 'A')
492 else if (criteria[j].relation == 'D')
499 j = sort_info->max_entries;
503 if (sort_info->num_entries == j)
506 j = (sort_info->num_entries)++;
507 new_entry = sort_info->entries[j];
510 sort_info->entries[j] = sort_info->entries[j-1];
513 sort_info->entries[i] = new_entry;
515 for (i = 0; i<num_criteria; i++)
516 memcpy (new_entry->buf[i], this_entry.buf[i], SORT_IDX_ENTRYSIZE);
517 new_entry->sysno = sysno;
518 new_entry->score = -1;
521 void resultSetInsertRank (ZebraHandle zh, struct zset_sort_info *sort_info,
522 zint sysno, int score, int relation)
524 struct zset_sort_entry *new_entry = NULL;
526 assert(zh); /* compiler shut up about unused arg */
528 i = sort_info->num_entries;
533 rel = score - sort_info->entries[i]->score;
540 else if (relation == 'A')
547 j = sort_info->max_entries;
551 if (sort_info->num_entries == j)
554 j = (sort_info->num_entries)++;
556 new_entry = sort_info->entries[j];
559 sort_info->entries[j] = sort_info->entries[j-1];
562 sort_info->entries[i] = new_entry;
564 new_entry->sysno = sysno;
565 new_entry->score = score;
568 void resultSetSort (ZebraHandle zh, NMEM nmem,
569 int num_input_setnames, const char **input_setnames,
570 const char *output_setname,
571 Z_SortKeySpecList *sort_sequence, int *sort_status)
576 if (num_input_setnames == 0)
581 if (num_input_setnames > 1)
586 yaz_log (LOG_DEBUG, "result set sort input=%s output=%s",
587 *input_setnames, output_setname);
588 sset = resultSetGet (zh, input_setnames[0]);
592 zh->errString = nmem_strdup (nmem, input_setnames[0]);
595 if (!(rset = sset->rset))
598 zh->errString = nmem_strdup (nmem, input_setnames[0]);
601 if (strcmp (output_setname, input_setnames[0]))
603 rset = rset_dup (rset);
604 sset = resultSetAdd (zh, output_setname, 1);
607 resultSetSortSingle (zh, nmem, sset, rset, sort_sequence, sort_status);
610 void resultSetSortSingle (ZebraHandle zh, NMEM nmem,
611 ZebraSet sset, RSET rset,
612 Z_SortKeySpecList *sort_sequence, int *sort_status)
617 struct sortKeyInfo sort_criteria[3];
621 yaz_log (LOG_LOG, "resultSetSortSingle start");
622 assert(nmem); /* compiler shut up about unused param */
623 sset->sort_info->num_entries = 0;
626 num_criteria = sort_sequence->num_specs;
627 if (num_criteria > 3)
629 for (i = 0; i < num_criteria; i++)
631 Z_SortKeySpec *sks = sort_sequence->specs[i];
634 if (*sks->sortRelation == Z_SortKeySpec_ascending)
635 sort_criteria[i].relation = 'A';
636 else if (*sks->sortRelation == Z_SortKeySpec_descending)
637 sort_criteria[i].relation = 'D';
643 if (sks->sortElement->which == Z_SortElement_databaseSpecific)
648 else if (sks->sortElement->which != Z_SortElement_generic)
653 sk = sks->sortElement->u.generic;
656 case Z_SortKey_sortField:
657 yaz_log (LOG_DEBUG, "Sort: key %d is of type sortField", i+1);
660 case Z_SortKey_elementSpec:
661 yaz_log (LOG_DEBUG, "Sort: key %d is of type elementSpec", i+1);
664 case Z_SortKey_sortAttributes:
665 yaz_log (LOG_DEBUG, "Sort: key %d is of type sortAttributes", i+1);
666 sort_criteria[i].attrUse =
667 zebra_maps_sort (zh->reg->zebra_maps,
668 sk->u.sortAttributes,
669 &sort_criteria[i].numerical);
670 yaz_log (LOG_DEBUG, "use value = %d", sort_criteria[i].attrUse);
671 if (sort_criteria[i].attrUse == -1)
676 if (sortIdx_type (zh->reg->sortIdx, sort_criteria[i].attrUse))
684 rfd = rset_open (rset, RSETF_READ);
685 while (rset_read (rset, rfd, &key))
688 zint this_sys = key.mem[0];
690 zint this_sys = key.sysno;
692 if (this_sys != psysno)
696 resultSetInsertSort (zh, sset,
697 sort_criteria, num_criteria, psysno);
700 rset_close (rset, rfd);
703 for (i = 0; i < rset->no_rset_terms; i++)
704 yaz_log (LOG_LOG, "term=\"%s\" nn=" ZINT_FORMAT
705 " type=%s count=" ZINT_FORMAT,
706 rset->rset_terms[i]->name,
707 rset->rset_terms[i]->nn,
708 rset->rset_terms[i]->flags,
709 rset->rset_terms[i]->count);
711 *sort_status = Z_SortResponse_success;
712 yaz_log (LOG_LOG, "resultSetSortSingle end");
715 RSET resultSetRef (ZebraHandle zh, const char *resultSetId)
719 if ((s = resultSetGet (zh, resultSetId)))
724 void resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset)
729 /* int term_index; */
731 ZebraRankClass rank_class;
732 struct rank_control *rc;
733 struct zset_sort_info *sort_info;
734 const char *rank_handler_name = res_get_def(zh->res, "rank", "rank-1");
736 zint est=-2; /* -2 not done, -1 can't do, >0 actual estimate*/
740 sort_info = zebraSet->sort_info;
741 sort_info->num_entries = 0;
743 rfd = rset_open (rset, RSETF_READ);
745 yaz_log (LOG_LOG, "resultSetRank");
747 rank_class = zebraRankLookup (zh, rank_handler_name);
750 yaz_log (LOG_WARN, "No such rank handler: %s", rank_handler_name);
753 rc = rank_class->control;
755 if (rset_read (rset, rfd, &key))
758 zint psysno = key.mem[0];
760 zint psysno = key.sysno;
764 (*rc->begin) (zh->reg, rank_class->class_handle, rset);
766 esthits=atoi(res_get_def(zh->res,"estimatehits","0"));
768 est=-1; /* can not do */
772 zint this_sys = key.mem[0];
774 zint this_sys = key.sysno;
777 if (this_sys != psysno)
779 score = (*rc->calc) (handle, psysno);
781 resultSetInsertRank (zh, sort_info, psysno, score, 'A');
785 /* FIXME - Ranking is broken, since rsets no longer have */
787 /* (*rc->add) (handle, this_sys, term_index); */
789 if ( (est==-2) && (zebraSet->hits==esthits))
790 { /* time to estimate the hits */
791 rset_pos(rset,rfd,&cur,&tot);
794 est=(zint)(0.5+zebraSet->hits/ratio);
795 logf(LOG_LOG, "Estimating hits (%s) "
797 "; %0.1f->"ZINT_FORMAT,
801 i=0; /* round to 3 significant digits */
811 while (rset_read (rset, rfd, &key) && (est<0) );
813 score = (*rc->calc) (handle, psysno);
814 resultSetInsertRank (zh, sort_info, psysno, score, 'A');
815 (*rc->end) (zh->reg, handle);
817 rset_close (rset, rfd);
819 for (i = 0; i < rset->no_rset_terms; i++)
822 rset->rset_terms[i]->count =
823 est=(zint)(rset->rset_terms[i]->count/ratio);
824 yaz_log (LOG_LOG, "term=\"%s\" nn=" ZINT_FORMAT
825 " type=%s count=" ZINT_FORMAT,
826 rset->rset_terms[i]->name,
827 rset->rset_terms[i]->nn,
828 rset->rset_terms[i]->flags,
829 rset->rset_terms[i]->count);
832 yaz_log (LOG_LOG, ZINT_FORMAT " keys, "ZINT_FORMAT" distinct sysnos",
833 kno, zebraSet->hits);
836 ZebraRankClass zebraRankLookup (ZebraHandle zh, const char *name)
838 ZebraRankClass p = zh->reg->rank_classes;
839 while (p && strcmp (p->control->name, name))
841 if (p && !p->init_flag)
843 if (p->control->create)
844 p->class_handle = (*p->control->create)(zh);
850 void zebraRankInstall (struct zebra_register *reg, struct rank_control *ctrl)
852 ZebraRankClass p = (ZebraRankClass) xmalloc (sizeof(*p));
853 p->control = (struct rank_control *) xmalloc (sizeof(*p->control));
854 memcpy (p->control, ctrl, sizeof(*p->control));
855 p->control->name = xstrdup (ctrl->name);
857 p->next = reg->rank_classes;
858 reg->rank_classes = p;
861 void zebraRankDestroy (struct zebra_register *reg)
863 ZebraRankClass p = reg->rank_classes;
866 ZebraRankClass p_next = p->next;
867 if (p->init_flag && p->control->destroy)
868 (*p->control->destroy)(reg, p->class_handle);
869 xfree (p->control->name);
874 reg->rank_classes = NULL;