estimatehits config option,
[idzebra-moved-to-github.git] / index / retrieve.c
1 /* $Id: retrieve.c,v 1.23 2004-08-06 09:43:03 heikki Exp $
2    Copyright (C) 1995,1996,1997,1998,1999,2000,2001,2002,2003,2004
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 #else
31 #include <unistd.h>
32 #endif
33
34 #include "index.h"
35 #include <direntz.h>
36
37 int zebra_record_ext_read (void *fh, char *buf, size_t count)
38 {
39     struct zebra_fetch_control *fc = (struct zebra_fetch_control *) fh;
40     return read (fc->fd, buf, count);
41 }
42
43 off_t zebra_record_ext_seek (void *fh, off_t offset)
44 {
45     struct zebra_fetch_control *fc = (struct zebra_fetch_control *) fh;
46     return lseek (fc->fd, offset + fc->record_offset, SEEK_SET);
47 }
48
49 off_t zebra_record_ext_tell (void *fh)
50 {
51     struct zebra_fetch_control *fc = (struct zebra_fetch_control *) fh;
52     return lseek (fc->fd, 0, SEEK_CUR) - fc->record_offset;
53 }
54
55 off_t zebra_record_int_seek (void *fh, off_t offset)
56 {
57     struct zebra_fetch_control *fc = (struct zebra_fetch_control *) fh;
58     return (off_t) (fc->record_int_pos = offset);
59 }
60
61 off_t zebra_record_int_tell (void *fh)
62 {
63     struct zebra_fetch_control *fc = (struct zebra_fetch_control *) fh;
64     return (off_t) fc->record_int_pos;
65 }
66
67 int zebra_record_int_read (void *fh, char *buf, size_t count)
68 {
69     struct zebra_fetch_control *fc = (struct zebra_fetch_control *) fh;
70     int l = fc->record_int_len - fc->record_int_pos;
71     if (l <= 0)
72         return 0;
73     l = (l < (int) count) ? l : count;
74     memcpy (buf, fc->record_int_buf + fc->record_int_pos, l);
75     fc->record_int_pos += l;
76     return l;
77 }
78
79 void zebra_record_int_end (void *fh, off_t off)
80 {
81     struct zebra_fetch_control *fc = (struct zebra_fetch_control *) fh;
82     fc->offset_end = off;
83 }
84
85 int zebra_record_fetch (ZebraHandle zh, SYSNO sysno, int score, ODR stream,
86                         oid_value input_format, Z_RecordComposition *comp,
87                         oid_value *output_format, char **rec_bufp,
88                         int *rec_lenp, char **basenamep)
89 {
90     Record rec;
91     char *fname, *file_type, *basename;
92     RecType rt;
93     struct recRetrieveCtrl retrieveCtrl;
94     char subType[128];
95     struct zebra_fetch_control fc;
96     RecordAttr *recordAttr;
97     void *clientData;
98     int raw_mode = 0;
99
100     rec = rec_get (zh->reg->records, sysno);
101     if (!rec)
102     {
103         logf (LOG_DEBUG, "rec_get fail on sysno=" ZINT_FORMAT, sysno);
104         *basenamep = 0;
105         return 14;
106     }
107     recordAttr = rec_init_attr (zh->reg->zei, rec);
108
109     file_type = rec->info[recInfo_fileType];
110     fname = rec->info[recInfo_filename];
111     basename = rec->info[recInfo_databaseName];
112     *basenamep = (char *) odr_malloc (stream, strlen(basename)+1);
113     strcpy (*basenamep, basename);
114
115     if (comp && comp->which == Z_RecordComp_simple &&
116         comp->u.simple->which == Z_ElementSetNames_generic)
117     {
118         if (!strcmp (comp->u.simple->u.generic, "R"))
119             raw_mode = 1;
120     }
121     if (!(rt = recType_byName (zh->reg->recTypes,
122                                file_type, subType, &clientData)))
123     {
124         logf (LOG_WARN, "Retrieve: Cannot handle type %s",  file_type);
125         return 14;
126     }
127     logf (LOG_DEBUG, "retrieve localno=" ZINT_FORMAT " score=%d", sysno,score);
128     retrieveCtrl.fh = &fc;
129     fc.fd = -1;
130     retrieveCtrl.fname = fname;
131     if (rec->size[recInfo_storeData] > 0)
132     {
133         retrieveCtrl.readf = zebra_record_int_read;
134         retrieveCtrl.seekf = zebra_record_int_seek;
135         retrieveCtrl.tellf = zebra_record_int_tell;
136         fc.record_int_len = rec->size[recInfo_storeData];
137         fc.record_int_buf = rec->info[recInfo_storeData];
138         fc.record_int_pos = 0;
139         logf (LOG_DEBUG, "Internal retrieve. %d bytes", fc.record_int_len);
140         if (raw_mode)
141         {
142             *output_format = VAL_SUTRS;
143             *rec_lenp = rec->size[recInfo_storeData];
144             *rec_bufp = (char *) odr_malloc(stream, *rec_lenp);
145             memcpy(*rec_bufp, rec->info[recInfo_storeData], *rec_lenp);
146             rec_rm (&rec);
147             return 0;
148         }
149     }
150     else
151     {
152         char full_rep[1024];
153
154         if (zh->path_reg && !yaz_is_abspath (fname))
155         {
156             strcpy (full_rep, zh->path_reg);
157             strcat (full_rep, "/");
158             strcat (full_rep, fname);
159         }
160         else
161             strcpy (full_rep, fname);
162
163         if ((fc.fd = open (full_rep, O_BINARY|O_RDONLY)) == -1)
164         {
165             logf (LOG_WARN|LOG_ERRNO, "Retrieve fail; missing file: %s",
166                   full_rep);
167             rec_rm (&rec);
168             return 14;
169         }
170         fc.record_offset = recordAttr->recordOffset;
171
172         retrieveCtrl.readf = zebra_record_ext_read;
173         retrieveCtrl.seekf = zebra_record_ext_seek;
174         retrieveCtrl.tellf = zebra_record_ext_tell;
175
176         zebra_record_ext_seek (retrieveCtrl.fh, 0);
177         if (raw_mode)
178         {
179             *output_format = VAL_SUTRS;
180             *rec_lenp = recordAttr->recordSize;
181             *rec_bufp = (char *) odr_malloc(stream, *rec_lenp);
182             zebra_record_ext_read(&fc, *rec_bufp, *rec_lenp);
183             rec_rm (&rec);
184             close (fc.fd);
185             return 0;
186         }
187     }
188     retrieveCtrl.subType = subType;
189     retrieveCtrl.localno = sysno;
190     retrieveCtrl.score = score;
191     retrieveCtrl.recordSize = recordAttr->recordSize;
192     retrieveCtrl.odr = stream;
193     retrieveCtrl.input_format = retrieveCtrl.output_format = input_format;
194     retrieveCtrl.comp = comp;
195     retrieveCtrl.encoding = zh->record_encoding;
196     retrieveCtrl.diagnostic = 0;
197     retrieveCtrl.dh = zh->reg->dh;
198     retrieveCtrl.res = zh->res;
199     retrieveCtrl.rec_buf = 0;
200     retrieveCtrl.rec_len = -1;
201     
202     (*rt->retrieve)(clientData, &retrieveCtrl);
203     *output_format = retrieveCtrl.output_format;
204     *rec_bufp = (char *) retrieveCtrl.rec_buf;
205     *rec_lenp = retrieveCtrl.rec_len;
206     if (fc.fd != -1)
207         close (fc.fd);
208     rec_rm (&rec);
209
210     return retrieveCtrl.diagnostic;
211 }