Allow safari filter to specify index type.
[idzebra-moved-to-github.git] / index / safari.c
1 /* $Id: safari.c,v 1.9 2007-04-25 09:38:21 adam Exp $
2    Copyright (C) 1995-2007
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 this program; if not, write to the Free Software
19 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
20
21 */
22
23 #include <yaz/oid_db.h>
24 #include <stdio.h>
25 #include <assert.h>
26 #include <ctype.h>
27
28 #include <idzebra/util.h>
29 #include <idzebra/recctrl.h>
30
31 struct filter_info {
32     int segments;
33 };
34
35 static void *filter_init(Res res, RecType recType)
36 {
37     struct filter_info *tinfo = (struct filter_info *) xmalloc(sizeof(*tinfo));
38     tinfo->segments = 0;
39     return tinfo;
40 }
41
42 static void *filter_init2(Res res, RecType recType)
43 {
44     struct filter_info *tinfo = (struct filter_info *) xmalloc(sizeof(*tinfo));
45     tinfo->segments = 1;
46     return tinfo;
47 }
48
49 static ZEBRA_RES filter_config(void *clientData, Res res, const char *args)
50 {
51     return ZEBRA_OK;
52 }
53
54 static void filter_destroy(void *clientData)
55 {
56     struct filter_info *tinfo = clientData;
57     xfree (tinfo);
58 }
59
60 struct fi_info {
61     struct recExtractCtrl *p;
62     char *buf;
63     int offset;
64     int max;
65 };
66
67 static struct fi_info *fi_open(struct recExtractCtrl *p)
68 {
69     struct fi_info *fi = (struct fi_info *) xmalloc (sizeof(*fi));
70
71     fi->p = p;
72     fi->buf = (char *) xmalloc (4096);
73     fi->offset = 1;
74     fi->max = 1;
75     return fi;
76 }
77
78 static int fi_getchar(struct fi_info *fi, char *dst)
79 {
80     if (fi->offset >= fi->max)
81     {
82         if (fi->max <= 0)
83             return 0;
84         fi->max = fi->p->stream->readf(fi->p->stream, fi->buf, 4096);
85         fi->offset = 0;
86         if (fi->max <= 0)
87             return 0;
88     }
89     *dst = fi->buf[(fi->offset)++];
90     return 1;
91 }
92
93 static int fi_gets(struct fi_info *fi, char *dst, int max)
94 {
95     int l = 0;
96     while(1)
97     {
98         char dstbyte;
99         if (!fi_getchar(fi, &dstbyte))
100             return 0;
101         if (dstbyte == '\n')
102             break;
103         if (l < max)
104             dst[l++] = dstbyte;
105     }
106     dst[l] = '\0';
107     return 1;
108 }
109
110 static void fi_close (struct fi_info *fi)
111 {
112     xfree (fi->buf);
113     xfree (fi);
114 }
115
116 static int filter_extract(void *clientData, struct recExtractCtrl *p)
117 {
118     struct filter_info *tinfo = clientData;
119     char line[512];
120     RecWord recWord;
121     struct fi_info *fi = fi_open(p);
122
123 #if 0
124     yaz_log(YLOG_LOG, "filter_extract off=%ld",
125             (long) (*fi->p->tellf)(fi->p->fh));
126 #endif
127     (*p->init)(p, &recWord);
128
129     if (!fi_gets(fi, line, sizeof(line)-1))
130         return RECCTRL_EXTRACT_EOF;
131     sscanf(line, "%255s", p->match_criteria);
132     
133     while (fi_gets(fi, line, sizeof(line)-1))
134     {
135         int nor = 0;
136         char field[40];
137         const char *cp = line;
138 #if 0
139         yaz_log(YLOG_LOG, "safari line: %s", line);
140 #endif
141         if (*cp >= '0' && *cp <= '9')
142             recWord.index_type = '0'; /* the default is 0 (raw) */
143         else
144             recWord.index_type = *cp++; /* type given */
145
146         if (tinfo->segments)
147         {
148             if (sscanf(cp, ZINT_FORMAT " " ZINT_FORMAT " " ZINT_FORMAT 
149                        ZINT_FORMAT " %39s %n",
150                        &recWord.record_id, &recWord.section_id, 
151                        &recWord.segment,
152                        &recWord.seqno,
153                        field, &nor) < 5)
154             {
155                 yaz_log(YLOG_WARN, "Bad safari record line: %s", line);
156                 return RECCTRL_EXTRACT_ERROR_GENERIC;
157             }
158         }
159         else
160         {
161             if (sscanf(cp, ZINT_FORMAT " " ZINT_FORMAT " " ZINT_FORMAT " %39s %n",
162                        &recWord.record_id, &recWord.section_id, &recWord.seqno,
163                        field, &nor) < 4)
164             {
165                 yaz_log(YLOG_WARN, "Bad safari record line: %s", line);
166                 return RECCTRL_EXTRACT_ERROR_GENERIC;
167             }
168         }
169         for (cp = cp + nor; *cp == ' '; cp++)
170             ;
171         recWord.index_name = field;
172         recWord.term_buf = cp;
173         recWord.term_len = strlen(cp);
174         (*p->tokenAdd)(&recWord);
175     }
176     fi_close(fi);
177     return RECCTRL_EXTRACT_OK;
178 }
179
180 static int filter_retrieve (void *clientData, struct recRetrieveCtrl *p)
181 {
182     int r, filter_ptr = 0;
183     static char *filter_buf = NULL;
184     static int filter_size = 0;
185     int make_header = 1;
186     int make_body = 1;
187     const char *elementSetName = NULL;
188     int no_lines = 0;
189
190     if (p->comp && p->comp->which == Z_RecordComp_simple &&
191         p->comp->u.simple->which == Z_ElementSetNames_generic)
192         elementSetName = p->comp->u.simple->u.generic;
193
194     if (elementSetName)
195     {
196         /* don't make header for the R(aw) element set name */
197         if (!strcmp(elementSetName, "R"))
198         {
199             make_header = 0;
200             make_body = 1;
201         }
202         /* only make header for the H(eader) element set name */
203         else if (!strcmp(elementSetName, "H"))
204         {
205             make_header = 1;
206             make_body = 0;
207         }
208     }
209     while (1)
210     {
211         if (filter_ptr + 4096 >= filter_size)
212         {
213             char *nb;
214
215             filter_size = 2*filter_size + 8192;
216             nb = (char *) xmalloc (filter_size);
217             if (filter_buf)
218             {
219                 memcpy (nb, filter_buf, filter_ptr);
220                 xfree (filter_buf);
221             }
222             filter_buf = nb;
223         }
224         if (make_header && filter_ptr == 0)
225         {
226             if (p->score >= 0)
227             {
228                 sprintf (filter_buf, "Rank: %d\n", p->score);
229                 filter_ptr = strlen(filter_buf);
230             }
231             sprintf (filter_buf + filter_ptr, "Local Number: " ZINT_FORMAT "\n",
232                      p->localno);
233             filter_ptr = strlen(filter_buf);
234             if (p->fname)
235             {
236                 sprintf (filter_buf + filter_ptr, "Filename: %s\n", p->fname);
237                 filter_ptr = strlen(filter_buf);
238             }
239             strcpy(filter_buf+filter_ptr++, "\n");
240         }
241         if (!make_body)
242             break;
243         r = p->stream->readf(p->stream, filter_buf + filter_ptr, 4096);
244         if (r <= 0)
245             break;
246         filter_ptr += r;
247     }
248     filter_buf[filter_ptr] = '\0';
249     if (elementSetName)
250     {
251         if (!strcmp (elementSetName, "B"))
252             no_lines = 4;
253         if (!strcmp (elementSetName, "M"))
254             no_lines = 20;
255     }
256     if (no_lines)
257     {
258         char *p = filter_buf;
259         int i = 0;
260
261         while (++i <= no_lines && (p = strchr (p, '\n')))
262             p++;
263         if (p)
264         {
265             p[1] = '\0';
266             filter_ptr = p-filter_buf;
267         }
268     }
269     p->output_format = yaz_oid_recsyn_sutrs;
270     p->rec_buf = filter_buf;
271     p->rec_len = filter_ptr; 
272     return 0;
273 }
274
275 static struct recType filter_type = {
276     0,
277     "safari",
278     filter_init,
279     filter_config,
280     filter_destroy,
281     filter_extract,
282     filter_retrieve
283 };
284
285 static struct recType filter_type2 = {
286     0,
287     "safari2",
288     filter_init2,
289     filter_config,
290     filter_destroy,
291     filter_extract,
292     filter_retrieve
293 };
294
295 RecType
296 #ifdef IDZEBRA_STATIC_SAFARI
297 idzebra_filter_safari
298 #else
299 idzebra_filter
300 #endif
301
302 [] = {
303     &filter_type,
304     &filter_type2,
305     0,
306 };
307 /*
308  * Local variables:
309  * c-basic-offset: 4
310  * indent-tabs-mode: nil
311  * End:
312  * vim: shiftwidth=4 tabstop=8 expandtab
313  */
314