1 /* This file is part of the Zebra server.
2 Copyright (C) 1994-2009 Index Data
4 Zebra is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
9 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
33 #include <yaz/diagbib1.h>
34 #include <yaz/snprintf.h>
36 #include <yaz/oid_db.h>
37 #include <zebra_strmap.h>
39 #define MAX_SYSNOS_PER_RECORD 40
41 #define ZEBRA_XML_HEADER_STR "<record xmlns=\"http://www.indexdata.com/zebra/\""
43 struct special_fetch_s {
51 static int zebra_create_record_stream(ZebraHandle zh,
53 struct ZebraRecStream *stream)
55 RecordAttr *recordAttr = rec_init_attr(zh->reg->zei, *rec);
57 if ((*rec)->size[recInfo_storeData] > 0
58 || (*rec)->info[recInfo_filename] == 0)
59 zebra_create_stream_mem(stream, (*rec)->info[recInfo_storeData],
60 (*rec)->size[recInfo_storeData]);
66 if (zh->path_reg && !yaz_is_abspath((*rec)->info[recInfo_filename])){
67 strcpy(full_rep, zh->path_reg);
68 strcat(full_rep, "/");
69 strcat(full_rep, (*rec)->info[recInfo_filename]);
72 strcpy(full_rep, (*rec)->info[recInfo_filename]);
74 if ((fd = open(full_rep, O_BINARY|O_RDONLY)) == -1){
75 yaz_log(YLOG_WARN|YLOG_ERRNO, "Retrieve fail; missing file: %s",
78 return YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
80 zebra_create_stream_fd(stream, fd, recordAttr->recordOffset);
87 const char *index_name;
88 const char *index_type;
90 struct index_spec *next;
94 struct index_spec *parse_index_spec(const char *elem, NMEM nmem,
97 struct index_spec *first = 0;
98 struct index_spec **last = &first;
99 const char *cp = elem;
102 if (cp[0] == ':' && cp[1] == ':')
105 cp++; /* skip first ':' */
110 struct index_spec *spec = nmem_malloc(nmem, sizeof(*spec));
111 spec->index_type = 0;
120 cp++; /* skip ',' or second ':' */
122 while (*cp != ':' && *cp != '\0' && *cp != ',')
124 spec->index_name = nmem_strdupn(nmem, cp0, cp - cp0);
125 if (*cp == ':') /* type as well */
130 while (*cp != '\0' && *cp != ',' && *cp != ':')
132 spec->index_type = nmem_strdupn(nmem, cp0, cp - cp0);
134 if (*cp == ':') /* extra arguments */
139 while (*cp != '\0' && *cp != ',' && *cp != ':')
141 spec->extra = nmem_strdupn(nmem, cp0, cp - cp0);
152 static int parse_zebra_elem(const char *elem,
153 const char **index, size_t *index_len,
154 const char **type, size_t *type_len)
165 /* verify that '::' is in the beginning of *elem
166 and something more follows */
168 || !(elem +1) || ':' != *(elem +1)
169 || !(elem +2) || '\0' == *(elem +2))
172 /* pick out info from string after '::' */
174 cp = strchr(elem, ':');
176 if (!cp) /* index, no colon, no type */
179 *index_len = strlen(elem);
181 else if (cp[1] == '\0') /* colon, but no following type */
185 else /* index, colon and type */
188 *index_len = cp - elem;
190 *type_len = strlen(cp+1);
197 static int sort_fetch(
198 struct special_fetch_s *fi, const char *elemsetname,
199 const Odr_oid *input_format,
200 const Odr_oid **output_format,
201 WRBUF result, WRBUF addinfo)
203 const char *retrieval_index;
204 size_t retrieval_index_len;
205 const char *retrieval_type;
206 size_t retrieval_type_len;
207 char retrieval_index_cstr[256];
208 char retrieval_type_cstr[256];
210 ZebraHandle zh = fi->zh;
212 if (!parse_zebra_elem(elemsetname,
213 &retrieval_index, &retrieval_index_len,
214 &retrieval_type, &retrieval_type_len))
216 return YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
219 if (retrieval_type_len == 0)
220 return -1; /* must have a register type specified */
221 if (!retrieval_index_len ||
222 retrieval_index_len >= sizeof(retrieval_index_cstr)-1)
224 return YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
227 memcpy(retrieval_index_cstr, retrieval_index, retrieval_index_len);
228 retrieval_index_cstr[retrieval_index_len] = '\0';
230 memcpy(retrieval_type_cstr, retrieval_type, retrieval_type_len);
231 retrieval_type_cstr[retrieval_type_len] = '\0';
233 ord = zebraExplain_lookup_attr_str(zh->reg->zei,
234 zinfo_index_category_sort,
236 retrieval_index_cstr);
238 return -1; /* is not a sort index */
241 WRBUF wrbuf_str = wrbuf_alloc();
242 const char *index_type;
244 const char *string_index = 0;
245 WRBUF wrbuf_result = result;
248 zebraExplain_lookup_ord(zh->reg->zei, ord, &index_type, &db,
250 if (!oid_oidcmp(input_format, yaz_oid_recsyn_xml))
252 *output_format = yaz_oid_recsyn_xml;
253 wrbuf_printf(wrbuf_result, ZEBRA_XML_HEADER_STR
254 " sysno=\"" ZINT_FORMAT "\""
255 " set=\"zebra::index%s/\">\n",
256 fi->sysno, elemsetname);
258 else if (!oid_oidcmp(input_format, yaz_oid_recsyn_sutrs))
260 *output_format = yaz_oid_recsyn_sutrs;
264 yaz_log(YLOG_WARN, "unsupported format for element set zebra::%s",
267 wrbuf_destroy(wrbuf_str);
268 return YAZ_BIB1_NO_SYNTAXES_AVAILABLE_FOR_THIS_REQUEST;
270 zebra_sort_type(zh->reg->sort_index, ord);
271 zebra_sort_sysno(zh->reg->sort_index, fi->sysno);
272 zebra_sort_read(zh->reg->sort_index, 0, wrbuf_str);
274 while (off != wrbuf_len(wrbuf_str))
276 char dst_buf[IT_MAX_WORD];
277 assert(off < wrbuf_len(wrbuf_str));
278 zebra_term_untrans(zh, index_type, dst_buf,
279 wrbuf_buf(wrbuf_str)+off);
281 if (!oid_oidcmp(input_format, yaz_oid_recsyn_xml))
283 wrbuf_printf(wrbuf_result, " <index name=\"%s\"",
285 wrbuf_printf(wrbuf_result, " type=\"%s\">", index_type);
286 wrbuf_xmlputs(wrbuf_result, dst_buf);
287 wrbuf_printf(wrbuf_result, "</index>\n");
289 else if (!oid_oidcmp(input_format, yaz_oid_recsyn_sutrs))
291 wrbuf_printf(wrbuf_result, "%s %s %s\n", string_index, index_type,
294 off += strlen(wrbuf_buf(wrbuf_str)+off) + 1;
296 if (!oid_oidcmp(input_format, yaz_oid_recsyn_xml))
298 wrbuf_printf(wrbuf_result, "</record>\n");
300 wrbuf_destroy(wrbuf_str);
305 static int special_index_fetch(
306 struct special_fetch_s *fi, const char *elemsetname,
307 const Odr_oid *input_format,
308 const Odr_oid **output_format,
309 WRBUF result, WRBUF addinfo,
312 const char *retrieval_index;
313 size_t retrieval_index_len;
314 const char *retrieval_type;
315 size_t retrieval_type_len;
316 zebra_rec_keys_t keys;
318 char retrieval_type_cstr[256];
319 ZebraHandle zh = fi->zh;
321 /* set output variables before processing possible error states */
324 /* only accept XML and SUTRS requests */
325 if (oid_oidcmp(input_format, yaz_oid_recsyn_xml)
326 && oid_oidcmp(input_format, yaz_oid_recsyn_sutrs))
328 yaz_log(YLOG_WARN, "unsupported format for element set zebra::%s",
331 return YAZ_BIB1_NO_SYNTAXES_AVAILABLE_FOR_THIS_REQUEST;
334 if (!parse_zebra_elem(elemsetname,
335 &retrieval_index, &retrieval_index_len,
336 &retrieval_type, &retrieval_type_len))
337 return YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
339 if (retrieval_type_len)
341 memcpy(retrieval_type_cstr, retrieval_type, retrieval_type_len);
342 retrieval_type_cstr[retrieval_type_len] = '\0';
345 if (retrieval_index_len)
347 char retrieval_index_cstr[256];
349 if (retrieval_index_len < sizeof(retrieval_index_cstr) -1)
351 memcpy(retrieval_index_cstr, retrieval_index, retrieval_index_len);
352 retrieval_index_cstr[retrieval_index_len] = '\0';
354 if (zebraExplain_lookup_attr_str(zh->reg->zei,
355 zinfo_index_category_index,
356 (retrieval_type_len == 0 ? 0 :
357 retrieval_type_cstr),
358 retrieval_index_cstr) == -1)
359 return YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
363 keys = zebra_rec_keys_open();
364 zebra_rec_keys_set_buf(keys, rec->info[recInfo_delKeys],
365 rec->size[recInfo_delKeys], 0);
367 if (!zebra_rec_keys_rewind(keys))
369 ret_code = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
375 struct it_key key_in;
376 WRBUF wrbuf = result;
378 if (!oid_oidcmp(input_format, yaz_oid_recsyn_xml))
380 *output_format = input_format;
381 wrbuf_printf(wrbuf, ZEBRA_XML_HEADER_STR
382 " sysno=\"" ZINT_FORMAT "\""
383 " set=\"zebra::index%s/\">\n",
384 fi->sysno, elemsetname);
386 else if (!oid_oidcmp(input_format, yaz_oid_recsyn_sutrs))
387 *output_format = input_format;
389 while (zebra_rec_keys_read(keys, &str, &slen, &key_in))
392 int ord = CAST_ZINT_TO_INT(key_in.mem[0]);
393 const char *index_type;
395 const char *string_index = 0;
396 size_t string_index_len;
397 char dst_buf[IT_MAX_WORD];
399 zebraExplain_lookup_ord(zh->reg->zei, ord, &index_type, &db,
401 string_index_len = strlen(string_index);
403 /* process only if index is not defined,
404 or if defined and matching */
405 if (retrieval_index == 0
406 || (string_index_len == retrieval_index_len
407 && !memcmp(string_index, retrieval_index,
410 /* process only if type is not defined, or is matching */
411 if (retrieval_type == 0
412 || !strcmp(retrieval_type_cstr, index_type))
414 if (zebra_term_untrans(zh, index_type, dst_buf, str))
415 *dst_buf = '\0'; /* untrans failed */
417 if (!oid_oidcmp(input_format, yaz_oid_recsyn_xml))
419 wrbuf_printf(wrbuf, " <index name=\"%s\"",
422 wrbuf_printf(wrbuf, " type=\"%s\"", index_type);
424 wrbuf_printf(wrbuf, " seq=\"" ZINT_FORMAT "\">",
425 key_in.mem[key_in.len -1]);
426 wrbuf_xmlputs(wrbuf, dst_buf);
427 wrbuf_printf(wrbuf, "</index>\n");
431 wrbuf_printf(wrbuf, "%s ", string_index);
433 wrbuf_printf(wrbuf, "%s", index_type);
435 for (i = 1; i < key_in.len; i++)
436 wrbuf_printf(wrbuf, " " ZINT_FORMAT,
439 wrbuf_printf(wrbuf, " %s", dst_buf);
441 wrbuf_printf(wrbuf, "\n");
448 if (!oid_oidcmp(input_format, yaz_oid_recsyn_xml))
449 wrbuf_printf(wrbuf, "</record>\n");
451 zebra_rec_keys_close(keys);
456 static void retrieve_puts_attr(WRBUF wrbuf, const char *name,
461 wrbuf_printf(wrbuf, " %s=\"", name);
462 wrbuf_xmlputs(wrbuf, value);
463 wrbuf_printf(wrbuf, "\"");
467 static void retrieve_puts_attr_int(WRBUF wrbuf, const char *name,
470 wrbuf_printf(wrbuf, " %s=\"%i\"", name, value);
473 static void retrieve_puts_str(WRBUF wrbuf, const char *name,
477 wrbuf_printf(wrbuf, "%s %s\n", name, value);
480 static void retrieve_puts_int(WRBUF wrbuf, const char *name,
483 wrbuf_printf(wrbuf, "%s %i\n", name, value);
487 static void snippet_check_fields(ZebraHandle zh, WRBUF wrbuf,
489 const zebra_snippet_word *doc_w,
490 const char *w_index_type)
492 /* beginning of snippet. See which fields the snippet also
494 const zebra_snippet_word *w;
496 for (w = zebra_snippets_constlist(doc); w; w = w->next)
498 /* same sequence but other field? */
499 if (w->seqno == doc_w->seqno && w->ord != doc_w->ord)
501 const char *index_type;
503 const char *string_index = 0;
505 zebraExplain_lookup_ord(zh->reg->zei, w->ord,
506 &index_type, &db, &string_index);
507 /* only report for same index type */
508 if (!strcmp(w_index_type, index_type))
511 wrbuf_printf(wrbuf, " fields=\"%s", string_index);
513 wrbuf_printf(wrbuf, " %s", string_index);
519 wrbuf_printf(wrbuf, "\"");
522 static void snippet_xml_record(ZebraHandle zh, WRBUF wrbuf, zebra_snippets *doc)
524 const zebra_snippet_word *doc_w;
527 wrbuf_printf(wrbuf, "%s>\n", ZEBRA_XML_HEADER_STR);
528 for (doc_w = zebra_snippets_constlist(doc); doc_w; doc_w = doc_w->next)
532 const char *index_type;
534 const char *string_index = 0;
536 zebraExplain_lookup_ord(zh->reg->zei, doc_w->ord,
537 &index_type, &db, &string_index);
542 wrbuf_printf(wrbuf, " <snippet name=\"%s\"", string_index);
543 wrbuf_printf(wrbuf, " type=\"%s\"", index_type);
544 snippet_check_fields(zh, wrbuf, doc, doc_w, index_type);
545 wrbuf_printf(wrbuf, ">");
548 wrbuf_puts(wrbuf, "<s>");
549 /* not printing leading ws */
550 if (mark_state || !doc_w->ws || doc_w->match)
551 wrbuf_xmlputs(wrbuf, doc_w->term);
553 wrbuf_puts(wrbuf, "</s>");
555 else if (mark_state == 1)
557 wrbuf_puts(wrbuf, "</snippet>\n");
559 mark_state = doc_w->mark;
563 wrbuf_puts(wrbuf, "</snippet>\n");
565 wrbuf_printf(wrbuf, "</record>");
568 int zebra_get_rec_snippets(ZebraHandle zh, zint sysno,
569 zebra_snippets *snippets)
572 Record rec = rec_get(zh->reg->records, sysno);
575 yaz_log(YLOG_WARN, "rec_get fail on sysno=" ZINT_FORMAT, sysno);
576 return_code = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
580 const char *file_type = rec->info[recInfo_fileType];
581 void *recTypeClientData;
582 RecType rt = recType_byName(zh->reg->recTypes, zh->res,
583 file_type, &recTypeClientData);
586 return_code = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
589 struct ZebraRecStream stream;
590 return_code = zebra_create_record_stream(zh, &rec, &stream);
591 if (return_code == 0)
593 extract_snippet(zh, snippets, &stream,
594 rt, recTypeClientData);
596 stream.destroy(&stream);
604 static int snippet_fetch(
605 struct special_fetch_s *fi, const char *elemsetname,
606 const Odr_oid *input_format,
607 const Odr_oid **output_format,
608 WRBUF result, WRBUF addinfo)
610 ZebraHandle zh = fi->zh;
611 zebra_snippets *rec_snippets = zebra_snippets_create();
612 int return_code = zebra_get_rec_snippets(zh, fi->sysno, rec_snippets);
616 WRBUF wrbuf = result;
617 zebra_snippets *hit_snippet = zebra_snippets_create();
619 zebra_snippets_hit_vector(zh, fi->setname, fi->sysno, hit_snippet);
622 /* for debugging purposes */
623 yaz_log(YLOG_LOG, "---------------------------");
624 yaz_log(YLOG_LOG, "REC SNIPPET:");
625 zebra_snippets_log(rec_snippets, YLOG_LOG, 1);
626 yaz_log(YLOG_LOG, "---------------------------");
627 yaz_log(YLOG_LOG, "HIT SNIPPET:");
628 zebra_snippets_log(hit_snippet, YLOG_LOG, 1);
631 zebra_snippets_ring(rec_snippets, hit_snippet, 5, 5);
634 yaz_log(YLOG_LOG, "---------------------------");
635 yaz_log(YLOG_LOG, "RING SNIPPET:");
636 zebra_snippets_log(rec_snippets, YLOG_LOG, 1);
638 snippet_xml_record(zh, wrbuf, rec_snippets);
640 *output_format = yaz_oid_recsyn_xml;
642 zebra_snippets_destroy(hit_snippet);
644 zebra_snippets_destroy(rec_snippets);
648 struct term_collect {
654 static zint freq_term(ZebraHandle zh, int ord, const char *term, RSET rset_set)
656 struct rset_key_control *kc = zebra_key_control_create(zh);
657 char ord_buf[IT_MAX_WORD];
658 int ord_len = key_SU_encode(ord, ord_buf);
661 NMEM nmem = nmem_create();
663 strcpy(ord_buf + ord_len, term);
665 info = dict_lookup(zh->reg->dict, ord_buf);
670 memcpy(&isam_p, info+1, sizeof(ISAM_P));
672 rsets[0] = zebra_create_rset_isam(zh, nmem, kc, kc->scope, isam_p, 0);
673 rsets[1] = rset_dup(rset_set);
675 rset = rset_create_and(nmem, kc, kc->scope, 2, rsets);
677 zebra_count_set(zh, rset, &hits, zh->approx_limit);
679 rset_delete(rsets[0]);
687 static int term_qsort_handle(const void *a, const void *b)
689 const struct term_collect *l = a;
690 const struct term_collect *r = b;
691 if (l->set_occur < r->set_occur)
693 else if (l->set_occur > r->set_occur)
697 const char *lterm = l->term ? l->term : "";
698 const char *rterm = r->term ? r->term : "";
699 return strcmp(lterm, rterm);
703 static void term_collect_freq(ZebraHandle zh,
704 struct term_collect *col, int no_terms_collect,
705 int ord, RSET rset, double scale_factor)
708 for (i = 0; i < no_terms_collect; i++)
712 if (scale_factor < 0.0)
714 col[i].set_occur = freq_term(zh, ord, col[i].term, rset);
717 col[i].set_occur = scale_factor * col[i].oc;
720 qsort(col, no_terms_collect, sizeof(*col), term_qsort_handle);
723 static struct term_collect *term_collect_create(zebra_strmap_t sm,
724 int no_terms_collect,
731 struct term_collect *col = nmem_malloc(nmem,
732 sizeof *col *no_terms_collect);
734 for (i = 0; i < no_terms_collect; i++)
738 col[i].set_occur = 0;
740 /* iterate over terms and collect the most frequent ones */
741 it = zebra_strmap_it_create(sm);
742 while ((term = zebra_strmap_it_next(it, &data_buf, &data_len)))
745 col[0] has lowest oc . col[no_terms_collect-1] has highest oc */
746 int oc = *(int*) data_buf;
748 /* insertion may be slow but terms terms will be "infrequent" and
749 thus number of iterations should be small below
751 while (j < no_terms_collect && oc > col[j].oc)
754 { /* oc <= col[j] and oc > col[j-1] */
756 memmove(col, col+1, sizeof(*col) * j);
761 zebra_strmap_it_destroy(it);
765 static int perform_facet_sort(ZebraHandle zh, int no_ord, int *ord_array,
766 zebra_strmap_t *map_array,
767 int num_recs, ZebraMetaRecord *poset)
770 WRBUF w = wrbuf_alloc();
773 for (ord_i = 0; ord_i < no_ord; ord_i++)
775 for (rec_i = 0; rec_i < num_recs; rec_i++)
777 if (!poset[rec_i].sysno)
780 zebra_sort_sysno(zh->reg->sort_index, poset[rec_i].sysno);
781 zebra_sort_type(zh->reg->sort_index, ord_array[ord_i]);
784 if (zebra_sort_read(zh->reg->sort_index, 0, w))
786 zebra_strmap_t sm = map_array[ord_i];
788 while (off != wrbuf_len(w))
790 const char *str = wrbuf_buf(w) + off;
791 int *freq = zebra_strmap_lookup(sm, str, 0, 0);
797 zebra_strmap_add(sm, str, &v, sizeof v);
799 off += strlen(str)+1;
809 static int perform_facet_index(ZebraHandle zh,
810 struct special_fetch_s *fi,
811 int no_ord, int *ord_array,
812 zebra_strmap_t *map_array,
813 int num_recs, ZebraMetaRecord *poset,
814 struct index_spec *spec_list)
818 res_get_int(zh->res, "facetMaxChunks", &max_chunks);
820 for (rec_i = 0; rec_i < num_recs; rec_i++)
824 zint sysnos[MAX_SYSNOS_PER_RECORD];
825 int no_sysnos = MAX_SYSNOS_PER_RECORD;
826 if (!poset[rec_i].sysno)
828 ret = zebra_result_recid_to_sysno(zh, fi->setname,
831 assert(no_sysnos > 0);
832 yaz_log(YLOG_DEBUG, "Analyzing rec=%d ISAM sysno=" ZINT_FORMAT " chunks=%d",
833 rec_i, poset[rec_i].sysno, no_sysnos);
834 for (j = 0; j < no_sysnos && j < max_chunks; j++)
838 struct it_key key_in;
839 Record rec = rec_get(zh->reg->records, sysnos[j]);
840 zebra_rec_keys_t keys = zebra_rec_keys_open();
841 zebra_rec_keys_set_buf(keys, rec->info[recInfo_delKeys],
842 rec->size[recInfo_delKeys], 0);
844 yaz_log(YLOG_DEBUG, "rec %d " ZINT_FORMAT " %s",
845 j, sysnos[j], zebra_rec_keys_empty(keys) ? "empty" : "non-empty");
846 if (zebra_rec_keys_rewind(keys))
848 while (zebra_rec_keys_read(keys, &str, &slen, &key_in))
851 struct index_spec *spec;
852 for (spec = spec_list, ord_i = 0; ord_i < no_ord;
853 ord_i++, spec = spec->next)
855 int ord = CAST_ZINT_TO_INT(key_in.mem[0]);
856 if (ord == ord_array[ord_i] &&
857 str[0] != FIRST_IN_FIELD_CHAR)
860 zebra_strmap_t sm = map_array[ord_i];
862 freq = zebra_strmap_lookup(sm, str, 0, 0);
868 zebra_strmap_add(sm, str, &v, sizeof v);
874 zebra_rec_keys_close(keys);
881 static int perform_facet(ZebraHandle zh,
882 struct special_fetch_s *fi,
884 int num_recs, ZebraMetaRecord *poset,
885 struct index_spec *spec_list,
886 int no_ord, int *ord_array,
888 zinfo_index_category_t cat)
893 struct index_spec *spec;
894 yaz_timing_t timing = yaz_timing_create();
895 zebra_strmap_t *map_array
896 = nmem_malloc(fi->nmem, sizeof *map_array * no_ord);
897 for (i = 0; i < no_ord; i++)
898 map_array[i] = zebra_strmap_create();
900 if (cat == zinfo_index_category_sort)
901 perform_facet_sort(zh, no_ord, ord_array, map_array,
904 perform_facet_index(zh, fi, no_ord, ord_array, map_array,
905 num_recs, poset, spec_list);
906 yaz_timing_stop(timing);
907 yaz_log(YLOG_LOG, "facet first phase real=%4.2f cat=%s",
908 yaz_timing_get_real(timing),
909 (cat == zinfo_index_category_sort) ? "sort" : "index");
910 yaz_timing_start(timing);
911 for (spec = spec_list, i = 0; i < no_ord; i++, spec = spec->next)
914 NMEM nmem = nmem_create();
915 struct term_collect *col;
916 int no_collect_terms = 20;
919 no_collect_terms = atoi(spec->extra);
920 if (no_collect_terms < 1)
921 no_collect_terms = 1;
922 col = term_collect_create(map_array[i], no_collect_terms, nmem);
923 term_collect_freq(zh, col, no_collect_terms, ord_array[i],
924 resultSetRef(zh, fi->setname),
925 cat == zinfo_index_category_sort ? 1.0 : -1.0);
928 wrbuf_printf(wr, " <facet type=\"%s\" index=\"%s\">\n",
929 spec->index_type, spec->index_name);
931 wrbuf_printf(wr, "facet %s %s\n",
932 spec->index_type, spec->index_name);
933 for (j = 0; j < no_collect_terms; j++)
937 char dst_buf[IT_MAX_WORD];
938 zebra_term_untrans(zh, spec->index_type, dst_buf, col[j].term);
941 wrbuf_printf(wr, " <term coccur=\"%d\"", col[j].oc);
942 if (col[j].set_occur)
943 wrbuf_printf(wr, " occur=\"" ZINT_FORMAT "\"",
945 wrbuf_printf(wr, ">");
946 wrbuf_xmlputs(wr, dst_buf);
947 wrbuf_printf(wr, "</term>\n");
951 wrbuf_printf(wr, "term %d", col[j].oc);
952 if (col[j].set_occur)
953 wrbuf_printf(wr, " " ZINT_FORMAT,
955 wrbuf_printf(wr, ": %s\n", dst_buf);
960 wrbuf_puts(wr, " </facet>\n");
963 for (i = 0; i < no_ord; i++)
964 zebra_strmap_destroy(map_array[i]);
965 yaz_timing_stop(timing);
966 yaz_log(YLOG_LOG, "facet second phase real=%4.2f",
967 yaz_timing_get_real(timing));
968 yaz_timing_destroy(&timing);
972 static int facet_fetch(
973 struct special_fetch_s *fi, const char *elemsetname,
974 const Odr_oid *input_format,
975 const Odr_oid **output_format,
976 WRBUF result, WRBUF addinfo)
980 int num_recs = 10; /* number of records to analyze */
981 ZebraMetaRecord *poset;
982 ZEBRA_RES ret = ZEBRA_OK;
986 struct index_spec *spec, *spec_list;
988 ZebraHandle zh = fi->zh;
989 /* whether sort or index based */
990 zinfo_index_category_t cat = zinfo_index_category_sort;
992 /* see if XML is required for response */
993 if (oid_oidcmp(input_format, yaz_oid_recsyn_xml) == 0)
996 spec_list = parse_index_spec(elemsetname, fi->nmem, &error);
998 if (!spec_list || error)
1000 return YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
1003 for (spec = spec_list; spec; spec = spec->next)
1005 if (!spec->index_type)
1006 return YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
1010 /* try to see if all specs are sort based.. If not, try the
1012 ord_array = nmem_malloc(fi->nmem, sizeof(*ord_array) * no_ord);
1014 for (spec = spec_list, i = 0; spec; spec = spec->next, i++)
1016 int ord = zebraExplain_lookup_attr_str(zh->reg->zei,
1017 zinfo_index_category_sort,
1027 cat = zinfo_index_category_index;
1028 for (spec = spec_list, i = 0; spec; spec = spec->next, i++)
1030 int ord = zebraExplain_lookup_attr_str(zh->reg->zei,
1031 zinfo_index_category_index,
1041 return YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
1043 res_get_int(zh->res, "facetNumRecs", &num_recs);
1045 pos_array = (zint *) nmem_malloc(fi->nmem, num_recs * sizeof(*pos_array));
1046 for (i = 0; i < num_recs; i++)
1048 poset = zebra_meta_records_create(zh, fi->setname, num_recs, pos_array);
1051 wrbuf_puts(addinfo, fi->setname);
1052 return YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST;
1058 wrbuf_printf(result, ZEBRA_XML_HEADER_STR ">\n");
1060 ret = perform_facet(zh, fi, result, num_recs, poset,
1061 spec_list, no_ord, ord_array, use_xml,
1064 wrbuf_puts(result, "</record>\n");
1066 *output_format = yaz_oid_recsyn_xml;
1067 zebra_meta_records_destroy(zh, poset, num_recs);
1072 static int zebra_special_fetch(
1073 void *handle, const char *elemsetname,
1074 const Odr_oid *input_format,
1075 const Odr_oid **output_format,
1076 WRBUF result, WRBUF addinfo)
1079 struct special_fetch_s *fi = (struct special_fetch_s *) handle;
1080 ZebraHandle zh = fi->zh;
1081 zint sysno = fi->sysno;
1083 /* processing zebra::facet */
1084 if (elemsetname && 0 == strncmp(elemsetname, "facet", 5))
1086 return facet_fetch(fi, elemsetname + 5,
1087 input_format, output_format,
1091 if (elemsetname && 0 == strcmp(elemsetname, "snippet"))
1093 return snippet_fetch(fi, elemsetname + 7,
1094 input_format, output_format,
1098 /* processing zebra::meta::sysno */
1099 if (elemsetname && 0 == strcmp(elemsetname, "meta::sysno"))
1102 if (!oid_oidcmp(input_format, yaz_oid_recsyn_sutrs))
1104 wrbuf_printf(result, ZINT_FORMAT, fi->sysno);
1105 *output_format = input_format;
1107 else if (!oid_oidcmp(input_format, yaz_oid_recsyn_xml))
1109 wrbuf_printf(result, ZEBRA_XML_HEADER_STR
1110 " sysno=\"" ZINT_FORMAT "\"/>\n",
1112 *output_format = input_format;
1115 ret = YAZ_BIB1_NO_SYNTAXES_AVAILABLE_FOR_THIS_REQUEST;
1119 /* processing special elementsetname zebra::index:: for sort elements */
1120 if (elemsetname && 0 == strncmp(elemsetname, "index", 5))
1122 int ret = sort_fetch(
1123 fi, elemsetname + 5,
1124 input_format, output_format,
1128 /* not a sort index so we continue to get the full record */
1132 /* fetching binary record up for all other display elementsets */
1133 rec = rec_get(zh->reg->records, sysno);
1136 yaz_log(YLOG_WARN, "rec_get fail on sysno=" ZINT_FORMAT, sysno);
1137 return YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1140 /* processing special elementsetnames zebra::data */
1141 if (elemsetname && 0 == strcmp(elemsetname, "data"))
1143 struct ZebraRecStream stream;
1144 RecordAttr *recordAttr = rec_init_attr(zh->reg->zei, rec);
1147 zebra_create_record_stream(zh, &rec, &stream);
1148 *output_format = input_format;
1150 b = nmem_malloc(fi->nmem, recordAttr->recordSize);
1151 stream.readf(&stream, b, recordAttr->recordSize);
1152 wrbuf_write(result, b, recordAttr->recordSize);
1154 stream.destroy(&stream);
1159 /* processing special elementsetnames zebra::meta:: */
1160 if (elemsetname && 0 == strcmp(elemsetname, "meta"))
1163 RecordAttr *recordAttr = rec_init_attr(zh->reg->zei, rec);
1165 if (!oid_oidcmp(input_format, yaz_oid_recsyn_xml))
1167 *output_format = input_format;
1169 wrbuf_printf(result, ZEBRA_XML_HEADER_STR
1170 " sysno=\"" ZINT_FORMAT "\"", sysno);
1171 retrieve_puts_attr(result, "base", rec->info[recInfo_databaseName]);
1172 retrieve_puts_attr(result, "file", rec->info[recInfo_filename]);
1173 retrieve_puts_attr(result, "type", rec->info[recInfo_fileType]);
1175 retrieve_puts_attr_int(result, "score", fi->score);
1177 wrbuf_printf(result,
1178 " rank=\"" ZINT_FORMAT "\""
1180 " set=\"zebra::%s\"/>\n",
1181 recordAttr->staticrank,
1182 recordAttr->recordSize,
1185 else if (!oid_oidcmp(input_format, yaz_oid_recsyn_sutrs))
1187 *output_format = input_format;
1188 wrbuf_printf(result, "sysno " ZINT_FORMAT "\n", sysno);
1189 retrieve_puts_str(result, "base", rec->info[recInfo_databaseName]);
1190 retrieve_puts_str(result, "file", rec->info[recInfo_filename]);
1191 retrieve_puts_str(result, "type", rec->info[recInfo_fileType]);
1193 retrieve_puts_int(result, "score", fi->score);
1195 wrbuf_printf(result,
1196 "rank " ZINT_FORMAT "\n"
1199 recordAttr->staticrank,
1200 recordAttr->recordSize,
1204 ret = YAZ_BIB1_NO_SYNTAXES_AVAILABLE_FOR_THIS_REQUEST;
1210 /* processing special elementsetnames zebra::index:: */
1211 if (elemsetname && 0 == strncmp(elemsetname, "index", 5))
1213 int ret = special_index_fetch(
1214 fi, elemsetname + 5,
1215 input_format, output_format,
1216 result, addinfo, rec);
1223 return YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
1226 int zebra_record_fetch(ZebraHandle zh, const char *setname,
1227 zint sysno, int score,
1229 const Odr_oid *input_format, Z_RecordComposition *comp,
1230 const Odr_oid **output_format,
1231 char **rec_bufp, int *rec_lenp, char **basenamep,
1235 char *fname, *file_type, *basename;
1236 const char *elemsetname;
1237 struct ZebraRecStream stream;
1238 RecordAttr *recordAttr;
1240 int return_code = 0;
1241 zint sysnos[MAX_SYSNOS_PER_RECORD];
1242 int no_sysnos = MAX_SYSNOS_PER_RECORD;
1244 struct special_fetch_s fetch_info;
1246 res = zebra_result_recid_to_sysno(zh, setname, sysno, sysnos, &no_sysnos);
1247 if (res != ZEBRA_OK)
1252 elemsetname = yaz_get_esn(comp);
1255 fetch_info.setname = setname;
1256 fetch_info.sysno = sysno;
1257 fetch_info.score = score;
1258 fetch_info.nmem = odr->mem;
1260 /* processing zebra special elementset names of form 'zebra:: */
1261 if (elemsetname && 0 == strncmp(elemsetname, "zebra::", 7))
1263 WRBUF result = wrbuf_alloc();
1264 int r = zebra_special_fetch(&fetch_info, elemsetname + 7,
1265 input_format, output_format,
1269 *rec_bufp = odr_strdup(odr, wrbuf_cstr(result));
1270 *rec_lenp = wrbuf_len(result);
1272 wrbuf_destroy(result);
1276 /* processing all other element set names */
1277 rec = rec_get(zh->reg->records, sysno);
1280 yaz_log(YLOG_WARN, "rec_get fail on sysno=" ZINT_FORMAT, sysno);
1282 return YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1286 recordAttr = rec_init_attr(zh->reg->zei, rec);
1288 file_type = rec->info[recInfo_fileType];
1289 fname = rec->info[recInfo_filename];
1290 basename = rec->info[recInfo_databaseName];
1291 *basenamep = (char *) odr_malloc(odr, strlen(basename)+1);
1292 strcpy(*basenamep, basename);
1294 yaz_log(YLOG_DEBUG, "retrieve localno=" ZINT_FORMAT " score=%d",
1297 return_code = zebra_create_record_stream(zh, &rec, &stream);
1302 struct recRetrieveCtrl retrieveCtrl;
1304 retrieveCtrl.stream = &stream;
1305 retrieveCtrl.fname = fname;
1306 retrieveCtrl.localno = sysno;
1307 retrieveCtrl.staticrank = recordAttr->staticrank;
1308 retrieveCtrl.score = score;
1309 retrieveCtrl.recordSize = recordAttr->recordSize;
1310 retrieveCtrl.odr = odr;
1311 retrieveCtrl.input_format = retrieveCtrl.output_format = input_format;
1312 retrieveCtrl.comp = comp;
1313 retrieveCtrl.encoding = zh->record_encoding;
1314 retrieveCtrl.diagnostic = 0;
1315 retrieveCtrl.addinfo = 0;
1316 retrieveCtrl.dh = zh->reg->dh;
1317 retrieveCtrl.res = zh->res;
1318 retrieveCtrl.rec_buf = 0;
1319 retrieveCtrl.rec_len = -1;
1320 retrieveCtrl.handle = &fetch_info;
1321 retrieveCtrl.special_fetch = zebra_special_fetch;
1323 if (!(rt = recType_byName(zh->reg->recTypes, zh->res,
1324 file_type, &clientData)))
1326 wrbuf_printf(addinfo_w, "Could not handle record type %.40s",
1328 return_code = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1332 (*rt->retrieve)(clientData, &retrieveCtrl);
1333 return_code = retrieveCtrl.diagnostic;
1335 *output_format = retrieveCtrl.output_format;
1336 *rec_bufp = (char *) retrieveCtrl.rec_buf;
1337 *rec_lenp = retrieveCtrl.rec_len;
1338 if (retrieveCtrl.addinfo)
1339 wrbuf_puts(addinfo_w, retrieveCtrl.addinfo);
1342 stream.destroy(&stream);
1352 * c-file-style: "Stroustrup"
1353 * indent-tabs-mode: nil
1355 * vim: shiftwidth=4 tabstop=8 expandtab