1 /* $Id: zsets.c,v 1.81 2005-04-25 11:54:08 adam Exp $
2 Copyright (C) 1995-2005
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 {
49 NMEM rset_nmem; /* for creating the rsets in */
54 struct zset_sort_info *sort_info;
55 struct zebra_set_term_entry *term_entries;
57 struct zebra_set *next;
60 zint cache_position; /* last position */
61 RSFD cache_rfd; /* rfd (NULL if not existing) */
62 zint cache_psysno; /* sysno for last position */
65 struct zset_sort_entry {
68 char buf[ZSET_SORT_MAX_LEVEL][SORT_IDX_ENTRYSIZE];
71 struct zset_sort_info {
74 struct zset_sort_entry *all_entries;
75 struct zset_sort_entry **entries;
78 static int log_level_set=0;
79 static int log_level_sorting=0;
80 static int log_level_searchhits=0;
81 static int log_level_searchterms=0;
82 static int log_level_resultsets=0;
84 static void loglevels()
88 log_level_sorting = yaz_log_module_level("sorting");
89 log_level_searchhits = yaz_log_module_level("searchhits");
90 log_level_searchterms = yaz_log_module_level("searchterms");
91 log_level_resultsets = yaz_log_module_level("resultsets");
95 ZEBRA_RES resultSetSearch(ZebraHandle zh, NMEM nmem, NMEM rset_nmem,
96 Z_RPNQuery *rpn, ZebraSet sset)
100 Z_SortKeySpecList *sort_sequence;
105 zh->errString = NULL;
108 sort_sequence = (Z_SortKeySpecList *)
109 nmem_malloc(nmem, sizeof(*sort_sequence));
110 sort_sequence->num_specs = 10; /* FIXME - Hard-coded number */
111 sort_sequence->specs = (Z_SortKeySpec **)
112 nmem_malloc(nmem, sort_sequence->num_specs *
113 sizeof(*sort_sequence->specs));
114 for (i = 0; i<sort_sequence->num_specs; i++)
115 sort_sequence->specs[i] = 0;
117 attrset = oid_getentbyoid (rpn->attributeSetId);
118 res = rpn_search_top(zh, rpn->RPNStructure, attrset->value,
121 sset->num_bases, sset->basenames,
130 yaz_log(YLOG_DEBUG, "search error: %d", zh->errCode);
132 for (i = 0; sort_sequence->specs[i]; i++)
134 sort_sequence->num_specs = i;
136 resultSetRank (zh, sset, rset, rset_nmem);
139 yaz_log(YLOG_DEBUG, "resultSetSortSingle in rpn_search");
140 resultSetSortSingle (zh, nmem, sset, rset,
141 sort_sequence, &sort_status);
144 yaz_log(YLOG_DEBUG, "resultSetSortSingle status = %d", zh->errCode);
152 ZEBRA_RES resultSetAddRPN (ZebraHandle zh, NMEM m, Z_RPNQuery *rpn,
153 int num_bases, char **basenames,
161 zh->errString = NULL;
164 zebraSet = resultSetAdd (zh, setname, 1);
167 zebraSet->locked = 1;
170 zebraSet->rset_nmem = nmem_create();
172 zebraSet->num_bases = num_bases;
173 zebraSet->basenames =
174 nmem_malloc (zebraSet->nmem, num_bases * sizeof(*zebraSet->basenames));
175 for (i = 0; i<num_bases; i++)
176 zebraSet->basenames[i] = nmem_strdup (zebraSet->nmem, basenames[i]);
178 res = resultSetSearch(zh, zebraSet->nmem, zebraSet->rset_nmem,
180 zh->hits = zebraSet->hits;
183 zebraSet->locked = 0;
189 void resultSetAddTerm (ZebraHandle zh, ZebraSet s, int reg_type,
190 const char *db, int set,
191 int use, const char *term)
193 assert(zh); /* compiler shut up */
195 s->nmem = nmem_create ();
196 if (!s->term_entries)
199 s->term_entries_max = 1000;
201 nmem_malloc (s->nmem, s->term_entries_max *
202 sizeof(*s->term_entries));
203 for (i = 0; i < s->term_entries_max; i++)
204 s->term_entries[i].term = 0;
206 if (s->hits < s->term_entries_max)
208 s->term_entries[s->hits].reg_type = reg_type;
209 s->term_entries[s->hits].db = nmem_strdup (s->nmem, db);
210 s->term_entries[s->hits].set = set;
211 s->term_entries[s->hits].use = use;
212 s->term_entries[s->hits].term = nmem_strdup (s->nmem, term);
217 ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov)
222 for (s = zh->sets; s; s = s->next)
223 if (!strcmp (s->name, name))
230 yaz_log(log_level_resultsets, "updating result set %s", name);
231 if (!ov || s->locked)
236 rset_close(s->cache_rfd);
237 rset_delete (s->rset);
240 nmem_destroy (s->rset_nmem);
242 nmem_destroy (s->nmem);
246 const char *sort_max_str = zebra_get_resource(zh, "sortmax", "1000");
248 yaz_log(log_level_resultsets, "adding result set %s", name);
249 s = (ZebraSet) xmalloc (sizeof(*s));
252 s->name = (char *) xmalloc (strlen(name)+1);
253 strcpy (s->name, name);
255 s->sort_info = (struct zset_sort_info *)
256 xmalloc (sizeof(*s->sort_info));
257 s->sort_info->max_entries = atoi(sort_max_str);
258 if (s->sort_info->max_entries < 2)
259 s->sort_info->max_entries = 2;
261 s->sort_info->entries = (struct zset_sort_entry **)
262 xmalloc (sizeof(*s->sort_info->entries) *
263 s->sort_info->max_entries);
264 s->sort_info->all_entries = (struct zset_sort_entry *)
265 xmalloc (sizeof(*s->sort_info->all_entries) *
266 s->sort_info->max_entries);
267 for (i = 0; i < s->sort_info->max_entries; i++)
268 s->sort_info->entries[i] = s->sort_info->all_entries + i;
277 s->cache_position = 0;
282 ZebraSet resultSetGet (ZebraHandle zh, const char *name)
286 for (s = zh->sets; s; s = s->next)
287 if (!strcmp (s->name, name))
289 if (!s->term_entries && !s->rset && s->rpn)
291 NMEM nmem = nmem_create ();
292 yaz_log(log_level_resultsets, "research %s", name);
294 s->rset_nmem=nmem_create();
295 resultSetSearch(zh, nmem, s->rset_nmem, s->rpn, s);
303 void resultSetInvalidate (ZebraHandle zh)
305 ZebraSet s = zh->sets;
307 yaz_log(log_level_resultsets, "invalidating result sets");
308 for (; s; s = s->next)
313 rset_close(s->cache_rfd);
314 rset_delete (s->rset);
318 s->cache_position = 0;
320 nmem_destroy(s->rset_nmem);
325 void resultSetDestroy (ZebraHandle zh, int num, char **names,int *statuses)
327 ZebraSet * ss = &zh->sets;
331 for (i = 0; i<num; i++)
332 statuses[i] = Z_DeleteStatus_resultSetDidNotExist;
334 zh->errString = NULL;
341 for (i = 0; i<num; i++)
342 if (!strcmp (s->name, names[i]))
345 statuses[i] = Z_DeleteStatus_success;
354 xfree (s->sort_info->all_entries);
355 xfree (s->sort_info->entries);
356 xfree (s->sort_info);
359 nmem_destroy (s->nmem);
363 rset_close(s->cache_rfd);
364 rset_delete (s->rset);
367 nmem_destroy(s->rset_nmem);
376 ZebraMetaRecord *zebra_meta_records_create_range (ZebraHandle zh,
381 zint *pos = pos_small;
385 if (num > 10000 || num <= 0)
389 pos = xmalloc(sizeof(*pos) * num);
391 for (i = 0; i<num; i++)
394 mr = zebra_meta_records_create(zh, name, num, pos);
401 ZebraMetaRecord *zebra_meta_records_create (ZebraHandle zh, const char *name,
402 int num, zint *positions)
405 ZebraMetaRecord *sr = 0;
408 struct zset_sort_info *sort_info;
412 if (!(sset = resultSetGet (zh, name)))
414 if (!(rset = sset->rset))
416 if (!sset->term_entries)
418 sr = (ZebraMetaRecord *) xmalloc (sizeof(*sr) * num);
419 for (i = 0; i<num; i++)
426 if (positions[i] <= sset->term_entries_max)
428 sr[i].term = sset->term_entries[positions[i]-1].term;
429 sr[i].db = sset->term_entries[positions[i]-1].db;
435 sr = (ZebraMetaRecord *) xmalloc (sizeof(*sr) * num);
436 for (i = 0; i<num; i++)
443 sort_info = sset->sort_info;
448 for (i = 0; i<num; i++)
450 position = positions[i];
451 if (position > 0 && position <= sort_info->num_entries)
453 yaz_log(log_level_sorting, "got pos=" ZINT_FORMAT
454 " (sorted)", position);
455 sr[i].sysno = sort_info->entries[position-1]->sysno;
456 sr[i].score = sort_info->entries[position-1]->score;
460 /* did we really get all entries using sort ? */
461 for (i = 0; i<num; i++)
466 if (i < num) /* nope, get the rest, unsorted - sorry */
475 position = sort_info->num_entries;
476 while (num_i < num && positions[num_i] <= position)
479 if (sset->cache_rfd &&
480 num_i < num && positions[num_i] > sset->cache_position)
482 position = sset->cache_position;
483 rfd = sset->cache_rfd;
484 psysno = sset->cache_psysno;
489 rset_close(sset->cache_rfd);
490 rfd = rset_open (rset, RSETF_READ);
492 while (num_i < num && rset_read (rfd, &key, 0))
494 zint this_sys = key.mem[0];
495 if (this_sys != psysno)
500 /* determine we alreay have this in our set */
501 for (i = sort_info->num_entries; --i >= 0; )
502 if (psysno == sort_info->entries[i]->sysno)
508 assert (num_i < num);
509 if (position == positions[num_i])
511 sr[num_i].sysno = psysno;
512 yaz_log(log_level_sorting, "got pos=" ZINT_FORMAT " (unsorted)", position);
513 sr[num_i].score = -1;
518 sset->cache_position = position;
519 sset->cache_psysno = psysno;
520 sset->cache_rfd = rfd;
526 void zebra_meta_records_destroy (ZebraHandle zh, ZebraMetaRecord *records,
529 assert(zh); /* compiler shut up about unused arg */
539 void resultSetInsertSort (ZebraHandle zh, ZebraSet sset,
540 struct sortKeyInfo *criteria, int num_criteria,
543 struct zset_sort_entry this_entry;
544 struct zset_sort_entry *new_entry = NULL;
545 struct zset_sort_info *sort_info = sset->sort_info;
548 sortIdx_sysno (zh->reg->sortIdx, sysno);
549 for (i = 0; i<num_criteria; i++)
551 sortIdx_type (zh->reg->sortIdx, criteria[i].attrUse);
552 sortIdx_read (zh->reg->sortIdx, this_entry.buf[i]);
554 i = sort_info->num_entries;
558 for (j = 0; j<num_criteria; j++)
560 if (criteria[j].numerical)
562 double diff = atof(this_entry.buf[j]) -
563 atof(sort_info->entries[i]->buf[j]);
572 rel = memcmp (this_entry.buf[j], sort_info->entries[i]->buf[j],
580 if (criteria[j].relation == 'A')
585 else if (criteria[j].relation == 'D')
592 j = sort_info->max_entries;
596 if (sort_info->num_entries == j)
599 j = (sort_info->num_entries)++;
600 new_entry = sort_info->entries[j];
603 sort_info->entries[j] = sort_info->entries[j-1];
606 sort_info->entries[i] = new_entry;
608 for (i = 0; i<num_criteria; i++)
609 memcpy (new_entry->buf[i], this_entry.buf[i], SORT_IDX_ENTRYSIZE);
610 new_entry->sysno = sysno;
611 new_entry->score = -1;
614 void resultSetInsertRank (ZebraHandle zh, struct zset_sort_info *sort_info,
615 zint sysno, int score, int relation)
617 struct zset_sort_entry *new_entry = NULL;
619 assert(zh); /* compiler shut up about unused arg */
621 i = sort_info->num_entries;
626 rel = score - sort_info->entries[i]->score;
633 else if (relation == 'A')
640 j = sort_info->max_entries;
644 if (sort_info->num_entries == j)
647 j = (sort_info->num_entries)++;
649 new_entry = sort_info->entries[j];
652 sort_info->entries[j] = sort_info->entries[j-1];
655 sort_info->entries[i] = new_entry;
657 new_entry->sysno = sysno;
658 new_entry->score = score;
661 void resultSetSort (ZebraHandle zh, NMEM nmem,
662 int num_input_setnames, const char **input_setnames,
663 const char *output_setname,
664 Z_SortKeySpecList *sort_sequence, int *sort_status)
669 if (num_input_setnames == 0)
674 if (num_input_setnames > 1)
681 yaz_log(log_level_sorting, "result set sort input=%s output=%s",
682 *input_setnames, output_setname);
683 sset = resultSetGet (zh, input_setnames[0]);
687 zh->errString = nmem_strdup (nmem, input_setnames[0]);
690 if (!(rset = sset->rset))
693 zh->errString = nmem_strdup (nmem, input_setnames[0]);
696 if (strcmp (output_setname, input_setnames[0]))
698 rset = rset_dup (rset);
699 sset = resultSetAdd (zh, output_setname, 1);
702 resultSetSortSingle (zh, nmem, sset, rset, sort_sequence, sort_status);
705 void resultSetSortSingle (ZebraHandle zh, NMEM nmem,
706 ZebraSet sset, RSET rset,
707 Z_SortKeySpecList *sort_sequence, int *sort_status)
714 struct sortKeyInfo sort_criteria[3];
721 assert(nmem); /* compiler shut up about unused param */
722 sset->sort_info->num_entries = 0;
724 rset_getterms(rset, 0, 0, &n);
725 terms = (TERMID *) nmem_malloc(nmem, sizeof(*terms)*n);
726 rset_getterms(rset, terms, n, &numTerms);
729 num_criteria = sort_sequence->num_specs;
730 if (num_criteria > 3)
732 for (i = 0; i < num_criteria; i++)
734 Z_SortKeySpec *sks = sort_sequence->specs[i];
737 if (*sks->sortRelation == Z_SortKeySpec_ascending)
738 sort_criteria[i].relation = 'A';
739 else if (*sks->sortRelation == Z_SortKeySpec_descending)
740 sort_criteria[i].relation = 'D';
746 if (sks->sortElement->which == Z_SortElement_databaseSpecific)
751 else if (sks->sortElement->which != Z_SortElement_generic)
756 sk = sks->sortElement->u.generic;
759 case Z_SortKey_sortField:
760 yaz_log(log_level_sorting, "Sort: key %d is of type sortField", i+1);
763 case Z_SortKey_elementSpec:
764 yaz_log(log_level_sorting, "Sort: key %d is of type elementSpec", i+1);
767 case Z_SortKey_sortAttributes:
768 yaz_log(log_level_sorting, "Sort: key %d is of type sortAttributes", i+1);
769 sort_criteria[i].attrUse =
770 zebra_maps_sort (zh->reg->zebra_maps,
771 sk->u.sortAttributes,
772 &sort_criteria[i].numerical);
773 yaz_log(log_level_sorting, "use value = %d", sort_criteria[i].attrUse);
774 if (sort_criteria[i].attrUse == -1)
779 if (sortIdx_type (zh->reg->sortIdx, sort_criteria[i].attrUse))
787 rfd = rset_open (rset, RSETF_READ);
788 while (rset_read (rfd, &key, &termid))
789 /* FIXME - pass a TERMID *, and use it for something below !! */
791 zint this_sys = key.mem[0];
793 if (this_sys != psysno)
797 resultSetInsertSort (zh, sset,
798 sort_criteria, num_criteria, psysno);
802 yaz_log(log_level_sorting, ZINT_FORMAT " keys, " ZINT_FORMAT " sysnos, sort",
804 for (i = 0; i < numTerms; i++)
805 yaz_log(log_level_sorting, "term=\"%s\" type=%s count=" ZINT_FORMAT,
806 terms[i]->name, terms[i]->flags, rset_count(terms[i]->rset));
807 *sort_status = Z_SortResponse_success;
810 RSET resultSetRef (ZebraHandle zh, const char *resultSetId)
814 if ((s = resultSetGet (zh, resultSetId)))
819 void resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset, NMEM nmem)
829 ZebraRankClass rank_class;
830 struct rank_control *rc;
831 struct zset_sort_info *sort_info;
832 const char *rank_handler_name = res_get_def(zh->res, "rank", "rank-1");
834 zint est=-2; /* -2 not done, -1 can't do, >0 actual estimate*/
840 sort_info = zebraSet->sort_info;
841 sort_info->num_entries = 0;
843 rset_getterms(rset, 0, 0, &n);
844 terms = (TERMID *) nmem_malloc(nmem, sizeof(*terms)*n);
845 rset_getterms(rset, terms, n, &numTerms);
847 rfd = rset_open (rset, RSETF_READ);
849 rank_class = zebraRankLookup (zh, rank_handler_name);
852 yaz_log(YLOG_WARN, "No such rank handler: %s", rank_handler_name);
855 rc = rank_class->control;
857 if (rset_read (rfd, &key, &termid))
859 zint psysno = key.mem[0];
862 (*rc->begin) (zh->reg, rank_class->class_handle, rset, nmem,
865 esthits = atoi(res_get_def(zh->res, "estimatehits","0"));
867 est = -1; /* can not do */
870 zint this_sys = key.mem[0]; /* FIXME - assumes scope==2 */
871 zint seqno = key.mem[key.len-1]; /* FIXME - assumes scope==2 */
873 key_logdump_txt(log_level_searchhits,&key," Got hit");
874 if (this_sys != psysno)
876 score = (*rc->calc) (handle, psysno);
878 resultSetInsertRank (zh, sort_info, psysno, score, 'A');
882 (*rc->add) (handle, CAST_ZINT_TO_INT(seqno), termid);
884 if ((est==-2) && (zebraSet->hits==esthits))
885 { /* time to estimate the hits */
886 rset_pos(rfd,&cur,&tot);
889 est = (zint)(0.5+zebraSet->hits/ratio);
890 yaz_log(log_level_searchhits, "Estimating hits (%s) "
891 "%0.1f->" ZINT_FORMAT
892 "; %0.1f->" ZINT_FORMAT,
896 i = 0; /* round to 3 significant digits */
903 zebraSet->hits = est;
907 while (rset_read (rfd, &key,&termid) && (est<0) );
908 score = (*rc->calc)(handle, psysno);
909 resultSetInsertRank(zh, sort_info, psysno, score, 'A');
910 (*rc->end) (zh->reg, handle);
914 yaz_log(log_level_searchterms, ZINT_FORMAT " keys, " ZINT_FORMAT " sysnos, rank",
915 kno, zebraSet->hits);
916 for (i = 0; i < numTerms; i++)
918 yaz_log(log_level_searchterms, "term=\"%s\" type=%s count=" ZINT_FORMAT,
919 terms[i]->name, terms[i]->flags, rset_count(terms[i]->rset));
923 ZebraRankClass zebraRankLookup (ZebraHandle zh, const char *name)
925 ZebraRankClass p = zh->reg->rank_classes;
926 while (p && strcmp (p->control->name, name))
928 if (p && !p->init_flag)
930 if (p->control->create)
931 p->class_handle = (*p->control->create)(zh);
937 void zebraRankInstall (struct zebra_register *reg, struct rank_control *ctrl)
939 ZebraRankClass p = (ZebraRankClass) xmalloc (sizeof(*p));
940 p->control = (struct rank_control *) xmalloc (sizeof(*p->control));
941 memcpy (p->control, ctrl, sizeof(*p->control));
942 p->control->name = xstrdup (ctrl->name);
944 p->next = reg->rank_classes;
945 reg->rank_classes = p;
948 void zebraRankDestroy (struct zebra_register *reg)
950 ZebraRankClass p = reg->rank_classes;
953 ZebraRankClass p_next = p->next;
954 if (p->init_flag && p->control->destroy)
955 (*p->control->destroy)(reg, p->class_handle);
956 xfree(p->control->name);
961 reg->rank_classes = NULL;