1 /* $Id: rpnscan.c,v 1.25 2008-01-24 16:17:03 adam Exp $
2 Copyright (C) 1995-2007
5 This file is part of the Zebra server.
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
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
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
33 #include <yaz/diagbib1.h>
35 #include <zebra_xpath.h>
36 #include <yaz/wrbuf.h>
40 #include <yaz/oid_db.h>
42 #define RPN_MAX_ORDS 32
44 /* convert APT SCAN term to internal cmap */
45 static ZEBRA_RES trans_scan_term(ZebraHandle zh, Z_AttributesPlusTerm *zapt,
46 char *termz, zebra_map_t zm)
48 char term_utf8[IT_MAX_WORD];
50 if (zapt_term_to_utf8(zh, zapt, term_utf8) == ZEBRA_FAIL)
51 return ZEBRA_FAIL; /* error */
52 else if (zebra_maps_is_icu(zm))
56 zebra_map_tokenize_start(zm, term_utf8, strlen(term_utf8));
58 if (zebra_map_tokenize_next(zm, &res_buf, &res_len, 0, 0))
60 memcpy(termz, res_buf, res_len);
61 termz[res_len] = '\0';
69 const char *cp = (const char *) term_utf8;
70 const char *cp_end = cp + strlen(cp);
73 const char *space_map = NULL;
76 while ((len = (cp_end - cp)) > 0)
78 map = zebra_maps_input(zm, &cp, len, 0);
79 if (**map == *CHR_SPACE)
84 for (src = space_map; *src; src++)
87 for (src = *map; *src; src++)
96 static void get_first_snippet_from_rset(ZebraHandle zh,
97 RSET rset, zebra_snippets *snippets,
103 size_t sysno_mem_index = 0;
105 if (zh->m_staticrank)
108 yaz_log(YLOG_DEBUG, "get_first_snippet_from_rset");
110 rfd = rset_open(rset, RSETF_READ);
112 while (rset_read(rfd, &key, &termid))
114 if (key.mem[sysno_mem_index] != *sysno)
118 *sysno = key.mem[sysno_mem_index];
123 for (ol = termid->ol; ol; ol = ol->next)
125 zebra_snippets_append(snippets, key.mem[key.len-1], 0,
126 ol->ord, termid->name);
133 struct scan2_info_entry {
141 static int scan_handle2(char *name, const char *info, int pos, void *client)
144 struct scan2_info_entry *scan_info = (struct scan2_info_entry *) client;
146 if (scan_info->pos_to_save != pos)
149 len_prefix = strlen(scan_info->prefix);
150 if (memcmp(name, scan_info->prefix, len_prefix))
153 /* skip special terms such as first-in-field specials */
154 if (name[len_prefix] < CHR_BASE_CHAR)
157 wrbuf_rewind(scan_info->term);
158 wrbuf_puts(scan_info->term, name+len_prefix);
160 assert(*info == sizeof(ISAM_P));
161 memcpy(&scan_info->isam_p, info+1, sizeof(ISAM_P));
166 static int scan_save_set(ZebraHandle zh, ODR stream, NMEM nmem,
167 struct rset_key_control *kc,
168 Z_AttributesPlusTerm *zapt,
171 const char *index_type,
172 struct scan2_info_entry *ar, int ord_no,
173 ZebraScanEntry *glist, int pos)
177 zint approx_limit = zh->approx_limit;
178 AttrType global_hits_limit_attr;
180 attr_init_APT(&global_hits_limit_attr, zapt, 12);
182 l = attr_find(&global_hits_limit_attr, NULL);
186 for (i = 0; i < ord_no; i++)
188 if (ar[i].isam_p && strcmp(wrbuf_cstr(ar[i].term), term) == 0)
190 struct ord_list *ol = ord_list_create(nmem);
193 ol = ord_list_append(nmem, ol, ar[i].ord);
197 zh, &ar[i].isam_p, 1,
198 wrbuf_buf(ar[i].term), wrbuf_len(ar[i].term),
199 NULL, 1, zapt->term->which, nmem,
200 kc, kc->scope, ol, index_type,
201 0 /* hits_limit_value */,
202 0 /* term_ref_id_str */);
211 rset = rset_create_or(nmem, kc, kc->scope, 0 /* termid */,
220 /* merge with limit_set if given */
225 rsets[1] = rset_dup(limit_set);
227 rset = rset_create_and(nmem, kc, kc->scope, 2, rsets);
230 zebra_count_set(zh, rset, &count, approx_limit);
235 zebra_snippets *hit_snippets = zebra_snippets_create();
238 glist[pos].display_term = 0;
240 get_first_snippet_from_rset(zh, rset, hit_snippets, &sysno);
243 zebra_snippets *rec_snippets = zebra_snippets_create();
244 int code = zebra_get_rec_snippets(zh, sysno, rec_snippets);
247 const struct zebra_snippet_word *w =
248 zebra_snippets_lookup(rec_snippets, hit_snippets);
251 glist[pos].display_term = odr_strdup(stream, w->term);
255 yaz_log(YLOG_WARN, "zebra_snippets_lookup failed for pos=%d", pos);
258 zebra_snippets_destroy(rec_snippets);
260 if (zebra_term_untrans_iconv(zh, stream->mem, index_type,
261 &glist[pos].term, term))
263 /* failed.. use display_term instead (which could be 0) */
264 glist[pos].term = glist[pos].display_term;
267 if (!glist[pos].term)
269 yaz_log(YLOG_WARN, "Could not generate scan term for pos=%d",
271 glist[pos].term = "None";
273 glist[pos].occurrences = count;
274 zebra_snippets_destroy(hit_snippets);
285 static ZEBRA_RES rpn_scan_norm(ZebraHandle zh, ODR stream, NMEM nmem,
286 struct rset_key_control *kc,
287 Z_AttributesPlusTerm *zapt,
288 int *position, int *num_entries,
289 ZebraScanEntry **list,
290 int *is_partial, RSET limit_set,
291 const char *index_type,
292 int ord_no, int *ords)
294 struct scan2_info_entry *ar = nmem_malloc(nmem, sizeof(*ar) * ord_no);
295 struct rpn_char_map_info rcmi;
296 zebra_map_t zm = zebra_map_get_or_add(zh->reg->zebra_maps, index_type);
301 ZebraScanEntry *glist = (ZebraScanEntry *)
302 odr_malloc(stream, *num_entries * sizeof(*glist));
305 if (*position > *num_entries+1)
312 rpn_char_map_prepare(zh->reg, zm, &rcmi);
314 for (i = 0; i < ord_no; i++)
315 ar[i].term = wrbuf_alloc();
317 for (i = 0; i < ord_no; i++)
319 char termz[IT_MAX_WORD+20];
322 prefix_len = key_SU_encode(ords[i], termz);
323 termz[prefix_len] = 0;
324 strcpy(ar[i].prefix, termz);
326 if (trans_scan_term(zh, zapt, termz+prefix_len, zm) ==
329 for (i = 0; i < ord_no; i++)
330 wrbuf_destroy(ar[i].term);
333 wrbuf_rewind(ar[i].term);
334 wrbuf_puts(ar[i].term, termz + prefix_len);
338 /** deal with terms before position .. */
339 /* the glist index starts at zero (unlike scan positions */
340 for (pos = *position-2; pos >= 0; )
344 /* scan on all maximum terms */
345 for (i = 0; i < ord_no; i++)
347 if (ar[i].isam_p == 0)
349 char termz[IT_MAX_WORD+20];
353 ar[i].pos_to_save = -1;
355 strcpy(termz, ar[i].prefix);
356 strcat(termz, wrbuf_cstr(ar[i].term));
357 dict_scan(zh->reg->dict, termz, &before, &after,
361 /* get maximum after scan */
362 for (i = 0; i < ord_no; i++)
365 && (hi == 0 || strcmp(wrbuf_cstr(ar[i].term), hi) > 0))
366 hi = wrbuf_cstr(ar[i].term);
370 if (scan_save_set(zh, stream, nmem, kc, zapt, limit_set, hi,
371 index_type, ar, ord_no, glist,
372 (pos >= 0 && pos < *num_entries) ? pos : -1))
375 /* see if we got all terms before.. */
379 /* did not get all terms; adjust the real position and reduce
381 yaz_log(YLOG_LOG, "before terms dif=%d", dif);
387 for (i = 0; i < ord_no; i++)
389 char termz[IT_MAX_WORD+20];
392 prefix_len = key_SU_encode(ords[i], termz);
393 termz[prefix_len] = 0;
394 strcpy(ar[i].prefix, termz);
396 if (trans_scan_term(zh, zapt, termz+prefix_len, zm) ==
399 wrbuf_rewind(ar[i].term);
400 wrbuf_puts(ar[i].term, termz + prefix_len);
405 after_pos = 1; /* immediate term first.. */
406 for (pos = *position-1; pos < *num_entries; )
410 /* scan on all minimum terms */
411 for (i = 0; i < ord_no; i++)
413 if (ar[i].isam_p == 0)
415 char termz[IT_MAX_WORD+20];
417 int after = after_pos;
419 ar[i].pos_to_save = 1;
421 strcpy(termz, ar[i].prefix);
422 strcat(termz, wrbuf_cstr(ar[i].term));
423 dict_scan(zh->reg->dict, termz, &before, &after,
427 after_pos = 2; /* next round we grab following term */
429 /* get minimum after scan */
430 for (i = 0; i < ord_no; i++)
433 && (lo == 0 || strcmp(wrbuf_cstr(ar[i].term), lo) < 0))
434 lo = wrbuf_cstr(ar[i].term);
438 if (scan_save_set(zh, stream, nmem, kc, zapt, limit_set, lo,
439 index_type, ar, ord_no, glist,
440 (pos >= 0 && pos < *num_entries) ? pos : -1))
444 if (pos != *num_entries)
455 for (i = 0; i < ord_no; i++)
456 wrbuf_destroy(ar[i].term);
461 struct scan1_info_entry {
467 struct scan1_info_entry *list;
473 ZEBRA_RES rpn_scan(ZebraHandle zh, ODR stream, Z_AttributesPlusTerm *zapt,
474 const Odr_oid *attributeset,
475 int num_bases, char **basenames,
476 int *position, int *num_entries, ZebraScanEntry **list,
477 int *is_partial, const char *set_name)
480 int ords[RPN_MAX_ORDS], ord_no = 0;
482 const char *index_type;
483 char *search_type = NULL;
489 struct rset_key_control *kc = 0;
496 attributeset = yaz_oid_attset_bib_1;
500 /* see if there is a @attr 8=set */
502 int termset_value_numeric;
503 const char *termset_value_string = 0;
504 attr_init_APT(&termset, zapt, 8);
505 termset_value_numeric =
506 attr_find_ex(&termset, NULL, &termset_value_string);
507 if (termset_value_numeric != -1)
509 if (termset_value_numeric != -2)
512 sprintf(resname, "%d", termset_value_numeric);
513 set_name = odr_strdup(stream, resname);
516 set_name = odr_strdup(stream, termset_value_string);
522 limit_set = resultSetRef(zh, set_name);
527 YAZ_BIB1_SPECIFIED_RESULT_SET_DOES_NOT_EXIST,
533 yaz_log(YLOG_DEBUG, "position = %d, num = %d",
534 *position, *num_entries);
536 if (zebra_maps_attr(zh->reg->zebra_maps, zapt, &index_type, &search_type,
537 rank_type, &complete_flag, &sort_flag))
540 zebra_setError(zh, YAZ_BIB1_UNSUPP_ATTRIBUTE_TYPE, 0);
543 if (num_bases > RPN_MAX_ORDS)
545 zebra_setError(zh, YAZ_BIB1_TOO_MANY_DATABASES_SPECIFIED, 0);
548 for (base_no = 0; base_no < num_bases; base_no++)
552 if (zebraExplain_curDatabase(zh->reg->zei, basenames[base_no]))
554 zebra_setError(zh, YAZ_BIB1_DATABASE_UNAVAILABLE,
559 if (zebra_apt_get_ord(zh, zapt, index_type, 0, attributeset, &ord)
562 ords[ord_no++] = ord;
566 *num_entries = 0; /* zebra_apt_get_ord should set error reason */
569 if (*num_entries < 1)
574 nmem = nmem_create();
575 kc = zebra_key_control_create(zh);
577 res = rpn_scan_norm(zh, stream, nmem, kc, zapt, position, num_entries,
578 list, is_partial, limit_set,
579 index_type, ord_no, ords);
588 * indent-tabs-mode: nil
590 * vim: shiftwidth=4 tabstop=8 expandtab