1 /* $Id: zsets.c,v 1.49.2.2 2005-01-07 14:06:16 adam 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;
59 int cache_position; /* last position */
60 RSFD cache_rfd; /* rfd (NULL if not existing) */
64 struct zset_sort_entry {
67 char buf[ZSET_SORT_MAX_LEVEL][SORT_IDX_ENTRYSIZE];
70 struct zset_sort_info {
73 struct zset_sort_entry *all_entries;
74 struct zset_sort_entry **entries;
77 ZebraSet resultSetAddRPN (ZebraHandle zh, NMEM m,
78 Z_RPNQuery *rpn, int num_bases,
89 zebraSet = resultSetAdd (zh, setname, 1);
96 zebraSet->num_bases = num_bases;
98 nmem_malloc (zebraSet->nmem, num_bases * sizeof(*zebraSet->basenames));
99 for (i = 0; i<num_bases; i++)
100 zebraSet->basenames[i] = nmem_strdup (zebraSet->nmem, basenames[i]);
103 zebraSet->rset = rpn_search (zh, zebraSet->nmem, rpn,
105 zebraSet->basenames, zebraSet->name,
107 zh->hits = zebraSet->hits;
110 zebraSet->locked = 0;
114 void resultSetAddTerm (ZebraHandle zh, ZebraSet s, int reg_type,
115 const char *db, int set,
116 int use, const char *term)
119 s->nmem = nmem_create ();
120 if (!s->term_entries)
123 s->term_entries_max = 1000;
125 nmem_malloc (s->nmem, s->term_entries_max *
126 sizeof(*s->term_entries));
127 for (i = 0; i < s->term_entries_max; i++)
128 s->term_entries[i].term = 0;
130 if (s->hits < s->term_entries_max)
132 s->term_entries[s->hits].reg_type = reg_type;
133 s->term_entries[s->hits].db = nmem_strdup (s->nmem, db);
134 s->term_entries[s->hits].set = set;
135 s->term_entries[s->hits].use = use;
136 s->term_entries[s->hits].term = nmem_strdup (s->nmem, term);
142 int zebra_resultSetTerms (ZebraHandle zh, const char *setname,
144 int *type, char *out, size_t *len)
146 ZebraSet s = resultSetGet (zh, setname);
153 no_max = s->rset->no_rset_terms;
154 if (no < 0 || no >= no_max)
157 *count = s->rset->rset_terms[no]->count;
159 *type = s->rset->rset_terms[no]->type;
163 char *inbuf = s->rset->rset_terms[no]->name;
164 size_t inleft = strlen(inbuf);
165 size_t outleft = *len - 1;
168 if (zh->iconv_from_utf8 != 0)
173 ret = yaz_iconv(zh->iconv_from_utf8, &inbuf, &inleft,
175 if (ret == (size_t)(-1))
183 if (inleft > outleft)
186 memcpy (out, inbuf, *len);
194 ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov)
199 for (s = zh->sets; s; s = s->next)
200 if (!strcmp (s->name, name))
204 yaz_log (LOG_DEBUG, "updating result set %s", name);
205 if (!ov || s->locked)
210 rset_close(s->rset, s->cache_rfd);
211 rset_delete (s->rset);
214 nmem_destroy (s->nmem);
218 const char *sort_max_str = zebra_get_resource(zh, "sortmax", "2");
220 yaz_log (LOG_DEBUG, "adding result set %s", name);
221 s = (ZebraSet) xmalloc (sizeof(*s));
224 s->name = (char *) xmalloc (strlen(name)+1);
225 strcpy (s->name, name);
227 s->sort_info = (struct zset_sort_info *)
228 xmalloc (sizeof(*s->sort_info));
229 s->sort_info->max_entries = atoi(sort_max_str);
230 if (s->sort_info->max_entries < 2)
231 s->sort_info->max_entries = 2;
233 s->sort_info->entries = (struct zset_sort_entry **)
234 xmalloc (sizeof(*s->sort_info->entries) *
235 s->sort_info->max_entries);
236 s->sort_info->all_entries = (struct zset_sort_entry *)
237 xmalloc (sizeof(*s->sort_info->all_entries) *
238 s->sort_info->max_entries);
239 for (i = 0; i < s->sort_info->max_entries; i++)
240 s->sort_info->entries[i] = s->sort_info->all_entries + i;
248 s->cache_position = 0;
253 ZebraSet resultSetGet (ZebraHandle zh, const char *name)
257 for (s = zh->sets; s; s = s->next)
258 if (!strcmp (s->name, name))
260 if (!s->term_entries && !s->rset && s->rpn)
262 NMEM nmem = nmem_create ();
263 yaz_log (LOG_LOG, "research %s", name);
265 rpn_search (zh, nmem, s->rpn, s->num_bases,
266 s->basenames, s->name, s);
274 void resultSetInvalidate (ZebraHandle zh)
276 ZebraSet s = zh->sets;
278 for (; s; s = s->next)
283 rset_close(s->rset, s->cache_rfd);
284 rset_delete (s->rset);
288 s->cache_position = 0;
292 void resultSetDestroy (ZebraHandle zh, int num, char **names,int *statuses)
294 ZebraSet * ss = &zh->sets;
298 for (i = 0; i<num; i++)
299 statuses[i] = Z_DeleteStatus_resultSetDidNotExist;
301 zh->errString = NULL;
308 for (i = 0; i<num; i++)
309 if (!strcmp (s->name, names[i]))
312 statuses[i] = Z_DeleteStatus_success;
321 xfree (s->sort_info->all_entries);
322 xfree (s->sort_info->entries);
323 xfree (s->sort_info);
326 nmem_destroy (s->nmem);
330 rset_close (s->rset, s->cache_rfd);
331 rset_delete (s->rset);
341 ZebraPosSet zebraPosSetCreate (ZebraHandle zh, const char *name,
342 int num, int *positions)
348 struct zset_sort_info *sort_info;
350 if (!(sset = resultSetGet (zh, name)))
352 if (!(rset = sset->rset))
354 if (!sset->term_entries)
356 sr = (ZebraPosSet) xmalloc (sizeof(*sr) * num);
357 for (i = 0; i<num; i++)
364 if (positions[i] <= sset->term_entries_max)
366 sr[i].term = sset->term_entries[positions[i]-1].term;
367 sr[i].db = sset->term_entries[positions[i]-1].db;
373 sr = (ZebraPosSet) xmalloc (sizeof(*sr) * num);
374 for (i = 0; i<num; i++)
381 sort_info = sset->sort_info;
386 for (i = 0; i<num; i++)
388 position = positions[i];
389 if (position > 0 && position <= sort_info->num_entries)
391 yaz_log (LOG_DEBUG, "got pos=%d (sorted)", position);
392 sr[i].sysno = sort_info->entries[position-1]->sysno;
393 sr[i].score = sort_info->entries[position-1]->score;
397 /* did we really get all entries using sort ? */
398 for (i = 0; i<num; i++)
403 if (i < num) /* nope, get the rest, unsorted - sorry */
413 position = sort_info->num_entries;
414 while (num_i < num && positions[num_i] < position)
417 if (sset->cache_rfd &&
418 num_i < num && positions[num_i] > sset->cache_position)
420 position = sset->cache_position;
421 rfd = sset->cache_rfd;
422 psysno = sset->cache_psysno;
427 rset_close(rset, sset->cache_rfd);
428 rfd = rset_open (rset, RSETF_READ);
430 while (num_i < num && rset_read (rset, rfd, &key, &term_index))
432 if (key.sysno != psysno)
437 /* determine we alreay have this in our set */
438 for (i = sort_info->num_entries; --i >= 0; )
439 if (psysno == sort_info->entries[i]->sysno)
445 assert (num_i < num);
446 if (position == positions[num_i])
448 sr[num_i].sysno = psysno;
449 yaz_log (LOG_DEBUG, "got pos=%d (unsorted)", position);
450 sr[num_i].score = -1;
455 sset->cache_position = position;
456 sset->cache_psysno = psysno;
457 sset->cache_rfd = rfd;
463 void zebraPosSetDestroy (ZebraHandle zh, ZebraPosSet records, int num)
474 void resultSetInsertSort (ZebraHandle zh, ZebraSet sset,
475 struct sortKeyInfo *criteria, int num_criteria,
478 struct zset_sort_entry this_entry;
479 struct zset_sort_entry *new_entry = NULL;
480 struct zset_sort_info *sort_info = sset->sort_info;
483 sortIdx_sysno (zh->reg->sortIdx, sysno);
484 for (i = 0; i<num_criteria; i++)
486 sortIdx_type (zh->reg->sortIdx, criteria[i].attrUse);
487 sortIdx_read (zh->reg->sortIdx, this_entry.buf[i]);
489 i = sort_info->num_entries;
493 for (j = 0; j<num_criteria; j++)
495 if (criteria[j].numerical)
497 double diff = atof(this_entry.buf[j]) -
498 atof(sort_info->entries[i]->buf[j]);
507 rel = memcmp (this_entry.buf[j], sort_info->entries[i]->buf[j],
515 if (criteria[j].relation == 'A')
520 else if (criteria[j].relation == 'D')
527 j = sort_info->max_entries;
531 if (sort_info->num_entries == j)
534 j = (sort_info->num_entries)++;
535 new_entry = sort_info->entries[j];
538 sort_info->entries[j] = sort_info->entries[j-1];
541 sort_info->entries[i] = new_entry;
543 for (i = 0; i<num_criteria; i++)
544 memcpy (new_entry->buf[i], this_entry.buf[i], SORT_IDX_ENTRYSIZE);
545 new_entry->sysno = sysno;
546 new_entry->score = -1;
549 void resultSetInsertRank(ZebraHandle zh, struct zset_sort_info *sort_info,
550 int sysno, int score, int relation)
552 struct zset_sort_entry *new_entry = NULL;
555 i = sort_info->num_entries;
560 rel = score - sort_info->entries[i]->score;
567 else if (relation == 'A')
574 j = sort_info->max_entries;
578 if (sort_info->num_entries == j)
581 j = (sort_info->num_entries)++;
583 new_entry = sort_info->entries[j];
586 sort_info->entries[j] = sort_info->entries[j-1];
589 sort_info->entries[i] = new_entry;
591 new_entry->sysno = sysno;
592 new_entry->score = score;
595 void resultSetSort (ZebraHandle zh, NMEM nmem,
596 int num_input_setnames, const char **input_setnames,
597 const char *output_setname,
598 Z_SortKeySpecList *sort_sequence, int *sort_status)
603 if (num_input_setnames == 0)
608 if (num_input_setnames > 1)
613 yaz_log (LOG_DEBUG, "result set sort input=%s output=%s",
614 *input_setnames, output_setname);
615 sset = resultSetGet (zh, input_setnames[0]);
619 zh->errString = nmem_strdup (nmem, input_setnames[0]);
622 if (!(rset = sset->rset))
625 zh->errString = nmem_strdup (nmem, input_setnames[0]);
628 if (strcmp (output_setname, input_setnames[0]))
630 rset = rset_dup (rset);
631 sset = resultSetAdd (zh, output_setname, 1);
634 resultSetSortSingle (zh, nmem, sset, rset, sort_sequence, sort_status);
637 void resultSetSortSingle (ZebraHandle zh, NMEM nmem,
638 ZebraSet sset, RSET rset,
639 Z_SortKeySpecList *sort_sequence, int *sort_status)
644 struct sortKeyInfo sort_criteria[3];
649 sset->sort_info->num_entries = 0;
652 num_criteria = sort_sequence->num_specs;
653 if (num_criteria > 3)
655 for (i = 0; i < num_criteria; i++)
657 Z_SortKeySpec *sks = sort_sequence->specs[i];
660 if (*sks->sortRelation == Z_SortKeySpec_ascending)
661 sort_criteria[i].relation = 'A';
662 else if (*sks->sortRelation == Z_SortKeySpec_descending)
663 sort_criteria[i].relation = 'D';
669 if (sks->sortElement->which == Z_SortElement_databaseSpecific)
674 else if (sks->sortElement->which != Z_SortElement_generic)
679 sk = sks->sortElement->u.generic;
682 case Z_SortKey_sortField:
683 yaz_log (LOG_DEBUG, "Sort: key %d is of type sortField", i+1);
686 case Z_SortKey_elementSpec:
687 yaz_log (LOG_DEBUG, "Sort: key %d is of type elementSpec", i+1);
690 case Z_SortKey_sortAttributes:
691 yaz_log (LOG_DEBUG, "Sort: key %d is of type sortAttributes", i+1);
692 sort_criteria[i].attrUse =
693 zebra_maps_sort (zh->reg->zebra_maps,
694 sk->u.sortAttributes,
695 &sort_criteria[i].numerical);
696 yaz_log (LOG_DEBUG, "use value = %d", sort_criteria[i].attrUse);
697 if (sort_criteria[i].attrUse == -1)
702 if (sortIdx_type (zh->reg->sortIdx, sort_criteria[i].attrUse))
710 rfd = rset_open (rset, RSETF_READ);
711 while (rset_read (rset, rfd, &key, &term_index))
714 if (key.sysno != psysno)
718 resultSetInsertSort (zh, sset,
719 sort_criteria, num_criteria, psysno);
722 rset_close (rset, rfd);
724 yaz_log (LOG_LOG, "%d keys, %d sysnos, sort", kno, sset->hits);
725 for (i = 0; i < rset->no_rset_terms; i++)
726 yaz_log (LOG_LOG, "term=\"%s\" nn=%d type=%s count=%d",
727 rset->rset_terms[i]->name,
728 rset->rset_terms[i]->nn,
729 rset->rset_terms[i]->flags,
730 rset->rset_terms[i]->count);
732 *sort_status = Z_SortResponse_success;
735 RSET resultSetRef (ZebraHandle zh, const char *resultSetId)
739 if ((s = resultSetGet (zh, resultSetId)))
744 void resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset)
750 ZebraRankClass rank_class;
751 struct rank_control *rc;
752 struct zset_sort_info *sort_info;
753 const char *rank_handler_name = res_get_def(zh->res, "rank", "rank-1");
755 sort_info = zebraSet->sort_info;
756 sort_info->num_entries = 0;
758 rfd = rset_open (rset, RSETF_READ);
760 rank_class = zebraRankLookup (zh, rank_handler_name);
763 yaz_log (LOG_WARN, "No such rank handler: %s", rank_handler_name);
766 rc = rank_class->control;
768 if (rset_read (rset, rfd, &key, &term_index))
770 int psysno = key.sysno;
773 (*rc->begin) (zh->reg, rank_class->class_handle, rset);
778 if (key.sysno != psysno)
780 score = (*rc->calc) (handle, psysno);
782 resultSetInsertRank (zh, sort_info, psysno, score, 'A');
786 (*rc->add) (handle, key.seqno, term_index);
788 while (rset_read (rset, rfd, &key, &term_index));
789 score = (*rc->calc) (handle, psysno);
790 resultSetInsertRank (zh, sort_info, psysno, score, 'A');
791 (*rc->end) (zh->reg, handle);
793 rset_close (rset, rfd);
795 yaz_log (LOG_LOG, "%d keys, %d sysnos, rank", kno, zebraSet->hits);
796 for (i = 0; i < rset->no_rset_terms; i++)
797 yaz_log (LOG_LOG, "term=\"%s\" nn=%d type=%s count=%d",
798 rset->rset_terms[i]->name,
799 rset->rset_terms[i]->nn,
800 rset->rset_terms[i]->flags,
801 rset->rset_terms[i]->count);
805 ZebraRankClass zebraRankLookup (ZebraHandle zh, const char *name)
807 ZebraRankClass p = zh->reg->rank_classes;
808 while (p && strcmp (p->control->name, name))
810 if (p && !p->init_flag)
812 if (p->control->create)
813 p->class_handle = (*p->control->create)(zh);
819 void zebraRankInstall (struct zebra_register *reg, struct rank_control *ctrl)
821 ZebraRankClass p = (ZebraRankClass) xmalloc (sizeof(*p));
822 p->control = (struct rank_control *) xmalloc (sizeof(*p->control));
823 memcpy (p->control, ctrl, sizeof(*p->control));
824 p->control->name = xstrdup (ctrl->name);
826 p->next = reg->rank_classes;
827 reg->rank_classes = p;
830 void zebraRankDestroy (struct zebra_register *reg)
832 ZebraRankClass p = reg->rank_classes;
835 ZebraRankClass p_next = p->next;
836 if (p->init_flag && p->control->destroy)
837 (*p->control->destroy)(reg, p->class_handle);
838 xfree (p->control->name);
843 reg->rank_classes = NULL;