2 * Copyright (C) 1994-1998, Index Data
4 * Sebastian Hammer, Adam Dickmeiss
7 * Revision 1.20 1998-11-16 10:10:53 adam
8 * Fixed problem with zebraPosSetCreate that occurred when positions were
11 * Revision 1.19 1998/09/22 10:48:22 adam
12 * Minor changes in search API.
14 * Revision 1.18 1998/09/22 10:03:45 adam
15 * Changed result sets to be persistent in the sense that they can
16 * be re-searched if needed.
17 * Fixed memory leak in rsm_or.
19 * Revision 1.17 1998/06/23 15:33:36 adam
20 * Added feature to specify sort criteria in query (type 7 specifies
23 * Revision 1.16 1998/05/20 10:12:24 adam
24 * Implemented automatic EXPLAIN database maintenance.
25 * Modified Zebra to work with ASN.1 compiled version of YAZ.
27 * Revision 1.15 1998/03/05 08:45:14 adam
28 * New result set model and modular ranking system. Moved towards
29 * descent server API. System information stored as "SGML" records.
31 * Revision 1.14 1998/02/10 16:39:15 adam
34 * Revision 1.13 1998/02/10 12:03:06 adam
37 * Revision 1.12 1997/09/25 14:57:36 adam
40 * Revision 1.11 1996/12/23 15:30:46 adam
42 * Bug fix: result sets weren't deleted after server shut down.
44 * Revision 1.10 1995/10/30 15:08:08 adam
47 * Revision 1.9 1995/10/17 18:02:14 adam
48 * New feature: databases. Implemented as prefix to words in dictionary.
50 * Revision 1.8 1995/10/10 13:59:25 adam
51 * Function rset_open changed its wflag parameter to general flags.
53 * Revision 1.7 1995/10/06 14:38:01 adam
54 * New result set method: r_score.
55 * Local no (sysno) and score is transferred to retrieveCtrl.
57 * Revision 1.6 1995/09/28 09:19:49 adam
58 * xfree/xmalloc used everywhere.
59 * Extract/retrieve method seems to work for text records.
61 * Revision 1.5 1995/09/27 16:17:32 adam
62 * More work on retrieve.
64 * Revision 1.4 1995/09/07 13:58:36 adam
65 * New parameter: result-set file descriptor (RSFD) to support multiple
66 * positions within the same result-set.
67 * Boolean operators: and, or, not implemented.
68 * Result-set references.
70 * Revision 1.3 1995/09/06 16:11:19 adam
71 * Option: only one word key per file.
73 * Revision 1.2 1995/09/06 10:33:04 adam
74 * More work on present. Some log messages removed.
76 * Revision 1.1 1995/09/05 15:28:40 adam
77 * More work on search engine.
91 #define SORT_IDX_ENTRYSIZE 64
92 #define ZSET_SORT_MAX_LEVEL 3
102 struct zset_sort_info *sort_info;
103 struct zebra_set *next;
106 struct zset_sort_entry {
109 char buf[ZSET_SORT_MAX_LEVEL][SORT_IDX_ENTRYSIZE];
112 struct zset_sort_info {
115 struct zset_sort_entry *all_entries;
116 struct zset_sort_entry **entries;
119 ZebraSet resultSetAddRPN (ZebraHandle zh, ODR input, ODR output,
120 Z_RPNQuery *rpn, int num_bases, char **basenames,
128 zh->errString = NULL;
131 zebraSet = resultSetAdd (zh, setname, 1);
135 zebraSet->num_bases = num_bases;
136 zebraSet->basenames = basenames;
137 zebraSet->nmem = odr_extract_mem (input);
139 zebraSet->rset = rpn_search (zh, output->mem, rpn,
141 zebraSet->basenames, zebraSet->name,
143 zh->hits = zebraSet->hits;
149 ZebraSet resultSetAdd (ZebraHandle zh, const char *name, int ov)
154 for (s = zh->sets; s; s = s->next)
155 if (!strcmp (s->name, name))
159 logf (LOG_DEBUG, "updating result set %s", name);
163 rset_delete (s->rset);
165 nmem_destroy (s->nmem);
169 logf (LOG_DEBUG, "adding result set %s", name);
170 s = xmalloc (sizeof(*s));
173 s->name = xmalloc (strlen(name)+1);
174 strcpy (s->name, name);
176 s->sort_info = xmalloc (sizeof(*s->sort_info));
177 s->sort_info->max_entries = 1000;
178 s->sort_info->entries =
179 xmalloc (sizeof(*s->sort_info->entries) *
180 s->sort_info->max_entries);
181 s->sort_info->all_entries =
182 xmalloc (sizeof(*s->sort_info->all_entries) *
183 s->sort_info->max_entries);
184 for (i = 0; i < s->sort_info->max_entries; i++)
185 s->sort_info->entries[i] = s->sort_info->all_entries + i;
192 ZebraSet resultSetGet (ZebraHandle zh, const char *name)
196 for (s = zh->sets; s; s = s->next)
197 if (!strcmp (s->name, name))
199 if (!s->rset && s->rpn)
201 NMEM nmem = nmem_create ();
203 rpn_search (zh, nmem, s->rpn, s->num_bases,
204 s->basenames, s->name, s);
214 void resultSetDestroy (ZebraHandle zh)
218 for (s = zh->sets; s; s = s1)
222 xfree (s->sort_info->all_entries);
223 xfree (s->sort_info->entries);
224 xfree (s->sort_info);
227 nmem_destroy (s->nmem);
228 rset_delete (s->rset);
235 ZebraPosSet zebraPosSetCreate (ZebraHandle zh, const char *name,
236 int num, int *positions)
242 struct zset_sort_info *sort_info;
244 if (!(sset = resultSetGet (zh, name)))
246 if (!(rset = sset->rset))
248 sr = xmalloc (sizeof(*sr) * num);
249 for (i = 0; i<num; i++)
254 sort_info = sset->sort_info;
259 for (i = 0; i<num; i++)
261 position = positions[i];
262 if (position > 0 && position <= sort_info->num_entries)
264 logf (LOG_DEBUG, "got pos=%d (sorted)", position);
265 sr[i].sysno = sort_info->entries[position-1]->sysno;
266 sr[i].score = sort_info->entries[position-1]->score;
270 /* did we really get all entries using sort ? */
271 for (i = 0; i<num; i++)
276 if (i < num) /* nope, get the rest, unsorted - sorry */
286 position = sort_info->num_entries;
287 while (num_i < num && positions[num_i] < position)
289 rfd = rset_open (rset, RSETF_READ);
290 while (num_i < num && rset_read (rset, rfd, &key, &term_index))
292 if (key.sysno != psysno)
297 /* determine we alreay have this in our set */
298 for (i = sort_info->num_entries; --i >= 0; )
299 if (psysno == sort_info->entries[i]->sysno)
305 assert (num_i < num);
306 if (position == positions[num_i])
308 sr[num_i].sysno = psysno;
309 logf (LOG_DEBUG, "got pos=%d (unsorted)", position);
310 sr[num_i].score = -1;
315 rset_close (rset, rfd);
320 void zebraPosSetDestroy (ZebraHandle zh, ZebraPosSet records, int num)
330 void resultSetInsertSort (ZebraHandle zh, ZebraSet sset,
331 struct sortKey *criteria, int num_criteria,
334 struct zset_sort_entry this_entry;
335 struct zset_sort_entry *new_entry = NULL;
336 struct zset_sort_info *sort_info = sset->sort_info;
339 sortIdx_sysno (zh->sortIdx, sysno);
340 for (i = 0; i<num_criteria; i++)
342 sortIdx_type (zh->sortIdx, criteria[i].attrUse);
343 sortIdx_read (zh->sortIdx, this_entry.buf[i]);
345 i = sort_info->num_entries;
349 for (j = 0; j<num_criteria; j++)
351 rel = memcmp (this_entry.buf[j], sort_info->entries[i]->buf[j],
358 if (criteria[j].relation == 'A')
363 else if (criteria[j].relation == 'D')
369 j = sort_info->max_entries-1;
373 new_entry = sort_info->entries[j];
376 sort_info->entries[j] = sort_info->entries[j-1];
379 sort_info->entries[j] = new_entry;
381 if (sort_info->num_entries != sort_info->max_entries)
382 (sort_info->num_entries)++;
383 for (i = 0; i<num_criteria; i++)
384 memcpy (new_entry->buf[i], this_entry.buf[i], SORT_IDX_ENTRYSIZE);
385 new_entry->sysno = sysno;
386 new_entry->score = -1;
389 void resultSetInsertRank (ZebraHandle zh, struct zset_sort_info *sort_info,
390 int sysno, int score, int relation)
392 struct zset_sort_entry *new_entry = NULL;
395 i = sort_info->num_entries;
400 rel = score - sort_info->entries[i]->score;
407 else if (relation == 'A')
413 j = sort_info->max_entries-1;
417 new_entry = sort_info->entries[j];
420 sort_info->entries[j] = sort_info->entries[j-1];
423 sort_info->entries[j] = new_entry;
425 if (sort_info->num_entries != sort_info->max_entries)
426 (sort_info->num_entries)++;
427 new_entry->sysno = sysno;
428 new_entry->score = score;
431 void resultSetSort (ZebraHandle zh, NMEM nmem,
432 int num_input_setnames, const char **input_setnames,
433 const char *output_setname,
434 Z_SortKeySpecList *sort_sequence, int *sort_status)
439 if (num_input_setnames == 0)
444 if (num_input_setnames > 1)
449 logf (LOG_DEBUG, "result set sort input=%s output=%s",
450 *input_setnames, output_setname);
451 sset = resultSetGet (zh, input_setnames[0]);
455 zh->errString = nmem_strdup (nmem, input_setnames[0]);
458 if (!(rset = sset->rset))
461 zh->errString = nmem_strdup (nmem, input_setnames[0]);
464 if (strcmp (output_setname, input_setnames[0]))
466 rset = rset_dup (rset);
467 sset = resultSetAdd (zh, output_setname, 1);
470 resultSetSortSingle (zh, nmem, sset, rset, sort_sequence, sort_status);
473 void resultSetSortSingle (ZebraHandle zh, NMEM nmem,
474 ZebraSet sset, RSET rset,
475 Z_SortKeySpecList *sort_sequence, int *sort_status)
479 struct sortKey sort_criteria[3];
484 logf (LOG_DEBUG, "resultSetSortSingle start");
485 sset->sort_info->num_entries = 0;
488 num_criteria = sort_sequence->num_specs;
489 if (num_criteria > 3)
491 for (i = 0; i < num_criteria; i++)
493 Z_SortKeySpec *sks = sort_sequence->specs[i];
496 if (*sks->sortRelation == Z_SortRelation_ascending)
497 sort_criteria[i].relation = 'A';
498 else if (*sks->sortRelation == Z_SortRelation_descending)
499 sort_criteria[i].relation = 'D';
505 if (sks->sortElement->which == Z_SortElement_databaseSpecific)
510 else if (sks->sortElement->which != Z_SortElement_generic)
515 sk = sks->sortElement->u.generic;
518 case Z_SortKey_sortField:
519 logf (LOG_DEBUG, "Sort: key %d is of type sortField", i+1);
522 case Z_SortKey_elementSpec:
523 logf (LOG_DEBUG, "Sort: key %d is of type elementSpec", i+1);
526 case Z_SortKey_sortAttributes:
527 logf (LOG_DEBUG, "Sort: key %d is of type sortAttributes", i+1);
528 sort_criteria[i].attrUse =
529 zebra_maps_sort (zh->zebra_maps, sk->u.sortAttributes);
530 logf (LOG_DEBUG, "use value = %d", sort_criteria[i].attrUse);
531 if (sort_criteria[i].attrUse == -1)
536 if (sortIdx_type (zh->sortIdx, sort_criteria[i].attrUse))
544 rfd = rset_open (rset, RSETF_READ);
545 while (rset_read (rset, rfd, &key, &term_index))
547 if (key.sysno != psysno)
551 resultSetInsertSort (zh, sset,
552 sort_criteria, num_criteria, psysno);
555 rset_close (rset, rfd);
558 *sort_status = Z_SortStatus_success;
559 logf (LOG_DEBUG, "resultSetSortSingle end");
562 RSET resultSetRef (ZebraHandle zh, Z_ResultSetId *resultSetId)
566 if ((s = resultSetGet (zh, resultSetId)))
571 void resultSetRank (ZebraHandle zh, ZebraSet zebraSet, RSET rset)
577 ZebraRankClass rank_class;
578 struct rank_control *rc;
579 struct zset_sort_info *sort_info;
581 sort_info = zebraSet->sort_info;
582 sort_info->num_entries = 0;
584 rfd = rset_open (rset, RSETF_READ);
586 logf (LOG_DEBUG, "resultSetRank");
587 for (i = 0; i < rset->no_rset_terms; i++)
588 logf (LOG_DEBUG, "term=\"%s\" cnt=%d type=%s",
589 rset->rset_terms[i]->name,
590 rset->rset_terms[i]->nn,
591 rset->rset_terms[i]->flags);
593 rank_class = zebraRankLookup (zh, "rank-1");
594 rc = rank_class->control;
596 if (rset_read (rset, rfd, &key, &term_index))
598 int psysno = key.sysno;
601 (*rc->begin) (zh, rank_class->class_handle, rset);
606 if (key.sysno != psysno)
608 score = (*rc->calc) (handle, psysno);
610 resultSetInsertRank (zh, sort_info, psysno, score, 'A');
614 (*rc->add) (handle, key.seqno, term_index);
616 while (rset_read (rset, rfd, &key, &term_index));
617 score = (*rc->calc) (handle, psysno);
618 resultSetInsertRank (zh, sort_info, psysno, score, 'A');
619 (*rc->end) (zh, handle);
621 rset_close (rset, rfd);
622 logf (LOG_DEBUG, "%d keys, %d distinct sysnos", kno, zebraSet->hits);
625 ZebraRankClass zebraRankLookup (ZebraHandle zh, const char *name)
627 ZebraRankClass p = zh->rank_classes;
628 while (p && strcmp (p->control->name, name))
630 if (p && !p->init_flag)
632 if (p->control->create)
633 p->class_handle = (*p->control->create)(zh);
639 void zebraRankInstall (ZebraHandle zh, struct rank_control *ctrl)
641 ZebraRankClass p = xmalloc (sizeof(*p));
642 p->control = xmalloc (sizeof(*p->control));
643 memcpy (p->control, ctrl, sizeof(*p->control));
644 p->control->name = xstrdup (ctrl->name);
646 p->next = zh->rank_classes;
647 zh->rank_classes = p;
650 void zebraRankDestroy (ZebraHandle zh)
652 ZebraRankClass p = zh->rank_classes;
655 ZebraRankClass p_next = p->next;
656 if (p->init_flag && p->control->destroy)
657 (*p->control->destroy)(zh, p->class_handle);
658 xfree (p->control->name);
663 zh->rank_classes = NULL;