written XML formatting for new zebra-specific elem set 'zebra::' which lets you dump...
[idzebra-moved-to-github.git] / index / retrieve.c
index 00d1d9e..6a1b65c 100644 (file)
@@ -1,41 +1,24 @@
-/*
- * Copyright (C) 1995-1999, Index Data
- * All rights reserved.
- * Sebastian Hammer, Adam Dickmeiss
- *
- * $Log: retrieve.c,v $
- * Revision 1.10  1999-05-26 07:49:13  adam
- * C++ compilation.
- *
- * Revision 1.9  1999/05/20 12:57:18  adam
- * Implemented TCL filter. Updated recctrl system.
- *
- * Revision 1.8  1999/03/09 16:27:49  adam
- * More work on SDRKit integration.
- *
- * Revision 1.7  1999/03/02 16:15:43  quinn
- * Added "tagsysno" and "tagrank" directives to zebra.cfg.
- *
- * Revision 1.6  1999/02/18 15:01:25  adam
- * Minor changes.
- *
- * Revision 1.5  1999/02/17 11:29:56  adam
- * Fixed in record_fetch. Minor updates to API.
- *
- * Revision 1.4  1999/02/02 14:51:07  adam
- * Updated WIN32 code specific sections. Changed header.
- *
- * Revision 1.3  1998/10/28 10:54:40  adam
- * SDRKit integration.
- *
- * Revision 1.2  1998/10/16 08:14:33  adam
- * Updated record control system.
- *
- * Revision 1.1  1998/03/05 08:45:13  adam
- * New result set model and modular ranking system. Moved towards
- * descent server API. System information stored as "SGML" records.
- *
- */
+/* $Id: retrieve.c,v 1.48 2006-11-13 13:53:49 marc 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 this program; if not, write to the Free Software
+Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
+
+*/
 
 #include <stdio.h>
 #include <assert.h>
 #ifdef WIN32
 #include <io.h>
 #include <process.h>
-#else
+#endif
+#if HAVE_UNISTD_H
 #include <unistd.h>
 #endif
 
-#include <recctrl.h>
-#include "zserver.h"
+#include "index.h"
+#include <yaz/diagbib1.h>
+#include <direntz.h>
 
-#ifndef ZEBRASDR
-#define ZEBRASDR 0
-#endif
+static void parse_zebra_elem(const char *elem,
+                             const char **index, size_t *index_len,
+                             const char **type, size_t *type_len)
+{
+    *type = 0;
+    *type_len = 0;
 
-#if ZEBRASDR
-#include "zebrasdr.h"
-#endif
+    *index = 0;
+    *index_len = 0;
 
-struct fetch_control {
-    int record_offset;
-    int record_int_pos;
-    char *record_int_buf;
-    int record_int_len;
-    int fd;
-};
+    if (elem && *elem)
+    {
+        const char *cp = strchr(elem, ':');
 
-static int record_ext_read (void *fh, char *buf, size_t count)
-{
-    struct fetch_control *fc = (struct fetch_control *) fh;
-    return read (fc->fd, buf, count);
+        if (!cp) /* no colon */
+        {
+            *index = elem;
+            *index_len = strlen(elem);
+        }
+        else if (cp[1] == '\0') /* 'index:' */
+        {
+            *index = elem;
+            *index_len = cp - elem;
+        }
+        else
+        {
+            *index = elem;
+            *index_len = cp - elem;
+            *type = cp+1;
+            *type_len = strlen(cp+1);
+        }
+    }
 }
 
-static off_t record_ext_seek (void *fh, off_t offset)
+int zebra_storekeys_fetch(ZebraHandle zh, SYSNO sysno, ODR odr,
+                          Record rec,
+                          const char *element_set,
+                          oid_value input_format,
+                          oid_value *output_format,
+                          char **rec_bufp, int *rec_lenp)
 {
-    struct fetch_control *fc = (struct fetch_control *) fh;
-    return lseek (fc->fd, offset + fc->record_offset, SEEK_SET);
-}
+    const char *retrieval_index;
+    size_t retrieval_index_len; 
+    const char *retrieval_type;
+    size_t retrieval_type_len;
+   
+    int return_code = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
 
-static off_t record_ext_tell (void *fh)
-{
-    struct fetch_control *fc = (struct fetch_control *) fh;
-    return lseek (fc->fd, 0, SEEK_CUR) - fc->record_offset;
-}
+    WRBUF wrbuf = wrbuf_alloc();
+    zebra_rec_keys_t keys;
+    
 
-static off_t record_int_seek (void *fh, off_t offset)
-{
-    struct fetch_control *fc = (struct fetch_control *) fh;
-    return (off_t) (fc->record_int_pos = offset);
-}
+    /* only accept XML and SUTRS requests */
+    if (input_format != VAL_TEXT_XML
+        && input_format != VAL_SUTRS)
+    {
+        yaz_log(YLOG_WARN, "unsupported format for element set zebra::%s", 
+                element_set);
+        *output_format = VAL_NONE;
+        return return_code;
+    }
 
-static off_t record_int_tell (void *fh)
-{
-    struct fetch_control *fc = (struct fetch_control *) fh;
-    return (off_t) fc->record_int_pos;
-}
 
-static int record_int_read (void *fh, char *buf, size_t count)
-{
-    struct fetch_control *fc = (struct fetch_control *) fh;
-    int l = fc->record_int_len - fc->record_int_pos;
-    if (l <= 0)
-        return 0;
-    l = (l < (int) count) ? l : count;
-    memcpy (buf, fc->record_int_buf + fc->record_int_pos, l);
-    fc->record_int_pos += l;
-    return l;
-}
+    keys = zebra_rec_keys_open();
+    zebra_rec_keys_set_buf(keys,
+                           rec->info[recInfo_delKeys],
+                           rec->size[recInfo_delKeys],
+                           0);
+
+    parse_zebra_elem(element_set,
+                     &retrieval_index, &retrieval_index_len,
+                     &retrieval_type,  &retrieval_type_len);
+
 
-int zebra_record_fetch (ZebraHandle zh, int sysno, int score, ODR stream,
-                       oid_value input_format, Z_RecordComposition *comp,
-                       oid_value *output_format, char **rec_bufp,
-                       int *rec_lenp, char **basenamep)
+
+
+
+    if (zebra_rec_keys_rewind(keys))
+    {
+        size_t slen;
+        const char *str;
+        struct it_key key_in;
+
+
+        if (input_format == VAL_TEXT_XML)
+            {
+                *output_format = VAL_TEXT_XML;
+                /*wrbuf_printf(wrbuf, 
+                  "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n");*/
+
+                wrbuf_printf(wrbuf, 
+                             "<record xmlns="
+                             "\"http://www.indexdata.com/zebra/\""
+                             " sysno=\"" ZINT_FORMAT "\""
+                             " set=\"zebra::%s\">\n",
+                             sysno, element_set);
+            }
+        else if (input_format == VAL_SUTRS)
+                *output_format = VAL_SUTRS;
+
+
+        while(zebra_rec_keys_read(keys, &str, &slen, &key_in))
+        {
+            int i;
+            int ord = CAST_ZINT_TO_INT(key_in.mem[0]);
+            int index_type;
+            const char *db = 0;
+            const char *string_index = 0;
+            size_t string_index_len;
+            char dst_buf[IT_MAX_WORD];
+            
+            zebraExplain_lookup_ord(zh->reg->zei, ord, &index_type, &db,
+                                    &string_index);
+            string_index_len = strlen(string_index);
+            if (retrieval_index == 0 
+                || (string_index_len == retrieval_index_len 
+                    && !memcmp(string_index, retrieval_index,
+                               string_index_len)))
+            {
+                
+                if (retrieval_type == 0 
+                    || (retrieval_type_len == 1 
+                        && retrieval_type[0] == index_type))
+                {
+                    
+                    if (input_format == VAL_TEXT_XML)
+                        {
+                            wrbuf_printf(wrbuf, "  <index name=\"%s\"", 
+                                         string_index);
+                    
+                            wrbuf_printf(wrbuf, " type=\"%c\"", index_type);
+
+                            wrbuf_printf(wrbuf, " seq=\"" ZINT_FORMAT "\">", 
+                                             key_in.mem[key_in.len -1]);
+
+                            zebra_term_untrans(zh, index_type, dst_buf, str);
+                            wrbuf_xmlputs(wrbuf, dst_buf);
+                            wrbuf_printf(wrbuf, "</index>\n");
+                        }
+                    else if (input_format == VAL_SUTRS)
+                        {
+                            wrbuf_printf(wrbuf, "%s ", string_index);
+                    
+                            wrbuf_printf(wrbuf, "%c", index_type);
+                    
+                            for (i = 1; i < key_in.len; i++)
+                                wrbuf_printf(wrbuf, " " ZINT_FORMAT, 
+                                             key_in.mem[i]);
+
+                            zebra_term_untrans(zh, index_type, dst_buf, str);
+                            wrbuf_printf(wrbuf, " %s", dst_buf);
+
+                            wrbuf_printf(wrbuf, "\n");
+                        }
+                }
+            }
+        }
+        if (input_format == VAL_TEXT_XML)
+            {
+                wrbuf_printf(wrbuf, "</record>\n");
+            }
+    }
+
+    *rec_lenp = wrbuf_len(wrbuf);
+    *rec_bufp = odr_malloc(odr, *rec_lenp);
+    memcpy(*rec_bufp, wrbuf_buf(wrbuf), *rec_lenp);
+    wrbuf_free(wrbuf, 1);
+    zebra_rec_keys_close(keys);
+    return 0;
+}
+                          
+int zebra_record_fetch(ZebraHandle zh, SYSNO sysno, int score,
+                       zebra_snippets *hit_snippet, ODR odr,
+                       oid_value input_format, Z_RecordComposition *comp,
+                       oid_value *output_format,
+                       char **rec_bufp, int *rec_lenp, char **basenamep,
+                       char **addinfo)
 {
     Record rec;
     char *fname, *file_type, *basename;
-    RecType rt;
-    struct recRetrieveCtrl retrieveCtrl;
-    char subType[128];
-    struct fetch_control fc;
+    struct ZebraRecStream stream;
     RecordAttr *recordAttr;
     void *clientData;
+    int raw_mode = 0;
+    int return_code = 0;
 
-    rec = rec_get (zh->records, sysno);
+    *basenamep = 0;
+    *addinfo = 0;
+    if (comp && comp->which == Z_RecordComp_simple &&
+        comp->u.simple->which == Z_ElementSetNames_generic && 
+        !strcmp (comp->u.simple->u.generic, "_sysno_"))
+    {
+       char rec_str[60];
+       sprintf(rec_str, ZINT_FORMAT, sysno);
+       *output_format = VAL_SUTRS;
+       *rec_lenp = strlen(rec_str);
+       *rec_bufp = odr_strdup(odr, rec_str);
+       return 0;
+    }
+    rec = rec_get (zh->reg->records, sysno);
     if (!rec)
     {
-        logf (LOG_DEBUG, "rec_get fail on sysno=%d", sysno);
-        return 14;
+        yaz_log (YLOG_DEBUG, "rec_get fail on sysno=" ZINT_FORMAT, sysno);
+        *basenamep = 0;
+        return YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
     }
-    recordAttr = rec_init_attr (zh->zei, rec);
+    recordAttr = rec_init_attr (zh->reg->zei, rec);
 
     file_type = rec->info[recInfo_fileType];
     fname = rec->info[recInfo_filename];
     basename = rec->info[recInfo_databaseName];
-    *basenamep = (char *) odr_malloc (stream, strlen(basename)+1);
+    *basenamep = (char *) odr_malloc (odr, strlen(basename)+1);
     strcpy (*basenamep, basename);
 
-    if (!(rt = recType_byName (zh->recTypes, file_type, subType, &clientData)))
+    if (comp && comp->which == Z_RecordComp_simple 
+        && comp->u.simple->which == Z_ElementSetNames_generic 
+        && strncmp(comp->u.simple->u.generic, "zebra::", 7) == 0)
     {
-        logf (LOG_WARN, "Retrieve: Cannot handle type %s",  file_type);
-       return 14;
+        int r = zebra_storekeys_fetch(zh, sysno, odr, rec,
+                                      comp->u.simple->u.generic + 7,
+                                      input_format, output_format,
+                                      rec_bufp, rec_lenp);
+
+        rec_free(&rec);
+        return r;
     }
-    logf (LOG_DEBUG, "retrieve localno=%d score=%d", sysno, score);
-    retrieveCtrl.fh = &fc;
-    fc.fd = -1;
-    if (rec->size[recInfo_storeData] > 0)
+
+    if (comp && comp->which == Z_RecordComp_simple &&
+        comp->u.simple->which == Z_ElementSetNames_generic && 
+        !strcmp (comp->u.simple->u.generic, "R"))
     {
-        retrieveCtrl.readf = record_int_read;
-        retrieveCtrl.seekf = record_int_seek;
-        retrieveCtrl.tellf = record_int_tell;
-        fc.record_int_len = rec->size[recInfo_storeData];
-        fc.record_int_buf = rec->info[recInfo_storeData];
-        fc.record_int_pos = 0;
-        logf (LOG_DEBUG, "Internal retrieve. %d bytes", fc.record_int_len);
+       raw_mode = 1;
     }
-#if ZEBRASDR
-    else if (*fname == '%')
-    {  
-       ZebraSdrHandle h;
-       int segment = 0, r;
-       char *cp, xname[128];
-       unsigned char *buf;
-
-       logf (LOG_DEBUG, "SDR");
-       strcpy (xname, fname+1);
-       if ((cp = strrchr (xname, '.')))
-       {
-           *cp++ = 0;
-           segment = atoi(cp);
-       }
-       h = zebraSdr_open (xname);
-       if (!h)
-       {
-           logf (LOG_WARN, "sdr open %s", xname);
-           return 0;
-       }
-        if (zebraSdr_segment (h, &segment) < 0)
-       {
-           logf (LOG_WARN, "zebraSdr_segment fail segment=%d",
-               segment);
-            rec_rm (&rec);
-            return 14;
-       }    
-        r = zebraSdr_read (h, &buf);
-       if (r < 1)
-       {
-           logf (LOG_WARN, "zebraSdr_read fail segment=%d",
-               segment);
-            rec_rm (&rec);
-            return 14;
-       }
-       zebraSdr_close (h);
-
-        fc.record_int_len = recordAttr->recordSize;
-        fc.record_int_buf = buf + recordAttr->recordOffset;
-        fc.record_int_pos = 0;
-
-       logf (LOG_LOG, "segment = %d len=%d off=%d",
-           segment,
-           recordAttr->recordSize,
-           recordAttr->recordOffset);
-       if (fc.record_int_len > 180)
-       {
-           logf (LOG_LOG, "%.70s", fc.record_int_buf);
-           logf (LOG_LOG, "%.70s", fc.record_int_buf +
-               (fc.record_int_len - 70));
-       }
-       else
-           logf (LOG_LOG, "%.*s",
-               fc.record_int_len, fc.record_int_buf);
-
-       /* the following two lines makes rec_rm delete buf */
-        rec->size[recInfo_storeData] = r;
-        rec->info[recInfo_storeData] = buf;
-
-        retrieveCtrl.readf = record_int_read;
-        retrieveCtrl.seekf = record_int_seek;
-        retrieveCtrl.tellf = record_int_tell;
+    yaz_log (YLOG_DEBUG, "retrieve localno=" ZINT_FORMAT " score=%d",
+             sysno, score);
+    if (rec->size[recInfo_storeData] > 0)
+    {
+        zebra_create_stream_mem(&stream, rec->info[recInfo_storeData],
+                                rec->size[recInfo_storeData]);
     }
-#endif
     else
     {
-        if ((fc.fd = open (fname, O_BINARY|O_RDONLY)) == -1)
+        char full_rep[1024];
+        int fd;
+
+        if (zh->path_reg && !yaz_is_abspath (fname))
+        {
+            strcpy (full_rep, zh->path_reg);
+            strcat (full_rep, "/");
+            strcat (full_rep, fname);
+        }
+        else
+            strcpy (full_rep, fname);
+
+        if ((fd = open (full_rep, O_BINARY|O_RDONLY)) == -1)
         {
-            logf (LOG_WARN|LOG_ERRNO, "Retrieve fail; missing file: %s",
-                 fname);
-            rec_rm (&rec);
+            yaz_log (YLOG_WARN|YLOG_ERRNO, "Retrieve fail; missing file: %s",
+                 full_rep);
+            rec_free(&rec);
             return 14;
         }
-       fc.record_offset = recordAttr->recordOffset;
+        zebra_create_stream_fd(&stream, fd, recordAttr->recordOffset);
+    }
 
-        retrieveCtrl.readf = record_ext_read;
-        retrieveCtrl.seekf = record_ext_seek;
-        retrieveCtrl.tellf = record_ext_tell;
+    if (raw_mode)
+    {
+        *output_format = VAL_SUTRS;
+        *rec_lenp = recordAttr->recordSize;
+        *rec_bufp = (char *) odr_malloc(odr, *rec_lenp);
+        stream.readf(&stream, *rec_bufp, *rec_lenp);
+    }
+    else
+    {
+       /* snippets code */
+       zebra_snippets *snippet;
+       zebra_rec_keys_t reckeys = zebra_rec_keys_open();
+        RecType rt;
+        struct recRetrieveCtrl retrieveCtrl;
+
+        retrieveCtrl.stream = &stream;
+        retrieveCtrl.fname = fname;
+        retrieveCtrl.localno = sysno;
+        retrieveCtrl.staticrank = recordAttr->staticrank;
+        retrieveCtrl.score = score;
+        retrieveCtrl.recordSize = recordAttr->recordSize;
+        retrieveCtrl.odr = odr;
+        retrieveCtrl.input_format = retrieveCtrl.output_format = input_format;
+        retrieveCtrl.comp = comp;
+        retrieveCtrl.encoding = zh->record_encoding;
+        retrieveCtrl.diagnostic = 0;
+        retrieveCtrl.addinfo = 0;
+        retrieveCtrl.dh = zh->reg->dh;
+        retrieveCtrl.res = zh->res;
+        retrieveCtrl.rec_buf = 0;
+        retrieveCtrl.rec_len = -1;
+        retrieveCtrl.hit_snippet = hit_snippet;
+        retrieveCtrl.doc_snippet = zebra_snippets_create();
+
+       zebra_rec_keys_set_buf(reckeys,
+                              rec->info[recInfo_delKeys],
+                              rec->size[recInfo_delKeys], 
+                              0);
+       zebra_rec_keys_to_snippets(zh, reckeys, retrieveCtrl.doc_snippet);
+       zebra_rec_keys_close(reckeys);
+
+#if 0
+       /* for debugging purposes */
+       yaz_log(YLOG_LOG, "DOC SNIPPET:");
+       zebra_snippets_log(retrieveCtrl.doc_snippet, YLOG_LOG);
+       yaz_log(YLOG_LOG, "HIT SNIPPET:");
+       zebra_snippets_log(retrieveCtrl.hit_snippet, YLOG_LOG);
+#endif
+       snippet = zebra_snippets_window(retrieveCtrl.doc_snippet,
+                                       retrieveCtrl.hit_snippet,
+                                       10);
+#if 0
+       /* for debugging purposes */
+       yaz_log(YLOG_LOG, "WINDOW SNIPPET:");
+       zebra_snippets_log(snippet, YLOG_LOG);
+#endif
 
-        record_ext_seek (retrieveCtrl.fh, 0);
+        if (!(rt = recType_byName (zh->reg->recTypes, zh->res,
+                                   file_type, &clientData)))
+        {
+            return_code = YAZ_BIB1_SYSTEM_ERROR_IN_PRESENTING_RECORDS;
+        }
+        else
+        {
+            (*rt->retrieve)(clientData, &retrieveCtrl);
+            return_code = retrieveCtrl.diagnostic;
+
+            *output_format = retrieveCtrl.output_format;
+            *rec_bufp = (char *) retrieveCtrl.rec_buf;
+            *rec_lenp = retrieveCtrl.rec_len;
+            *addinfo = retrieveCtrl.addinfo;
+        }
+       zebra_snippets_destroy(snippet);
+        zebra_snippets_destroy(retrieveCtrl.doc_snippet);
     }
-    retrieveCtrl.subType = subType;
-    retrieveCtrl.localno = sysno;
-    retrieveCtrl.score = score;
-    retrieveCtrl.recordSize = recordAttr->recordSize;
-    retrieveCtrl.odr = stream;
-    retrieveCtrl.input_format = retrieveCtrl.output_format = input_format;
-    retrieveCtrl.comp = comp;
-    retrieveCtrl.diagnostic = 0;
-    retrieveCtrl.dh = zh->dh;
-    retrieveCtrl.res = zh->res;
-    (*rt->retrieve)(clientData, &retrieveCtrl);
-    *output_format = retrieveCtrl.output_format;
-    *rec_bufp = (char *) retrieveCtrl.rec_buf;
-    *rec_lenp = retrieveCtrl.rec_len;
-    if (fc.fd != -1)
-        close (fc.fd);
-    rec_rm (&rec);
-
-    return retrieveCtrl.diagnostic;
+    stream.destroy(&stream);
+    rec_free(&rec);
+
+    return return_code;
 }
+
+/*
+ * Local variables:
+ * c-basic-offset: 4
+ * indent-tabs-mode: nil
+ * End:
+ * vim: shiftwidth=4 tabstop=8 expandtab
+ */
+