Record management uses the bfile system.
[idzebra-moved-to-github.git] / index / extract.c
1 /*
2  * Copyright (C) 1994-1995, Index Data I/S 
3  * All rights reserved.
4  * Sebastian Hammer, Adam Dickmeiss
5  *
6  * $Log: extract.c,v $
7  * Revision 1.30  1995-11-22 17:19:16  adam
8  * Record management uses the bfile system.
9  *
10  * Revision 1.29  1995/11/21  15:01:14  adam
11  * New general match criteria implemented.
12  * New feature: document groups.
13  *
14  * Revision 1.28  1995/11/21  09:20:30  adam
15  * Yet more work on record match.
16  *
17  * Revision 1.27  1995/11/20  16:59:45  adam
18  * New update method: the 'old' keys are saved for each records.
19  *
20  * Revision 1.26  1995/11/20  11:56:24  adam
21  * Work on new traversal.
22  *
23  * Revision 1.25  1995/11/16  15:34:54  adam
24  * Uses new record management system in both indexer and server.
25  *
26  * Revision 1.24  1995/11/15  19:13:08  adam
27  * Work on record management.
28  *
29  * Revision 1.23  1995/10/27  14:00:10  adam
30  * Implemented detection of database availability.
31  *
32  * Revision 1.22  1995/10/17  18:02:07  adam
33  * New feature: databases. Implemented as prefix to words in dictionary.
34  *
35  * Revision 1.21  1995/10/10  12:24:38  adam
36  * Temporary sort files are compressed.
37  *
38  * Revision 1.20  1995/10/06  13:52:05  adam
39  * Bug fixes. Handler may abort further scanning.
40  *
41  * Revision 1.19  1995/10/04  12:55:16  adam
42  * Bug fix in ranked search. Use=Any keys inserted.
43  *
44  * Revision 1.18  1995/10/04  09:37:08  quinn
45  * Fixed bug.
46  *
47  * Revision 1.17  1995/10/03  14:28:57  adam
48  * Buffered read in extract works.
49  *
50  * Revision 1.16  1995/10/03  14:28:45  adam
51  * Work on more effecient read handler in extract.
52  *
53  * Revision 1.15  1995/10/02  15:42:53  adam
54  * Extract uses file descriptors instead of FILE pointers.
55  *
56  * Revision 1.14  1995/10/02  15:29:13  adam
57  * More logging in file_extract.
58  *
59  * Revision 1.13  1995/09/29  14:01:39  adam
60  * Bug fixes.
61  *
62  * Revision 1.12  1995/09/28  14:22:56  adam
63  * Sort uses smaller temporary files.
64  *
65  * Revision 1.11  1995/09/28  12:10:31  adam
66  * Bug fixes. Field prefix used in queries.
67  *
68  * Revision 1.10  1995/09/28  09:19:41  adam
69  * xfree/xmalloc used everywhere.
70  * Extract/retrieve method seems to work for text records.
71  *
72  * Revision 1.9  1995/09/27  12:22:28  adam
73  * More work on extract in record control.
74  * Field name is not in isam keys but in prefix in dictionary words.
75  *
76  * Revision 1.8  1995/09/14  07:48:22  adam
77  * Record control management.
78  *
79  * Revision 1.7  1995/09/11  13:09:32  adam
80  * More work on relevance feedback.
81  *
82  * Revision 1.6  1995/09/08  14:52:27  adam
83  * Minor changes. Dictionary is lower case now.
84  *
85  * Revision 1.5  1995/09/06  16:11:16  adam
86  * Option: only one word key per file.
87  *
88  * Revision 1.4  1995/09/05  15:28:39  adam
89  * More work on search engine.
90  *
91  * Revision 1.3  1995/09/04  12:33:41  adam
92  * Various cleanup. YAZ util used instead.
93  *
94  * Revision 1.2  1995/09/04  09:10:34  adam
95  * More work on index add/del/update.
96  * Merge sort implemented.
97  * Initial work on z39 server.
98  *
99  * Revision 1.1  1995/09/01  14:06:35  adam
100  * Split of work into more files.
101  *
102  */
103 #include <stdio.h>
104 #include <assert.h>
105 #include <unistd.h>
106 #include <fcntl.h>
107 #include <ctype.h>
108
109 #include <alexutil.h>
110 #include <recctrl.h>
111 #include "index.h"
112
113 #include "recindex.h"
114
115 static Dict matchDict;
116
117 static Records records = NULL;
118
119 static char **key_buf;
120 static size_t ptr_top;
121 static size_t ptr_i;
122 static size_t key_buf_used;
123 static int key_file_no;
124
125 static int records_inserted = 0;
126 static int records_updated = 0;
127 static int records_deleted = 0;
128
129 #define MATCH_DICT "match"
130
131 void key_open (int mem)
132 {
133     if (mem < 50000)
134         mem = 50000;
135     key_buf = xmalloc (mem);
136     ptr_top = mem/sizeof(char*);
137     ptr_i = 0;
138
139     key_buf_used = 0;
140     key_file_no = 0;
141
142     if (!(matchDict = dict_open (MATCH_DICT, 20, 1)))
143     {
144         logf (LOG_FATAL, "dict_open fail of %s", MATCH_DICT);
145         exit (1);
146     }
147     assert (!records);
148     records = rec_open (1);
149 }
150
151 struct encode_info {
152     int  sysno;
153     int  seqno;
154     char buf[512];
155 };
156
157 void encode_key_init (struct encode_info *i)
158 {
159     i->sysno = 0;
160     i->seqno = 0;
161 }
162
163 char *encode_key_int (int d, char *bp)
164 {
165     if (d <= 63)
166         *bp++ = d;
167     else if (d <= 16383)
168     {
169         *bp++ = 64 + (d>>8);
170         *bp++ = d  & 255;
171     }
172     else if (d <= 4194303)
173     {
174         *bp++ = 128 + (d>>16);
175         *bp++ = (d>>8) & 255;
176         *bp++ = d & 255;
177     }
178     else
179     {
180         *bp++ = 192 + (d>>24);
181         *bp++ = (d>>16) & 255;
182         *bp++ = (d>>8) & 255;
183         *bp++ = d & 255;
184     }
185     return bp;
186 }
187
188 void encode_key_write (char *k, struct encode_info *i, FILE *outf)
189 {
190     struct it_key key;
191     char *bp = i->buf;
192
193     while ((*bp++ = *k++))
194         ;
195     memcpy (&key, k+1, sizeof(struct it_key));
196     bp = encode_key_int ( (key.sysno - i->sysno) * 2 + *k, bp);
197     if (i->sysno != key.sysno)
198     {
199         i->sysno = key.sysno;
200         i->seqno = 0;
201     }
202     bp = encode_key_int (key.seqno - i->seqno, bp);
203     i->seqno = key.seqno;
204     if (fwrite (i->buf, bp - i->buf, 1, outf) != 1)
205     {
206         logf (LOG_FATAL|LOG_ERRNO, "fwrite");
207         exit (1);
208     }
209 }
210
211 void key_flush (void)
212 {
213     FILE *outf;
214     char out_fname[200];
215     char *prevcp, *cp;
216     struct encode_info encode_info;
217     
218     if (ptr_i <= 0)
219         return;
220
221     key_file_no++;
222     logf (LOG_LOG, "sorting section %d", key_file_no);
223     qsort (key_buf + ptr_top-ptr_i, ptr_i, sizeof(char*), key_qsort_compare);
224     sprintf (out_fname, TEMP_FNAME, key_file_no);
225
226     if (!(outf = fopen (out_fname, "w")))
227     {
228         logf (LOG_FATAL|LOG_ERRNO, "fopen (4) %s", out_fname);
229         exit (1);
230     }
231     logf (LOG_LOG, "writing section %d", key_file_no);
232     prevcp = cp = key_buf[ptr_top-ptr_i];
233     
234     encode_key_init (&encode_info);
235     encode_key_write (cp, &encode_info, outf);
236     while (--ptr_i > 0)
237     {
238         cp = key_buf[ptr_top-ptr_i];
239         if (strcmp (cp, prevcp))
240         {
241             encode_key_init (&encode_info);
242             encode_key_write (cp, &encode_info, outf);
243             prevcp = cp;
244         }
245         else
246             encode_key_write (cp + strlen(cp), &encode_info, outf);
247     }
248     if (fclose (outf))
249     {
250         logf (LOG_FATAL|LOG_ERRNO, "fclose %s", out_fname);
251         exit (1);
252     }
253     logf (LOG_LOG, "finished section %d", key_file_no);
254     ptr_i = 0;
255     key_buf_used = 0;
256 }
257
258 int key_close (void)
259 {
260     key_flush ();
261     xfree (key_buf);
262     rec_close (&records);
263     dict_close (matchDict);
264
265     logf (LOG_LOG, "Records inserted %6d", records_inserted);
266     logf (LOG_LOG, "Records updated  %6d", records_updated);
267     logf (LOG_LOG, "Records deleted  %6d", records_deleted);
268     return key_file_no;
269 }
270
271 static void wordInit (RecWord *p)
272 {
273     p->attrSet = 1;
274     p->attrUse = 1016;
275     p->which = Word_String;
276 }
277
278 struct recKeys {
279     int buf_used;
280     int buf_max;
281     char *buf;
282 } reckeys;
283
284 static void addRecordKey (const RecWord *p)
285 {
286     char *dst;
287     char attrSet;
288     short attrUse;
289     size_t i;
290
291     if (reckeys.buf_used+1024 > reckeys.buf_max)
292     {
293         char *b;
294
295         b = malloc (reckeys.buf_max += 65000);
296         if (reckeys.buf_used > 0)
297             memcpy (b, reckeys.buf, reckeys.buf_used);
298         free (reckeys.buf);
299         reckeys.buf = b;
300     }
301     dst = reckeys.buf + reckeys.buf_used;
302     switch (p->which)
303     {
304     case Word_String:
305         attrSet = p->attrSet;
306         memcpy (dst, &attrSet, sizeof(attrSet));
307         dst += sizeof(attrSet);
308
309         attrUse = p->attrUse;
310         memcpy (dst, &attrUse, sizeof(attrUse));
311         dst += sizeof(attrUse);
312         
313         for (i = 0; p->u.string[i]; i++)
314             *dst++ = p->u.string[i];
315         *dst++ = '\0';
316
317         memcpy (dst, &p->seqno, sizeof(p->seqno));
318         dst += sizeof(p->seqno);
319
320         break;
321     default:
322         return;
323     }
324     reckeys.buf_used = dst - reckeys.buf;
325 }
326
327 static void flushRecordKeys (SYSNO sysno, int cmd, struct recKeys *reckeys, 
328                              const char *databaseName)
329 {
330     int off = 0;
331     while (off < reckeys->buf_used)
332     {
333         const char *src = reckeys->buf + off;
334         char attrSet;
335         short attrUse;
336         struct it_key key;
337         
338         memcpy (&attrSet, src, sizeof(attrSet));
339         src += sizeof(attrSet);
340
341         memcpy (&attrUse, src, sizeof(attrUse));
342         src += sizeof(attrUse);
343
344         if (key_buf_used + 1024 > (ptr_top-ptr_i)*sizeof(char*))
345             key_flush ();
346         ++ptr_i;
347         key_buf[ptr_top-ptr_i] = (char*)key_buf + key_buf_used;
348         key_buf_used += index_word_prefix ((char*)key_buf + key_buf_used,
349                                            attrSet, attrUse, databaseName);
350         while (*src)
351             ((char*)key_buf) [key_buf_used++] = index_char_cvt (*src++);
352         src++;
353         ((char*)key_buf) [key_buf_used++] = '\0';
354         
355         ((char*) key_buf)[key_buf_used++] = cmd;
356
357         memcpy (&key.seqno, src, sizeof(key.seqno));
358         src += sizeof(key.seqno);
359         key.sysno = sysno;
360         memcpy ((char*)key_buf + key_buf_used, &key, sizeof(key));
361         key_buf_used += sizeof(key);
362         off = src - reckeys->buf;
363     }
364     assert (off == reckeys->buf_used);
365 }
366
367 static const char **searchRecordKey (struct recKeys *reckeys,
368                                int attrSetS, int attrUseS)
369 {
370     static const char *ws[32];
371     int off = 0;
372     int startSeq = -1;
373     int i;
374
375     for (i = 0; i<32; i++)
376         ws[i] = NULL;
377     
378     while (off < reckeys->buf_used)
379     {
380         const char *src = reckeys->buf + off;
381         char attrSet;
382         short attrUse;
383         int seqno;
384         const char *wstart;
385         
386         memcpy (&attrSet, src, sizeof(attrSet));
387         src += sizeof(attrSet);
388
389         memcpy (&attrUse, src, sizeof(attrUse));
390         src += sizeof(attrUse);
391
392         wstart = src;
393         while (*src++)
394             ;
395
396         memcpy (&seqno, src, sizeof(seqno));
397         src += sizeof(seqno);
398
399 #if 0
400         logf (LOG_LOG, "(%d,%d) %d %s", attrSet, attrUse, seqno, wstart);
401 #endif
402         if (attrUseS == attrUse && attrSetS == attrSet)
403         {
404             int woff;
405
406
407             if (startSeq == -1)
408                 startSeq = seqno;
409             woff = seqno - startSeq;
410             if (woff >= 0 && woff < 31)
411                 ws[woff] = wstart;
412         }
413
414         off = src - reckeys->buf;
415     }
416     assert (off == reckeys->buf_used);
417     return ws;
418 }
419
420 static void addRecordKeyAny (const RecWord *p)
421 {
422     if (p->attrSet != 1 || p->attrUse != 1016)
423     {
424         RecWord w;
425
426         memcpy (&w, p, sizeof(w));
427         w.attrSet = 1;
428         w.attrUse = 1016;
429         addRecordKey (&w);
430     }
431     addRecordKey (p);
432 }
433
434 static char *file_buf;
435 static int file_offset;
436 static int file_bufsize;
437
438 static void file_read_start (int fd)
439 {
440     file_offset = 0;
441     file_buf = xmalloc (4096);
442     file_bufsize = read (fd, file_buf, 4096);
443 }
444
445 static void file_read_stop (int fd)
446 {
447     xfree (file_buf);
448 }
449
450 static int file_read (int fd, char *buf, size_t count)
451 {
452     int l = file_bufsize - file_offset;
453
454     if (count > l)
455     {
456         int r;
457         if (l > 0)
458             memcpy (buf, file_buf + file_offset, l);
459         count = count-l;
460         if (count > file_bufsize)
461         {
462             if ((r = read (fd, buf + l, count)) == -1)
463             {
464                 logf (LOG_FATAL|LOG_ERRNO, "read");
465                 exit (1);
466             }
467             file_bufsize = 0;
468             file_offset = 0;
469             return r;
470         }
471         file_bufsize = r = read (fd, file_buf, 4096);
472         if (r == -1)
473         {
474             logf (LOG_FATAL|LOG_ERRNO, "read");
475             exit (1);
476         }
477         else if (r <= count)
478         {
479             file_offset = r;
480             memcpy (buf + l, file_buf, r);
481             return l + r;
482         }
483         else
484         {
485             file_offset = count;
486             memcpy (buf + l, file_buf, count - l);
487             return count;
488         }
489     }
490     memcpy (buf, file_buf + file_offset, count);
491     file_offset += count;
492     return count;
493 }
494
495 static int atois (const char **s)
496 {
497     int val = 0, c;
498     while ( (c=**s) >= '0' && c <= '9')
499     {
500         val = val*10 + c - '0';
501         ++(*s);
502     }
503     return val;
504 }
505
506 static char *fileMatchStr (struct recKeys *reckeys, struct recordGroup *rGroup,
507                            const char *fname,
508                            const char *recordType,
509                            const char *spec)
510 {
511     static char dstBuf[2048];
512     char *dst = dstBuf;
513     const char *s = spec;
514     static const char **w;
515     int i;
516
517     while (1)
518     {
519         while (*s == ' ' || *s == '\t')
520             s++;
521         if (!*s)
522             break;
523         if (*s == '(')
524         {
525             char matchFlag[32];
526             int attrSet, attrUse;
527             int first = 1;
528
529             s++;
530             attrSet = atois (&s);
531             if (*s != ',')
532             {
533                 logf (LOG_WARN, "Missing , in match criteria %s in group %s",
534                       spec, rGroup->groupName ? rGroup->groupName : "none");
535                 return NULL;
536             }
537             s++;
538             attrUse = atois (&s);
539             w = searchRecordKey (reckeys, attrSet, attrUse);
540             assert (w);
541
542             if (*s == ')')
543             {
544                 for (i = 0; i<32; i++)
545                     matchFlag[i] = 1;
546             }
547             else
548             {
549                 logf (LOG_WARN, "Missing ) in match criteria %s in group %s",
550                       spec, rGroup->groupName ? rGroup->groupName : "none");
551                 return NULL;
552             }
553             s++;
554
555             for (i = 0; i<32; i++)
556                 if (matchFlag[i] && w[i])
557                 {
558                     if (first)
559                     {
560                         *dst++ = ' ';
561                         first = 0;
562                     }
563                     strcpy (dst, w[i]);
564                     dst += strlen(w[i]);
565                 }
566             if (first)
567             {
568                 logf (LOG_WARN, "Record in file %s didn't contain match"
569                       " fields in (%d,%d)", fname, attrSet, attrUse);
570                 return NULL;
571             }
572         }
573         else if (*s == '$')
574         {
575             int spec_len;
576             char special[32];
577             const char *spec_src = NULL;
578             const char *s1 = ++s;
579             while (*s1 && *s1 != ' ' && *s1 != '\t')
580                 s1++;
581
582             spec_len = s1 - s;
583             if (spec_len > 31)
584                 spec_len = 31;
585             memcpy (special, s, spec_len);
586             special[spec_len] = '\0';
587             s = s1;
588
589             if (strcmp (special, "group"))
590                 spec_src = rGroup->groupName;
591             else if (strcmp (special, "database"))
592                 spec_src = rGroup->databaseName;
593             else if (strcmp (special, "filename"))
594                 spec_src = fname;
595             else if (strcmp (special, "type"))
596                 spec_src = recordType;
597             else 
598                 spec_src = NULL;
599             if (spec_src)
600             {
601                 strcpy (dst, spec_src);
602                 dst += strlen(spec_src);
603             }
604         }
605         else
606         {
607             logf (LOG_WARN, "Syntax error in match criteria %s in group %s",
608                   spec, rGroup->groupName ? rGroup->groupName : "none");
609             return NULL;
610         }
611         *dst++ = 1;
612     }
613     if (dst == dstBuf)
614     {
615         logf (LOG_WARN, "No match criteria for record %s in group %s",
616               fname, rGroup->groupName ? rGroup->groupName : "none");
617         return NULL;
618     }
619     return dstBuf;
620 }
621
622 int fileExtract (SYSNO *sysno, const char *fname, struct recordGroup *rGroup,
623                  int deleteFlag)
624 {
625     SYSNO sysnotmp;
626     int i, r;
627     char gprefix[128];
628     char ext[128];
629     char ext_res[128];
630     const char *file_type;
631     const char *file_match;
632     struct recExtractCtrl extractCtrl;
633     RecType recType;
634     Record rec;
635     char *matchStr;
636
637     if (!rGroup->groupName || !*rGroup->groupName)
638         *gprefix = '\0';
639     else
640         sprintf (gprefix, "%s.", rGroup->groupName);
641
642     logf (LOG_DEBUG, "fileExtractAdd %s", fname);
643
644     /* determine file extension */
645     for (i = strlen(fname); --i >= 0; )
646         if (fname[i] == '/')
647         {
648             strcpy (ext, "");
649             break;
650         }
651         else if (fname[i] == '.')
652         {
653             strcpy (ext, fname+i+1);
654             break;
655         }
656     /* determine file type - depending on extension */
657     sprintf (ext_res, "%sfileExtension.%s", gprefix, ext);
658     if (!(file_type = res_get (common_resource, ext_res)))
659         return 0;
660     if (!(recType = recType_byName (file_type)))
661         return 0;
662
663     /* determine match criteria */
664     sprintf (ext_res, "%sfileMatch.%s", gprefix, ext);
665     file_match = res_get (common_resource, ext_res);
666     if (!file_match)
667     {
668         sprintf (ext_res, "%sfileMatch", gprefix);
669         file_match = res_get (common_resource, ext_res);
670     }
671
672     /* determine database name */
673     if (!rGroup->databaseName)
674     {
675         sprintf (ext_res, "%sdatabase.%s", gprefix, ext);
676         if (!(rGroup->databaseName = res_get (common_resource, ext_res)))
677         {
678             sprintf (ext_res, "%sdatabase", gprefix);
679             rGroup->databaseName = res_get (common_resource, ext_res);
680         }
681     }
682     if (!rGroup->databaseName)
683         rGroup->databaseName = "Default";
684
685     /* open input file */
686     if ((extractCtrl.fd = open (fname, O_RDONLY)) == -1)
687     {
688         logf (LOG_WARN|LOG_ERRNO, "open %s", fname);
689         return 0;
690     }
691
692     /* extract keys */
693     extractCtrl.subType = "";
694     extractCtrl.init = wordInit;
695     extractCtrl.add = addRecordKeyAny;
696
697     reckeys.buf_used = 0;
698     file_read_start (extractCtrl.fd);
699     extractCtrl.readf = file_read;
700     r = (*recType->extract)(&extractCtrl);
701     file_read_stop (extractCtrl.fd);
702     close (extractCtrl.fd);
703   
704     if (r)      
705     {
706         logf (LOG_WARN, "Couldn't extract file %s, code %d", fname, r);
707         return 0;
708     }
709
710     /* perform match if sysno not known and if match criteria is specified */
711        
712     matchStr = NULL;
713     if (!sysno && file_match)
714     {
715         char *rinfo;
716         
717         sysno = &sysnotmp;
718         matchStr = fileMatchStr(&reckeys, rGroup, fname, file_type,
719                                 file_match);
720         if (matchStr)
721         {
722             rinfo = dict_lookup (matchDict, matchStr);
723             if (rinfo)
724                 memcpy (sysno, rinfo+1, sizeof(*sysno));
725             else
726                 *sysno = 0;
727         }
728         else
729         {
730             logf (LOG_WARN, "Record not inserted");
731             return 0;
732         }
733     }
734
735     /* new record ? */
736     if (! *sysno)
737     {
738         if (deleteFlag)
739         {
740             logf (LOG_LOG, "? record %s", fname);
741             return 1;
742         }
743         logf (LOG_LOG, "add record %s", fname);
744         rec = rec_new (records);
745         *sysno = rec->sysno;
746
747         if (matchStr)
748             dict_insert (matchDict, matchStr, sizeof(*sysno), sysno);
749         flushRecordKeys (*sysno, 1, &reckeys, rGroup->databaseName);
750
751         records_inserted++;
752     }
753     else
754     {
755         struct recKeys delkeys;
756
757         rec = rec_get (records, *sysno);
758
759         delkeys.buf_used = rec->size[2];
760         delkeys.buf = rec->info[2];
761         flushRecordKeys (*sysno, 0, &delkeys, rec->info[3]);
762         if (deleteFlag)
763         {
764             logf (LOG_LOG, "delete record %s", fname);
765             records_deleted++;
766             rec_del (records, &rec);
767             return 1;
768         }
769         else
770         {
771             logf (LOG_LOG, "update record %s", fname);
772             flushRecordKeys (*sysno, 1, &reckeys, rGroup->databaseName); 
773             records_updated++;
774         }
775     }
776     free (rec->info[0]);
777     rec->info[0] = rec_strdup (file_type, &rec->size[0]);
778
779     free (rec->info[1]);
780     rec->info[1] = rec_strdup (fname, &rec->size[1]);
781
782     free (rec->info[2]);
783     if (reckeys.buf_used > 0)
784     {
785         rec->info[2] = malloc (reckeys.buf_used);
786         rec->size[2] = reckeys.buf_used;
787         memcpy (rec->info[2], reckeys.buf, rec->size[2]);
788     }
789     else
790     {
791         rec->info[2] = NULL;
792         rec->size[2] = 0;
793     }
794     free (rec->info[3]);
795     rec->info[3] = rec_strdup (rGroup->databaseName, &rec->size[3]); 
796
797     rec_put (records, &rec);
798     return 1;
799 }