1 /* $Id: zsets.c,v 1.80 2005-04-15 10:47:49 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;
104 zh->errString = NULL;
107 sort_sequence = (Z_SortKeySpecList *)
108 nmem_malloc(nmem, sizeof(*sort_sequence));
109 sort_sequence->num_specs = 10; /* FIXME - Hard-coded number */
110 sort_sequence->specs = (Z_SortKeySpec **)
111 nmem_malloc(nmem, sort_sequence->num_specs *
112 sizeof(*sort_sequence->specs));
113 for (i = 0; i<sort_sequence->num_specs; i++)
114 sort_sequence->specs[i] = 0;
116 attrset = oid_getentbyoid (rpn->attributeSetId);
117 rset = rpn_search_structure (zh, rpn->RPNStructure, attrset->value,
120 sset->num_bases, sset->basenames);
128 yaz_log(YLOG_DEBUG, "search error: %d", zh->errCode);
130 for (i = 0; sort_sequence->specs[i]; i++)
132 sort_sequence->num_specs = i;
134 resultSetRank (zh, sset, rset, rset_nmem);
137 yaz_log(YLOG_DEBUG, "resultSetSortSingle in rpn_search");
138 resultSetSortSingle (zh, nmem, sset, rset,
139 sort_sequence, &sort_status);
142 yaz_log(YLOG_DEBUG, "resultSetSortSingle status = %d", zh->errCode);
150 ZEBRA_RES resultSetAddRPN (ZebraHandle zh, NMEM m, Z_RPNQuery *rpn,
151 int num_bases, char **basenames,
159 zh->errString = NULL;
162 zebraSet = resultSetAdd (zh, setname, 1);
165 zebraSet->locked = 1;
168 zebraSet->rset_nmem = nmem_create();
170 zebraSet->num_bases = num_bases;
171 zebraSet->basenames =
172 nmem_malloc (zebraSet->nmem, num_bases * sizeof(*zebraSet->basenames));
173 for (i = 0; i<num_bases; i++)
174 zebraSet->basenames[i] = nmem_strdup (zebraSet->nmem, basenames[i]);
176 res = resultSetSearch(zh, zebraSet->nmem, zebraSet->rset_nmem,
178 zh->hits = zebraSet->hits;
181 zebraSet->locked = 0;
187 void resultSetAddTerm (ZebraHandle zh, ZebraSet s, int reg_type,
188 const char *db, int set,
189 int use, const char *term)
191 assert(zh); /* compiler shut up */
193 s->nmem = nmem_create ();
194 if (!s->term_entries)
197 s->term_entries_max = 1000;
199 nmem_malloc (s->nmem, s->term_entries_max *
200 sizeof(*s->term_entries));
201 for (i = 0; i < s->term_entries_max; i++)
202 s->term_entries[i].term = 0;
204 if (s->hits < s->term_entries_max)
206 s->term_entries[s->hits].reg_type = reg_type;
207 s->term_entries[s->hits].db = nmem_strdup (s->nmem, db);
208 s->term_entries[s->hits].set = set;
209 s->term_entries[s->hits].use = use;
210 s->term_entries[s->hits].term = nmem_strdup (s->nmem, term);
215 ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov)
220 for (s = zh->sets; s; s = s->next)
221 if (!strcmp (s->name, name))
228 yaz_log(log_level_resultsets, "updating result set %s", name);
229 if (!ov || s->locked)
234 rset_close(s->cache_rfd);
235 rset_delete (s->rset);
238 nmem_destroy (s->rset_nmem);
240 nmem_destroy (s->nmem);
244 const char *sort_max_str = zebra_get_resource(zh, "sortmax", "1000");
246 yaz_log(log_level_resultsets, "adding result set %s", name);
247 s = (ZebraSet) xmalloc (sizeof(*s));
250 s->name = (char *) xmalloc (strlen(name)+1);
251 strcpy (s->name, name);
253 s->sort_info = (struct zset_sort_info *)
254 xmalloc (sizeof(*s->sort_info));
255 s->sort_info->max_entries = atoi(sort_max_str);
256 if (s->sort_info->max_entries < 2)
257 s->sort_info->max_entries = 2;
259 s->sort_info->entries = (struct zset_sort_entry **)
260 xmalloc (sizeof(*s->sort_info->entries) *
261 s->sort_info->max_entries);
262 s->sort_info->all_entries = (struct zset_sort_entry *)
263 xmalloc (sizeof(*s->sort_info->all_entries) *
264 s->sort_info->max_entries);
265 for (i = 0; i < s->sort_info->max_entries; i++)
266 s->sort_info->entries[i] = s->sort_info->all_entries + i;
275 s->cache_position = 0;
280 ZebraSet resultSetGet (ZebraHandle zh, const char *name)
284 for (s = zh->sets; s; s = s->next)
285 if (!strcmp (s->name, name))
287 if (!s->term_entries && !s->rset && s->rpn)
289 NMEM nmem = nmem_create ();
290 yaz_log(log_level_resultsets, "research %s", name);
292 s->rset_nmem=nmem_create();
293 resultSetSearch(zh, nmem, s->rset_nmem, s->rpn, s);
301 void resultSetInvalidate (ZebraHandle zh)
303 ZebraSet s = zh->sets;
305 yaz_log(log_level_resultsets, "invalidating result sets");
306 for (; s; s = s->next)
311 rset_close(s->cache_rfd);
312 rset_delete (s->rset);
316 s->cache_position = 0;
318 nmem_destroy(s->rset_nmem);
323 void resultSetDestroy (ZebraHandle zh, int num, char **names,int *statuses)
325 ZebraSet * ss = &zh->sets;
329 for (i = 0; i<num; i++)
330 statuses[i] = Z_DeleteStatus_resultSetDidNotExist;
332 zh->errString = NULL;
339 for (i = 0; i<num; i++)
340 if (!strcmp (s->name, names[i]))
343 statuses[i] = Z_DeleteStatus_success;
352 xfree (s->sort_info->all_entries);
353 xfree (s->sort_info->entries);
354 xfree (s->sort_info);
357 nmem_destroy (s->nmem);
361 rset_close(s->cache_rfd);
362 rset_delete (s->rset);
365 nmem_destroy(s->rset_nmem);
374 ZebraMetaRecord *zebra_meta_records_create_range (ZebraHandle zh,
379 zint *pos = pos_small;
383 if (num > 10000 || num <= 0)
387 pos = xmalloc(sizeof(*pos) * num);
389 for (i = 0; i<num; i++)
392 mr = zebra_meta_records_create(zh, name, num, pos);
399 ZebraMetaRecord *zebra_meta_records_create (ZebraHandle zh, const char *name,
400 int num, zint *positions)
403 ZebraMetaRecord *sr = 0;
406 struct zset_sort_info *sort_info;
410 if (!(sset = resultSetGet (zh, name)))
412 if (!(rset = sset->rset))
414 if (!sset->term_entries)
416 sr = (ZebraMetaRecord *) xmalloc (sizeof(*sr) * num);
417 for (i = 0; i<num; i++)
424 if (positions[i] <= sset->term_entries_max)
426 sr[i].term = sset->term_entries[positions[i]-1].term;
427 sr[i].db = sset->term_entries[positions[i]-1].db;
433 sr = (ZebraMetaRecord *) xmalloc (sizeof(*sr) * num);
434 for (i = 0; i<num; i++)
441 sort_info = sset->sort_info;
446 for (i = 0; i<num; i++)
448 position = positions[i];
449 if (position > 0 && position <= sort_info->num_entries)
451 yaz_log(log_level_sorting, "got pos=" ZINT_FORMAT
452 " (sorted)", position);
453 sr[i].sysno = sort_info->entries[position-1]->sysno;
454 sr[i].score = sort_info->entries[position-1]->score;
458 /* did we really get all entries using sort ? */
459 for (i = 0; i<num; i++)
464 if (i < num) /* nope, get the rest, unsorted - sorry */
473 position = sort_info->num_entries;
474 while (num_i < num && positions[num_i] <= position)
477 if (sset->cache_rfd &&
478 num_i < num && positions[num_i] > sset->cache_position)
480 position = sset->cache_position;
481 rfd = sset->cache_rfd;
482 psysno = sset->cache_psysno;
487 rset_close(sset->cache_rfd);
488 rfd = rset_open (rset, RSETF_READ);
490 while (num_i < num && rset_read (rfd, &key, 0))
492 zint this_sys = key.mem[0];
493 if (this_sys != psysno)
498 /* determine we alreay have this in our set */
499 for (i = sort_info->num_entries; --i >= 0; )
500 if (psysno == sort_info->entries[i]->sysno)
506 assert (num_i < num);
507 if (position == positions[num_i])
509 sr[num_i].sysno = psysno;
510 yaz_log(log_level_sorting, "got pos=" ZINT_FORMAT " (unsorted)", position);
511 sr[num_i].score = -1;
516 sset->cache_position = position;
517 sset->cache_psysno = psysno;
518 sset->cache_rfd = rfd;
524 void zebra_meta_records_destroy (ZebraHandle zh, ZebraMetaRecord *records,
527 assert(zh); /* compiler shut up about unused arg */
537 void resultSetInsertSort (ZebraHandle zh, ZebraSet sset,
538 struct sortKeyInfo *criteria, int num_criteria,
541 struct zset_sort_entry this_entry;
542 struct zset_sort_entry *new_entry = NULL;
543 struct zset_sort_info *sort_info = sset->sort_info;
546 sortIdx_sysno (zh->reg->sortIdx, sysno);
547 for (i = 0; i<num_criteria; i++)
549 sortIdx_type (zh->reg->sortIdx, criteria[i].attrUse);
550 sortIdx_read (zh->reg->sortIdx, this_entry.buf[i]);
552 i = sort_info->num_entries;
556 for (j = 0; j<num_criteria; j++)
558 if (criteria[j].numerical)
560 double diff = atof(this_entry.buf[j]) -
561 atof(sort_info->entries[i]->buf[j]);
570 rel = memcmp (this_entry.buf[j], sort_info->entries[i]->buf[j],
578 if (criteria[j].relation == 'A')
583 else if (criteria[j].relation == 'D')
590 j = sort_info->max_entries;
594 if (sort_info->num_entries == j)
597 j = (sort_info->num_entries)++;
598 new_entry = sort_info->entries[j];
601 sort_info->entries[j] = sort_info->entries[j-1];
604 sort_info->entries[i] = new_entry;
606 for (i = 0; i<num_criteria; i++)
607 memcpy (new_entry->buf[i], this_entry.buf[i], SORT_IDX_ENTRYSIZE);
608 new_entry->sysno = sysno;
609 new_entry->score = -1;
612 void resultSetInsertRank (ZebraHandle zh, struct zset_sort_info *sort_info,
613 zint sysno, int score, int relation)
615 struct zset_sort_entry *new_entry = NULL;
617 assert(zh); /* compiler shut up about unused arg */
619 i = sort_info->num_entries;
624 rel = score - sort_info->entries[i]->score;
631 else if (relation == 'A')
638 j = sort_info->max_entries;
642 if (sort_info->num_entries == j)
645 j = (sort_info->num_entries)++;
647 new_entry = sort_info->entries[j];
650 sort_info->entries[j] = sort_info->entries[j-1];
653 sort_info->entries[i] = new_entry;
655 new_entry->sysno = sysno;
656 new_entry->score = score;
659 void resultSetSort (ZebraHandle zh, NMEM nmem,
660 int num_input_setnames, const char **input_setnames,
661 const char *output_setname,
662 Z_SortKeySpecList *sort_sequence, int *sort_status)
667 if (num_input_setnames == 0)
672 if (num_input_setnames > 1)
679 yaz_log(log_level_sorting, "result set sort input=%s output=%s",
680 *input_setnames, output_setname);
681 sset = resultSetGet (zh, input_setnames[0]);
685 zh->errString = nmem_strdup (nmem, input_setnames[0]);
688 if (!(rset = sset->rset))
691 zh->errString = nmem_strdup (nmem, input_setnames[0]);
694 if (strcmp (output_setname, input_setnames[0]))
696 rset = rset_dup (rset);
697 sset = resultSetAdd (zh, output_setname, 1);
700 resultSetSortSingle (zh, nmem, sset, rset, sort_sequence, sort_status);
703 void resultSetSortSingle (ZebraHandle zh, NMEM nmem,
704 ZebraSet sset, RSET rset,
705 Z_SortKeySpecList *sort_sequence, int *sort_status)
712 struct sortKeyInfo sort_criteria[3];
719 assert(nmem); /* compiler shut up about unused param */
720 sset->sort_info->num_entries = 0;
722 rset_getterms(rset, 0, 0, &n);
723 terms = (TERMID *) nmem_malloc(nmem, sizeof(*terms)*n);
724 rset_getterms(rset, terms, n, &numTerms);
727 num_criteria = sort_sequence->num_specs;
728 if (num_criteria > 3)
730 for (i = 0; i < num_criteria; i++)
732 Z_SortKeySpec *sks = sort_sequence->specs[i];
735 if (*sks->sortRelation == Z_SortKeySpec_ascending)
736 sort_criteria[i].relation = 'A';
737 else if (*sks->sortRelation == Z_SortKeySpec_descending)
738 sort_criteria[i].relation = 'D';
744 if (sks->sortElement->which == Z_SortElement_databaseSpecific)
749 else if (sks->sortElement->which != Z_SortElement_generic)
754 sk = sks->sortElement->u.generic;
757 case Z_SortKey_sortField:
758 yaz_log(log_level_sorting, "Sort: key %d is of type sortField", i+1);
761 case Z_SortKey_elementSpec:
762 yaz_log(log_level_sorting, "Sort: key %d is of type elementSpec", i+1);
765 case Z_SortKey_sortAttributes:
766 yaz_log(log_level_sorting, "Sort: key %d is of type sortAttributes", i+1);
767 sort_criteria[i].attrUse =
768 zebra_maps_sort (zh->reg->zebra_maps,
769 sk->u.sortAttributes,
770 &sort_criteria[i].numerical);
771 yaz_log(log_level_sorting, "use value = %d", sort_criteria[i].attrUse);
772 if (sort_criteria[i].attrUse == -1)
777 if (sortIdx_type (zh->reg->sortIdx, sort_criteria[i].attrUse))
785 rfd = rset_open (rset, RSETF_READ);
786 while (rset_read (rfd, &key, &termid))
787 /* FIXME - pass a TERMID *, and use it for something below !! */
789 zint this_sys = key.mem[0];
791 if (this_sys != psysno)
795 resultSetInsertSort (zh, sset,
796 sort_criteria, num_criteria, psysno);
800 yaz_log(log_level_sorting, ZINT_FORMAT " keys, " ZINT_FORMAT " sysnos, sort",
802 for (i = 0; i < numTerms; i++)
803 yaz_log(log_level_sorting, "term=\"%s\" type=%s count=" ZINT_FORMAT,
804 terms[i]->name, terms[i]->flags, rset_count(terms[i]->rset));
805 *sort_status = Z_SortResponse_success;
808 RSET resultSetRef (ZebraHandle zh, const char *resultSetId)
812 if ((s = resultSetGet (zh, resultSetId)))
817 void resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset, NMEM nmem)
827 ZebraRankClass rank_class;
828 struct rank_control *rc;
829 struct zset_sort_info *sort_info;
830 const char *rank_handler_name = res_get_def(zh->res, "rank", "rank-1");
832 zint est=-2; /* -2 not done, -1 can't do, >0 actual estimate*/
838 sort_info = zebraSet->sort_info;
839 sort_info->num_entries = 0;
841 rset_getterms(rset, 0, 0, &n);
842 terms = (TERMID *) nmem_malloc(nmem, sizeof(*terms)*n);
843 rset_getterms(rset, terms, n, &numTerms);
845 rfd = rset_open (rset, RSETF_READ);
847 rank_class = zebraRankLookup (zh, rank_handler_name);
850 yaz_log(YLOG_WARN, "No such rank handler: %s", rank_handler_name);
853 rc = rank_class->control;
855 if (rset_read (rfd, &key, &termid))
857 zint psysno = key.mem[0];
860 (*rc->begin) (zh->reg, rank_class->class_handle, rset, nmem,
863 esthits = atoi(res_get_def(zh->res, "estimatehits","0"));
865 est = -1; /* can not do */
868 zint this_sys = key.mem[0]; /* FIXME - assumes scope==2 */
869 zint seqno = key.mem[key.len-1]; /* FIXME - assumes scope==2 */
871 key_logdump_txt(log_level_searchhits,&key," Got hit");
872 if (this_sys != psysno)
874 score = (*rc->calc) (handle, psysno);
876 resultSetInsertRank (zh, sort_info, psysno, score, 'A');
880 (*rc->add) (handle, CAST_ZINT_TO_INT(seqno), termid);
882 if ((est==-2) && (zebraSet->hits==esthits))
883 { /* time to estimate the hits */
884 rset_pos(rfd,&cur,&tot);
887 est = (zint)(0.5+zebraSet->hits/ratio);
888 yaz_log(log_level_searchhits, "Estimating hits (%s) "
889 "%0.1f->" ZINT_FORMAT
890 "; %0.1f->" ZINT_FORMAT,
894 i = 0; /* round to 3 significant digits */
901 zebraSet->hits = est;
905 while (rset_read (rfd, &key,&termid) && (est<0) );
906 score = (*rc->calc)(handle, psysno);
907 resultSetInsertRank(zh, sort_info, psysno, score, 'A');
908 (*rc->end) (zh->reg, handle);
912 yaz_log(log_level_searchterms, ZINT_FORMAT " keys, " ZINT_FORMAT " sysnos, rank",
913 kno, zebraSet->hits);
914 for (i = 0; i < numTerms; i++)
916 yaz_log(log_level_searchterms, "term=\"%s\" type=%s count=" ZINT_FORMAT,
917 terms[i]->name, terms[i]->flags, rset_count(terms[i]->rset));
921 ZebraRankClass zebraRankLookup (ZebraHandle zh, const char *name)
923 ZebraRankClass p = zh->reg->rank_classes;
924 while (p && strcmp (p->control->name, name))
926 if (p && !p->init_flag)
928 if (p->control->create)
929 p->class_handle = (*p->control->create)(zh);
935 void zebraRankInstall (struct zebra_register *reg, struct rank_control *ctrl)
937 ZebraRankClass p = (ZebraRankClass) xmalloc (sizeof(*p));
938 p->control = (struct rank_control *) xmalloc (sizeof(*p->control));
939 memcpy (p->control, ctrl, sizeof(*p->control));
940 p->control->name = xstrdup (ctrl->name);
942 p->next = reg->rank_classes;
943 reg->rank_classes = p;
946 void zebraRankDestroy (struct zebra_register *reg)
948 ZebraRankClass p = reg->rank_classes;
951 ZebraRankClass p_next = p->next;
952 if (p->init_flag && p->control->destroy)
953 (*p->control->destroy)(reg, p->class_handle);
954 xfree(p->control->name);
959 reg->rank_classes = NULL;