1 /* $Id: zebramap.c,v 1.61 2007-10-31 16:56:15 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 Zebra; see the file LICENSE.zebra. If not, write to the
19 Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
29 #include <yaz/yaz-util.h>
33 #define ZEBRA_MAP_TYPE_SORT 1
34 #define ZEBRA_MAP_TYPE_INDEX 2
35 #define ZEBRA_MAP_TYPE_STATICRANK 3
37 #define ZEBRA_REPLACE_ANY 300
52 const char *maptab_name;
53 zebra_maps_t zebra_maps;
54 struct zebra_map *next;
62 const char *temp_map_ptr[2];
66 zebra_map_t *last_map;
69 void zebra_maps_close(zebra_maps_t zms)
71 struct zebra_map *zm = zms->map_list;
75 chrmaptab_destroy(zm->maptab);
78 wrbuf_destroy(zms->wrbuf_1);
79 nmem_destroy(zms->nmem);
83 zebra_map_t zebra_add_map(zebra_maps_t zms, const char *index_type,
86 zebra_map_t zm = (zebra_map_t) nmem_malloc(zms->nmem, sizeof(*zm));
89 zm->id = nmem_strdup(zms->nmem, index_type);
95 zm->alwaysmatches = 0;
96 zm->first_in_field = 0;
100 zms->last_map = &zm->next;
107 ZEBRA_RES zebra_maps_read_file(zebra_maps_t zms, const char *fname)
117 if (!(f = yaz_fopen(zms->tabpath, fname, "r", zms->tabroot)))
119 yaz_log(YLOG_ERRNO|YLOG_FATAL, "%s", fname);
122 while ((argc = readconf_line(f, &lineno, line, 512, argv, 10)))
126 yaz_log(YLOG_WARN, "%s:%d: Missing arguments for '%s'",
127 fname, lineno, argv[0]);
133 yaz_log(YLOG_WARN, "%s:%d: Too many arguments for '%s'",
134 fname, lineno, argv[0]);
138 if (!yaz_matchstr(argv[0], "index"))
140 zm = zebra_add_map(zms, argv[1], ZEBRA_MAP_TYPE_INDEX);
143 else if (!yaz_matchstr(argv[0], "sort"))
145 zm = zebra_add_map(zms, argv[1], ZEBRA_MAP_TYPE_SORT);
146 zm->u.sort.entry_size = 80;
148 else if (!yaz_matchstr(argv[0], "staticrank"))
150 zm = zebra_add_map(zms, argv[1], ZEBRA_MAP_TYPE_STATICRANK);
151 zm->completeness = 1;
155 yaz_log(YLOG_WARN, "%s:%d: Missing sort/index before '%s'",
156 fname, lineno, argv[0]);
159 else if (!yaz_matchstr(argv[0], "charmap") && argc == 2)
161 if (zm->type != ZEBRA_MAP_TYPE_STATICRANK)
162 zm->maptab_name = nmem_strdup(zms->nmem, argv[1]);
165 yaz_log(YLOG_WARN|YLOG_FATAL, "%s:%d: charmap for "
166 "staticrank is invalid", fname, lineno);
167 yaz_log(YLOG_LOG, "Type is %d", zm->type);
171 else if (!yaz_matchstr(argv[0], "completeness") && argc == 2)
173 zm->completeness = atoi(argv[1]);
175 else if (!yaz_matchstr(argv[0], "position") && argc == 2)
177 zm->positioned = atoi(argv[1]);
179 else if (!yaz_matchstr(argv[0], "alwaysmatches") && argc == 2)
181 if (zm->type != ZEBRA_MAP_TYPE_STATICRANK)
182 zm->alwaysmatches = atoi(argv[1]);
185 yaz_log(YLOG_WARN|YLOG_FATAL, "%s:%d: alwaysmatches for "
186 "staticrank is invalid", fname, lineno);
190 else if (!yaz_matchstr(argv[0], "firstinfield") && argc == 2)
192 zm->first_in_field = atoi(argv[1]);
194 else if (!yaz_matchstr(argv[0], "entrysize") && argc == 2)
196 if (zm->type == ZEBRA_MAP_TYPE_SORT)
197 zm->u.sort.entry_size = atoi(argv[1]);
201 "%s:%d: entrysize only valid in sort section",
209 yaz_log(YLOG_WARN, "%s:%d: Unrecognized directive '%s'",
210 fname, lineno, argv[0]);
221 zebra_maps_t zebra_maps_open(Res res, const char *base_path,
222 const char *profile_path)
224 zebra_maps_t zms = (zebra_maps_t) xmalloc(sizeof(*zms));
226 zms->nmem = nmem_create();
228 zms->tabpath = profile_path ? nmem_strdup(zms->nmem, profile_path) : 0;
231 zms->tabroot = nmem_strdup(zms->nmem, base_path);
233 zms->last_map = &zms->map_list;
235 zms->temp_map_str[0] = '\0';
236 zms->temp_map_str[1] = '\0';
238 zms->temp_map_ptr[0] = zms->temp_map_str;
239 zms->temp_map_ptr[1] = NULL;
241 zms->wrbuf_1 = wrbuf_alloc();
246 zebra_map_t zebra_map_get(zebra_maps_t zms, const char *id)
249 for (zm = zms->map_list; zm; zm = zm->next)
250 if (!strcmp(zm->id, id))
255 zebra_map_t zebra_map_get_or_add(zebra_maps_t zms, const char *id)
257 struct zebra_map *zm = zebra_map_get(zms, id);
260 zm = zebra_add_map(zms, id, ZEBRA_MAP_TYPE_INDEX);
262 /* no reason to warn if no maps are installed at ALL
263 Note that zebra_add_maps increments no_maps ..
265 if (zms->no_maps > 1)
266 yaz_log(YLOG_WARN, "Unknown register type: %s", id);
270 zm->maptab_name = nmem_strdup(zms->nmem, "@");
271 zm->completeness = 0;
277 chrmaptab zebra_charmap_get(zebra_map_t zm)
281 if (!zm->maptab_name || !yaz_matchstr(zm->maptab_name, "@"))
283 if (!(zm->maptab = chrmaptab_create(zm->zebra_maps->tabpath,
285 zm->zebra_maps->tabroot)))
286 yaz_log(YLOG_WARN, "Failed to read character table %s",
289 yaz_log(YLOG_DEBUG, "Read character table %s", zm->maptab_name);
294 const char **zebra_maps_input(zebra_map_t zm,
295 const char **from, int len, int first)
297 chrmaptab maptab = zebra_charmap_get(zm);
299 return chr_map_input(maptab, from, len, first);
301 zm->zebra_maps->temp_map_str[0] = **from;
304 return zm->zebra_maps->temp_map_ptr;
307 const char **zebra_maps_search(zebra_map_t zm,
308 const char **from, int len, int *q_map_match)
313 maptab = zebra_charmap_get(zm);
317 map = chr_map_q_input(maptab, from, len, 0);
323 map = chr_map_input(maptab, from, len, 0);
327 zm->zebra_maps->temp_map_str[0] = **from;
330 return zm->zebra_maps->temp_map_ptr;
333 const char *zebra_maps_output(zebra_map_t zm,
336 chrmaptab maptab = zebra_charmap_get(zm);
339 return chr_map_output(maptab, from, 1);
343 /* ------------------------------------ */
345 int zebra_maps_is_complete(zebra_map_t zm)
348 return zm->completeness;
352 int zebra_maps_is_positioned(zebra_map_t zm)
355 return zm->positioned;
359 int zebra_maps_is_index(zebra_map_t zm)
362 return zm->type == ZEBRA_MAP_TYPE_INDEX;
366 int zebra_maps_is_staticrank(zebra_map_t zm)
369 return zm->type == ZEBRA_MAP_TYPE_STATICRANK;
373 int zebra_maps_is_sort(zebra_map_t zm)
376 return zm->type == ZEBRA_MAP_TYPE_SORT;
380 int zebra_maps_is_alwaysmatches(zebra_map_t zm)
383 return zm->alwaysmatches;
387 int zebra_maps_is_first_in_field(zebra_map_t zm)
390 return zm->first_in_field;
394 int zebra_maps_sort(zebra_maps_t zms, Z_SortAttributes *sortAttributes,
400 attr_init_AttrList(&use, sortAttributes->list, 1);
401 attr_init_AttrList(&structure, sortAttributes->list, 4);
404 structure_value = attr_find(&structure, 0);
405 if (structure_value == 109)
407 return attr_find(&use, NULL);
410 int zebra_maps_attr(zebra_maps_t zms, Z_AttributesPlusTerm *zapt,
411 const char **index_type, char **search_type, char *rank_type,
412 int *complete_flag, int *sort_flag)
414 AttrType completeness;
417 AttrType sort_relation;
420 int completeness_value;
422 const char *structure_str = 0;
424 int sort_relation_value;
428 attr_init_APT(&structure, zapt, 4);
429 attr_init_APT(&completeness, zapt, 6);
430 attr_init_APT(&relation, zapt, 2);
431 attr_init_APT(&sort_relation, zapt, 7);
432 attr_init_APT(&weight, zapt, 9);
433 attr_init_APT(&use, zapt, 1);
435 completeness_value = attr_find(&completeness, NULL);
436 structure_value = attr_find_ex(&structure, NULL, &structure_str);
437 relation_value = attr_find(&relation, NULL);
438 sort_relation_value = attr_find(&sort_relation, NULL);
439 weight_value = attr_find(&weight, NULL);
440 use_value = attr_find(&use, NULL);
442 if (completeness_value == 2 || completeness_value == 3)
448 *sort_flag =(sort_relation_value > 0) ? 1 : 0;
449 *search_type = "phrase";
450 strcpy(rank_type, "void");
451 if (relation_value == 102)
453 if (weight_value == -1)
455 sprintf(rank_type, "rank,w=%d,u=%d", weight_value, use_value);
461 switch (structure_value)
463 case 6: /* word list */
464 *search_type = "and-list";
466 case 105: /* free-form-text */
467 *search_type = "or-list";
469 case 106: /* document-text */
470 *search_type = "or-list";
475 case 108: /* string */
476 *search_type = "phrase";
478 case 107: /* local-number */
479 *search_type = "local";
482 case 109: /* numeric string */
484 *search_type = "numeric";
488 *search_type = "phrase";
492 *search_type = "phrase";
496 *search_type = "phrase";
500 *search_type = "phrase";
503 if (structure_str && *structure_str)
504 *index_type = structure_str;
514 WRBUF zebra_replace(zebra_map_t zm, const char *ex_list,
515 const char *input_str, int input_len)
517 wrbuf_rewind(zm->zebra_maps->wrbuf_1);
518 wrbuf_write(zm->zebra_maps->wrbuf_1, input_str, input_len);
519 return zm->zebra_maps->wrbuf_1;
525 * indent-tabs-mode: nil
527 * vim: shiftwidth=4 tabstop=8 expandtab