First work on regular expressions/truncations.
[idzebra-moved-to-github.git] / index / zrpn.c
index 08897a4..c0e9b06 100644 (file)
@@ -1,10 +1,43 @@
 /*
- * Copyright (C) 1995, Index Data I/S 
+ * Copyright (C) 1994-1995, Index Data I/S 
  * All rights reserved.
  * Sebastian Hammer, Adam Dickmeiss
  *
  * $Log: zrpn.c,v $
- * Revision 1.1  1995-09-04 09:10:40  adam
+ * Revision 1.11  1995-09-14 11:53:27  adam
+ * First work on regular expressions/truncations.
+ *
+ * Revision 1.10  1995/09/11  15:23:26  adam
+ * More work on relevance search.
+ *
+ * Revision 1.9  1995/09/11  13:09:35  adam
+ * More work on relevance feedback.
+ *
+ * Revision 1.8  1995/09/08  14:52:27  adam
+ * Minor changes. Dictionary is lower case now.
+ *
+ * Revision 1.7  1995/09/07  13:58:36  adam
+ * New parameter: result-set file descriptor (RSFD) to support multiple
+ * positions within the same result-set.
+ * Boolean operators: and, or, not implemented.
+ * Result-set references.
+ *
+ * Revision 1.6  1995/09/06  16:11:18  adam
+ * Option: only one word key per file.
+ *
+ * Revision 1.5  1995/09/06  10:33:04  adam
+ * More work on present. Some log messages removed.
+ *
+ * Revision 1.4  1995/09/05  15:28:40  adam
+ * More work on search engine.
+ *
+ * Revision 1.3  1995/09/04  15:20:22  adam
+ * Minor changes.
+ *
+ * Revision 1.2  1995/09/04  12:33:43  adam
+ * Various cleanup. YAZ util used instead.
+ *
+ * Revision 1.1  1995/09/04  09:10:40  adam
  * More work on index add/del/update.
  * Merge sort implemented.
  * Initial work on z39 server.
 #include <assert.h>
 #include <unistd.h>
 
-#include <util.h>
-#include <dict.h>
-#include <isam.h>
+#include "zserver.h"
+
 #include <rsisam.h>
 #include <rstemp.h>
+#include <rsnull.h>
+#include <rsbool.h>
+#include <rsrel.h>
 
-#include <proto.h>
+/*
+ * attr_print: log attributes
+ */
+static void attr_print (Z_AttributesPlusTerm *t)
+{
+    int of, i;
+    for (of = 0; of < t->num_attributes; of++)
+    {
+        Z_AttributeElement *element;
+        element = t->attributeList[of];
 
-#include "index.h"
+        switch (element->which) 
+        {
+        case Z_AttributeValue_numeric:
+            logf (LOG_DEBUG, "attributeType=%d value=%d", 
+                  *element->attributeType,
+                  *element->value.numeric);
+            break;
+        case Z_AttributeValue_complex:
+            logf (LOG_DEBUG, "attributeType=%d complex", 
+                  *element->attributeType);
+            for (i = 0; i<element->value.complex->num_list; i++)
+            {
+                if (element->value.complex->list[i]->which ==
+                    Z_StringOrNumeric_string)
+                    logf (LOG_DEBUG, "   string: '%s'",
+                          element->value.complex->list[i]->u.string);
+                else if (element->value.complex->list[i]->which ==
+                         Z_StringOrNumeric_numeric)
+                    logf (LOG_DEBUG, "   numeric: '%d'",
+                          *element->value.complex->list[i]->u.numeric);
+            }
+            break;
+        default:
+            assert (0);
+        }
+    }
+}
 
-static Dict dict;
-static ISAM isam;
+typedef struct {
+    int type;
+    int major;
+    int minor;
+    Z_AttributesPlusTerm *zapt;
+} AttrType;
 
-static RSET rpn_search_APT (Z_AttributesPlusTerm *zapt)
+static int attr_find (AttrType *src)
 {
-    struct rset_isam_parms parms;
-    const char *info;
-    Z_Term *term = zapt->term;
+    while (src->major < src->zapt->num_attributes)
+    {
+        Z_AttributeElement *element;
+        element = src->zapt->attributeList[src->major];
 
-    if (term->which != Z_Term_general)
-        return NULL; 
-    if (!(info = dict_lookup (dict, term->u.general->buf)))
-        return NULL;
-    assert (*info == sizeof(parms.pos));
-    memcpy (&parms.pos, info+1, sizeof(parms.pos));
-    parms.is = isam;
-    return rset_create (rset_kind_isam, &parms);
+        if (src->type == *element->attributeType)
+        {
+            switch (element->which) 
+            {
+            case Z_AttributeValue_numeric:
+                ++(src->major);
+                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);
+                return *element->value.complex->list[src->minor-1]->u.numeric;
+            default:
+                assert (0);
+            }
+        }
+        ++(src->major);
+    }
+    return -1;
 }
 
-static RSET rpn_search_and (RSET r_l, RSET r_r)
+static void attr_init (AttrType *src, Z_AttributesPlusTerm *zapt,
+                       int type)
 {
-    struct it_key k1, k2;
-    RSET r_dst;
-    int i1, i2;
-    rset_open (r_l, 0);
-    rset_open (r_r, 0);
-    r_dst = rset_create (rset_kind_temp, NULL);
-    rset_open (r_dst, 1);
-    
-    i1 = rset_read (r_l, &k1);
-    i2 = rset_read (r_r, &k2);
-    while (i1 && i2)
+    src->zapt = zapt;
+    src->type = type;
+    src->major = 0;
+    src->minor = 0;
+}
+
+static ISAM_P *isam_p_buf = NULL;
+static int isam_p_size = 0;
+static int isam_p_indx;
+
+static void add_isam_p (const char *info)
+{
+    if (isam_p_indx == isam_p_size)
     {
-        if (k1.sysno > k2.sysno)
-            i2 = rset_read (r_r, &k2);
-        else if (k1.sysno < k2.sysno)
-            i1 = rset_read (r_l, &k1);
-        else if (!(i1 = key_compare_x (&k1, &k2)))
+        ISAM_P *new_isam_p_buf;
+        
+        isam_p_size = 2*isam_p_size + 100;
+        new_isam_p_buf = xmalloc (sizeof(*new_isam_p_buf) *
+                                  isam_p_size);
+        if (isam_p_buf)
         {
-            rset_write (r_dst, &k1);
-            i1 = rset_read (r_l, &k1);
-            i2 = rset_read (r_r, &k2);
+            memcpy (new_isam_p_buf, isam_p_buf,
+                    isam_p_indx * sizeof(*isam_p_buf));
+            xfree (isam_p_buf);
         }
-        else if (i1 > 0)
+        isam_p_buf = new_isam_p_buf;
+    }
+    assert (*info == sizeof(*isam_p_buf));
+    memcpy (isam_p_buf + isam_p_indx, info+1, sizeof(*isam_p_buf));
+    isam_p_indx++;
+}
+
+static int grep_handle (Dict_char *name, const char *info)
+{
+    logf (LOG_DEBUG, "dict name: %s", name);
+    add_isam_p (info);
+    return 0;
+}
+
+static int trunc_term (ZServerInfo *zi, Z_AttributesPlusTerm *zapt,
+                       ISAM_P **isam_ps,
+                       int *no, int split_flag)
+{
+    char termz[IT_MAX_WORD+1];
+    char term_sub[IT_MAX_WORD+1];
+    char term_dict[2*IT_MAX_WORD+2];
+    int sizez, i, j;
+    char *p0 = termz, *p1 = NULL;
+    const char *info;    
+    AttrType truncation;
+    int truncation_value;
+    Z_Term *term = zapt->term;
+
+    isam_p_indx = 0;
+    attr_init (&truncation, zapt, 5);
+    truncation_value = attr_find (&truncation);
+    logf (LOG_DEBUG, "truncation value %d", truncation_value);
+    *no = 0;
+    if (term->which != Z_Term_general)
+    {
+        zi->errCode = 124;
+        return -1;
+    }
+    sizez = term->u.general->len;
+    if (sizez > IT_MAX_WORD)
+        sizez = IT_MAX_WORD;
+    for (i = 0; i<sizez; i++)
+        termz[i] = index_char_cvt (term->u.general->buf[i]);
+    termz[i] = '\0';
+
+    while (1)
+    {
+        if (split_flag && (p1 = strchr (p0, ' ')))
         {
-            rset_write (r_dst, &k2);
-            i2 = rset_read (r_r, &k2);
+            memcpy (term_sub, p0, p1-p0);
+            term_sub[p1-p0] = '\0';
         }
         else
+            strcpy (term_sub, p0);
+        switch (truncation_value)
         {
-            rset_write (r_dst, &k1);
-            i1 = rset_read (r_l, &k1);
+        case -1:         /* not specified */
+        case 100:        /* do not truncate */
+            strcpy (term_dict, term_sub);
+            logf (LOG_DEBUG, "dict_lookup: %s", term_dict);
+            if ((info = dict_lookup (zi->wordDict, term_dict)))
+                add_isam_p (info);
+            break;
+        case 1:          /* right truncation */
+            strcpy (term_dict, term_sub);
+            strcat (term_dict, ".*");
+            dict_lookup_grep (zi->wordDict, term_dict, 0, grep_handle);
+            break;
+        case 2:          /* left truncation */
+        case 3:          /* left&right truncation */
+            zi->errCode = 120;
+            return -1;
+        case 101:        /* process # in term */
+            for (j = 0, i = 0; term_sub[i] && i < 3; i++)
+                term_dict[j++] = term_sub[i];
+            for (; term_sub[i]; i++)
+                if (term_sub[i] == '#')
+                {
+                    term_dict[j++] = '.';
+                    term_dict[j++] = '*';
+                }
+                else
+                    term_dict[j++] = term_sub[i];
+            term_dict[j] = '\0';
+            dict_lookup_grep (zi->wordDict, term_dict, 0, grep_handle);
+            break;
+        case 102:        /* regular expression */
+            strcpy (term_dict, term_sub);
+            dict_lookup_grep (zi->wordDict, term_dict, 0, grep_handle);
+            break;
         }
-    } 
-    rset_close (r_dst);
-    return r_dst;
+        if (!p1)
+            break;
+        p0 = p1+1;
+    }       
+    *isam_ps = isam_p_buf;
+    *no = isam_p_indx; 
+    logf (LOG_DEBUG, "%d positions", *no);
+    return 0;
+}
+
+static RSET rpn_search_APT_relevance (ZServerInfo *zi, 
+                                      Z_AttributesPlusTerm *zapt)
+{
+    rset_relevance_parms parms;
+
+    parms.key_size = sizeof(struct it_key);
+    parms.max_rec = 100;
+    parms.cmp = key_compare;
+    parms.is = zi->wordIsam;
+    if (trunc_term (zi, zapt, &parms.isam_positions, 
+                &parms.no_isam_positions, 1))
+        return NULL;
+    if (parms.no_isam_positions > 0)
+        return rset_create (rset_kind_relevance, &parms);
+    else
+        return rset_create (rset_kind_null, NULL);
 }
 
-static RSET rpn_search_or (RSET r_l, RSET r_r)
+static RSET rpn_search_APT_word (ZServerInfo *zi,
+                                 Z_AttributesPlusTerm *zapt)
 {
-    return r_l;
+    ISAM_P *isam_positions;
+    int no_isam_positions;
+    rset_isam_parms parms;
+
+    if (trunc_term (zi, zapt, &isam_positions,
+                    &no_isam_positions, 0))
+        return NULL;
+    if (no_isam_positions != 1)
+        return rset_create (rset_kind_null, NULL);
+    parms.is = zi->wordIsam;
+    parms.pos = *isam_positions;
+    return rset_create (rset_kind_isam, &parms);
 }
 
-static RSET rpn_search_not (RSET r_l, RSET r_r)
+static RSET rpn_search_APT_phrase (ZServerInfo *zi,
+                                   Z_AttributesPlusTerm *zapt)
 {
-    return r_l;
+    ISAM_P *isam_positions;
+    int no_isam_positions;
+    rset_isam_parms parms;
+
+    if (trunc_term (zi, zapt, &isam_positions,
+                    &no_isam_positions, 1))
+        return NULL;
+    if (no_isam_positions != 1)
+        return rset_create (rset_kind_null, NULL);
+    parms.is = zi->wordIsam;
+    parms.pos = *isam_positions;
+    return rset_create (rset_kind_isam, &parms);
 }
 
-static RSET rpn_search_ref (Z_ResultSetId *resultSetId)
+static RSET rpn_search_APT (ZServerInfo *zi, Z_AttributesPlusTerm *zapt)
 {
+    AttrType relation;
+    AttrType structure;
+    int relation_value, structure_value;
+
+    attr_init (&relation, zapt, 2);
+    attr_init (&structure, zapt, 4);
+    
+    relation_value = attr_find (&relation);
+    structure_value = attr_find (&structure);
+    switch (structure_value)
+    {
+    case -1:
+        if (relation_value == 102) /* relevance relation */
+            return rpn_search_APT_relevance (zi, zapt);
+        return rpn_search_APT_word (zi, zapt);
+    case 1: /* phrase */
+        if (relation_value == 102) /* relevance relation */
+            return rpn_search_APT_relevance (zi, zapt);
+        return rpn_search_APT_phrase (zi, zapt);
+        break;
+    case 2: /* word */
+        if (relation_value == 102) /* relevance relation */
+            return rpn_search_APT_relevance (zi, zapt);
+        return rpn_search_APT_word (zi, zapt);
+    case 3: /* key */
+        break;
+    case 4: /* year */
+        break;
+    case 5: /* date - normalized */
+        break;
+    case 6: /* word list */
+        return rpn_search_APT_relevance (zi, zapt);
+    case 100: /* date - un-normalized */
+        break;
+    case 101: /* name - normalized */
+        break;
+    case 102: /* date - un-normalized */
+        break;
+    case 103: /* structure */
+        break;
+    case 104: /* urx */
+        break;
+    case 105: /* free-form-text */
+        return rpn_search_APT_relevance (zi, zapt);
+    case 106: /* document-text */
+        return rpn_search_APT_relevance (zi, zapt);
+    case 107: /* local-number */
+        break;
+    case 108: /* string */ 
+        return rpn_search_APT_word (zi, zapt);
+    case 109: /* numeric string */
+        break;
+    }
+    zi->errCode = 118;
     return NULL;
 }
 
-static RSET rpn_search_structure (Z_RPNStructure *zs)
+static RSET rpn_search_ref (ZServerInfo *zi, Z_ResultSetId *resultSetId)
 {
-    RSET r;
+    ZServerSet *s;
+
+    if (!(s = resultSetGet (zi, resultSetId)))
+        return rset_create (rset_kind_null, NULL);
+    return s->rset;
+}
+
+static RSET rpn_search_structure (ZServerInfo *zi, Z_RPNStructure *zs)
+{
+    RSET r = NULL;
     if (zs->which == Z_RPNStructure_complex)
     {
-        RSET r_l, r_r;
+        rset_bool_parms bool_parms;
 
-        r_l = rpn_search_structure (zs->u.complex->s1);
-        r_r = rpn_search_structure (zs->u.complex->s2);
+        bool_parms.rset_l = rpn_search_structure (zi, zs->u.complex->s1);
+        if (bool_parms.rset_l == NULL)
+            return NULL;
+        bool_parms.rset_r = rpn_search_structure (zi, zs->u.complex->s2);
+        if (bool_parms.rset_r == NULL)
+        {
+            rset_delete (bool_parms.rset_l);
+            return NULL;
+        }
+        bool_parms.key_size = sizeof(struct it_key);
+        bool_parms.cmp = key_compare;
 
         switch (zs->u.complex->operator->which)
         {
         case Z_Operator_and:
-            r = rpn_search_and (r_l, r_r);
+            r = rset_create (rset_kind_and, &bool_parms);
             break;
         case Z_Operator_or:
-            r = rpn_search_or (r_l, r_r);
+            r = rset_create (rset_kind_or, &bool_parms);
             break;
         case Z_Operator_and_not:
-            r = rpn_search_not (r_l, r_r);
+            r = rset_create (rset_kind_not, &bool_parms);
             break;
         default:
             assert (0);
         }
-        rset_delete (r_l);
-        rset_delete (r_r);
     }
     else if (zs->which == Z_RPNStructure_simple)
     {
         if (zs->u.simple->which == Z_Operand_APT)
-            r = rpn_search_APT (zs->u.simple->u.attributesPlusTerm);
+        {
+            logf (LOG_DEBUG, "rpn_search_APT");
+            r = rpn_search_APT (zi, zs->u.simple->u.attributesPlusTerm);
+        }
         else if (zs->u.simple->which == Z_Operand_resultSetId)
-            r = rpn_search_ref (zs->u.simple->u.resultSetId);
+        {
+            logf (LOG_DEBUG, "rpn_search_ref");
+            r = rpn_search_ref (zi, zs->u.simple->u.resultSetId);
+        }
         else
         {
             assert (0);
@@ -141,3 +438,41 @@ static RSET rpn_search_structure (Z_RPNStructure *zs)
     }
     return r;
 }
+
+static void count_set (RSET r, int *count)
+{
+    int psysno = 0;
+    struct it_key key;
+    RSFD rfd;
+
+    logf (LOG_DEBUG, "rpn_save_set");
+    *count = 0;
+    rfd = rset_open (r, 0);
+    while (rset_read (r, rfd, &key))
+    {
+        if (key.sysno != psysno)
+        {
+            psysno = key.sysno;
+            (*count)++;
+        }
+    }
+    rset_close (r, rfd);
+    logf (LOG_DEBUG, "%d distinct sysnos", *count);
+}
+
+int rpn_search (ZServerInfo *zi,
+                Z_RPNQuery *rpn, int num_bases, char **basenames, 
+                const char *setname, int *hits)
+{
+    RSET rset;
+
+    zi->errCode = 0;
+    zi->errString = NULL;
+    rset = rpn_search_structure (zi, rpn->RPNStructure);
+    if (!rset)
+        return zi->errCode;
+    count_set (rset, hits);
+    resultSetAdd (zi, setname, 1, rset);
+    return zi->errCode;
+}
+