index/retrieve.c

   1 /* $Id: retrieve.c,v 1.77 2007-12-03 11:49:11 adam Exp $
   2    Copyright (C) 1995-2007
   3    Index Data ApS
   4
   5 This file is part of the Zebra server.
   6
   7 Zebra is free software; you can redistribute it and/or modify it under
   8 the terms of the GNU General Public License as published by the Free
   9 Software Foundation; either version 2, or (at your option) any later
  10 version.
  11
  12 Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
  13 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  14 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  15 for more details.
  16
  17 You should have received a copy of the GNU General Public License
  18 along with this program; if not, write to the Free Software
  19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  20
  21 */
  22
  23 #include <stdio.h>
  24 #include <assert.h>
  25
  26 #include <fcntl.h>
  27 #ifdef WIN32
  28 #include <io.h>
  29 #include <process.h>
  30 #endif
  31 #if HAVE_UNISTD_H
  32 #include <unistd.h>
  33 #endif
  34
  35 #include "index.h"
  36 #include <yaz/diagbib1.h>
  37 #include <yaz/snprintf.h>
  38 #include <direntz.h>
  39 #include <yaz/oid_db.h>
  40 #include <zebra_strmap.h>
  41
  42 #define MAX_SYSNOS_PER_RECORD 40
  43
  44 #define ZEBRA_XML_HEADER_STR "<record xmlns=\"http://www.indexdata.com/zebra/\""
  45
  46 static int zebra_create_record_stream(ZebraHandle zh,
  47                                       Record *rec,
  48                                       struct ZebraRecStream *stream)
  49 {
  50     RecordAttr *recordAttr = rec_init_attr(zh->reg->zei, *rec);
  51
  52     if ((*rec)->size[recInfo_storeData] > 0)
  53         zebra_create_stream_mem(stream, (*rec)->info[recInfo_storeData],
  54                                 (*rec)->size[recInfo_storeData]);
  55     else
  56     {
  57         char full_rep[1024];
  58         int fd;
  59
  60         if (zh->path_reg && !yaz_is_abspath((*rec)->info[recInfo_filename])){
  61             strcpy(full_rep, zh->path_reg);
  62             strcat(full_rep, "/");
  63             strcat(full_rep, (*rec)->info[recInfo_filename]);
  64         }
  65         else
  66             strcpy(full_rep, (*rec)->info[recInfo_filename]);
  67
  68         if ((fd = open(full_rep, O_BINARY|O_RDONLY)) == -1){
  69             yaz_log(YLOG_WARN|YLOG_ERRNO, "Retrieve fail; missing file: %s",
  70                      full_rep);
  71             rec_free(rec);
  72             return YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
  73         }
  74         zebra_create_stream_fd(stream, fd, recordAttr->recordOffset);
  75     }
  76     return 0;
  77 }
  78
  79
  80 struct index_spec {
  81     const char *index_name;
  82     const char *index_type;
  83     struct index_spec *next;
  84 };
  85
  86
  87 struct index_spec *parse_index_spec(const char *elem, NMEM nmem,
  88                                     int *error)
  89 {
  90     struct index_spec *first = 0;
  91     struct index_spec **last = &first;
  92     const char *cp = elem;
  93
  94     *error = 0;
  95     if (cp[0] == ':' && cp[1] == ':')
  96     {
  97
  98         cp++; /* skip first ':' */
  99
 100         for (;;)
 101         {
 102             const char *cp0;
 103             struct index_spec *spec = nmem_malloc(nmem, sizeof(*spec));
 104             spec->index_type = 0;
 105             spec->next = 0;
 106
 107             if (!first)
 108                 first = spec;
 109             *last = spec;
 110             last = &spec->next;
 111
 112             cp++; /* skip ',' or second ':' */
 113             cp0 = cp;
 114             while (*cp != ':' && *cp != '\0' && *cp != ',')
 115                 cp++;
 116             spec->index_name = nmem_strdupn(nmem, cp0, cp - cp0);
 117             if (*cp == ':') /* type as well */
 118             {
 119                 cp++;
 120                 cp0 = cp;
 121
 122                 while (*cp != '\0' && *cp != ',')
 123                     cp++;
 124                 spec->index_type = nmem_strdupn(nmem, cp0, cp - cp0);
 125             }
 126             if (*cp != ',')
 127                 break;
 128         }
 129     }
 130     if (*cp != '\0')
 131         *error = 1;
 132     return first;
 133 }
 134
 135 static int parse_zebra_elem(const char *elem,
 136                             const char **index, size_t *index_len,
 137                             const char **type, size_t *type_len)
 138 {
 139     *index = 0;
 140     *index_len = 0;
 141
 142     *type = 0;
 143     *type_len = 0;
 144
 145     if (elem && *elem)
 146     {
 147         char *cp;
 148         /* verify that '::' is in the beginning of *elem
 149            and something more follows */
 150         if (':' != *elem
 151             || !(elem +1) || ':' != *(elem +1)
 152             || !(elem +2) || '\0' == *(elem +2))
 153             return 0;
 154
 155         /* pick out info from string after '::' */
 156         elem = elem + 2;
 157         cp = strchr(elem, ':');
 158
 159         if (!cp) /* index, no colon, no type */
 160         {
 161             *index = elem;
 162             *index_len = strlen(elem);
 163         }
 164         else if (cp[1] == '\0') /* colon, but no following type */
 165         {
 166             return 0;
 167         }
 168         else  /* index, colon and type */
 169         {
 170             *index = elem;
 171             *index_len = cp - elem;
 172             *type = cp+1;
 173             *type_len = strlen(cp+1);
 174         }
 175     }
 176     return 1;
 177 }
 178
 179
 180 int zebra_special_sort_fetch(ZebraHandle zh, zint sysno, ODR odr,
 181                              const char *elemsetname,
 182                              const Odr_oid *input_format,
 183                              const Odr_oid **output_format,
 184                              char **rec_bufp, int *rec_lenp)
 185 {
 186     const char *retrieval_index;
 187     size_t retrieval_index_len;
 188     const char *retrieval_type;
 189     size_t retrieval_type_len;
 190     char retrieval_index_cstr[256];
 191     char retrieval_type_cstr[256];
 192     int ord;
 193
 194     /* only accept XML and SUTRS requests */
 195     if (oid_oidcmp(input_format, yaz_oid_recsyn_xml)
 196         && oid_oidcmp(input_format, yaz_oid_recsyn_sutrs))
 197     {
 198         yaz_log(YLOG_WARN, "unsupported format for element set zebra::%s",
 199                 elemsetname);
 200         *output_format = 0;
 201         return YAZ_BIB1_NO_SYNTAXES_AVAILABLE_FOR_THIS_REQUEST;
 202     }
 203
 204     if (!parse_zebra_elem(elemsetname,
 205                           &retrieval_index, &retrieval_index_len,
 206                           &retrieval_type,  &retrieval_type_len))
 207     {
 208         return YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
 209     }
 210
 211     if (retrieval_type_len == 0)
 212         return -1;   /* must have a register type specified */
 213     if (!retrieval_index_len ||
 214         retrieval_index_len >= sizeof(retrieval_index_cstr)-1)
 215     {
 216         return YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
 217     }
 218
 219     memcpy(retrieval_index_cstr, retrieval_index, retrieval_index_len);
 220     retrieval_index_cstr[retrieval_index_len] = '\0';
 221
 222     memcpy(retrieval_type_cstr, retrieval_type, retrieval_type_len);
 223     retrieval_type_cstr[retrieval_type_len] = '\0';
 224
 225     ord = zebraExplain_lookup_attr_str(zh->reg->zei,
 226                                        zinfo_index_category_sort,
 227                                        retrieval_type_cstr,
 228                                        retrieval_index_cstr);
 229     if (ord == -1)
 230         return -1;  /* is not a sort index */
 231     else
 232     {
 233         char dst_buf[IT_MAX_WORD];
 234         char str[IT_MAX_WORD];
 235         const char *index_type;
 236         const char *db = 0;
 237         const char *string_index = 0;
 238         WRBUF wrbuf = wrbuf_alloc();
 239
 240         zebra_sort_sysno(zh->reg->sort_index, sysno);
 241         zebra_sort_type(zh->reg->sort_index, ord);
 242         zebra_sort_read(zh->reg->sort_index, str);
 243
 244         zebraExplain_lookup_ord(zh->reg->zei, ord, &index_type, &db, &string_index);
 245
 246         zebra_term_untrans(zh, index_type, dst_buf, str);
 247
 248         if (!oid_oidcmp(input_format, yaz_oid_recsyn_xml))
 249         {
 250             *output_format = yaz_oid_recsyn_xml;
 251             wrbuf_printf(wrbuf, ZEBRA_XML_HEADER_STR
 252                          " sysno=\"" ZINT_FORMAT "\""
 253                          " set=\"zebra::index%s/\">\n",
 254                          sysno, elemsetname);
 255
 256             wrbuf_printf(wrbuf, "  <index name=\"%s\"",
 257                          string_index);
 258             wrbuf_printf(wrbuf, " type=\"%s\">", index_type);
 259             wrbuf_xmlputs(wrbuf, dst_buf);
 260             wrbuf_printf(wrbuf, "</index>\n");
 261             wrbuf_printf(wrbuf, "</record>\n");
 262         }
 263         else if (!oid_oidcmp(input_format, yaz_oid_recsyn_sutrs))
 264         {
 265             *output_format = yaz_oid_recsyn_sutrs;
 266
 267             wrbuf_printf(wrbuf, "%s %s %s\n", string_index, index_type,
 268                          dst_buf);
 269         }
 270         *rec_lenp = wrbuf_len(wrbuf);
 271         *rec_bufp = odr_malloc(odr, *rec_lenp);
 272         memcpy(*rec_bufp, wrbuf_buf(wrbuf), *rec_lenp);
 273         wrbuf_destroy(wrbuf);
 274         return 0;
 275     }
 276 }
 277
 278 int zebra_special_index_fetch(ZebraHandle zh, zint sysno, ODR odr,
 279                               Record rec,
 280                               const char *elemsetname,
 281                               const Odr_oid *input_format,
 282                               const Odr_oid **output_format,
 283                               char **rec_bufp, int *rec_lenp)
 284 {
 285     const char *retrieval_index;
 286     size_t retrieval_index_len;
 287     const char *retrieval_type;
 288     size_t retrieval_type_len;
 289     zebra_rec_keys_t keys;
 290     int ret_code = 0;
 291     char retrieval_type_cstr[256];
 292
 293     /* set output variables before processing possible error states */
 294     /* *rec_lenp = 0; */
 295
 296     /* only accept XML and SUTRS requests */
 297     if (oid_oidcmp(input_format, yaz_oid_recsyn_xml)
 298         && oid_oidcmp(input_format, yaz_oid_recsyn_sutrs))
 299     {
 300         yaz_log(YLOG_WARN, "unsupported format for element set zebra::%s",
 301                 elemsetname);
 302         *output_format = 0;
 303         return YAZ_BIB1_NO_SYNTAXES_AVAILABLE_FOR_THIS_REQUEST;
 304     }
 305
 306     if (!parse_zebra_elem(elemsetname,
 307                      &retrieval_index, &retrieval_index_len,
 308                      &retrieval_type,  &retrieval_type_len))
 309         return YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
 310
 311     if (retrieval_type_len)
 312     {
 313         memcpy(retrieval_type_cstr, retrieval_type, retrieval_type_len);
 314         retrieval_type_cstr[retrieval_type_len] = '\0';
 315     }
 316
 317     if (retrieval_index_len)
 318     {
 319         char retrieval_index_cstr[256];
 320
 321         if (retrieval_index_len < sizeof(retrieval_index_cstr) -1)
 322         {
 323             memcpy(retrieval_index_cstr, retrieval_index, retrieval_index_len);
 324             retrieval_index_cstr[retrieval_index_len] = '\0';
 325
 326             if (zebraExplain_lookup_attr_str(zh->reg->zei,
 327                                              zinfo_index_category_index,
 328                                              (retrieval_type_len == 0 ? 0 :
 329                                               retrieval_type_cstr),
 330                                              retrieval_index_cstr) == -1)
 331                 return YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
 332         }
 333     }
 334
 335     keys = zebra_rec_keys_open();
 336     zebra_rec_keys_set_buf(keys, rec->info[recInfo_delKeys],
 337                            rec->size[recInfo_delKeys], 0);
 338
 339     if (!zebra_rec_keys_rewind(keys))
 340     {
 341         ret_code = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
 342     }
 343     else
 344     {
 345         size_t slen;
 346         const char *str;
 347         struct it_key key_in;
 348         WRBUF wrbuf = wrbuf_alloc();
 349
 350         if (!oid_oidcmp(input_format, yaz_oid_recsyn_xml))
 351         {
 352             *output_format = input_format;
 353             wrbuf_printf(wrbuf, ZEBRA_XML_HEADER_STR
 354                          " sysno=\"" ZINT_FORMAT "\""
 355                          " set=\"zebra::index%s/\">\n",
 356                          sysno, elemsetname);
 357         }
 358         else if (!oid_oidcmp(input_format, yaz_oid_recsyn_sutrs))
 359             *output_format = input_format;
 360
 361         while (zebra_rec_keys_read(keys, &str, &slen, &key_in))
 362         {
 363             int i;
 364             int ord = CAST_ZINT_TO_INT(key_in.mem[0]);
 365             const char *index_type;
 366             const char *db = 0;
 367             const char *string_index = 0;
 368             size_t string_index_len;
 369             char dst_buf[IT_MAX_WORD];
 370
 371             zebraExplain_lookup_ord(zh->reg->zei, ord, &index_type, &db,
 372                                     &string_index);
 373             string_index_len = strlen(string_index);
 374
 375             /* process only if index is not defined,
 376                or if defined and matching */
 377             if (retrieval_index == 0
 378                 || (string_index_len == retrieval_index_len
 379                     && !memcmp(string_index, retrieval_index,
 380                                string_index_len)))
 381             {
 382                 /* process only if type is not defined, or is matching */
 383                 if (retrieval_type == 0
 384                     || !strcmp(retrieval_type_cstr, index_type))
 385                 {
 386                     zebra_term_untrans(zh, index_type, dst_buf, str);
 387                     if (strlen(dst_buf))
 388                     {
 389                         if (!oid_oidcmp(input_format, yaz_oid_recsyn_xml))
 390                         {
 391                             wrbuf_printf(wrbuf, "  <index name=\"%s\"",
 392                                          string_index);
 393
 394                             wrbuf_printf(wrbuf, " type=\"%s\"", index_type);
 395
 396                             wrbuf_printf(wrbuf, " seq=\"" ZINT_FORMAT "\">",
 397                                          key_in.mem[key_in.len -1]);
 398
 399                             wrbuf_xmlputs(wrbuf, dst_buf);
 400                             wrbuf_printf(wrbuf, "</index>\n");
 401                         }
 402                         else
 403                         {
 404                             wrbuf_printf(wrbuf, "%s ", string_index);
 405
 406                             wrbuf_printf(wrbuf, "%s", index_type);
 407
 408                             for (i = 1; i < key_in.len; i++)
 409                                 wrbuf_printf(wrbuf, " " ZINT_FORMAT,
 410                                              key_in.mem[i]);
 411
 412                             wrbuf_printf(wrbuf, " %s", dst_buf);
 413
 414                             wrbuf_printf(wrbuf, "\n");
 415                         }
 416                     }
 417
 418                 }
 419             }
 420         }
 421         if (!oid_oidcmp(input_format, yaz_oid_recsyn_xml))
 422             wrbuf_printf(wrbuf, "</record>\n");
 423         *rec_lenp = wrbuf_len(wrbuf);
 424         *rec_bufp = odr_malloc(odr, *rec_lenp);
 425         memcpy(*rec_bufp, wrbuf_buf(wrbuf), *rec_lenp);
 426         wrbuf_destroy(wrbuf);
 427     }
 428     zebra_rec_keys_close(keys);
 429     return ret_code;
 430 }
 431
 432
 433 static void retrieve_puts_attr(WRBUF wrbuf, const char *name,
 434                                const char *value)
 435 {
 436     if (value)
 437     {
 438         wrbuf_printf(wrbuf, " %s=\"", name);
 439         wrbuf_xmlputs(wrbuf, value);
 440         wrbuf_printf(wrbuf, "\"");
 441     }
 442 }
 443
 444 static void retrieve_puts_attr_int(WRBUF wrbuf, const char *name,
 445                                const int value)
 446 {
 447     wrbuf_printf(wrbuf, " %s=\"%i\"", name, value);
 448 }
 449
 450 static void retrieve_puts_str(WRBUF wrbuf, const char *name,
 451                                const char *value)
 452 {
 453     if (value)
 454         wrbuf_printf(wrbuf, "%s %s\n", name, value);
 455 }
 456
 457 static void retrieve_puts_int(WRBUF wrbuf, const char *name,
 458                                const int value)
 459 {
 460     wrbuf_printf(wrbuf, "%s %i\n", name, value);
 461 }
 462
 463
 464 static void snippet_xml_record(ZebraHandle zh, WRBUF wrbuf, zebra_snippets *doc)
 465 {
 466     const zebra_snippet_word *doc_w;
 467     int mark_state = 0;
 468
 469     wrbuf_printf(wrbuf, "%s>\n", ZEBRA_XML_HEADER_STR);
 470     for (doc_w = zebra_snippets_constlist(doc); doc_w; doc_w = doc_w->next)
 471     {
 472         if (doc_w->mark)
 473         {
 474             const char *index_type;
 475             const char *db = 0;
 476             const char *string_index = 0;
 477
 478             zebraExplain_lookup_ord(zh->reg->zei, doc_w->ord,
 479                                     &index_type, &db, &string_index);
 480
 481             if (mark_state == 0)
 482             {
 483                 wrbuf_printf(wrbuf, "  <snippet name=\"%s\"",  string_index);
 484                 wrbuf_printf(wrbuf, " type=\"%s\">", index_type);
 485             }
 486             if (doc_w->match)
 487                 wrbuf_puts(wrbuf, "<s>");
 488             /* not printing leading ws */
 489             if (mark_state || !doc_w->ws || doc_w->match)
 490                 wrbuf_xmlputs(wrbuf, doc_w->term);
 491             if (doc_w->match)
 492                 wrbuf_puts(wrbuf, "</s>");
 493         }
 494         else if (mark_state == 1)
 495         {
 496             wrbuf_puts(wrbuf, "</snippet>\n");
 497         }
 498         mark_state = doc_w->mark;
 499     }
 500     if (mark_state == 1)
 501     {
 502         wrbuf_puts(wrbuf, "</snippet>\n");
 503     }
 504     wrbuf_printf(wrbuf, "</record>");
 505 }
 506
 507 int zebra_get_rec_snippets(ZebraHandle zh, zint sysno,
 508                            zebra_snippets *snippets)
 509 {
 510     int return_code = 0;
 511     Record rec = rec_get(zh->reg->records, sysno);
 512     if (!rec)
 513     {
 514         yaz_log(YLOG_WARN, "rec_get fail on sysno=" ZINT_FORMAT, sysno);
 515         return_code = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
 516     }
 517     else
 518     {
 519         const char *file_type = rec->info[recInfo_fileType];
 520         void *recTypeClientData;
 521         RecType rt = recType_byName(zh->reg->recTypes, zh->res,
 522                                     file_type, &recTypeClientData);
 523
 524         if (!rt)
 525             return_code = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
 526         else
 527         {
 528             struct ZebraRecStream stream;
 529             return_code = zebra_create_record_stream(zh, &rec, &stream);
 530             if (return_code == 0)
 531             {
 532                 extract_snippet(zh, snippets, &stream,
 533                                 rt, recTypeClientData);
 534
 535                 stream.destroy(&stream);
 536             }
 537         }
 538         rec_free(&rec);
 539     }
 540     return return_code;
 541 }
 542
 543 static int snippet_fetch(ZebraHandle zh, const char *setname,
 544                          zint sysno, ODR odr,
 545                          const char *elemsetname,
 546                          const Odr_oid *input_format,
 547                          const Odr_oid **output_format,
 548                          char **rec_bufp, int *rec_lenp)
 549 {
 550     zebra_snippets *rec_snippets = zebra_snippets_create();
 551     int return_code = zebra_get_rec_snippets(zh, sysno, rec_snippets);
 552
 553     if (!return_code)
 554     {
 555         WRBUF wrbuf = wrbuf_alloc();
 556         zebra_snippets *hit_snippet = zebra_snippets_create();
 557
 558         zebra_snippets_hit_vector(zh, setname, sysno, hit_snippet);
 559
 560 #if 0
 561         /* for debugging purposes */
 562         yaz_log(YLOG_LOG, "---------------------------");
 563         yaz_log(YLOG_LOG, "REC SNIPPET:");
 564         zebra_snippets_log(rec_snippet, YLOG_LOG, 1);
 565         yaz_log(YLOG_LOG, "---------------------------");
 566         yaz_log(YLOG_LOG, "HIT SNIPPET:");
 567         zebra_snippets_log(hit_snippet, YLOG_LOG, 1);
 568 #endif
 569
 570         zebra_snippets_ring(rec_snippets, hit_snippet, 5, 5);
 571
 572 #if 0
 573         yaz_log(YLOG_LOG, "---------------------------");
 574         yaz_log(YLOG_LOG, "RING SNIPPET:");
 575         zebra_snippets_log(rec_snippets, YLOG_LOG, 1);
 576 #endif
 577         snippet_xml_record(zh, wrbuf, rec_snippets);
 578
 579         *output_format = yaz_oid_recsyn_xml;
 580
 581         if (return_code == 0)
 582         {
 583             *rec_lenp = wrbuf_len(wrbuf);
 584             *rec_bufp = odr_strdup(odr, wrbuf_cstr(wrbuf));
 585         }
 586         wrbuf_destroy(wrbuf);
 587         zebra_snippets_destroy(hit_snippet);
 588     }
 589     zebra_snippets_destroy(rec_snippets);
 590     return return_code;
 591 }
 592
 593 struct term_collect {
 594     const char *term;
 595     int oc;
 596     zint set_occur;
 597 };
 598
 599 zint freq_term(ZebraHandle zh, int ord, const char *term, RSET rset_set)
 600 {
 601     struct rset_key_control *kc = zebra_key_control_create(zh);
 602     char ord_buf[IT_MAX_WORD];
 603     int ord_len = key_SU_encode(ord, ord_buf);
 604     char *info;
 605     zint hits = 0;
 606     NMEM nmem = nmem_create();
 607
 608     strcpy(ord_buf + ord_len, term);
 609
 610     info = dict_lookup(zh->reg->dict, ord_buf);
 611     if (info)
 612     {
 613         ISAM_P isam_p;
 614         RSET rsets[2], rset;
 615         memcpy(&isam_p, info+1, sizeof(ISAM_P));
 616
 617         rsets[0] = rsisamb_create(nmem, kc,
 618                                   2, zh->reg->isamb, isam_p, 0);
 619         rsets[1] = rset_dup(rset_set);
 620
 621         rset = rset_create_and(nmem, kc, kc->scope, 2, rsets);
 622
 623         zebra_count_set(zh, rset, &hits, zh->approx_limit);
 624
 625         rset_delete(rsets[0]);
 626         rset_delete(rset);
 627     }
 628     (*kc->dec)(kc);
 629     nmem_destroy(nmem);
 630     return hits;
 631 }
 632
 633 void term_collect_freq(ZebraHandle zh,
 634                        struct term_collect *col, int no_terms_collect,
 635                        int ord, RSET rset)
 636 {
 637     int i;
 638     for (i = 0; i < no_terms_collect; i++)
 639     {
 640         if (col[i].term)
 641             col[i].set_occur = freq_term(zh, ord, col[i].term, rset);
 642     }
 643 }
 644
 645 struct term_collect *term_collect_create(zebra_strmap_t sm,
 646                                          int no_terms_collect,
 647                                          NMEM nmem)
 648 {
 649     const char *term;
 650     void *data_buf;
 651     size_t data_len;
 652     zebra_strmap_it it;
 653     struct term_collect *col = nmem_malloc(nmem,
 654                                            sizeof *col *no_terms_collect);
 655     int i;
 656     for (i = 0; i < no_terms_collect; i++)
 657     {
 658         col[i].term = 0;
 659         col[i].oc = 0;
 660         col[i].set_occur = 0;
 661     }
 662     /* iterate over terms and collect the most frequent ones */
 663     it = zebra_strmap_it_create(sm);
 664     while ((term = zebra_strmap_it_next(it, &data_buf, &data_len)))
 665     {
 666         int oc = *(int*) data_buf;
 667         int j = 0;
 668         /* insertion may be slow but terms terms will be "infrequent" and
 669            thus number of iterations should be small below */
 670         while (j < no_terms_collect && oc > col[j].oc)
 671             j++;
 672         if (j)
 673         {
 674             --j;
 675             memmove(col, col+1, sizeof(*col) * j);
 676             col[j].term = term;
 677             col[j].oc = oc;
 678         }
 679     }
 680     zebra_strmap_it_destroy(it);
 681     return col;
 682 }
 683
 684 static ZEBRA_RES facet_fetch(ZebraHandle zh, const char *setname,
 685                              ODR odr,
 686                              const char *elemsetname,
 687                              const Odr_oid *input_format,
 688                              const Odr_oid **output_format,
 689                              char **rec_bufp, int *rec_lenp)
 690 {
 691     zint *pos_array;
 692     int i;
 693     int num_recs = 10; /* number of records to analyze */
 694     int no_collect_terms = 20; /* number of term candidates */
 695     ZebraMetaRecord *poset;
 696     ZEBRA_RES ret = ZEBRA_OK;
 697     int *ord_array;
 698     WRBUF wr = wrbuf_alloc();
 699
 700     int no_ord = 0;
 701     struct index_spec *spec, *spec_list;
 702     int error;
 703
 704
 705     spec_list = parse_index_spec(elemsetname, odr_getmem(odr), &error);
 706
 707     if (!spec_list || error)
 708         return YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
 709
 710     for (spec = spec_list; spec; spec = spec->next)
 711     {
 712         if (!spec->index_type)
 713             return YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
 714         no_ord++;
 715     }
 716
 717     ord_array = odr_malloc(odr, sizeof(*ord_array) * no_ord);
 718
 719     for (spec = spec_list, i = 0; spec; spec = spec->next, i++)
 720     {
 721         int ord = zebraExplain_lookup_attr_str(zh->reg->zei,
 722                                                zinfo_index_category_index,
 723                                                spec->index_type,
 724                                                spec->index_name);
 725         if (ord == -1)
 726         {
 727             return YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
 728         }
 729         ord_array[i] = ord;
 730     }
 731
 732     pos_array = (zint *) xmalloc(num_recs * sizeof(*pos_array));
 733     for (i = 0; i < num_recs; i++)
 734         pos_array[i] = i+1;
 735     poset = zebra_meta_records_create(zh, setname, num_recs, pos_array);
 736     if (!poset)
 737     {
 738         zebra_setError(zh, YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
 739                        setname);
 740         xfree(pos_array);
 741         ret = ZEBRA_FAIL;
 742     }
 743     else
 744     {
 745         zebra_strmap_t *map_array
 746             = odr_malloc(odr, sizeof *map_array * no_ord);
 747         for (i = 0; i < no_ord; i++)
 748             map_array[i] = zebra_strmap_create();
 749
 750         for (i = 0; i < num_recs; i++)
 751         {
 752             int j;
 753             zint sysnos[MAX_SYSNOS_PER_RECORD];
 754             int no_sysnos = MAX_SYSNOS_PER_RECORD;
 755             if (!poset[i].sysno)
 756                 continue;
 757             ret = zebra_result_recid_to_sysno(zh,  setname,
 758                                               poset[i].sysno,
 759                                               sysnos, &no_sysnos);
 760             assert(no_sysnos > 0);
 761             for (j = 0; j < no_sysnos; j++)
 762             {
 763                 size_t slen;
 764                 const char *str;
 765                 struct it_key key_in;
 766                 Record rec = rec_get(zh->reg->records, sysnos[j]);
 767                 zebra_rec_keys_t keys = zebra_rec_keys_open();
 768                 zebra_rec_keys_set_buf(keys, rec->info[recInfo_delKeys],
 769                                        rec->size[recInfo_delKeys], 0);
 770
 771                 if (zebra_rec_keys_rewind(keys))
 772                 {
 773                     while (zebra_rec_keys_read(keys, &str, &slen, &key_in))
 774                     {
 775                         int i;
 776                         struct index_spec *spec;
 777                         for (spec = spec_list, i = 0; i < no_ord;
 778                              i++, spec = spec->next)
 779                         {
 780                             int ord = CAST_ZINT_TO_INT(key_in.mem[0]);
 781                             if (ord == ord_array[i])
 782                             {
 783                                 int *freq;
 784                                 zebra_strmap_t sm = map_array[i];
 785
 786                                 freq = zebra_strmap_lookup(sm, str, 0, 0);
 787                                 if (freq)
 788                                     (*freq)++;
 789                                 else
 790                                 {
 791                                     int v = 1;
 792                                     zebra_strmap_add(sm, str, &v, sizeof v);
 793                                 }
 794                             }
 795                         }
 796                     }
 797                 }
 798                 zebra_rec_keys_close(keys);
 799                 rec_free(&rec);
 800             }
 801         }
 802         wrbuf_puts(wr, "<facets>\n");
 803         for (spec = spec_list, i = 0; i < no_ord; i++, spec = spec->next)
 804         {
 805             int j;
 806             NMEM nmem = nmem_create();
 807             struct term_collect *col = term_collect_create(map_array[i],
 808                                                            no_collect_terms,
 809                                                            nmem);
 810             term_collect_freq(zh, col, no_collect_terms, ord_array[i],
 811                               resultSetRef(zh, setname));
 812
 813             wrbuf_printf(wr, "  <facet type=\"%s\" index=\"%s\">\n",
 814                          spec->index_type, spec->index_name);
 815             for (j = 0; j < no_collect_terms; j++)
 816             {
 817                 if (col[j].term)
 818                 {
 819                     char dst_buf[IT_MAX_WORD];
 820                     zebra_term_untrans(zh, spec->index_type, dst_buf, col[j].term);
 821                     wrbuf_printf(wr, "    <term coccur=\"%d\"", col[j].oc);
 822                     if (col[j].set_occur)
 823                         wrbuf_printf(wr, " occur=\"" ZINT_FORMAT "\"",
 824                                      col[j].set_occur);
 825                     wrbuf_printf(wr, ">");
 826                     wrbuf_xmlputs(wr, dst_buf);
 827                     wrbuf_printf(wr, "</term>\n");
 828                 }
 829             }
 830             wrbuf_puts(wr, "  </facet>\n");
 831             nmem_destroy(nmem);
 832         }
 833         wrbuf_puts(wr, "</facets>\n");
 834         for (i = 0; i < no_ord; i++)
 835             zebra_strmap_destroy(map_array[i]);
 836     }
 837
 838
 839     *rec_bufp = odr_strdup(odr, wrbuf_cstr(wr));
 840     wrbuf_destroy(wr);
 841     *rec_lenp = strlen(*rec_bufp);
 842     *output_format = input_format;
 843
 844     xfree(pos_array);
 845     zebra_meta_records_destroy(zh, poset, num_recs);
 846     return ret;
 847 }
 848
 849 int zebra_special_fetch(ZebraHandle zh, const char *setname,
 850                         zint sysno, int score, ODR odr,
 851                         const char *elemsetname,
 852                         const Odr_oid *input_format,
 853                         const Odr_oid **output_format,
 854                         char **rec_bufp, int *rec_lenp)
 855 {
 856     Record rec;
 857
 858     /* set output variables before processing possible error states */
 859     /* *rec_lenp = 0; */
 860
 861     if (elemsetname && 0 == strncmp(elemsetname, "facet", 5))
 862     {
 863         return facet_fetch(zh, setname, odr,
 864                            elemsetname + 5,
 865                            input_format, output_format,
 866                            rec_bufp, rec_lenp);
 867     }
 868
 869     if (elemsetname && 0 == strcmp(elemsetname, "snippet"))
 870     {
 871         return snippet_fetch(zh, setname, sysno, odr,
 872                              elemsetname + 7,
 873                              input_format, output_format,
 874                              rec_bufp, rec_lenp);
 875     }
 876
 877     /* processing zebra::meta::sysno elemset without fetching binary data */
 878     if (elemsetname && 0 == strcmp(elemsetname, "meta::sysno"))
 879     {
 880         int ret = 0;
 881         WRBUF wrbuf = wrbuf_alloc();
 882         if (!oid_oidcmp(input_format, yaz_oid_recsyn_sutrs))
 883         {
 884             wrbuf_printf(wrbuf, ZINT_FORMAT, sysno);
 885             *output_format = input_format;
 886         }
 887         else if (!oid_oidcmp(input_format, yaz_oid_recsyn_xml))
 888         {
 889             wrbuf_printf(wrbuf, ZEBRA_XML_HEADER_STR
 890                          " sysno=\"" ZINT_FORMAT "\"/>\n",
 891                          sysno);
 892             *output_format = input_format;
 893         }
 894         *rec_lenp = wrbuf_len(wrbuf);
 895         if (*rec_lenp)
 896             *rec_bufp = odr_strdup(odr, wrbuf_cstr(wrbuf));
 897         else
 898             ret = YAZ_BIB1_NO_SYNTAXES_AVAILABLE_FOR_THIS_REQUEST;
 899         wrbuf_destroy(wrbuf);
 900         return ret;
 901     }
 902
 903     /* processing special elementsetname zebra::index:: for sort elements */
 904     if (elemsetname && 0 == strncmp(elemsetname, "index", 5))
 905     {
 906         int ret = zebra_special_sort_fetch(zh, sysno, odr,
 907                                            elemsetname + 5,
 908                                            input_format, output_format,
 909                                            rec_bufp, rec_lenp);
 910         if (ret != -1)
 911             return ret;
 912         /* not a sort index so we continue to get the full record */
 913     }
 914
 915
 916     /* fetching binary record up for all other display elementsets */
 917     rec = rec_get(zh->reg->records, sysno);
 918     if (!rec)
 919     {
 920         yaz_log(YLOG_WARN, "rec_get fail on sysno=" ZINT_FORMAT, sysno);
 921         return YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
 922     }
 923
 924     /* processing special elementsetnames zebra::data */
 925     if (elemsetname && 0 == strcmp(elemsetname, "data"))
 926     {
 927         struct ZebraRecStream stream;
 928         RecordAttr *recordAttr = rec_init_attr(zh->reg->zei, rec);
 929         zebra_create_record_stream(zh, &rec, &stream);
 930         *output_format = input_format;
 931         *rec_lenp = recordAttr->recordSize;
 932         *rec_bufp = (char *) odr_malloc(odr, *rec_lenp);
 933         stream.readf(&stream, *rec_bufp, *rec_lenp);
 934         stream.destroy(&stream);
 935         rec_free(&rec);
 936         return 0;
 937     }
 938
 939     /* only accept XML and SUTRS requests from now */
 940     if (oid_oidcmp(input_format, yaz_oid_recsyn_xml)
 941         && oid_oidcmp(input_format, yaz_oid_recsyn_sutrs))
 942     {
 943         yaz_log(YLOG_WARN, "unsupported format for element set zebra::%s",
 944                 elemsetname);
 945         return YAZ_BIB1_NO_SYNTAXES_AVAILABLE_FOR_THIS_REQUEST;
 946     }
 947
 948
 949     /* processing special elementsetnames zebra::meta:: */
 950     if (elemsetname && 0 == strcmp(elemsetname, "meta"))
 951     {
 952         int ret = 0;
 953         WRBUF wrbuf = wrbuf_alloc();
 954         RecordAttr *recordAttr = rec_init_attr(zh->reg->zei, rec);
 955
 956         if (!oid_oidcmp(input_format, yaz_oid_recsyn_xml))
 957         {
 958             *output_format = input_format;
 959
 960             wrbuf_printf(wrbuf, ZEBRA_XML_HEADER_STR
 961                          " sysno=\"" ZINT_FORMAT "\"", sysno);
 962             retrieve_puts_attr(wrbuf, "base", rec->info[recInfo_databaseName]);
 963             retrieve_puts_attr(wrbuf, "file", rec->info[recInfo_filename]);
 964             retrieve_puts_attr(wrbuf, "type", rec->info[recInfo_fileType]);
 965             if (score >= 0)
 966                 retrieve_puts_attr_int(wrbuf, "score", score);
 967
 968             wrbuf_printf(wrbuf,
 969                          " rank=\"" ZINT_FORMAT "\""
 970                          " size=\"%i\""
 971                          " set=\"zebra::%s\"/>\n",
 972                          recordAttr->staticrank,
 973                          recordAttr->recordSize,
 974                          elemsetname);
 975         }
 976         else if (!oid_oidcmp(input_format, yaz_oid_recsyn_sutrs))
 977         {
 978             *output_format = input_format;
 979             wrbuf_printf(wrbuf, "sysno " ZINT_FORMAT "\n", sysno);
 980             retrieve_puts_str(wrbuf, "base", rec->info[recInfo_databaseName]);
 981             retrieve_puts_str(wrbuf, "file", rec->info[recInfo_filename]);
 982             retrieve_puts_str(wrbuf, "type", rec->info[recInfo_fileType]);
 983             if (score >= 0)
 984                 retrieve_puts_int(wrbuf, "score", score);
 985
 986             wrbuf_printf(wrbuf,
 987                          "rank " ZINT_FORMAT "\n"
 988                          "size %i\n"
 989                          "set zebra::%s\n",
 990                          recordAttr->staticrank,
 991                          recordAttr->recordSize,
 992                          elemsetname);
 993         }
 994         *rec_lenp = wrbuf_len(wrbuf);
 995         if (*rec_lenp)
 996             *rec_bufp = odr_strdup(odr, wrbuf_cstr(wrbuf));
 997         else
 998             ret = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
 999
1000         wrbuf_destroy(wrbuf);
1001         rec_free(&rec);
1002         return ret;
1003     }
1004
1005     /* processing special elementsetnames zebra::index:: */
1006     if (elemsetname && 0 == strncmp(elemsetname, "index", 5))
1007     {
1008         int ret = zebra_special_index_fetch(zh, sysno, odr, rec,
1009                                             elemsetname + 5,
1010                                             input_format, output_format,
1011                                             rec_bufp, rec_lenp);
1012
1013         rec_free(&rec);
1014         return ret;
1015     }
1016
1017     if (rec)
1018         rec_free(&rec);
1019     return YAZ_BIB1_SPECIFIED_ELEMENT_SET_NAME_NOT_VALID_FOR_SPECIFIED_;
1020 }
1021
1022
1023 int zebra_record_fetch(ZebraHandle zh, const char *setname,
1024                        zint sysno, int score,
1025                        ODR odr,
1026                        const Odr_oid *input_format, Z_RecordComposition *comp,
1027                        const Odr_oid **output_format,
1028                        char **rec_bufp, int *rec_lenp, char **basenamep,
1029                        char **addinfo)
1030 {
1031     Record rec;
1032     char *fname, *file_type, *basename;
1033     const char *elemsetname;
1034     struct ZebraRecStream stream;
1035     RecordAttr *recordAttr;
1036     void *clientData;
1037     int return_code = 0;
1038     zint sysnos[MAX_SYSNOS_PER_RECORD];
1039     int no_sysnos = MAX_SYSNOS_PER_RECORD;
1040     ZEBRA_RES res;
1041
1042     res = zebra_result_recid_to_sysno(zh, setname, sysno, sysnos, &no_sysnos);
1043     if (res != ZEBRA_OK)
1044         return ZEBRA_FAIL;
1045
1046     sysno = sysnos[0];
1047     *basenamep = 0;
1048     *addinfo = 0;
1049     elemsetname = yaz_get_esn(comp);
1050
1051     /* processing zebra special elementset names of form 'zebra:: */
1052     if (elemsetname && 0 == strncmp(elemsetname, "zebra::", 7))
1053         return  zebra_special_fetch(zh, setname, sysno, score, odr,
1054                                     elemsetname + 7,
1055                                     input_format, output_format,
1056                                     rec_bufp, rec_lenp);
1057
1058
1059     /* processing all other element set names */
1060     rec = rec_get(zh->reg->records, sysno);
1061     if (!rec)
1062     {
1063         yaz_log(YLOG_WARN, "rec_get fail on sysno=" ZINT_FORMAT, sysno);
1064         *basenamep = 0;
1065         return YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1066     }
1067
1068
1069     recordAttr = rec_init_attr(zh->reg->zei, rec);
1070
1071     file_type = rec->info[recInfo_fileType];
1072     fname = rec->info[recInfo_filename];
1073     basename = rec->info[recInfo_databaseName];
1074     *basenamep = (char *) odr_malloc(odr, strlen(basename)+1);
1075     strcpy(*basenamep, basename);
1076
1077     yaz_log(YLOG_DEBUG, "retrieve localno=" ZINT_FORMAT " score=%d",
1078             sysno, score);
1079
1080     return_code = zebra_create_record_stream(zh, &rec, &stream);
1081
1082     if (rec)
1083     {
1084         RecType rt;
1085         struct recRetrieveCtrl retrieveCtrl;
1086
1087         retrieveCtrl.stream = &stream;
1088         retrieveCtrl.fname = fname;
1089         retrieveCtrl.localno = sysno;
1090         retrieveCtrl.staticrank = recordAttr->staticrank;
1091         retrieveCtrl.score = score;
1092         retrieveCtrl.recordSize = recordAttr->recordSize;
1093         retrieveCtrl.odr = odr;
1094         retrieveCtrl.input_format = retrieveCtrl.output_format = input_format;
1095         retrieveCtrl.comp = comp;
1096         retrieveCtrl.encoding = zh->record_encoding;
1097         retrieveCtrl.diagnostic = 0;
1098         retrieveCtrl.addinfo = 0;
1099         retrieveCtrl.dh = zh->reg->dh;
1100         retrieveCtrl.res = zh->res;
1101         retrieveCtrl.rec_buf = 0;
1102         retrieveCtrl.rec_len = -1;
1103
1104         if (!(rt = recType_byName(zh->reg->recTypes, zh->res,
1105                                   file_type, &clientData)))
1106         {
1107             char addinfo_str[100];
1108
1109             sprintf(addinfo_str, "Could not handle record type %.40s",
1110                     file_type);
1111
1112             *addinfo = odr_strdup(odr, addinfo_str);
1113             return_code = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
1114         }
1115         else
1116         {
1117             (*rt->retrieve)(clientData, &retrieveCtrl);
1118             return_code = retrieveCtrl.diagnostic;
1119
1120             *output_format = retrieveCtrl.output_format;
1121             *rec_bufp = (char *) retrieveCtrl.rec_buf;
1122             *rec_lenp = retrieveCtrl.rec_len;
1123             *addinfo = retrieveCtrl.addinfo;
1124         }
1125
1126         stream.destroy(&stream);
1127         rec_free(&rec);
1128     }
1129
1130     return return_code;
1131 }
1132
1133 /*
1134  * Local variables:
1135  * c-basic-offset: 4
1136  * indent-tabs-mode: nil
1137  * End:
1138  * vim: shiftwidth=4 tabstop=8 expandtab
1139  */
1140