1 /* $Id: zsets.c,v 1.49.2.7 2006-08-14 10:39:02 adam Exp $
2 Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004,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 this program; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
35 #define SORT_IDX_ENTRYSIZE 64
36 #define ZSET_SORT_MAX_LEVEL 3
38 struct zebra_set_term_entry {
53 Z_SortKeySpecList *sortSpec;
54 struct zset_sort_info *sort_info;
55 struct zebra_set_term_entry *term_entries;
57 struct zebra_set *next;
60 int cache_position; /* last position */
61 RSFD cache_rfd; /* rfd (NULL if not existing) */
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 ZebraSet resultSetAddRPN (ZebraHandle zh, NMEM m,
79 Z_RPNQuery *rpn, int num_bases,
90 zebraSet = resultSetAdd (zh, setname, 1);
97 zebraSet->num_bases = num_bases;
99 nmem_malloc (zebraSet->nmem, num_bases * sizeof(*zebraSet->basenames));
100 for (i = 0; i<num_bases; i++)
101 zebraSet->basenames[i] = nmem_strdup (zebraSet->nmem, basenames[i]);
104 zebraSet->rset = rpn_search (zh, zebraSet->nmem, rpn,
106 zebraSet->basenames, zebraSet->name,
108 zh->hits = zebraSet->hits;
111 zebraSet->locked = 0;
115 void resultSetAddTerm (ZebraHandle zh, ZebraSet s, int reg_type,
116 const char *db, int set,
117 int use, const char *term)
120 s->nmem = nmem_create ();
121 if (!s->term_entries)
124 s->term_entries_max = 1000;
126 nmem_malloc (s->nmem, s->term_entries_max *
127 sizeof(*s->term_entries));
128 for (i = 0; i < s->term_entries_max; i++)
129 s->term_entries[i].term = 0;
131 if (s->hits < s->term_entries_max)
133 s->term_entries[s->hits].reg_type = reg_type;
134 s->term_entries[s->hits].db = nmem_strdup (s->nmem, db);
135 s->term_entries[s->hits].set = set;
136 s->term_entries[s->hits].use = use;
137 s->term_entries[s->hits].term = nmem_strdup (s->nmem, term);
143 int zebra_resultSetTerms (ZebraHandle zh, const char *setname,
145 int *type, char *out, size_t *len)
147 ZebraSet s = resultSetGet (zh, setname);
154 no_max = s->rset->no_rset_terms;
155 if (no < 0 || no >= no_max)
158 *count = s->rset->rset_terms[no]->count;
160 *type = s->rset->rset_terms[no]->type;
164 char *inbuf = s->rset->rset_terms[no]->name;
165 size_t inleft = strlen(inbuf);
166 size_t outleft = *len - 1;
169 if (zh->iconv_from_utf8 != 0)
174 ret = yaz_iconv(zh->iconv_from_utf8, &inbuf, &inleft,
176 if (ret == (size_t)(-1))
184 if (inleft > outleft)
187 memcpy (out, inbuf, *len);
195 ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov)
200 for (s = zh->sets; s; s = s->next)
201 if (!strcmp (s->name, name))
205 yaz_log (LOG_DEBUG, "updating result set %s", name);
206 if (!ov || s->locked)
211 rset_close(s->rset, s->cache_rfd);
212 rset_delete (s->rset);
215 nmem_destroy (s->nmem);
219 const char *sort_max_str = zebra_get_resource(zh, "sortmax", "1000");
221 yaz_log (LOG_DEBUG, "adding result set %s", name);
222 s = (ZebraSet) xmalloc (sizeof(*s));
225 s->name = (char *) xmalloc (strlen(name)+1);
226 strcpy (s->name, name);
228 s->sort_info = (struct zset_sort_info *)
229 xmalloc (sizeof(*s->sort_info));
230 s->sort_info->max_entries = atoi(sort_max_str);
231 if (s->sort_info->max_entries < 2)
232 s->sort_info->max_entries = 2;
234 s->sort_info->entries = (struct zset_sort_entry **)
235 xmalloc (sizeof(*s->sort_info->entries) *
236 s->sort_info->max_entries);
237 s->sort_info->all_entries = (struct zset_sort_entry *)
238 xmalloc (sizeof(*s->sort_info->all_entries) *
239 s->sort_info->max_entries);
240 for (i = 0; i < s->sort_info->max_entries; i++)
241 s->sort_info->entries[i] = s->sort_info->all_entries + i;
250 s->cache_position = 0;
255 ZebraSet resultSetGet (ZebraHandle zh, const char *name)
259 for (s = zh->sets; s; s = s->next)
260 if (!strcmp (s->name, name))
262 if (!s->term_entries && !s->rset && s->rpn)
264 NMEM nmem = nmem_create ();
265 yaz_log (LOG_LOG, "research %s", name);
267 rpn_search (zh, nmem, s->rpn, s->num_bases,
268 s->basenames, s->name, s);
269 if (s->rset && s->sortSpec)
272 yaz_log (LOG_LOG, "resort %s", name);
273 resultSetSortSingle (zh, nmem, s, s->rset, s->sortSpec,
283 void resultSetInvalidate (ZebraHandle zh)
285 ZebraSet s = zh->sets;
287 for (; s; s = s->next)
292 rset_close(s->rset, s->cache_rfd);
293 rset_delete (s->rset);
297 s->cache_position = 0;
301 void resultSetDestroy (ZebraHandle zh, int num, char **names,int *statuses)
303 ZebraSet * ss = &zh->sets;
307 for (i = 0; i<num; i++)
308 statuses[i] = Z_DeleteStatus_resultSetDidNotExist;
310 zh->errString = NULL;
317 for (i = 0; i<num; i++)
318 if (!strcmp (s->name, names[i]))
321 statuses[i] = Z_DeleteStatus_success;
330 xfree (s->sort_info->all_entries);
331 xfree (s->sort_info->entries);
332 xfree (s->sort_info);
335 nmem_destroy (s->nmem);
339 rset_close (s->rset, s->cache_rfd);
340 rset_delete (s->rset);
350 ZebraPosSet zebraPosSetCreate (ZebraHandle zh, const char *name,
351 int num, int *positions)
357 struct zset_sort_info *sort_info;
359 if (!(sset = resultSetGet (zh, name)))
361 if (!(rset = sset->rset))
363 if (!sset->term_entries)
365 sr = (ZebraPosSet) xmalloc (sizeof(*sr) * num);
366 for (i = 0; i<num; i++)
373 if (positions[i] <= sset->term_entries_max)
375 sr[i].term = sset->term_entries[positions[i]-1].term;
376 sr[i].db = sset->term_entries[positions[i]-1].db;
382 sr = (ZebraPosSet) xmalloc (sizeof(*sr) * num);
383 for (i = 0; i<num; i++)
390 sort_info = sset->sort_info;
395 for (i = 0; i<num; i++)
397 position = positions[i];
398 if (position > 0 && position <= sort_info->num_entries)
400 yaz_log (LOG_DEBUG, "got pos=%d (sorted)", position);
401 sr[i].sysno = sort_info->entries[position-1]->sysno;
402 sr[i].score = sort_info->entries[position-1]->score;
406 /* did we really get all entries using sort ? */
407 for (i = 0; i<num; i++)
412 if (i < num) /* nope, get the rest, unsorted - sorry */
422 position = sort_info->num_entries;
423 while (num_i < num && positions[num_i] < position)
426 if (sset->cache_rfd &&
427 num_i < num && positions[num_i] > sset->cache_position)
429 position = sset->cache_position;
430 rfd = sset->cache_rfd;
431 psysno = sset->cache_psysno;
436 rset_close(rset, sset->cache_rfd);
437 rfd = rset_open (rset, RSETF_READ);
439 while (num_i < num && rset_read (rset, rfd, &key, &term_index))
441 if (key.sysno != psysno)
446 /* determine we alreay have this in our set */
447 for (i = sort_info->num_entries; --i >= 0; )
448 if (psysno == sort_info->entries[i]->sysno)
454 assert (num_i < num);
455 if (position == positions[num_i])
457 sr[num_i].sysno = psysno;
458 yaz_log (LOG_DEBUG, "got pos=%d (unsorted)", position);
459 sr[num_i].score = -1;
464 sset->cache_position = position;
465 sset->cache_psysno = psysno;
466 sset->cache_rfd = rfd;
472 void zebraPosSetDestroy (ZebraHandle zh, ZebraPosSet records, int num)
483 void resultSetInsertSort (ZebraHandle zh, ZebraSet sset,
484 struct sortKeyInfo *criteria, int num_criteria,
487 struct zset_sort_entry this_entry;
488 struct zset_sort_entry *new_entry = NULL;
489 struct zset_sort_info *sort_info = sset->sort_info;
492 sortIdx_sysno (zh->reg->sortIdx, sysno);
493 for (i = 0; i<num_criteria; i++)
495 memset(this_entry.buf[i], '\0', SORT_IDX_ENTRYSIZE);
496 if (criteria[i].attrUse != -1)
498 sortIdx_type (zh->reg->sortIdx, criteria[i].attrUse);
499 sortIdx_read (zh->reg->sortIdx, this_entry.buf[i]);
502 i = sort_info->num_entries;
506 for (j = 0; j<num_criteria; j++)
508 if (criteria[j].numerical)
510 double diff = atof(this_entry.buf[j]) -
511 atof(sort_info->entries[i]->buf[j]);
520 rel = memcmp (this_entry.buf[j], sort_info->entries[i]->buf[j],
528 if (criteria[j].relation == 'A')
533 else if (criteria[j].relation == 'D')
540 j = sort_info->max_entries;
544 if (sort_info->num_entries == j)
547 j = (sort_info->num_entries)++;
548 new_entry = sort_info->entries[j];
551 sort_info->entries[j] = sort_info->entries[j-1];
554 sort_info->entries[i] = new_entry;
556 for (i = 0; i<num_criteria; i++)
557 memcpy (new_entry->buf[i], this_entry.buf[i], SORT_IDX_ENTRYSIZE);
558 new_entry->sysno = sysno;
559 new_entry->score = -1;
562 void resultSetInsertRank(ZebraHandle zh, struct zset_sort_info *sort_info,
563 int sysno, int score, int relation)
565 struct zset_sort_entry *new_entry = NULL;
568 i = sort_info->num_entries;
573 rel = score - sort_info->entries[i]->score;
580 else if (relation == 'A')
587 j = sort_info->max_entries;
591 if (sort_info->num_entries == j)
594 j = (sort_info->num_entries)++;
596 new_entry = sort_info->entries[j];
599 sort_info->entries[j] = sort_info->entries[j-1];
602 sort_info->entries[i] = new_entry;
604 new_entry->sysno = sysno;
605 new_entry->score = score;
609 static Z_RPNQuery *copy_RPNQuery(Z_RPNQuery *src, NMEM nmem)
612 ODR encode = odr_createmem(ODR_ENCODE);
613 ODR decode = odr_createmem(ODR_DECODE);
615 if (z_RPNQuery(encode, &src, 0, 0))
618 char *buf = odr_getbuf(encode, &len, 0);
622 odr_setbuf(decode, buf, len, 0);
623 z_RPNQuery(decode, &dst, 0, 0);
626 nmem_transfer(nmem, decode->mem);
632 static Z_SortKeySpecList *copy_SortKeySpecList(Z_SortKeySpecList *src, NMEM nmem)
634 Z_SortKeySpecList *dst = 0;
635 ODR encode = odr_createmem(ODR_ENCODE);
636 ODR decode = odr_createmem(ODR_DECODE);
638 if (z_SortKeySpecList(encode, &src, 0, 0))
641 char *buf = odr_getbuf(encode, &len, 0);
645 odr_setbuf(decode, buf, len, 0);
646 z_SortKeySpecList(decode, &dst, 0, 0);
649 nmem_transfer(nmem, decode->mem);
655 ZebraSet resultSetClone(ZebraHandle zh, const char *setname,
661 nset = resultSetAdd(zh, setname, 1);
665 nset->nmem = nmem_create();
667 nset->num_bases = rset->num_bases;
669 nmem_malloc (nset->nmem, nset->num_bases * sizeof(*rset->basenames));
670 for (i = 0; i<rset->num_bases; i++)
671 nset->basenames[i] = nmem_strdup(nset->nmem, rset->basenames[i]);
674 nset->rset = rset_dup(rset->rset);
676 nset->rpn = copy_RPNQuery(rset->rpn, nset->nmem);
680 void resultSetSort (ZebraHandle zh, NMEM nmem,
681 int num_input_setnames, const char **input_setnames,
682 const char *output_setname,
683 Z_SortKeySpecList *sort_sequence, int *sort_status)
688 if (num_input_setnames == 0)
693 if (num_input_setnames > 1)
698 yaz_log (LOG_DEBUG, "result set sort input=%s output=%s",
699 *input_setnames, output_setname);
700 sset = resultSetGet (zh, input_setnames[0]);
704 zh->errString = nmem_strdup (nmem, input_setnames[0]);
707 if (!(rset = sset->rset))
710 zh->errString = nmem_strdup (nmem, input_setnames[0]);
713 if (strcmp (output_setname, input_setnames[0]))
714 sset = resultSetClone(zh, output_setname, sset);
715 sset->sortSpec = copy_SortKeySpecList(sort_sequence, sset->nmem);
716 resultSetSortSingle (zh, nmem, sset, rset, sort_sequence, sort_status);
719 void resultSetSortSingle (ZebraHandle zh, NMEM nmem,
720 ZebraSet sset, RSET rset,
721 Z_SortKeySpecList *sort_sequence, int *sort_status)
726 struct sortKeyInfo sort_criteria[3];
731 sset->sort_info->num_entries = 0;
734 num_criteria = sort_sequence->num_specs;
735 if (num_criteria > 3)
737 for (i = 0; i < num_criteria; i++)
739 Z_SortKeySpec *sks = sort_sequence->specs[i];
742 if (*sks->sortRelation == Z_SortKeySpec_ascending)
743 sort_criteria[i].relation = 'A';
744 else if (*sks->sortRelation == Z_SortKeySpec_descending)
745 sort_criteria[i].relation = 'D';
751 if (sks->sortElement->which == Z_SortElement_databaseSpecific)
756 else if (sks->sortElement->which != Z_SortElement_generic)
762 if (sks->which == Z_SortKeySpec_missingValueData)
768 sk = sks->sortElement->u.generic;
771 case Z_SortKey_sortField:
772 yaz_log (LOG_DEBUG, "Sort: key %d is of type sortField", i+1);
775 case Z_SortKey_elementSpec:
776 yaz_log (LOG_DEBUG, "Sort: key %d is of type elementSpec", i+1);
779 case Z_SortKey_sortAttributes:
780 yaz_log (LOG_DEBUG, "Sort: key %d is of type sortAttributes", i+1);
781 sort_criteria[i].attrUse =
782 zebra_maps_sort (zh->reg->zebra_maps,
783 sk->u.sortAttributes,
784 &sort_criteria[i].numerical);
785 yaz_log (LOG_DEBUG, "use value = %d", sort_criteria[i].attrUse);
786 if (sort_criteria[i].attrUse == -1 && sks->which != Z_SortKeySpec_null)
791 if (sortIdx_type (zh->reg->sortIdx, sort_criteria[i].attrUse))
793 if (sks->which != Z_SortKeySpec_null)
799 sort_criteria[i].attrUse = -1;
804 rfd = rset_open (rset, RSETF_READ);
805 while (rset_read (rset, rfd, &key, &term_index))
808 if (key.sysno != psysno)
812 resultSetInsertSort (zh, sset,
813 sort_criteria, num_criteria, psysno);
816 rset_close (rset, rfd);
818 yaz_log (LOG_LOG, "%d keys, %d sysnos, sort", kno, sset->hits);
819 for (i = 0; i < rset->no_rset_terms; i++)
820 yaz_log (LOG_LOG, "term=\"%s\" nn=%d type=%s count=%d",
821 rset->rset_terms[i]->name,
822 rset->rset_terms[i]->nn,
823 rset->rset_terms[i]->flags,
824 rset->rset_terms[i]->count);
826 *sort_status = Z_SortResponse_success;
829 RSET resultSetRef (ZebraHandle zh, const char *resultSetId)
833 if ((s = resultSetGet (zh, resultSetId)))
838 void resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset)
844 ZebraRankClass rank_class;
845 struct rank_control *rc;
846 struct zset_sort_info *sort_info;
847 const char *rank_handler_name = res_get_def(zh->res, "rank", "rank-1");
849 sort_info = zebraSet->sort_info;
850 sort_info->num_entries = 0;
852 rfd = rset_open (rset, RSETF_READ);
854 rank_class = zebraRankLookup (zh, rank_handler_name);
857 yaz_log (LOG_WARN, "No such rank handler: %s", rank_handler_name);
860 rc = rank_class->control;
862 if (rset_read (rset, rfd, &key, &term_index))
864 int psysno = key.sysno;
867 (*rc->begin) (zh->reg, rank_class->class_handle, rset);
872 if (key.sysno != psysno)
874 score = (*rc->calc) (handle, psysno);
876 resultSetInsertRank (zh, sort_info, psysno, score, 'A');
880 (*rc->add) (handle, key.seqno, term_index);
882 while (rset_read (rset, rfd, &key, &term_index));
883 score = (*rc->calc) (handle, psysno);
884 resultSetInsertRank (zh, sort_info, psysno, score, 'A');
885 (*rc->end) (zh->reg, handle);
887 rset_close (rset, rfd);
889 yaz_log (LOG_LOG, "%d keys, %d sysnos, rank", kno, zebraSet->hits);
890 for (i = 0; i < rset->no_rset_terms; i++)
891 yaz_log (LOG_LOG, "term=\"%s\" nn=%d type=%s count=%d",
892 rset->rset_terms[i]->name,
893 rset->rset_terms[i]->nn,
894 rset->rset_terms[i]->flags,
895 rset->rset_terms[i]->count);
899 ZebraRankClass zebraRankLookup (ZebraHandle zh, const char *name)
901 ZebraRankClass p = zh->reg->rank_classes;
902 while (p && strcmp (p->control->name, name))
904 if (p && !p->init_flag)
906 if (p->control->create)
907 p->class_handle = (*p->control->create)(zh);
913 void zebraRankInstall (struct zebra_register *reg, struct rank_control *ctrl)
915 ZebraRankClass p = (ZebraRankClass) xmalloc (sizeof(*p));
916 p->control = (struct rank_control *) xmalloc (sizeof(*p->control));
917 memcpy (p->control, ctrl, sizeof(*p->control));
918 p->control->name = xstrdup (ctrl->name);
920 p->next = reg->rank_classes;
921 reg->rank_classes = p;
924 void zebraRankDestroy (struct zebra_register *reg)
926 ZebraRankClass p = reg->rank_classes;
929 ZebraRankClass p_next = p->next;
930 if (p->init_flag && p->control->destroy)
931 (*p->control->destroy)(reg, p->class_handle);
932 xfree (p->control->name);
937 reg->rank_classes = NULL;