2 * Copyright (C) 1994-1998, Index Data
4 * Sebastian Hammer, Adam Dickmeiss
7 * Revision 1.19 1998-09-22 10:48:22 adam
8 * Minor changes in search API.
10 * Revision 1.18 1998/09/22 10:03:45 adam
11 * Changed result sets to be persistent in the sense that they can
12 * be re-searched if needed.
13 * Fixed memory leak in rsm_or.
15 * Revision 1.17 1998/06/23 15:33:36 adam
16 * Added feature to specify sort criteria in query (type 7 specifies
19 * Revision 1.16 1998/05/20 10:12:24 adam
20 * Implemented automatic EXPLAIN database maintenance.
21 * Modified Zebra to work with ASN.1 compiled version of YAZ.
23 * Revision 1.15 1998/03/05 08:45:14 adam
24 * New result set model and modular ranking system. Moved towards
25 * descent server API. System information stored as "SGML" records.
27 * Revision 1.14 1998/02/10 16:39:15 adam
30 * Revision 1.13 1998/02/10 12:03:06 adam
33 * Revision 1.12 1997/09/25 14:57:36 adam
36 * Revision 1.11 1996/12/23 15:30:46 adam
38 * Bug fix: result sets weren't deleted after server shut down.
40 * Revision 1.10 1995/10/30 15:08:08 adam
43 * Revision 1.9 1995/10/17 18:02:14 adam
44 * New feature: databases. Implemented as prefix to words in dictionary.
46 * Revision 1.8 1995/10/10 13:59:25 adam
47 * Function rset_open changed its wflag parameter to general flags.
49 * Revision 1.7 1995/10/06 14:38:01 adam
50 * New result set method: r_score.
51 * Local no (sysno) and score is transferred to retrieveCtrl.
53 * Revision 1.6 1995/09/28 09:19:49 adam
54 * xfree/xmalloc used everywhere.
55 * Extract/retrieve method seems to work for text records.
57 * Revision 1.5 1995/09/27 16:17:32 adam
58 * More work on retrieve.
60 * Revision 1.4 1995/09/07 13:58:36 adam
61 * New parameter: result-set file descriptor (RSFD) to support multiple
62 * positions within the same result-set.
63 * Boolean operators: and, or, not implemented.
64 * Result-set references.
66 * Revision 1.3 1995/09/06 16:11:19 adam
67 * Option: only one word key per file.
69 * Revision 1.2 1995/09/06 10:33:04 adam
70 * More work on present. Some log messages removed.
72 * Revision 1.1 1995/09/05 15:28:40 adam
73 * More work on search engine.
87 #define SORT_IDX_ENTRYSIZE 64
88 #define ZSET_SORT_MAX_LEVEL 3
98 struct zset_sort_info *sort_info;
99 struct zebra_set *next;
102 struct zset_sort_entry {
105 char buf[ZSET_SORT_MAX_LEVEL][SORT_IDX_ENTRYSIZE];
108 struct zset_sort_info {
111 struct zset_sort_entry *all_entries;
112 struct zset_sort_entry **entries;
115 ZebraSet resultSetAddRPN (ZebraHandle zh, ODR input, ODR output,
116 Z_RPNQuery *rpn, int num_bases, char **basenames,
124 zh->errString = NULL;
127 zebraSet = resultSetAdd (zh, setname, 1);
131 zebraSet->num_bases = num_bases;
132 zebraSet->basenames = basenames;
133 zebraSet->nmem = odr_extract_mem (input);
135 zebraSet->rset = rpn_search (zh, output->mem, rpn,
137 zebraSet->basenames, zebraSet->name,
139 zh->hits = zebraSet->hits;
145 ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov)
150 for (s = zh->sets; s; s = s->next)
151 if (!strcmp (s->name, name))
155 logf (LOG_DEBUG, "updating result set %s", name);
159 rset_delete (s->rset);
161 nmem_destroy (s->nmem);
165 logf (LOG_DEBUG, "adding result set %s", name);
166 s = xmalloc (sizeof(*s));
169 s->name = xmalloc (strlen(name)+1);
170 strcpy (s->name, name);
172 s->sort_info = xmalloc (sizeof(*s->sort_info));
173 s->sort_info->max_entries = 1000;
174 s->sort_info->entries =
175 xmalloc (sizeof(*s->sort_info->entries) *
176 s->sort_info->max_entries);
177 s->sort_info->all_entries =
178 xmalloc (sizeof(*s->sort_info->all_entries) *
179 s->sort_info->max_entries);
180 for (i = 0; i < s->sort_info->max_entries; i++)
181 s->sort_info->entries[i] = s->sort_info->all_entries + i;
188 ZebraSet resultSetGet (ZebraHandle zh, const char *name)
192 for (s = zh->sets; s; s = s->next)
193 if (!strcmp (s->name, name))
195 if (!s->rset && s->rpn)
197 NMEM nmem = nmem_create ();
199 rpn_search (zh, nmem, s->rpn, s->num_bases,
200 s->basenames, s->name, s);
210 void resultSetDestroy (ZebraHandle zh)
214 for (s = zh->sets; s; s = s1)
218 xfree (s->sort_info->all_entries);
219 xfree (s->sort_info->entries);
220 xfree (s->sort_info);
223 nmem_destroy (s->nmem);
224 rset_delete (s->rset);
231 ZebraPosSet zebraPosSetCreate (ZebraHandle zh, const char *name,
232 int num, int *positions)
238 struct zset_sort_info *sort_info;
240 if (!(sset = resultSetGet (zh, name)))
242 if (!(rset = sset->rset))
244 sr = xmalloc (sizeof(*sr) * num);
245 for (i = 0; i<num; i++)
250 sort_info = sset->sort_info;
255 for (i = 0; i<num; i++)
257 position = positions[i];
258 if (position <= sort_info->num_entries)
260 logf (LOG_DEBUG, "got pos=%d (sorted)", position);
261 sr[i].sysno = sort_info->entries[position-1]->sysno;
262 sr[i].score = sort_info->entries[position-1]->score;
266 /* did we really get all entries using sort ? */
267 for (i = 0; i<num; i++)
272 if (i < num) /* nope, get the rest, unsorted - sorry */
282 position = sort_info->num_entries;
283 while (num_i < num && positions[num_i] < position)
285 rfd = rset_open (rset, RSETF_READ);
286 while (num_i < num && rset_read (rset, rfd, &key, &term_index))
288 if (key.sysno != psysno)
293 /* determine we alreay have this in our set */
294 for (i = sort_info->num_entries; --i >= 0; )
295 if (psysno == sort_info->entries[i]->sysno)
301 assert (num_i < num);
302 if (position == positions[num_i])
304 sr[num_i].sysno = psysno;
305 logf (LOG_DEBUG, "got pos=%d (unsorted)", position);
306 sr[num_i].score = -1;
311 rset_close (rset, rfd);
316 void zebraPosSetDestroy (ZebraHandle zh, ZebraPosSet records, int num)
326 void resultSetInsertSort (ZebraHandle zh, ZebraSet sset,
327 struct sortKey *criteria, int num_criteria,
330 struct zset_sort_entry this_entry;
331 struct zset_sort_entry *new_entry = NULL;
332 struct zset_sort_info *sort_info = sset->sort_info;
335 sortIdx_sysno (zh->sortIdx, sysno);
336 for (i = 0; i<num_criteria; i++)
338 sortIdx_type (zh->sortIdx, criteria[i].attrUse);
339 sortIdx_read (zh->sortIdx, this_entry.buf[i]);
341 i = sort_info->num_entries;
345 for (j = 0; j<num_criteria; j++)
347 rel = memcmp (this_entry.buf[j], sort_info->entries[i]->buf[j],
354 if (criteria[j].relation == 'A')
359 else if (criteria[j].relation == 'D')
365 j = sort_info->max_entries-1;
369 new_entry = sort_info->entries[j];
372 sort_info->entries[j] = sort_info->entries[j-1];
375 sort_info->entries[j] = new_entry;
377 if (sort_info->num_entries != sort_info->max_entries)
378 (sort_info->num_entries)++;
379 for (i = 0; i<num_criteria; i++)
380 memcpy (new_entry->buf[i], this_entry.buf[i], SORT_IDX_ENTRYSIZE);
381 new_entry->sysno = sysno;
382 new_entry->score = -1;
385 void resultSetInsertRank (ZebraHandle zh, struct zset_sort_info *sort_info,
386 int sysno, int score, int relation)
388 struct zset_sort_entry *new_entry = NULL;
391 i = sort_info->num_entries;
396 rel = score - sort_info->entries[i]->score;
403 else if (relation == 'A')
409 j = sort_info->max_entries-1;
413 new_entry = sort_info->entries[j];
416 sort_info->entries[j] = sort_info->entries[j-1];
419 sort_info->entries[j] = new_entry;
421 if (sort_info->num_entries != sort_info->max_entries)
422 (sort_info->num_entries)++;
423 new_entry->sysno = sysno;
424 new_entry->score = score;
427 void resultSetSort (ZebraHandle zh, NMEM nmem,
428 int num_input_setnames, const char **input_setnames,
429 const char *output_setname,
430 Z_SortKeySpecList *sort_sequence, int *sort_status)
435 if (num_input_setnames == 0)
440 if (num_input_setnames > 1)
445 logf (LOG_DEBUG, "result set sort input=%s output=%s",
446 *input_setnames, output_setname);
447 sset = resultSetGet (zh, input_setnames[0]);
451 zh->errString = nmem_strdup (nmem, input_setnames[0]);
454 if (!(rset = sset->rset))
457 zh->errString = nmem_strdup (nmem, input_setnames[0]);
460 if (strcmp (output_setname, input_setnames[0]))
462 rset = rset_dup (rset);
463 sset = resultSetAdd (zh, output_setname, 1);
466 resultSetSortSingle (zh, nmem, sset, rset, sort_sequence, sort_status);
469 void resultSetSortSingle (ZebraHandle zh, NMEM nmem,
470 ZebraSet sset, RSET rset,
471 Z_SortKeySpecList *sort_sequence, int *sort_status)
475 struct sortKey sort_criteria[3];
480 logf (LOG_DEBUG, "resultSetSortSingle start");
481 sset->sort_info->num_entries = 0;
484 num_criteria = sort_sequence->num_specs;
485 if (num_criteria > 3)
487 for (i = 0; i < num_criteria; i++)
489 Z_SortKeySpec *sks = sort_sequence->specs[i];
492 if (*sks->sortRelation == Z_SortRelation_ascending)
493 sort_criteria[i].relation = 'A';
494 else if (*sks->sortRelation == Z_SortRelation_descending)
495 sort_criteria[i].relation = 'D';
501 if (sks->sortElement->which == Z_SortElement_databaseSpecific)
506 else if (sks->sortElement->which != Z_SortElement_generic)
511 sk = sks->sortElement->u.generic;
514 case Z_SortKey_sortField:
515 logf (LOG_DEBUG, "Sort: key %d is of type sortField", i+1);
518 case Z_SortKey_elementSpec:
519 logf (LOG_DEBUG, "Sort: key %d is of type elementSpec", i+1);
522 case Z_SortKey_sortAttributes:
523 logf (LOG_DEBUG, "Sort: key %d is of type sortAttributes", i+1);
524 sort_criteria[i].attrUse =
525 zebra_maps_sort (zh->zebra_maps, sk->u.sortAttributes);
526 logf (LOG_DEBUG, "use value = %d", sort_criteria[i].attrUse);
527 if (sort_criteria[i].attrUse == -1)
532 if (sortIdx_type (zh->sortIdx, sort_criteria[i].attrUse))
540 rfd = rset_open (rset, RSETF_READ);
541 while (rset_read (rset, rfd, &key, &term_index))
543 if (key.sysno != psysno)
547 resultSetInsertSort (zh, sset,
548 sort_criteria, num_criteria, psysno);
551 rset_close (rset, rfd);
554 *sort_status = Z_SortStatus_success;
555 logf (LOG_DEBUG, "resultSetSortSingle end");
558 RSET resultSetRef (ZebraHandle zh, Z_ResultSetId *resultSetId)
562 if ((s = resultSetGet (zh, resultSetId)))
567 void resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset)
573 ZebraRankClass rank_class;
574 struct rank_control *rc;
575 struct zset_sort_info *sort_info;
577 sort_info = zebraSet->sort_info;
578 sort_info->num_entries = 0;
580 rfd = rset_open (rset, RSETF_READ);
582 logf (LOG_DEBUG, "resultSetRank");
583 for (i = 0; i < rset->no_rset_terms; i++)
584 logf (LOG_DEBUG, "term=\"%s\" cnt=%d type=%s",
585 rset->rset_terms[i]->name,
586 rset->rset_terms[i]->nn,
587 rset->rset_terms[i]->flags);
589 rank_class = zebraRankLookup (zh, "rank-1");
590 rc = rank_class->control;
592 if (rset_read (rset, rfd, &key, &term_index))
594 int psysno = key.sysno;
597 (*rc->begin) (zh, rank_class->class_handle, rset);
602 if (key.sysno != psysno)
604 score = (*rc->calc) (handle, psysno);
606 resultSetInsertRank (zh, sort_info, psysno, score, 'A');
610 (*rc->add) (handle, key.seqno, term_index);
612 while (rset_read (rset, rfd, &key, &term_index));
613 score = (*rc->calc) (handle, psysno);
614 resultSetInsertRank (zh, sort_info, psysno, score, 'A');
615 (*rc->end) (zh, handle);
617 rset_close (rset, rfd);
618 logf (LOG_DEBUG, "%d keys, %d distinct sysnos", kno, zebraSet->hits);
621 ZebraRankClass zebraRankLookup (ZebraHandle zh, const char *name)
623 ZebraRankClass p = zh->rank_classes;
624 while (p && strcmp (p->control->name, name))
626 if (p && !p->init_flag)
628 if (p->control->create)
629 p->class_handle = (*p->control->create)(zh);
635 void zebraRankInstall (ZebraHandle zh, struct rank_control *ctrl)
637 ZebraRankClass p = xmalloc (sizeof(*p));
638 p->control = xmalloc (sizeof(*p->control));
639 memcpy (p->control, ctrl, sizeof(*p->control));
640 p->control->name = xstrdup (ctrl->name);
642 p->next = zh->rank_classes;
643 zh->rank_classes = p;
646 void zebraRankDestroy (ZebraHandle zh)
648 ZebraRankClass p = zh->rank_classes;
651 ZebraRankClass p_next = p->next;
652 if (p->init_flag && p->control->destroy)
653 (*p->control->destroy)(zh, p->class_handle);
654 xfree (p->control->name);
659 zh->rank_classes = NULL;