Fixed addinfo passing. Index type 's' is sort for absent index rules.
[idzebra-moved-to-github.git] / index / retrieve.c
1 /* This file is part of the Zebra server.
2    Copyright (C) 1995-2008 Index Data
3
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
7 version.
8
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
12 for more details.
13
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
17
18 */
19
20 #include <stdio.h>
21 #include <assert.h>
22
23 #include <fcntl.h>
24 #ifdef WIN32
25 #include <io.h>
26 #include <process.h>
27 #endif
28 #if HAVE_UNISTD_H
29 #include <unistd.h>
30 #endif
31
32 #include "index.h"
33 #include <yaz/diagbib1.h>
34 #include <yaz/snprintf.h>
35 #include <direntz.h>
36 #include <yaz/oid_db.h>
37 #include <zebra_strmap.h>
38
39 #define MAX_SYSNOS_PER_RECORD 40
40
41 #define ZEBRA_XML_HEADER_STR "<record xmlns=\"http://www.indexdata.com/zebra/\""
42
43 struct special_fetch_s {
44     ZebraHandle zh;
45     const char *setname;
46     zint sysno;
47     int score;
48     NMEM nmem;
49 };
50
51 static int zebra_create_record_stream(ZebraHandle zh, 
52                                       Record *rec,
53                                       struct ZebraRecStream *stream)
54 {
55     RecordAttr *recordAttr = rec_init_attr(zh->reg->zei, *rec);
56
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]);
61     else
62     {
63         char full_rep[1024];
64         int fd;
65             
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]);
70         }
71         else
72             strcpy(full_rep, (*rec)->info[recInfo_filename]);
73             
74         if ((fd = open(full_rep, O_BINARY|O_RDONLY)) == -1){
75             yaz_log(YLOG_WARN|YLOG_ERRNO, "Retrieve fail; missing file: %s",
76                      full_rep);
77             rec_free(rec);
78             return YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
79         }
80         zebra_create_stream_fd(stream, fd, recordAttr->recordOffset);
81     }
82     return 0;
83 }
84    
85
86 struct index_spec {
87     const char *index_name;
88     const char *index_type;
89     const char *extra;
90     struct index_spec *next;
91 };
92
93
94 struct index_spec *parse_index_spec(const char *elem, NMEM nmem,
95                                     int *error)
96 {
97     struct index_spec *first = 0;
98     struct index_spec **last = &first;
99     const char *cp = elem;
100
101     *error = 0;
102     if (cp[0] == ':' && cp[1] == ':')
103     {
104
105         cp++; /* skip first ':' */
106
107         for (;;)
108         {
109             const char *cp0;
110             struct index_spec *spec = nmem_malloc(nmem, sizeof(*spec));
111             spec->index_type = 0;
112             spec->next = 0;
113             spec->extra = 0;
114
115             if (!first)
116                 first = spec;
117             *last = spec;
118             last = &spec->next;
119
120             cp++; /* skip ',' or second ':' */
121             cp0 = cp;
122             while (*cp != ':' && *cp != '\0' && *cp != ',')
123                 cp++;
124             spec->index_name = nmem_strdupn(nmem, cp0, cp - cp0);
125             if (*cp == ':') /* type as well */
126             {
127                 cp++;
128                 cp0 = cp;
129                 
130                 while (*cp != '\0' && *cp != ',' && *cp != ':')
131                     cp++;
132                 spec->index_type = nmem_strdupn(nmem, cp0, cp - cp0);
133             }
134             if (*cp == ':') /* extra arguments */
135             {
136                 cp++;
137                 cp0 = cp;
138                 
139                 while (*cp != '\0' && *cp != ',' && *cp != ':')
140                     cp++;
141                 spec->extra = nmem_strdupn(nmem, cp0, cp - cp0);
142             }
143             if (*cp != ',')
144                 break;
145         }
146     }
147     if (*cp != '\0')
148         *error = 1;
149     return first;
150 }
151                             
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)
155 {
156     *index = 0;
157     *index_len = 0;
158
159     *type = 0;
160     *type_len = 0;
161
162     if (elem && *elem)
163     {
164         char *cp;
165         /* verify that '::' is in the beginning of *elem 
166            and something more follows */
167         if (':' != *elem
168             || !(elem +1) || ':' != *(elem +1)
169             || !(elem +2) || '\0' == *(elem +2))
170             return 0;
171  
172         /* pick out info from string after '::' */
173         elem = elem + 2;
174         cp = strchr(elem, ':');
175
176         if (!cp) /* index, no colon, no type */
177         {
178             *index = elem;
179             *index_len = strlen(elem);
180         }
181         else if (cp[1] == '\0') /* colon, but no following type */
182         {
183             return 0;
184         }
185         else  /* index, colon and type */
186         {
187             *index = elem;
188             *index_len = cp - elem;
189             *type = cp+1;
190             *type_len = strlen(cp+1);
191         }
192     }
193     return 1;
194 }
195
196
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)
202 {
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];
209     int ord;
210     ZebraHandle zh = fi->zh;
211
212     if (!parse_zebra_elem(elemsetname,
213                           &retrieval_index, &retrieval_index_len,
214                           &retrieval_type,  &retrieval_type_len))
215     {
216         return YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
217     }
218     
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)
223     {
224         return YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
225     }
226         
227     memcpy(retrieval_index_cstr, retrieval_index, retrieval_index_len);
228     retrieval_index_cstr[retrieval_index_len] = '\0';
229
230     memcpy(retrieval_type_cstr, retrieval_type, retrieval_type_len);
231     retrieval_type_cstr[retrieval_type_len] = '\0';
232
233     ord = zebraExplain_lookup_attr_str(zh->reg->zei,
234                                        zinfo_index_category_sort,
235                                        retrieval_type_cstr,
236                                        retrieval_index_cstr);
237     if (ord == -1)
238         return -1;  /* is not a sort index */
239     else
240     {
241         WRBUF wrbuf_str = wrbuf_alloc();
242         const char *index_type;
243         const char *db = 0;
244         const char *string_index = 0;
245         WRBUF wrbuf_result = result;
246         int off = 0;
247         
248         zebraExplain_lookup_ord(zh->reg->zei, ord, &index_type, &db, 
249                                 &string_index);
250         if (!oid_oidcmp(input_format, yaz_oid_recsyn_xml))
251         {
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);
257         }
258         else if (!oid_oidcmp(input_format, yaz_oid_recsyn_sutrs))
259         {
260             *output_format = yaz_oid_recsyn_sutrs;
261         }
262         else
263         {
264             yaz_log(YLOG_WARN, "unsupported format for element set zebra::%s", 
265                     elemsetname);
266             *output_format = 0;
267             wrbuf_destroy(wrbuf_str);
268             return YAZ_BIB1_NO_SYNTAXES_AVAILABLE_FOR_THIS_REQUEST;
269         }
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, wrbuf_str);
273
274         while (off != wrbuf_len(wrbuf_str))
275         {
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);
280             
281             if (!oid_oidcmp(input_format, yaz_oid_recsyn_xml))
282             {
283                 wrbuf_printf(wrbuf_result, "  <index name=\"%s\"", 
284                              string_index);
285                 wrbuf_printf(wrbuf_result, " type=\"%s\">", index_type);
286                 wrbuf_xmlputs(wrbuf_result, dst_buf);
287                 wrbuf_printf(wrbuf_result, "</index>\n");
288             }
289             else if (!oid_oidcmp(input_format, yaz_oid_recsyn_sutrs))
290             {
291                 wrbuf_printf(wrbuf_result, "%s %s %s\n", string_index, index_type,
292                              dst_buf);
293             }
294             off += strlen(wrbuf_buf(wrbuf_str)+off) + 1;
295         }
296         if (!oid_oidcmp(input_format, yaz_oid_recsyn_xml))
297         {
298             wrbuf_printf(wrbuf_result, "</record>\n");
299         }
300         wrbuf_destroy(wrbuf_str);
301         return 0;
302     }
303 }
304                             
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,
310     Record rec)
311 {
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;
317     int ret_code = 0;
318     char retrieval_type_cstr[256];
319     ZebraHandle zh = fi->zh;
320     
321     /* set output variables before processing possible error states */
322     /* *rec_lenp = 0; */
323
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))
327     {
328         yaz_log(YLOG_WARN, "unsupported format for element set zebra::%s", 
329                 elemsetname);
330         *output_format = 0;
331         return YAZ_BIB1_NO_SYNTAXES_AVAILABLE_FOR_THIS_REQUEST;
332     }
333
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_;
338
339     if (retrieval_type_len)
340     {
341         memcpy(retrieval_type_cstr, retrieval_type, retrieval_type_len);
342         retrieval_type_cstr[retrieval_type_len] = '\0';
343     }
344     
345     if (retrieval_index_len)
346     {
347         char retrieval_index_cstr[256];
348
349         if (retrieval_index_len < sizeof(retrieval_index_cstr) -1)
350         {
351             memcpy(retrieval_index_cstr, retrieval_index, retrieval_index_len);
352             retrieval_index_cstr[retrieval_index_len] = '\0';
353             
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_;
360         }
361     }
362
363     keys = zebra_rec_keys_open();
364     zebra_rec_keys_set_buf(keys, rec->info[recInfo_delKeys],
365                            rec->size[recInfo_delKeys], 0);
366
367     if (!zebra_rec_keys_rewind(keys))
368     {
369         ret_code = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
370     }
371     else
372     {
373         size_t slen;
374         const char *str;
375         struct it_key key_in;
376         WRBUF wrbuf = result;
377     
378         if (!oid_oidcmp(input_format, yaz_oid_recsyn_xml))
379         {
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);
385         }
386         else if (!oid_oidcmp(input_format, yaz_oid_recsyn_sutrs))
387             *output_format = input_format;
388
389         while (zebra_rec_keys_read(keys, &str, &slen, &key_in))
390         {
391             int i;
392             int ord = CAST_ZINT_TO_INT(key_in.mem[0]);
393             const char *index_type;
394             const char *db = 0;
395             const char *string_index = 0;
396             size_t string_index_len;
397             char dst_buf[IT_MAX_WORD];
398             
399             zebraExplain_lookup_ord(zh->reg->zei, ord, &index_type, &db,
400                                     &string_index);
401             string_index_len = strlen(string_index);
402
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,
408                                string_index_len)))
409             {
410                 /* process only if type is not defined, or is matching */
411                 if (retrieval_type == 0 
412                     || !strcmp(retrieval_type_cstr, index_type))
413                 {
414                     if (zebra_term_untrans(zh, index_type, dst_buf, str))
415                         *dst_buf = '\0'; /* untrans failed */
416
417                     if (!oid_oidcmp(input_format, yaz_oid_recsyn_xml))
418                     {
419                         wrbuf_printf(wrbuf, "  <index name=\"%s\"", 
420                                      string_index);
421                         
422                         wrbuf_printf(wrbuf, " type=\"%s\"", index_type);
423                         
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");
428                     }
429                     else 
430                     {
431                         wrbuf_printf(wrbuf, "%s ", string_index);
432                         
433                         wrbuf_printf(wrbuf, "%s", index_type);
434                         
435                         for (i = 1; i < key_in.len; i++)
436                             wrbuf_printf(wrbuf, " " ZINT_FORMAT, 
437                                              key_in.mem[i]);
438                         
439                         wrbuf_printf(wrbuf, " %s", dst_buf);
440                         
441                         wrbuf_printf(wrbuf, "\n");
442
443                     }
444                     
445                 }
446             }
447         }
448         if (!oid_oidcmp(input_format, yaz_oid_recsyn_xml))
449             wrbuf_printf(wrbuf, "</record>\n");
450     }
451     zebra_rec_keys_close(keys);
452     return ret_code;
453 }
454
455
456 static void retrieve_puts_attr(WRBUF wrbuf, const char *name,
457                                const char *value)
458 {
459     if (value)
460     {
461         wrbuf_printf(wrbuf, " %s=\"", name);
462         wrbuf_xmlputs(wrbuf, value);
463         wrbuf_printf(wrbuf, "\"");
464     }
465 }
466
467 static void retrieve_puts_attr_int(WRBUF wrbuf, const char *name,
468                                const int value)
469 {
470     wrbuf_printf(wrbuf, " %s=\"%i\"", name, value);
471 }
472
473 static void retrieve_puts_str(WRBUF wrbuf, const char *name,
474                                const char *value)
475 {
476     if (value)
477         wrbuf_printf(wrbuf, "%s %s\n", name, value);
478 }
479
480 static void retrieve_puts_int(WRBUF wrbuf, const char *name,
481                                const int value)
482 {
483     wrbuf_printf(wrbuf, "%s %i\n", name, value);
484 }
485
486
487 static void snippet_xml_record(ZebraHandle zh, WRBUF wrbuf, zebra_snippets *doc)
488 {
489     const zebra_snippet_word *doc_w;
490     int mark_state = 0;
491
492     wrbuf_printf(wrbuf, "%s>\n", ZEBRA_XML_HEADER_STR);
493     for (doc_w = zebra_snippets_constlist(doc); doc_w; doc_w = doc_w->next)
494     {
495         if (doc_w->mark)
496         {
497             const char *index_type;
498             const char *db = 0;
499             const char *string_index = 0;
500
501             zebraExplain_lookup_ord(zh->reg->zei, doc_w->ord, 
502                                     &index_type, &db, &string_index);
503
504             if (mark_state == 0)
505             {
506                 wrbuf_printf(wrbuf, "  <snippet name=\"%s\"",  string_index);
507                 wrbuf_printf(wrbuf, " type=\"%s\">", index_type);
508             }
509             if (doc_w->match)
510                 wrbuf_puts(wrbuf, "<s>");
511             /* not printing leading ws */
512             if (mark_state || !doc_w->ws || doc_w->match) 
513                 wrbuf_xmlputs(wrbuf, doc_w->term);
514             if (doc_w->match)
515                 wrbuf_puts(wrbuf, "</s>");
516         }
517         else if (mark_state == 1)
518         {
519             wrbuf_puts(wrbuf, "</snippet>\n");
520         }
521         mark_state = doc_w->mark;
522     }
523     if (mark_state == 1)
524     {
525         wrbuf_puts(wrbuf, "</snippet>\n");
526     }
527     wrbuf_printf(wrbuf, "</record>");
528 }
529
530 int zebra_get_rec_snippets(ZebraHandle zh, zint sysno,
531                            zebra_snippets *snippets)
532 {
533     int return_code = 0;
534     Record rec = rec_get(zh->reg->records, sysno);
535     if (!rec)
536     {
537         yaz_log(YLOG_WARN, "rec_get fail on sysno=" ZINT_FORMAT, sysno);
538         return_code = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
539     }
540     else
541     {
542         const char *file_type = rec->info[recInfo_fileType];
543         void *recTypeClientData;
544         RecType rt = recType_byName(zh->reg->recTypes, zh->res,
545                                     file_type, &recTypeClientData);
546
547         if (!rt)
548             return_code = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
549         else
550         {
551             struct ZebraRecStream stream;
552             return_code = zebra_create_record_stream(zh, &rec, &stream);
553             if (return_code == 0)
554             {
555                 extract_snippet(zh, snippets, &stream,
556                                 rt, recTypeClientData);
557
558                 stream.destroy(&stream);
559             }
560         }
561         rec_free(&rec);
562     }
563     return return_code;
564 }
565
566 static int snippet_fetch(
567     struct special_fetch_s *fi, const char *elemsetname,
568     const Odr_oid *input_format,
569     const Odr_oid **output_format,
570     WRBUF result, WRBUF addinfo)
571 {
572     ZebraHandle zh = fi->zh;
573     zebra_snippets *rec_snippets = zebra_snippets_create();
574     int return_code = zebra_get_rec_snippets(zh, fi->sysno, rec_snippets);
575
576     if (!return_code)
577     {
578         WRBUF wrbuf = result;
579         zebra_snippets *hit_snippet = zebra_snippets_create();
580
581         zebra_snippets_hit_vector(zh, fi->setname, fi->sysno, hit_snippet);
582
583 #if 0
584         /* for debugging purposes */
585         yaz_log(YLOG_LOG, "---------------------------");
586         yaz_log(YLOG_LOG, "REC SNIPPET:");
587         zebra_snippets_log(rec_snippets, YLOG_LOG, 1);
588         yaz_log(YLOG_LOG, "---------------------------");
589         yaz_log(YLOG_LOG, "HIT SNIPPET:");
590         zebra_snippets_log(hit_snippet, YLOG_LOG, 1);
591 #endif
592         
593         zebra_snippets_ring(rec_snippets, hit_snippet, 5, 5);
594         
595 #if 0
596         yaz_log(YLOG_LOG, "---------------------------");
597         yaz_log(YLOG_LOG, "RING SNIPPET:");
598         zebra_snippets_log(rec_snippets, YLOG_LOG, 1);
599 #endif
600         snippet_xml_record(zh, wrbuf, rec_snippets);
601         
602         *output_format = yaz_oid_recsyn_xml;
603         
604         zebra_snippets_destroy(hit_snippet);
605     }
606     zebra_snippets_destroy(rec_snippets);
607     return return_code;
608 }
609
610 struct term_collect {
611     const char *term;
612     int oc;
613     zint set_occur;
614 };
615
616 static zint freq_term(ZebraHandle zh, int ord, const char *term, RSET rset_set)
617 {
618     struct rset_key_control *kc = zebra_key_control_create(zh);
619     char ord_buf[IT_MAX_WORD];
620     int ord_len = key_SU_encode(ord, ord_buf);
621     char *info;
622     zint hits = 0;
623     NMEM nmem = nmem_create();
624     
625     strcpy(ord_buf + ord_len, term);
626     
627     info = dict_lookup(zh->reg->dict, ord_buf);
628     if (info)
629     {
630         ISAM_P isam_p;
631         RSET rsets[2], rset;
632         memcpy(&isam_p, info+1, sizeof(ISAM_P));
633         
634         rsets[0] = zebra_create_rset_isam(zh, nmem, kc, kc->scope, isam_p, 0);
635         rsets[1] = rset_dup(rset_set);
636         
637         rset = rset_create_and(nmem, kc, kc->scope, 2, rsets);
638
639         zebra_count_set(zh, rset, &hits, zh->approx_limit);
640
641         rset_delete(rsets[0]);
642         rset_delete(rset);
643     }
644     (*kc->dec)(kc);
645     nmem_destroy(nmem);
646     return hits;
647 }
648
649 static int term_qsort_handle(const void *a, const void *b)
650 {
651     const struct term_collect *l = a;
652     const struct term_collect *r = b;
653     if (l->set_occur < r->set_occur)
654         return 1;
655     else if (l->set_occur > r->set_occur)
656         return -1;
657     else
658     {
659         const char *lterm = l->term ? l->term : "";
660         const char *rterm = r->term ? r->term : "";
661         return strcmp(lterm, rterm);
662     }
663 }
664
665 static void term_collect_freq(ZebraHandle zh,
666                               struct term_collect *col, int no_terms_collect,
667                               int ord, RSET rset)
668 {
669     int i;
670     for (i = 0; i < no_terms_collect; i++)
671     {
672         if (col[i].term)
673             col[i].set_occur = freq_term(zh, ord, col[i].term, rset);
674     }
675     qsort(col, no_terms_collect, sizeof(*col), term_qsort_handle);
676 }
677
678 static struct term_collect *term_collect_create(zebra_strmap_t sm, 
679                                                 int no_terms_collect,
680                                                 NMEM nmem)
681 {
682     const char *term;
683     void *data_buf;
684     size_t data_len;
685     zebra_strmap_it it;
686     struct term_collect *col = nmem_malloc(nmem, 
687                                            sizeof *col *no_terms_collect);
688     int i;
689     for (i = 0; i < no_terms_collect; i++)
690     {
691         col[i].term = 0;
692         col[i].oc = 0;
693         col[i].set_occur = 0;
694     }
695     /* iterate over terms and collect the most frequent ones */
696     it = zebra_strmap_it_create(sm);
697     while ((term = zebra_strmap_it_next(it, &data_buf, &data_len)))
698     {
699         /* invariant:
700            col[0] has lowest oc .  col[no_terms_collect-1] has highest oc */
701         int oc = *(int*) data_buf;
702         int j = 0;
703         /* insertion may be slow but terms terms will be "infrequent" and
704            thus number of iterations should be small below 
705         */
706         while (j < no_terms_collect && oc > col[j].oc)
707             j++;
708         if (j) 
709         {   /* oc <= col[j] and oc > col[j-1] */
710             --j;
711             memmove(col, col+1, sizeof(*col) * j);
712             col[j].term = term;
713             col[j].oc = oc;
714         }
715     }
716     zebra_strmap_it_destroy(it);
717     return col;
718 }
719
720 static int perform_facet_sort(ZebraHandle zh, int no_ord, int *ord_array,
721                               zebra_strmap_t *map_array,
722                               int num_recs, ZebraMetaRecord *poset)
723 {
724     int rec_i;
725     WRBUF w = wrbuf_alloc();
726     int ord_i;
727
728     for (ord_i = 0; ord_i < no_ord; ord_i++)
729     {
730         for (rec_i = 0; rec_i < num_recs; rec_i++)
731         {
732             if (!poset[rec_i].sysno)
733                 continue;
734             
735             zebra_sort_sysno(zh->reg->sort_index, poset[rec_i].sysno);
736             zebra_sort_type(zh->reg->sort_index, ord_array[ord_i]);
737             
738             wrbuf_rewind(w);
739             if (zebra_sort_read(zh->reg->sort_index, w))
740             {
741                 zebra_strmap_t sm = map_array[ord_i];
742                 int off = 0;
743                 while (off != wrbuf_len(w))
744                 {
745                     const char *str = wrbuf_buf(w) + off;
746                     int *freq = zebra_strmap_lookup(sm, str, 0, 0);
747                     if (freq)
748                         (*freq)++;
749                     else
750                     {
751                         int v = 1;
752                         zebra_strmap_add(sm, str, &v, sizeof v);
753                     }
754                     off += strlen(str)+1;
755                 }
756             }
757         }
758     }
759     wrbuf_destroy(w);
760     return 0;
761 }
762
763
764 static int perform_facet_index(ZebraHandle zh,
765                                struct special_fetch_s *fi,
766                                int no_ord, int *ord_array,
767                                zebra_strmap_t *map_array,
768                                int num_recs, ZebraMetaRecord *poset,
769                                struct index_spec *spec_list)
770 {
771     int max_chunks = 2;
772     int rec_i;
773     res_get_int(zh->res, "facetMaxChunks", &max_chunks);
774
775     for (rec_i = 0; rec_i < num_recs; rec_i++)
776     {
777         int ret;
778         int j;
779         zint sysnos[MAX_SYSNOS_PER_RECORD];
780         int no_sysnos = MAX_SYSNOS_PER_RECORD;
781         if (!poset[rec_i].sysno)
782             continue;
783         ret = zebra_result_recid_to_sysno(zh, fi->setname,
784                                           poset[rec_i].sysno,
785                                           sysnos, &no_sysnos);
786         assert(no_sysnos > 0);
787         yaz_log(YLOG_DEBUG, "Analyzing rec=%d ISAM sysno=" ZINT_FORMAT " chunks=%d",
788                 rec_i, poset[rec_i].sysno, no_sysnos);
789         for (j = 0; j < no_sysnos && j < max_chunks; j++)
790         {
791             size_t slen;
792             const char *str;
793             struct it_key key_in;
794             Record rec = rec_get(zh->reg->records, sysnos[j]);
795             zebra_rec_keys_t keys = zebra_rec_keys_open();
796             zebra_rec_keys_set_buf(keys, rec->info[recInfo_delKeys],
797                                    rec->size[recInfo_delKeys], 0);
798             
799             yaz_log(YLOG_DEBUG, "rec %d " ZINT_FORMAT " %s", 
800                     j, sysnos[j], zebra_rec_keys_empty(keys) ? "empty" : "non-empty");
801             if (zebra_rec_keys_rewind(keys))
802             {
803                 while (zebra_rec_keys_read(keys, &str, &slen, &key_in))
804                 {
805                     int ord_i;
806                     struct index_spec *spec;
807                     for (spec = spec_list, ord_i = 0; ord_i < no_ord; 
808                          ord_i++, spec = spec->next)
809                     {
810                         int ord = CAST_ZINT_TO_INT(key_in.mem[0]);
811                         if (ord == ord_array[ord_i] && 
812                             str[0] != FIRST_IN_FIELD_CHAR)
813                         {
814                             int *freq;
815                             zebra_strmap_t sm = map_array[ord_i];
816                             
817                             freq = zebra_strmap_lookup(sm, str, 0, 0);
818                             if (freq)
819                                 (*freq)++;
820                             else
821                             {
822                                 int v = 1;
823                                 zebra_strmap_add(sm, str, &v, sizeof v);
824                             }
825                         }
826                     }
827                 }
828             }
829             zebra_rec_keys_close(keys);
830             rec_free(&rec);
831         }
832     }
833     return 0;
834 }
835
836 static int perform_facet(ZebraHandle zh,  
837                          struct special_fetch_s *fi,
838                          WRBUF result,
839                          int num_recs, ZebraMetaRecord *poset,
840                          struct index_spec *spec_list,
841                          int no_ord, int *ord_array,
842                          int use_xml,
843                          zinfo_index_category_t cat)
844 {
845     int i;
846     int ret = 0;
847     WRBUF wr = result;
848     struct index_spec *spec;
849     yaz_timing_t timing = yaz_timing_create();
850     zebra_strmap_t *map_array
851         = nmem_malloc(fi->nmem, sizeof *map_array * no_ord);
852     for (i = 0; i < no_ord; i++)
853         map_array[i] = zebra_strmap_create();
854
855     if (cat == zinfo_index_category_sort)
856         perform_facet_sort(zh, no_ord, ord_array, map_array,
857                            num_recs, poset);
858     else
859         perform_facet_index(zh, fi, no_ord, ord_array, map_array,
860                             num_recs, poset, spec_list);
861     yaz_timing_stop(timing);
862     yaz_log(YLOG_LOG, "facet first phase real=%4.2f cat=%s",
863             yaz_timing_get_real(timing),
864             (cat == zinfo_index_category_sort) ? "sort" : "index");
865     yaz_timing_start(timing);
866     for (spec = spec_list, i = 0; i < no_ord; i++, spec = spec->next)
867     {
868         int j;
869         NMEM nmem = nmem_create();
870         struct term_collect *col;
871         int no_collect_terms = 20;
872         
873         if (spec->extra)
874             no_collect_terms = atoi(spec->extra);
875         if (no_collect_terms < 1)
876             no_collect_terms = 1;
877         col = term_collect_create(map_array[i], no_collect_terms, nmem);
878         term_collect_freq(zh, col, no_collect_terms, ord_array[i],
879                           resultSetRef(zh, fi->setname));
880         
881         if (use_xml)
882             wrbuf_printf(wr, "  <facet type=\"%s\" index=\"%s\">\n",
883                          spec->index_type, spec->index_name);
884         else
885             wrbuf_printf(wr, "facet %s %s\n",
886                          spec->index_type, spec->index_name);
887         for (j = 0; j < no_collect_terms; j++)
888         {
889             if (col[j].term)
890             {
891                 char dst_buf[IT_MAX_WORD];
892                 zebra_term_untrans(zh, spec->index_type, dst_buf, col[j].term);
893                 if (use_xml)
894                 {
895                     wrbuf_printf(wr, "    <term coccur=\"%d\"", col[j].oc);
896                     if (col[j].set_occur)
897                         wrbuf_printf(wr, " occur=\"" ZINT_FORMAT "\"", 
898                                      col[j].set_occur);
899                     wrbuf_printf(wr, ">");
900                     wrbuf_xmlputs(wr, dst_buf);
901                     wrbuf_printf(wr, "</term>\n");
902                 }
903                 else
904                 {
905                     wrbuf_printf(wr, "term %d", col[j].oc);
906                     if (col[j].set_occur)
907                         wrbuf_printf(wr, " " ZINT_FORMAT, 
908                                      col[j].set_occur);
909                     wrbuf_printf(wr, ": %s\n", dst_buf);
910                 }
911             }
912         }
913         if (use_xml)
914             wrbuf_puts(wr, "  </facet>\n");
915         nmem_destroy(nmem);
916     }
917     for (i = 0; i < no_ord; i++)
918         zebra_strmap_destroy(map_array[i]);
919     yaz_timing_stop(timing);
920     yaz_log(YLOG_LOG, "facet second phase real=%4.2f",
921             yaz_timing_get_real(timing));
922     yaz_timing_destroy(&timing);
923     return ret;
924 }
925
926 static int facet_fetch(
927     struct special_fetch_s *fi, const char *elemsetname,
928     const Odr_oid *input_format,
929     const Odr_oid **output_format,
930     WRBUF result, WRBUF addinfo)
931 {
932     zint *pos_array;
933     int i;
934     int num_recs = 10; /* number of records to analyze */
935     ZebraMetaRecord *poset;
936     ZEBRA_RES ret = ZEBRA_OK;
937     int *ord_array;
938     int use_xml = 0;
939     int no_ord = 0;
940     struct index_spec *spec, *spec_list;
941     int error;
942     ZebraHandle zh = fi->zh;
943     /* whether sort or index based */
944     zinfo_index_category_t cat = zinfo_index_category_sort;
945
946     res_get_int(zh->res, "facetNumRecs", &num_recs);
947
948     /* see if XML is required for response */
949     if (oid_oidcmp(input_format, yaz_oid_recsyn_xml) == 0)
950         use_xml = 1;
951
952     spec_list = parse_index_spec(elemsetname, fi->nmem, &error);
953               
954     if (!spec_list || error)
955     {
956         return YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
957     }          
958   
959     for (spec = spec_list; spec; spec = spec->next)
960     {
961         if (!spec->index_type)
962             return YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
963         no_ord++;
964     }
965
966     /* try to see if all specs are sort based.. If not, try the
967        index based ones */
968     ord_array = nmem_malloc(fi->nmem, sizeof(*ord_array) * no_ord);
969
970     for (spec = spec_list, i = 0; spec; spec = spec->next, i++)
971     {
972         int ord = zebraExplain_lookup_attr_str(zh->reg->zei,
973                                                zinfo_index_category_sort,
974                                                spec->index_type,
975                                                spec->index_name);
976         if (ord == -1)
977             break;
978         ord_array[i] = ord;
979     }
980     if (spec)
981     {
982         cat = zinfo_index_category_index;
983         for (spec = spec_list, i = 0; spec; spec = spec->next, i++)
984         {
985             int ord = zebraExplain_lookup_attr_str(zh->reg->zei,
986                                                    zinfo_index_category_index,
987                                                    spec->index_type,
988                                                    spec->index_name);
989             if (ord == -1)
990                 break;
991             ord_array[i] = ord;
992             
993         }
994     }
995     if (spec)
996         return YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
997
998     pos_array = (zint *) nmem_malloc(fi->nmem, num_recs * sizeof(*pos_array));
999     for (i = 0; i < num_recs; i++)
1000         pos_array[i] = i+1;
1001     poset = zebra_meta_records_create(zh, fi->setname, num_recs, pos_array);
1002     if (!poset)
1003     {
1004         wrbuf_puts(addinfo, fi->setname);
1005         return YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST;
1006     }
1007     else
1008     {
1009         if (use_xml)
1010         {
1011             wrbuf_printf(result, ZEBRA_XML_HEADER_STR ">\n");
1012         }
1013         ret = perform_facet(zh, fi, result, num_recs, poset,
1014                             spec_list, no_ord, ord_array, use_xml,
1015                             cat);
1016         if (use_xml)
1017             wrbuf_puts(result, "</record>\n");
1018     }
1019     *output_format = yaz_oid_recsyn_xml;
1020     zebra_meta_records_destroy(zh, poset, num_recs);
1021     return ret;
1022 }
1023
1024
1025 static int zebra_special_fetch(
1026     void *handle, const char *elemsetname,
1027     const Odr_oid *input_format,
1028     const Odr_oid **output_format,
1029     WRBUF result, WRBUF addinfo)
1030 {
1031     Record rec = 0;
1032     struct special_fetch_s *fi = (struct special_fetch_s *) handle;
1033     ZebraHandle zh = fi->zh;
1034     zint sysno = fi->sysno;
1035     
1036     /* processing zebra::facet */
1037     if (elemsetname && 0 == strncmp(elemsetname, "facet", 5))
1038     {
1039         return facet_fetch(fi, elemsetname + 5, 
1040                            input_format, output_format,
1041                            result, addinfo);
1042     }
1043
1044     if (elemsetname && 0 == strcmp(elemsetname, "snippet"))
1045     {
1046         return snippet_fetch(fi, elemsetname + 7,
1047                              input_format, output_format,
1048                              result, addinfo);
1049     }
1050
1051     /* processing zebra::meta::sysno  */
1052     if (elemsetname && 0 == strcmp(elemsetname, "meta::sysno"))
1053     {
1054         int ret = 0;
1055         if (!oid_oidcmp(input_format, yaz_oid_recsyn_sutrs))
1056         {
1057             wrbuf_printf(result, ZINT_FORMAT, fi->sysno);
1058             *output_format = input_format;
1059         } 
1060         else if (!oid_oidcmp(input_format, yaz_oid_recsyn_xml))
1061         {
1062             wrbuf_printf(result, ZEBRA_XML_HEADER_STR
1063                          " sysno=\"" ZINT_FORMAT "\"/>\n",
1064                          fi->sysno);
1065             *output_format = input_format;
1066         }
1067         else
1068             ret = YAZ_BIB1_NO_SYNTAXES_AVAILABLE_FOR_THIS_REQUEST;
1069         return ret;
1070     }
1071
1072     /* processing special elementsetname zebra::index:: for sort elements */
1073     if (elemsetname && 0 == strncmp(elemsetname, "index", 5))
1074     {
1075         int ret = sort_fetch(
1076             fi, elemsetname + 5,
1077             input_format, output_format,
1078             result, addinfo);
1079         if (ret != -1)
1080             return ret;
1081         /* not a sort index so we continue to get the full record */
1082     }
1083
1084
1085     /* fetching binary record up for all other display elementsets */
1086     rec = rec_get(zh->reg->records, sysno);
1087     if (!rec)
1088     {
1089         yaz_log(YLOG_WARN, "rec_get fail on sysno=" ZINT_FORMAT, sysno);
1090         return YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1091     }
1092
1093     /* processing special elementsetnames zebra::data */    
1094     if (elemsetname && 0 == strcmp(elemsetname, "data"))
1095     {
1096         struct ZebraRecStream stream;
1097         RecordAttr *recordAttr = rec_init_attr(zh->reg->zei, rec); 
1098         char *b;
1099
1100         zebra_create_record_stream(zh, &rec, &stream);
1101         *output_format = input_format;
1102
1103         b = nmem_malloc(fi->nmem, recordAttr->recordSize);
1104         stream.readf(&stream, b, recordAttr->recordSize);
1105         wrbuf_write(result, b, recordAttr->recordSize);
1106
1107         stream.destroy(&stream);
1108         rec_free(&rec);
1109         return 0;
1110     }
1111
1112     /* processing special elementsetnames zebra::meta:: */
1113     if (elemsetname && 0 == strcmp(elemsetname, "meta"))
1114     {
1115         int ret = 0;
1116         RecordAttr *recordAttr = rec_init_attr(zh->reg->zei, rec); 
1117
1118         if (!oid_oidcmp(input_format, yaz_oid_recsyn_xml))
1119         {
1120             *output_format = input_format;
1121             
1122             wrbuf_printf(result, ZEBRA_XML_HEADER_STR
1123                          " sysno=\"" ZINT_FORMAT "\"", sysno);
1124             retrieve_puts_attr(result, "base", rec->info[recInfo_databaseName]);
1125             retrieve_puts_attr(result, "file", rec->info[recInfo_filename]);
1126             retrieve_puts_attr(result, "type", rec->info[recInfo_fileType]);
1127             if (fi->score >= 0)
1128                 retrieve_puts_attr_int(result, "score", fi->score);
1129            
1130             wrbuf_printf(result,
1131                          " rank=\"" ZINT_FORMAT "\""
1132                          " size=\"%i\""
1133                          " set=\"zebra::%s\"/>\n",
1134                          recordAttr->staticrank,
1135                          recordAttr->recordSize,
1136                          elemsetname);
1137         }
1138         else if (!oid_oidcmp(input_format, yaz_oid_recsyn_sutrs))
1139         {
1140             *output_format = input_format;
1141             wrbuf_printf(result, "sysno " ZINT_FORMAT "\n", sysno);
1142             retrieve_puts_str(result, "base", rec->info[recInfo_databaseName]);
1143             retrieve_puts_str(result, "file", rec->info[recInfo_filename]);
1144             retrieve_puts_str(result, "type", rec->info[recInfo_fileType]);
1145             if (fi->score >= 0)
1146                 retrieve_puts_int(result, "score", fi->score);
1147
1148             wrbuf_printf(result,
1149                          "rank " ZINT_FORMAT "\n"
1150                          "size %i\n"
1151                          "set zebra::%s\n",
1152                          recordAttr->staticrank,
1153                          recordAttr->recordSize,
1154                          elemsetname);
1155         }
1156         else
1157             ret = YAZ_BIB1_NO_SYNTAXES_AVAILABLE_FOR_THIS_REQUEST;
1158
1159         rec_free(&rec);
1160         return ret;
1161     }
1162
1163     /* processing special elementsetnames zebra::index:: */
1164     if (elemsetname && 0 == strncmp(elemsetname, "index", 5))
1165     {
1166         int ret = special_index_fetch(
1167             fi, elemsetname + 5,
1168             input_format, output_format,
1169             result, addinfo, rec);
1170         rec_free(&rec);
1171         return ret;
1172     }
1173
1174     if (rec)
1175         rec_free(&rec);
1176     return YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
1177 }
1178
1179 int zebra_record_fetch(ZebraHandle zh, const char *setname,
1180                        zint sysno, int score,
1181                        ODR odr,
1182                        const Odr_oid *input_format, Z_RecordComposition *comp,
1183                        const Odr_oid **output_format,
1184                        char **rec_bufp, int *rec_lenp, char **basenamep,
1185                        WRBUF addinfo_w)
1186 {
1187     Record rec;
1188     char *fname, *file_type, *basename;
1189     const char *elemsetname;
1190     struct ZebraRecStream stream;
1191     RecordAttr *recordAttr;
1192     void *clientData;
1193     int return_code = 0;
1194     zint sysnos[MAX_SYSNOS_PER_RECORD];
1195     int no_sysnos = MAX_SYSNOS_PER_RECORD;
1196     ZEBRA_RES res;
1197     struct special_fetch_s fetch_info;
1198
1199     res = zebra_result_recid_to_sysno(zh, setname, sysno, sysnos, &no_sysnos);
1200     if (res != ZEBRA_OK)
1201         return ZEBRA_FAIL;
1202
1203     sysno = sysnos[0];
1204     *basenamep = 0;
1205     elemsetname = yaz_get_esn(comp);
1206
1207     fetch_info.zh = zh;
1208     fetch_info.setname = setname;
1209     fetch_info.sysno = sysno;
1210     fetch_info.score = score;
1211     fetch_info.nmem = odr->mem;
1212
1213     /* processing zebra special elementset names of form 'zebra:: */
1214     if (elemsetname && 0 == strncmp(elemsetname, "zebra::", 7))
1215     {
1216         WRBUF result = wrbuf_alloc();
1217         int r = zebra_special_fetch(&fetch_info, elemsetname + 7,
1218                                     input_format, output_format,
1219                                     result, addinfo_w);
1220         if (r == 0)
1221         {
1222             *rec_bufp = odr_strdup(odr, wrbuf_cstr(result));
1223             *rec_lenp = wrbuf_len(result);
1224         }
1225         wrbuf_destroy(result);
1226         return r;
1227     }
1228
1229     /* processing all other element set names */
1230     rec = rec_get(zh->reg->records, sysno);
1231     if (!rec)
1232     {
1233         yaz_log(YLOG_WARN, "rec_get fail on sysno=" ZINT_FORMAT, sysno);
1234         *basenamep = 0;
1235         return YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1236     }
1237
1238
1239     recordAttr = rec_init_attr(zh->reg->zei, rec);
1240
1241     file_type = rec->info[recInfo_fileType];
1242     fname = rec->info[recInfo_filename];
1243     basename = rec->info[recInfo_databaseName];
1244     *basenamep = (char *) odr_malloc(odr, strlen(basename)+1);
1245     strcpy(*basenamep, basename);
1246
1247     yaz_log(YLOG_DEBUG, "retrieve localno=" ZINT_FORMAT " score=%d",
1248             sysno, score);
1249
1250     return_code = zebra_create_record_stream(zh, &rec, &stream);
1251
1252     if (rec)
1253     {
1254         RecType rt;
1255         struct recRetrieveCtrl retrieveCtrl;
1256
1257         retrieveCtrl.stream = &stream;
1258         retrieveCtrl.fname = fname;
1259         retrieveCtrl.localno = sysno;
1260         retrieveCtrl.staticrank = recordAttr->staticrank;
1261         retrieveCtrl.score = score;
1262         retrieveCtrl.recordSize = recordAttr->recordSize;
1263         retrieveCtrl.odr = odr;
1264         retrieveCtrl.input_format = retrieveCtrl.output_format = input_format;
1265         retrieveCtrl.comp = comp;
1266         retrieveCtrl.encoding = zh->record_encoding;
1267         retrieveCtrl.diagnostic = 0;
1268         retrieveCtrl.addinfo = 0;
1269         retrieveCtrl.dh = zh->reg->dh;
1270         retrieveCtrl.res = zh->res;
1271         retrieveCtrl.rec_buf = 0;
1272         retrieveCtrl.rec_len = -1;
1273         retrieveCtrl.handle = &fetch_info;
1274         retrieveCtrl.special_fetch = zebra_special_fetch;
1275
1276         if (!(rt = recType_byName(zh->reg->recTypes, zh->res,
1277                                   file_type, &clientData)))
1278         {
1279             wrbuf_printf(addinfo_w, "Could not handle record type %.40s",
1280                          file_type);
1281             return_code = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1282         }
1283         else
1284         {
1285             (*rt->retrieve)(clientData, &retrieveCtrl);
1286             return_code = retrieveCtrl.diagnostic;
1287
1288             *output_format = retrieveCtrl.output_format;
1289             *rec_bufp = (char *) retrieveCtrl.rec_buf;
1290             *rec_lenp = retrieveCtrl.rec_len;
1291             if (retrieveCtrl.addinfo)
1292                 wrbuf_puts(addinfo_w, retrieveCtrl.addinfo);
1293         }
1294
1295         stream.destroy(&stream);
1296         rec_free(&rec);
1297     }
1298
1299     return return_code;
1300 }
1301
1302 /*
1303  * Local variables:
1304  * c-basic-offset: 4
1305  * indent-tabs-mode: nil
1306  * End:
1307  * vim: shiftwidth=4 tabstop=8 expandtab
1308  */
1309