renamed record filter module sources
[idzebra-moved-to-github.git] / index / mod_safari.c
diff --git a/index/mod_safari.c b/index/mod_safari.c
new file mode 100644 (file)
index 0000000..be8c567
--- /dev/null
@@ -0,0 +1,320 @@
+/* This file is part of the Zebra server.
+   Copyright (C) 1995-2008 Index Data
+
+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 this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+*/
+
+#include <yaz/oid_db.h>
+#include <stdio.h>
+#include <assert.h>
+#include <ctype.h>
+
+#include <idzebra/util.h>
+#include <idzebra/recctrl.h>
+
+struct filter_info {
+    int segments;
+};
+
+static void *filter_init(Res res, RecType recType)
+{
+    struct filter_info *tinfo = (struct filter_info *) xmalloc(sizeof(*tinfo));
+    tinfo->segments = 0;
+    return tinfo;
+}
+
+static void *filter_init2(Res res, RecType recType)
+{
+    struct filter_info *tinfo = (struct filter_info *) xmalloc(sizeof(*tinfo));
+    tinfo->segments = 1;
+    return tinfo;
+}
+
+static ZEBRA_RES filter_config(void *clientData, Res res, const char *args)
+{
+    return ZEBRA_OK;
+}
+
+static void filter_destroy(void *clientData)
+{
+    struct filter_info *tinfo = clientData;
+    xfree (tinfo);
+}
+
+struct fi_info {
+    struct recExtractCtrl *p;
+    char *buf;
+    int offset;
+    int max;
+};
+
+static struct fi_info *fi_open(struct recExtractCtrl *p)
+{
+    struct fi_info *fi = (struct fi_info *) xmalloc (sizeof(*fi));
+
+    fi->p = p;
+    fi->buf = (char *) xmalloc (4096);
+    fi->offset = 1;
+    fi->max = 1;
+    return fi;
+}
+
+static int fi_getchar(struct fi_info *fi, char *dst)
+{
+    if (fi->offset >= fi->max)
+    {
+        if (fi->max <= 0)
+            return 0;
+        fi->max = fi->p->stream->readf(fi->p->stream, fi->buf, 4096);
+        fi->offset = 0;
+        if (fi->max <= 0)
+            return 0;
+    }
+    *dst = fi->buf[(fi->offset)++];
+    return 1;
+}
+
+static int fi_gets(struct fi_info *fi, char *dst, int max)
+{
+    int l = 0;
+    while(1)
+    {
+       char dstbyte;
+       if (!fi_getchar(fi, &dstbyte))
+           return 0;
+       if (dstbyte == '\n')
+           break;
+       if (l < max)
+           dst[l++] = dstbyte;
+    }
+    dst[l] = '\0';
+    return 1;
+}
+
+static void fi_close (struct fi_info *fi)
+{
+    xfree (fi->buf);
+    xfree (fi);
+}
+
+static int filter_extract(void *clientData, struct recExtractCtrl *p)
+{
+    struct filter_info *tinfo = clientData;
+    char line[512];
+    RecWord recWord;
+    int ret = RECCTRL_EXTRACT_OK;
+    struct fi_info *fi = fi_open(p);
+
+#if 0
+    yaz_log(YLOG_LOG, "filter_extract off=%ld",
+           (long) (*fi->p->tellf)(fi->p->fh));
+#endif
+    (*p->init)(p, &recWord);
+
+    if (!fi_gets(fi, line, sizeof(line)-1))
+        ret = RECCTRL_EXTRACT_EOF;
+    else
+    {
+        sscanf(line, "%255s", p->match_criteria);
+        while (fi_gets(fi, line, sizeof(line)-1))
+        {
+            int nor = 0;
+            char field[40];
+            const char *cp = line;
+            char type_cstr[2];
+#if 0
+            yaz_log(YLOG_LOG, "safari line: %s", line);
+#endif
+            type_cstr[1] = '\0';
+            if (*cp >= '0' && *cp <= '9')
+                type_cstr[0] = '0'; /* the default is 0 (raw) */
+            else
+                type_cstr[0] = *cp++; /* type given */
+            type_cstr[1] = '\0';
+
+            recWord.index_type = type_cstr;
+            if (tinfo->segments)
+            {
+                if (sscanf(cp, ZINT_FORMAT " " ZINT_FORMAT " " ZINT_FORMAT 
+                           ZINT_FORMAT " %39s %n",
+                           &recWord.record_id, &recWord.section_id, 
+                           &recWord.segment,
+                           &recWord.seqno,
+                           field, &nor) < 5)
+                {
+                    yaz_log(YLOG_WARN, "Bad safari record line: %s", line);
+                    ret = RECCTRL_EXTRACT_ERROR_GENERIC;
+                    break;
+                }
+            }
+            else
+            {
+                if (sscanf(cp, ZINT_FORMAT " " ZINT_FORMAT " " ZINT_FORMAT " %39s %n",
+                           &recWord.record_id, &recWord.section_id, &recWord.seqno,
+                           field, &nor) < 4)
+                {
+                    yaz_log(YLOG_WARN, "Bad safari record line: %s", line);
+                    ret = RECCTRL_EXTRACT_ERROR_GENERIC;
+                    break;
+                }
+            }
+            for (cp = cp + nor; *cp == ' '; cp++)
+                ;
+            recWord.index_name = field;
+            recWord.term_buf = cp;
+            recWord.term_len = strlen(cp);
+            (*p->tokenAdd)(&recWord);
+        }
+    }
+    fi_close(fi);
+    return ret;
+}
+
+static int filter_retrieve (void *clientData, struct recRetrieveCtrl *p)
+{
+    int r, filter_ptr = 0;
+    static char *filter_buf = NULL;
+    static int filter_size = 0;
+    int make_header = 1;
+    int make_body = 1;
+    const char *elementSetName = NULL;
+    int no_lines = 0;
+
+    if (p->comp && p->comp->which == Z_RecordComp_simple &&
+        p->comp->u.simple->which == Z_ElementSetNames_generic)
+        elementSetName = p->comp->u.simple->u.generic;
+
+    if (elementSetName)
+    {
+       /* don't make header for the R(aw) element set name */
+       if (!strcmp(elementSetName, "R"))
+       {
+           make_header = 0;
+           make_body = 1;
+       }
+       /* only make header for the H(eader) element set name */
+       else if (!strcmp(elementSetName, "H"))
+       {
+           make_header = 1;
+           make_body = 0;
+       }
+    }
+    while (1)
+    {
+        if (filter_ptr + 4096 >= filter_size)
+        {
+            char *nb;
+
+            filter_size = 2*filter_size + 8192;
+            nb = (char *) xmalloc (filter_size);
+            if (filter_buf)
+            {
+                memcpy (nb, filter_buf, filter_ptr);
+                xfree (filter_buf);
+            }
+            filter_buf = nb;
+        }
+        if (make_header && filter_ptr == 0)
+        {
+            if (p->score >= 0)
+            {
+                sprintf (filter_buf, "Rank: %d\n", p->score);
+                filter_ptr = strlen(filter_buf);
+            }
+            sprintf (filter_buf + filter_ptr, "Local Number: " ZINT_FORMAT "\n",
+                    p->localno);
+            filter_ptr = strlen(filter_buf);
+           if (p->fname)
+           {
+               sprintf (filter_buf + filter_ptr, "Filename: %s\n", p->fname);
+               filter_ptr = strlen(filter_buf);
+           }
+           strcpy(filter_buf+filter_ptr++, "\n");
+        }
+       if (!make_body)
+           break;
+        r = p->stream->readf(p->stream, filter_buf + filter_ptr, 4096);
+        if (r <= 0)
+            break;
+        filter_ptr += r;
+    }
+    filter_buf[filter_ptr] = '\0';
+    if (elementSetName)
+    {
+        if (!strcmp (elementSetName, "B"))
+            no_lines = 4;
+        if (!strcmp (elementSetName, "M"))
+            no_lines = 20;
+    }
+    if (no_lines)
+    {
+        char *p = filter_buf;
+        int i = 0;
+
+        while (++i <= no_lines && (p = strchr (p, '\n')))
+            p++;
+        if (p)
+        {
+            p[1] = '\0';
+            filter_ptr = p-filter_buf;
+        }
+    }
+    p->output_format = yaz_oid_recsyn_sutrs;
+    p->rec_buf = filter_buf;
+    p->rec_len = filter_ptr; 
+    return 0;
+}
+
+static struct recType filter_type = {
+    0,
+    "safari",
+    filter_init,
+    filter_config,
+    filter_destroy,
+    filter_extract,
+    filter_retrieve
+};
+
+static struct recType filter_type2 = {
+    0,
+    "safari2",
+    filter_init2,
+    filter_config,
+    filter_destroy,
+    filter_extract,
+    filter_retrieve
+};
+
+RecType
+#ifdef IDZEBRA_STATIC_SAFARI
+idzebra_filter_safari
+#else
+idzebra_filter
+#endif
+
+[] = {
+    &filter_type,
+    &filter_type2,
+    0,
+};
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+