index/retrieve.c

   1 /* $Id: retrieve.c,v 1.39 2006-05-02 08:27:43 marc Exp $
   2    Copyright (C) 1995-2005
   3    Index Data ApS
   4
   5 This file is part of the Zebra server.
   6
   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
  10 version.
  11
  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
  15 for more details.
  16
  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
  20 02111-1307, USA.
  21 */
  22
  23 #include <stdio.h>
  24 #include <assert.h>
  25
  26 #include <fcntl.h>
  27 #ifdef WIN32
  28 #include <io.h>
  29 #include <process.h>
  30 #endif
  31 #if HAVE_UNISTD_H
  32 #include <unistd.h>
  33 #endif
  34
  35 #include "index.h"
  36 #include <direntz.h>
  37
  38 int zebra_record_ext_read (void *fh, char *buf, size_t count)
  39 {
  40     struct zebra_fetch_control *fc = (struct zebra_fetch_control *) fh;
  41     return read (fc->fd, buf, count);
  42 }
  43
  44 off_t zebra_record_ext_seek (void *fh, off_t offset)
  45 {
  46     struct zebra_fetch_control *fc = (struct zebra_fetch_control *) fh;
  47     return lseek (fc->fd, offset + fc->record_offset, SEEK_SET);
  48 }
  49
  50 off_t zebra_record_ext_tell (void *fh)
  51 {
  52     struct zebra_fetch_control *fc = (struct zebra_fetch_control *) fh;
  53     return lseek (fc->fd, 0, SEEK_CUR) - fc->record_offset;
  54 }
  55
  56 off_t zebra_record_int_seek (void *fh, off_t offset)
  57 {
  58     struct zebra_fetch_control *fc = (struct zebra_fetch_control *) fh;
  59     return (off_t) (fc->record_int_pos = offset);
  60 }
  61
  62 off_t zebra_record_int_tell (void *fh)
  63 {
  64     struct zebra_fetch_control *fc = (struct zebra_fetch_control *) fh;
  65     return (off_t) fc->record_int_pos;
  66 }
  67
  68 int zebra_record_int_read (void *fh, char *buf, size_t count)
  69 {
  70     struct zebra_fetch_control *fc = (struct zebra_fetch_control *) fh;
  71     int l = fc->record_int_len - fc->record_int_pos;
  72     if (l <= 0)
  73         return 0;
  74     l = (l < (int) count) ? l : (int) count;
  75     memcpy (buf, fc->record_int_buf + fc->record_int_pos, l);
  76     fc->record_int_pos += l;
  77     return l;
  78 }
  79
  80 void zebra_record_int_end (void *fh, off_t off)
  81 {
  82     struct zebra_fetch_control *fc = (struct zebra_fetch_control *) fh;
  83     fc->offset_end = off;
  84 }
  85
  86 int zebra_record_fetch (ZebraHandle zh, SYSNO sysno, int score,
  87                         zebra_snippets *hit_snippet, ODR stream,
  88                         oid_value input_format, Z_RecordComposition *comp,
  89                         oid_value *output_format, char **rec_bufp,
  90                         int *rec_lenp, char **basenamep,
  91                         char **addinfo)
  92 {
  93     Record rec;
  94     char *fname, *file_type, *basename;
  95     RecType rt;
  96     struct recRetrieveCtrl retrieveCtrl;
  97     struct zebra_fetch_control fc;
  98     RecordAttr *recordAttr;
  99     void *clientData;
 100     int raw_mode = 0;
 101
 102     *basenamep = 0;
 103     *addinfo = 0;
 104     if (comp && comp->which == Z_RecordComp_simple &&
 105         comp->u.simple->which == Z_ElementSetNames_generic &&
 106         !strcmp (comp->u.simple->u.generic, "_sysno_"))
 107     {
 108         char rec_str[60];
 109         sprintf(rec_str, ZINT_FORMAT, sysno);
 110         *output_format = VAL_SUTRS;
 111         *rec_lenp = strlen(rec_str);
 112         *rec_bufp = odr_strdup(stream, rec_str);
 113         return 0;
 114     }
 115     rec = rec_get (zh->reg->records, sysno);
 116     if (!rec)
 117     {
 118         yaz_log (YLOG_DEBUG, "rec_get fail on sysno=" ZINT_FORMAT, sysno);
 119         *basenamep = 0;
 120         return 14;
 121     }
 122     recordAttr = rec_init_attr (zh->reg->zei, rec);
 123
 124     file_type = rec->info[recInfo_fileType];
 125     fname = rec->info[recInfo_filename];
 126     basename = rec->info[recInfo_databaseName];
 127     *basenamep = (char *) odr_malloc (stream, strlen(basename)+1);
 128     strcpy (*basenamep, basename);
 129
 130     if (comp && comp->which == Z_RecordComp_simple &&
 131         comp->u.simple->which == Z_ElementSetNames_generic &&
 132         !strcmp (comp->u.simple->u.generic, "_storekeys_"))
 133     {
 134         WRBUF wrbuf = wrbuf_alloc();
 135         zebra_rec_keys_t keys = zebra_rec_keys_open();
 136         zebra_rec_keys_set_buf(keys,
 137                                rec->info[recInfo_delKeys],
 138                                rec->size[recInfo_delKeys],
 139                                0);
 140         if (zebra_rec_keys_rewind(keys))
 141         {
 142             size_t slen;
 143             const char *str;
 144             struct it_key key_in;
 145             while(zebra_rec_keys_read(keys, &str, &slen, &key_in))
 146             {
 147                 int i;
 148                 int ord = key_in.mem[0];
 149                 int index_type;
 150                 const char *db = 0;
 151                 int set = 0;
 152                 int use = 0;
 153                 const char *string_index = 0;
 154                 char dst_buf[IT_MAX_WORD];
 155
 156                 zebraExplain_lookup_ord (zh->reg->zei, ord,
 157                                          &index_type, &db,
 158                                          &set, &use, &string_index);
 159
 160                 if (string_index)
 161                     wrbuf_printf(wrbuf, "%s", string_index);
 162                 else
 163                     wrbuf_printf(wrbuf, "set=%d,use=%d", set, use);
 164
 165                 zebra_term_untrans(zh, index_type, dst_buf, str);
 166                 wrbuf_printf(wrbuf, " %s", dst_buf);
 167
 168                 for (i = 1; i < key_in.len; i++)
 169                     wrbuf_printf(wrbuf, " " ZINT_FORMAT, key_in.mem[i]);
 170                 wrbuf_printf(wrbuf, "\n");
 171
 172             }
 173         }
 174         *output_format = VAL_SUTRS;
 175         *rec_lenp = wrbuf_len(wrbuf);
 176         *rec_bufp = odr_malloc(stream, *rec_lenp);
 177         memcpy(*rec_bufp, wrbuf_buf(wrbuf), *rec_lenp);
 178         wrbuf_free(wrbuf, 1);
 179         zebra_rec_keys_close(keys);
 180         return 0;
 181     }
 182     if (comp && comp->which == Z_RecordComp_simple &&
 183         comp->u.simple->which == Z_ElementSetNames_generic &&
 184         !strcmp (comp->u.simple->u.generic, "R"))
 185     {
 186         raw_mode = 1;
 187     }
 188     if (!(rt = recType_byName (zh->reg->recTypes, zh->res,
 189                                file_type, &clientData)))
 190     {
 191         yaz_log (YLOG_WARN, "Retrieve: Cannot handle type %s",  file_type);
 192         return 14;
 193     }
 194     yaz_log (YLOG_DEBUG, "retrieve localno=" ZINT_FORMAT " score=%d", sysno,score);
 195     retrieveCtrl.fh = &fc;
 196     fc.fd = -1;
 197     retrieveCtrl.fname = fname;
 198     if (rec->size[recInfo_storeData] > 0)
 199     {
 200         retrieveCtrl.readf = zebra_record_int_read;
 201         retrieveCtrl.seekf = zebra_record_int_seek;
 202         retrieveCtrl.tellf = zebra_record_int_tell;
 203         fc.record_int_len = rec->size[recInfo_storeData];
 204         fc.record_int_buf = rec->info[recInfo_storeData];
 205         fc.record_int_pos = 0;
 206         yaz_log (YLOG_DEBUG, "Internal retrieve. %d bytes", fc.record_int_len);
 207         if (raw_mode)
 208         {
 209             *output_format = VAL_SUTRS;
 210             *rec_lenp = rec->size[recInfo_storeData];
 211             *rec_bufp = (char *) odr_malloc(stream, *rec_lenp);
 212             memcpy(*rec_bufp, rec->info[recInfo_storeData], *rec_lenp);
 213             rec_rm (&rec);
 214             return 0;
 215         }
 216     }
 217     else
 218     {
 219         char full_rep[1024];
 220
 221         if (zh->path_reg && !yaz_is_abspath (fname))
 222         {
 223             strcpy (full_rep, zh->path_reg);
 224             strcat (full_rep, "/");
 225             strcat (full_rep, fname);
 226         }
 227         else
 228             strcpy (full_rep, fname);
 229
 230         if ((fc.fd = open (full_rep, O_BINARY|O_RDONLY)) == -1)
 231         {
 232             yaz_log (YLOG_WARN|YLOG_ERRNO, "Retrieve fail; missing file: %s",
 233                   full_rep);
 234             rec_rm (&rec);
 235             return 14;
 236         }
 237         fc.record_offset = recordAttr->recordOffset;
 238
 239         retrieveCtrl.readf = zebra_record_ext_read;
 240         retrieveCtrl.seekf = zebra_record_ext_seek;
 241         retrieveCtrl.tellf = zebra_record_ext_tell;
 242
 243         zebra_record_ext_seek (retrieveCtrl.fh, 0);
 244         if (raw_mode)
 245         {
 246             *output_format = VAL_SUTRS;
 247             *rec_lenp = recordAttr->recordSize;
 248             *rec_bufp = (char *) odr_malloc(stream, *rec_lenp);
 249             zebra_record_ext_read(&fc, *rec_bufp, *rec_lenp);
 250             rec_rm (&rec);
 251             close (fc.fd);
 252             return 0;
 253         }
 254     }
 255     retrieveCtrl.localno = sysno;
 256     retrieveCtrl.staticrank = recordAttr->staticrank;
 257     retrieveCtrl.score = score;
 258     retrieveCtrl.recordSize = recordAttr->recordSize;
 259     retrieveCtrl.odr = stream;
 260     retrieveCtrl.input_format = retrieveCtrl.output_format = input_format;
 261     retrieveCtrl.comp = comp;
 262     retrieveCtrl.encoding = zh->record_encoding;
 263     retrieveCtrl.diagnostic = 0;
 264     retrieveCtrl.addinfo = 0;
 265     retrieveCtrl.dh = zh->reg->dh;
 266     retrieveCtrl.res = zh->res;
 267     retrieveCtrl.rec_buf = 0;
 268     retrieveCtrl.rec_len = -1;
 269     retrieveCtrl.hit_snippet = hit_snippet;
 270     retrieveCtrl.doc_snippet = zebra_snippets_create();
 271
 272     if (1)
 273     {
 274         /* snippets code */
 275         zebra_snippets *snippet;
 276
 277         zebra_rec_keys_t reckeys = zebra_rec_keys_open();
 278
 279         zebra_rec_keys_set_buf(reckeys,
 280                                rec->info[recInfo_delKeys],
 281                                rec->size[recInfo_delKeys],
 282                                0);
 283         zebra_snippets_rec_keys(zh, reckeys, retrieveCtrl.doc_snippet);
 284         zebra_rec_keys_close(reckeys);
 285
 286
 287 #if 0
 288         /* for debugging purposes */
 289         yaz_log(YLOG_LOG, "DOC SNIPPET:");
 290         zebra_snippets_log(retrieveCtrl.doc_snippet, YLOG_LOG);
 291         yaz_log(YLOG_LOG, "HIT SNIPPET:");
 292         zebra_snippets_log(retrieveCtrl.hit_snippet, YLOG_LOG);
 293 #endif
 294         snippet = zebra_snippets_window(retrieveCtrl.doc_snippet,
 295                                         retrieveCtrl.hit_snippet,
 296                                         10);
 297 #if 0
 298         /* for debugging purposes */
 299         yaz_log(YLOG_LOG, "WINDOW SNIPPET:");
 300         zebra_snippets_log(snippet, YLOG_LOG);
 301 #endif
 302         (*rt->retrieve)(clientData, &retrieveCtrl);
 303
 304         zebra_snippets_destroy(snippet);
 305     }
 306     else
 307     {
 308         (*rt->retrieve)(clientData, &retrieveCtrl);
 309     }
 310
 311     zebra_snippets_destroy(retrieveCtrl.doc_snippet);
 312
 313     *output_format = retrieveCtrl.output_format;
 314     *rec_bufp = (char *) retrieveCtrl.rec_buf;
 315     *rec_lenp = retrieveCtrl.rec_len;
 316     if (fc.fd != -1)
 317         close (fc.fd);
 318     rec_rm (&rec);
 319
 320     *addinfo = retrieveCtrl.addinfo;
 321     return retrieveCtrl.diagnostic;
 322 }