Honor position attribute, i.e. allow first-in-field search. To
[idzebra-moved-to-github.git] / util / zebramap.c
index 3d75a41..b075257 100644 (file)
@@ -1,76 +1,46 @@
-/*
- * Copyright (C) 1994-1999, Index Data 
- * All rights reserved.
- * Sebastian Hammer, Adam Dickmeiss
- *
- * $Log: zebramap.c,v $
- * Revision 1.15  1999-05-26 07:49:14  adam
- * C++ compilation.
- *
- * Revision 1.14  1999/02/19 10:37:40  adam
- * Minor fix.
- *
- * Revision 1.13  1999/02/18 15:01:04  adam
- * Structure=key uses register type 0.
- *
- * Revision 1.12  1999/02/12 13:29:25  adam
- * Implemented position-flag for registers.
- *
- * Revision 1.11  1998/10/13 20:09:19  adam
- * Changed call to readconf_line.
- *
- * Revision 1.10  1998/06/23 15:33:37  adam
- * Added feature to specify sort criteria in query (type 7 specifies
- * sort flags).
- *
- * Revision 1.9  1998/04/02 14:35:30  adam
- * First version of Zebra that works with compiled ASN.1.
- *
- * Revision 1.8  1998/03/05 08:42:44  adam
- * Minor changes to zebramap data structures. Query mapping rules changed.
- *
- * Revision 1.7  1998/02/10 12:03:07  adam
- * Implemented Sort.
- *
- * Revision 1.6  1998/01/29 13:36:01  adam
- * Structure word-list, free-form-text and document-text all
- * trigger ranked search.
- *
- * Revision 1.5  1997/11/19 10:22:14  adam
- * Bug fix (introduced by previous commit).
- *
- * Revision 1.4  1997/11/18 10:05:08  adam
- * Changed character map facility so that admin can specify character
- * mapping files for each register type, w, p, etc.
- *
- * Revision 1.3  1997/11/17 15:35:26  adam
- * Bug fix. Relation=relevance wasn't observed.
- *
- * Revision 1.2  1997/10/31 12:39:30  adam
- * Changed log message.
- *
- * Revision 1.1  1997/10/27 14:33:06  adam
- * Moved towards generic character mapping depending on "structure"
- * field in abstract syntax file. Fixed a few memory leaks. Fixed
- * bug with negative integers when doing searches with relational
- * operators.
- *
- */
+/* $Id: zebramap.c,v 1.53 2006-09-08 14:41:00 adam Exp $
+   Copyright (C) 1995-2006
+   Index Data ApS
+
+   This file is part of the Zebra server.
+
+   Zebra is free software; you can redistribute it and/or modify it under
+   the terms of the GNU General Public License as published by the Free
+   Software Foundation; either version 2, or (at your option) any later
+   version.
+
+   Zebra is distributed in the hope that it will be useful, but WITHOUT ANY
+   WARRANTY; without even the implied warranty of MERCHANTABILITY or
+   FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
+   for more details.
+
+   You should have received a copy of the GNU General Public License
+   along with Zebra; see the file LICENSE.zebra.  If not, write to the
+   Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
+   02111-1307, USA.
+*/
 
 #include <assert.h>
+#include <stdlib.h>
 #include <ctype.h>
 
-#include <yaz-util.h>
 #include <charmap.h>
+#include <attrfind.h>
+#include <yaz/yaz-util.h>
+
 #include <zebramap.h>
 
 #define ZEBRA_MAP_TYPE_SORT  1
 #define ZEBRA_MAP_TYPE_INDEX 2
 
+#define ZEBRA_REPLACE_ANY  300
+
 struct zebra_map {
     unsigned reg_id;
     int completeness;
     int positioned;
+    int alwaysmatches;
+    int first_in_field;
     int type;
     union {
         struct {
@@ -87,63 +57,85 @@ struct zebra_map {
 
 struct zebra_maps {
     char *tabpath;
+    char *tabroot;
     NMEM nmem;
     struct zebra_map *map_list;
     char temp_map_str[2];
     const char *temp_map_ptr[2];
     struct zebra_map **lookup_array;
+    WRBUF wrbuf_1;
+    int no_maps;
 };
 
-void zebra_maps_close (ZebraMaps zms)
+void zebra_maps_close(ZebraMaps zms)
 {
     struct zebra_map *zm = zms->map_list;
     while (zm)
     {
        if (zm->maptab)
-           chrmaptab_destroy (zm->maptab);
+           chrmaptab_destroy(zm->maptab);
        zm = zm->next;
     }
-    nmem_destroy (zms->nmem);
-    xfree (zms);
+    wrbuf_free(zms->wrbuf_1, 1);
+    nmem_destroy(zms->nmem);
+    xfree(zms);
 }
 
-static void zebra_map_read (ZebraMaps zms, const char *name)
+ZEBRA_RES zebra_maps_read_file(ZebraMaps zms, const char *fname)
 {
     FILE *f;
     char line[512];
     char *argv[10];
     int argc;
     int lineno = 0;
+    int failures = 0;
     struct zebra_map **zm = 0, *zp;
 
-    if (!(f = yaz_path_fopen(zms->tabpath, name, "r")))
+    if (!(f = yaz_fopen(zms->tabpath, fname, "r", zms->tabroot)))
     {
-       logf(LOG_WARN|LOG_ERRNO, "%s", name);
-       return ;
+       yaz_log(YLOG_ERRNO|YLOG_FATAL, "%s", fname);
+       return ZEBRA_FAIL;
     }
     while ((argc = readconf_line(f, &lineno, line, 512, argv, 10)))
     {
-       if (!yaz_matchstr (argv[0], "index") && argc == 2)
+        if (argc == 1)
+        {
+            yaz_log(YLOG_WARN, "%s:%d: Missing arguments for '%s'",
+                    fname, lineno, argv[0]);
+            failures++;
+            break;
+        }
+        if (argc > 2)
+        {
+            yaz_log(YLOG_WARN, "%s:%d: Too many arguments for '%s'",
+                    fname, lineno, argv[0]);
+            failures++;
+            break;
+        }
+       if (!yaz_matchstr(argv[0], "index"))
        {
            if (!zm)
                zm = &zms->map_list;
            else
                zm = &(*zm)->next;
-           *zm = (struct zebra_map *) nmem_malloc (zms->nmem, sizeof(**zm));
+           *zm = (struct zebra_map *) nmem_malloc(zms->nmem, sizeof(**zm));
            (*zm)->reg_id = argv[1][0];
            (*zm)->maptab_name = NULL;
            (*zm)->maptab = NULL;
            (*zm)->type = ZEBRA_MAP_TYPE_INDEX;
            (*zm)->completeness = 0;
            (*zm)->positioned = 1;
+           (*zm)->alwaysmatches = 0;
+           (*zm)->first_in_field = 0;
+           zms->no_maps++;
        }
-       else if (!yaz_matchstr (argv[0], "sort") && argc == 2)
+       else if (!yaz_matchstr(argv[0], "sort"))
        {
            if (!zm)
                zm = &zms->map_list;
            else
                zm = &(*zm)->next;
-           *zm = (struct zebra_map *) nmem_malloc (zms->nmem, sizeof(**zm));
+           *zm = (struct zebra_map *) nmem_malloc(zms->nmem, sizeof(**zm));
            (*zm)->reg_id = argv[1][0];
            (*zm)->maptab_name = NULL;
            (*zm)->type = ZEBRA_MAP_TYPE_SORT;
@@ -151,47 +143,72 @@ static void zebra_map_read (ZebraMaps zms, const char *name)
            (*zm)->maptab = NULL;
            (*zm)->completeness = 0;
            (*zm)->positioned = 0;
+           (*zm)->alwaysmatches = 0;
+           (*zm)->first_in_field = 0;
+           zms->no_maps++;
+       }
+        else if (!zm)
+        {
+            yaz_log(YLOG_WARN, "%s:%d: Missing sort/index before '%s'",  
+                    fname, lineno, argv[0]);
+            failures++;
+        }
+       else if (!yaz_matchstr(argv[0], "charmap") && argc == 2)
+       {
+           (*zm)->maptab_name = nmem_strdup(zms->nmem, argv[1]);
+       }
+       else if (!yaz_matchstr(argv[0], "completeness") && argc == 2)
+       {
+           (*zm)->completeness = atoi(argv[1]);
        }
-       else if (zm && !yaz_matchstr (argv[0], "charmap") && argc == 2)
+       else if (!yaz_matchstr(argv[0], "position") && argc == 2)
        {
-           (*zm)->maptab_name = nmem_strdup (zms->nmem, argv[1]);
+           (*zm)->positioned = atoi(argv[1]);
        }
-       else if (zm && !yaz_matchstr (argv[0], "completeness") && argc == 2)
+       else if (!yaz_matchstr(argv[0], "alwaysmatches") && argc == 2)
        {
-           (*zm)->completeness = atoi (argv[1]);
+           (*zm)->alwaysmatches = atoi(argv[1]);
        }
-       else if (zm && !yaz_matchstr (argv[0], "position") && argc == 2)
+       else if (!yaz_matchstr(argv[0], "firstinfield") && argc == 2)
        {
-           (*zm)->positioned = atoi (argv[1]);
+           (*zm)->first_in_field = atoi(argv[1]);
        }
-        else if (zm && !yaz_matchstr (argv[0], "entrysize") && argc == 2)
+        else if (!yaz_matchstr(argv[0], "entrysize") && argc == 2)
         {
             if ((*zm)->type == ZEBRA_MAP_TYPE_SORT)
-               (*zm)->u.sort.entry_size = atoi (argv[1]);
+               (*zm)->u.sort.entry_size = atoi(argv[1]);
+        }
+        else
+        {
+            yaz_log(YLOG_WARN, "%s:%d: Unrecognized directive '%s'",  
+                    fname, lineno, argv[0]);
+            failures++;
         }
     }
     if (zm)
        (*zm)->next = NULL;
-    fclose (f);
+    yaz_fclose(f);
 
     for (zp = zms->map_list; zp; zp = zp->next)
        zms->lookup_array[zp->reg_id] = zp;
-}
 
-static void zms_map_handle (void *p, const char *name, const char *value)
-{
-    ZebraMaps zms = (ZebraMaps) p;
-    
-    zebra_map_read (zms, value);
+    if (failures)
+        return ZEBRA_FAIL;
+    return ZEBRA_OK;
 }
 
-ZebraMaps zebra_maps_open (Res res)
+ZebraMaps zebra_maps_open(Res res, const char *base_path,
+                         const char *profile_path)
 {
-    ZebraMaps zms = (ZebraMaps) xmalloc (sizeof(*zms));
+    ZebraMaps zms = (ZebraMaps) xmalloc(sizeof(*zms));
     int i;
 
-    zms->nmem = nmem_create ();
-    zms->tabpath = nmem_strdup (zms->nmem, res_get_def (res, "profilePath", "."));
+    zms->nmem = nmem_create();
+    zms->no_maps = 0;
+    zms->tabpath = nmem_strdup(zms->nmem, profile_path);
+    zms->tabroot = 0;
+    if (base_path)
+        zms->tabroot = nmem_strdup(zms->nmem, base_path);
     zms->map_list = NULL;
 
     zms->temp_map_str[0] = '\0';
@@ -201,29 +218,33 @@ ZebraMaps zebra_maps_open (Res res)
     zms->temp_map_ptr[1] = NULL;
 
     zms->lookup_array = (struct zebra_map**)
-       nmem_malloc (zms->nmem, sizeof(*zms->lookup_array)*256);
+       nmem_malloc(zms->nmem, sizeof(*zms->lookup_array)*256);
+    zms->wrbuf_1 = wrbuf_alloc();
+
     for (i = 0; i<256; i++)
        zms->lookup_array[i] = 0;
-    if (!res || !res_trav (res, "index", zms, zms_map_handle))
-       zebra_map_read (zms, "default.idx");
     return zms;
 }
 
-struct zebra_map *zebra_map_get (ZebraMaps zms, unsigned reg_id)
+struct zebra_map *zebra_map_get(ZebraMaps zms, unsigned reg_id)
 {
+    assert(reg_id >= 0 && reg_id <= 255);
     return zms->lookup_array[reg_id];
 }
 
-chrmaptab zebra_charmap_get (ZebraMaps zms, unsigned reg_id)
+chrmaptab zebra_charmap_get(ZebraMaps zms, unsigned reg_id)
 {
-    struct zebra_map *zm = zebra_map_get (zms, reg_id);
+    struct zebra_map *zm = zebra_map_get(zms, reg_id);
     if (!zm)
     {
-       zm = (struct zebra_map *) nmem_malloc (zms->nmem, sizeof(*zm));
-       logf (LOG_WARN, "Unknown register type: %c", reg_id);
+       zm = (struct zebra_map *) nmem_malloc(zms->nmem, sizeof(*zm));
+       
+       /* no reason to warn if no maps are installed at ALL */
+       if (zms->no_maps)
+           yaz_log(YLOG_WARN, "Unknown register type: %c", reg_id);
 
        zm->reg_id = reg_id;
-       zm->maptab_name = NULL;
+       zm->maptab_name = nmem_strdup(zms->nmem, "@");
        zm->maptab = NULL;
        zm->type = ZEBRA_MAP_TYPE_INDEX;
        zm->completeness = 0;
@@ -234,26 +255,27 @@ chrmaptab zebra_charmap_get (ZebraMaps zms, unsigned reg_id)
     }
     if (!zm->maptab)
     {
-       if (!zm->maptab_name || !yaz_matchstr (zm->maptab_name, "@"))
+       if (!zm->maptab_name || !yaz_matchstr(zm->maptab_name, "@"))
            return NULL;
-       if (!(zm->maptab = chrmaptab_create (zms->tabpath,
-                                            zm->maptab_name, 0)))
-           logf(LOG_WARN, "Failed to read character table %s",
-                zm->maptab_name);
+       if (!(zm->maptab = chrmaptab_create(zms->tabpath,
+                                           zm->maptab_name,
+                                           zms->tabroot)))
+           yaz_log(YLOG_WARN, "Failed to read character table %s",
+                   zm->maptab_name);
        else
-           logf(LOG_DEBUG, "Read character table %s", zm->maptab_name);
+           yaz_log(YLOG_DEBUG, "Read character table %s", zm->maptab_name);
     }
     return zm->maptab;
 }
 
-const char **zebra_maps_input (ZebraMaps zms, unsigned reg_id,
-                              const char **from, int len)
+const char **zebra_maps_input(ZebraMaps zms, unsigned reg_id,
+                             const char **from, int len, int first)
 {
     chrmaptab maptab;
 
-    maptab = zebra_charmap_get (zms, reg_id);
+    maptab = zebra_charmap_get(zms, reg_id);
     if (maptab)
-       return chr_map_input(maptab, from, len);
+       return chr_map_input(maptab, from, len, first);
     
     zms->temp_map_str[0] = **from;
 
@@ -261,156 +283,130 @@ const char **zebra_maps_input (ZebraMaps zms, unsigned reg_id,
     return zms->temp_map_ptr;
 }
 
-const char *zebra_maps_output(ZebraMaps zms, unsigned reg_id,
-                             const char **from)
+const char **zebra_maps_search(ZebraMaps zms, unsigned reg_id,
+                              const char **from, int len,  int *q_map_match)
 {
     chrmaptab maptab;
-    unsigned char i = (unsigned char) **from;
-    static char buf[2] = {0,0};
-
-    maptab = zebra_charmap_get (zms, reg_id);
+    
+    *q_map_match = 0;
+    maptab = zebra_charmap_get(zms, reg_id);
     if (maptab)
-       return chr_map_output (maptab, from, 1);
-    (*from)++;
-    buf[0] = i;
-    return buf;
-}
-
-
-/* ------------------------------------ */
-
-typedef struct {
-    int type;
-    int major;
-    int minor;
-    Z_AttributeElement **attributeList;
-    int num_attributes;
-} AttrType;
-
-static int attr_find (AttrType *src, oid_value *attributeSetP)
-{
-    while (src->major < src->num_attributes)
     {
-        Z_AttributeElement *element;
-
-        element = src->attributeList[src->major];
-        if (src->type == *element->attributeType)
-        {
-            switch (element->which) 
-            {
-            case Z_AttributeValue_numeric:
-                ++(src->major);
-                if (element->attributeSet && attributeSetP)
-                {
-                    oident *attrset;
-
-                    attrset = oid_getentbyoid (element->attributeSet);
-                    *attributeSetP = attrset->value;
-                }
-                return *element->value.numeric;
-                break;
-            case Z_AttributeValue_complex:
-                if (src->minor >= element->value.complex->num_list ||
-                    element->value.complex->list[src->minor]->which !=  
-                    Z_StringOrNumeric_numeric)
-                    break;
-                ++(src->minor);
-                if (element->attributeSet && attributeSetP)
-                {
-                    oident *attrset;
-
-                    attrset = oid_getentbyoid (element->attributeSet);
-                    *attributeSetP = attrset->value;
-                }
-                return *element->value.complex->list[src->minor-1]->u.numeric;
-            default:
-                assert (0);
-            }
-        }
-        ++(src->major);
+       const char **map;
+       map = chr_map_q_input(maptab, from, len, 0);
+       if (map && map[0])
+       {
+           *q_map_match = 1;
+           return map;
+       }
+       map = chr_map_input(maptab, from, len, 0);
+       if (map)
+           return map;
     }
-    return -1;
-}
+    zms->temp_map_str[0] = **from;
 
-static void attr_init_APT (AttrType *src, Z_AttributesPlusTerm *zapt, int type)
-{
-#ifdef ASN_COMPILED
-    src->attributeList = zapt->attributes->attributes;
-    src->num_attributes = zapt->attributes->num_attributes;
-#else
-    src->attributeList = zapt->attributeList;
-    src->num_attributes = zapt->num_attributes;
-#endif
-    src->type = type;
-    src->major = 0;
-    src->minor = 0;
+    (*from)++;
+    return zms->temp_map_ptr;
 }
 
-static void attr_init_AttrList (AttrType *src, Z_AttributeList *list, int type)
+const char *zebra_maps_output(ZebraMaps zms, unsigned reg_id,
+                             const char **from)
 {
-    src->attributeList = list->attributes;
-    src->num_attributes = list->num_attributes;
-    src->type = type;
-    src->major = 0;
-    src->minor = 0;
+    chrmaptab maptab = zebra_charmap_get(zms, reg_id);
+    if (!maptab)
+       return 0;
+    return chr_map_output(maptab, from, 1);
 }
 
+
 /* ------------------------------------ */
 
-int zebra_maps_is_complete (ZebraMaps zms, unsigned reg_id)
+int zebra_maps_is_complete(ZebraMaps zms, unsigned reg_id)
 { 
-    struct zebra_map *zm = zebra_map_get (zms, reg_id);
+    struct zebra_map *zm = zebra_map_get(zms, reg_id);
     if (zm)
        return zm->completeness;
     return 0;
 }
 
-int zebra_maps_is_positioned (ZebraMaps zms, unsigned reg_id)
+int zebra_maps_is_positioned(ZebraMaps zms, unsigned reg_id)
 {
-    struct zebra_map *zm = zebra_map_get (zms, reg_id);
+    struct zebra_map *zm = zebra_map_get(zms, reg_id);
     if (zm)
        return zm->positioned;
     return 0;
 }
     
-int zebra_maps_is_sort (ZebraMaps zms, unsigned reg_id)
+int zebra_maps_is_sort(ZebraMaps zms, unsigned reg_id)
 {
-    struct zebra_map *zm = zebra_map_get (zms, reg_id);
+    struct zebra_map *zm = zebra_map_get(zms, reg_id);
     if (zm)
        return zm->type == ZEBRA_MAP_TYPE_SORT;
     return 0;
 }
 
-int zebra_maps_sort (ZebraMaps zms, Z_SortAttributes *sortAttributes)
+int zebra_maps_is_alwaysmatches(ZebraMaps zms, unsigned reg_id)
 {
-    AttrType use;
-    attr_init_AttrList (&use, sortAttributes->list, 1);
+    struct zebra_map *zm = zebra_map_get(zms, reg_id);
+    if (zm)
+       return zm->alwaysmatches;
+    return 0;
+}
+
+int zebra_maps_is_first_in_field(ZebraMaps zms, unsigned reg_id)
+{
+    struct zebra_map *zm = zebra_map_get(zms, reg_id);
+    if (zm)
+       return zm->first_in_field;
+    return 0;
+}
 
-    return attr_find (&use, NULL);
+int zebra_maps_sort(ZebraMaps zms, Z_SortAttributes *sortAttributes,
+                   int *numerical)
+{
+    AttrType use;
+    AttrType structure;
+    int structure_value;
+    attr_init_AttrList(&use, sortAttributes->list, 1);
+    attr_init_AttrList(&structure, sortAttributes->list, 4);
+
+    *numerical = 0;
+    structure_value = attr_find(&structure, 0);
+    if (structure_value == 109)
+        *numerical = 1;
+    return attr_find(&use, NULL);
 }
 
-int zebra_maps_attr (ZebraMaps zms, Z_AttributesPlusTerm *zapt,
-                    unsigned *reg_id, char **search_type, char **rank_type,
-                    int *complete_flag, int *sort_flag)
+int zebra_maps_attr(ZebraMaps zms, Z_AttributesPlusTerm *zapt,
+                   unsigned *reg_id, char **search_type, char *rank_type,
+                   int *complete_flag, int *sort_flag)
 {
     AttrType completeness;
     AttrType structure;
     AttrType relation;
     AttrType sort_relation;
+    AttrType weight;
+    AttrType use;
     int completeness_value;
     int structure_value;
     int relation_value;
     int sort_relation_value;
-
-    attr_init_APT (&structure, zapt, 4);
-    attr_init_APT (&completeness, zapt, 6);
-    attr_init_APT (&relation, zapt, 2);
-    attr_init_APT (&sort_relation, zapt, 7);
-
-    completeness_value = attr_find (&completeness, NULL);
-    structure_value = attr_find (&structure, NULL);
-    relation_value = attr_find (&relation, NULL);
-    sort_relation_value = attr_find (&sort_relation, NULL);
+    int weight_value;
+    int use_value;
+
+    attr_init_APT(&structure, zapt, 4);
+    attr_init_APT(&completeness, zapt, 6);
+    attr_init_APT(&relation, zapt, 2);
+    attr_init_APT(&sort_relation, zapt, 7);
+    attr_init_APT(&weight, zapt, 9);
+    attr_init_APT(&use, zapt, 1);
+
+    completeness_value = attr_find(&completeness, NULL);
+    structure_value = attr_find(&structure, NULL);
+    relation_value = attr_find(&relation, NULL);
+    sort_relation_value = attr_find(&sort_relation, NULL);
+    weight_value = attr_find(&weight, NULL);
+    use_value = attr_find(&use, NULL);
 
     if (completeness_value == 2 || completeness_value == 3)
        *complete_flag = 1;
@@ -418,12 +414,15 @@ int zebra_maps_attr (ZebraMaps zms, Z_AttributesPlusTerm *zapt,
        *complete_flag = 0;
     *reg_id = 0;
 
-    *sort_flag = (sort_relation_value > 0) ? 1 : 0;
+    *sort_flag =(sort_relation_value > 0) ? 1 : 0;
     *search_type = "phrase";
-    *rank_type = "void";
+    strcpy(rank_type, "void");
     if (relation_value == 102)
-       *rank_type = "rank";
-    
+    {
+        if (weight_value == -1)
+            weight_value = 34;
+        sprintf(rank_type, "rank,w=%d,u=%d", weight_value, use_value);
+    }
     if (*complete_flag)
        *reg_id = 'p';
     else
@@ -461,8 +460,33 @@ int zebra_maps_attr (ZebraMaps zms, Z_AttributesPlusTerm *zapt,
         *reg_id = '0';
         *search_type = "phrase";
         break;
+    case 4:  /* year */
+        *reg_id = 'y';
+        *search_type = "phrase";
+        break;
+    case 5:  /* date */
+        *reg_id = 'd';
+        *search_type = "phrase";
+        break;
     default:
        return -1;
     }
     return 0;
 }
+
+WRBUF zebra_replace(ZebraMaps zms, unsigned reg_id, const char *ex_list,
+                   const char *input_str, int input_len)
+{
+    wrbuf_rewind(zms->wrbuf_1);
+    wrbuf_write(zms->wrbuf_1, input_str, input_len);
+    return zms->wrbuf_1;
+}
+
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+