Allow record filters to return 'skip' this record (RECCTRL_EXTRACT_SKIP).
[idzebra-moved-to-github.git] / index / extract.c
index bad3586..51d2b94 100644 (file)
@@ -1,5 +1,5 @@
-/* $Id: extract.c,v 1.241 2006-11-21 22:17:49 adam Exp $
-   Copyright (C) 1995-2006
+/* $Id: extract.c,v 1.250 2007-03-01 10:35:46 adam Exp $
+   Copyright (C) 1995-2007
    Index Data ApS
 
 This file is part of the Zebra server.
@@ -59,8 +59,18 @@ static void extract_flush_sort_keys(ZebraHandle zh, zint sysno,
 static void extract_schema_add (struct recExtractCtrl *p, Odr_oid *oid);
 static void extract_token_add (RecWord *p);
 
+static void check_log_limit(ZebraHandle zh)
+{
+    if (zh->records_processed + zh->records_skipped == zh->m_file_verbose_limit)
+    {
+        yaz_log(YLOG_LOG, "More than %d file log entries. Omitting rest",
+                zh->m_file_verbose_limit);
+    }
+}
+
 static void logRecord (ZebraHandle zh)
 {
+    check_log_limit(zh);
     ++zh->records_processed;
     if (!(zh->records_processed % 1000))
     {
@@ -351,8 +361,11 @@ ZEBRA_RES zebra_extract_file(ZebraHandle zh, zint *sysno, const char *fname,
     }
     if (!zh->m_record_type)
     {
-       if (zh->records_processed < zh->m_file_verbose_limit)
+        check_log_limit(zh);
+       if (zh->records_processed + zh->records_skipped
+            < zh->m_file_verbose_limit)
             yaz_log (YLOG_LOG, "? %s", fname);
+        zh->records_skipped++;
         return 0;
     }
     /* determine match criteria */
@@ -406,6 +419,7 @@ ZEBRA_RES zebra_extract_file(ZebraHandle zh, zint *sysno, const char *fname,
     }
     while(1)
     {
+        int more = 0;
         r = zebra_extract_record_stream(zh, streamp,
                                         deleteFlag,
                                         0, /* tst_mode */
@@ -415,11 +429,9 @@ ZEBRA_RES zebra_extract_file(ZebraHandle zh, zint *sysno, const char *fname,
                                         fname,
                                         1, /* force_update */
                                         1, /* allow_update */
-                                        recType, recTypeClientData);
-       if (r != ZEBRA_OK)
-       {
-           break;
-       }
+                                        recType, recTypeClientData, &more);
+        if (!more)
+            break;
        if (sysno)
        {
            break;
@@ -453,6 +465,7 @@ ZEBRA_RES zebra_buffer_extract_record(ZebraHandle zh,
     ZEBRA_RES res;
     void *clientData;
     RecType recType = 0;
+    int more = 0;
 
     if (recordType && *recordType)
     {
@@ -481,8 +494,6 @@ ZEBRA_RES zebra_buffer_extract_record(ZebraHandle zh,
         return ZEBRA_FAIL;
     }
 
-
-
     zebra_create_stream_mem(&stream, buf, buf_size);
 
     res = zebra_extract_record_stream(zh, &stream,
@@ -494,7 +505,7 @@ ZEBRA_RES zebra_buffer_extract_record(ZebraHandle zh,
                                       fname,
                                       force_update,
                                       allow_update,
-                                      recType, clientData);
+                                      recType, clientData, &more);
     stream.destroy(&stream);
     return res;
 }
@@ -511,7 +522,8 @@ ZEBRA_RES zebra_extract_record_stream(ZebraHandle zh,
                                       int force_update,
                                       int allow_update,
                                       RecType recType,
-                                      void *recTypeClientData)
+                                      void *recTypeClientData,
+                                      int *more)
 
 {
     zint sysno0 = 0;
@@ -520,9 +532,10 @@ ZEBRA_RES zebra_extract_record_stream(ZebraHandle zh,
     int r;
     const char *matchStr = 0;
     Record rec;
-    off_t start_offset = 0;
+    off_t start_offset = 0, end_offset = 0;
     const char *pr_fname = fname;  /* filename to print .. */
-    int show_progress = zh->records_processed < zh->m_file_verbose_limit ? 1:0;
+    int show_progress = zh->records_processed + zh->records_skipped 
+        < zh->m_file_verbose_limit ? 1:0;
 
     zebra_init_log_level();
 
@@ -558,35 +571,56 @@ ZEBRA_RES zebra_extract_record_stream(ZebraHandle zh,
         extractCtrl.match_criteria[0] = '\0';
         extractCtrl.staticrank = 0;
 
-    
         init_extractCtrl(zh, &extractCtrl);
         
         extract_set_store_data_prepare(&extractCtrl);
         
         r = (*recType->extract)(recTypeClientData, &extractCtrl);
-        
-        if (r == RECCTRL_EXTRACT_EOF)
-            return ZEBRA_FAIL;
-        else if (r == RECCTRL_EXTRACT_ERROR_GENERIC)
+
+        switch (r)
         {
+        case RECCTRL_EXTRACT_EOF:
+            return ZEBRA_FAIL;
+        case RECCTRL_EXTRACT_ERROR_GENERIC:
             /* error occured during extraction ... */
             yaz_log (YLOG_WARN, "extract error: generic");
             return ZEBRA_FAIL;
-        }
-        else if (r == RECCTRL_EXTRACT_ERROR_NO_SUCH_FILTER)
-        {
+        case RECCTRL_EXTRACT_ERROR_NO_SUCH_FILTER:
             /* error occured during extraction ... */
             yaz_log (YLOG_WARN, "extract error: no such filter");
             return ZEBRA_FAIL;
+        case RECCTRL_EXTRACT_SKIP:
+            if (show_progress)
+                yaz_log (YLOG_LOG, "skip %s %s " ZINT_FORMAT,
+                         recordType, pr_fname, (zint) start_offset);
+            *more = 1;
+            
+            end_offset = stream->endf(stream, 0);
+            if (end_offset)
+                stream->seekf(stream, end_offset);
+
+            return ZEBRA_OK;
+        case RECCTRL_EXTRACT_OK:
+            break;
+        default:
+            yaz_log (YLOG_WARN, "extract error: unknown error: %d", r);
+            return ZEBRA_FAIL;
         }
-        
+        end_offset = stream->endf(stream, 0);
+        if (end_offset)
+            stream->seekf(stream, end_offset);
+        else
+            end_offset = stream->tellf(stream);
+
         all_matches_add(&extractCtrl);
         
         if (extractCtrl.match_criteria[0])
             match_criteria = extractCtrl.match_criteria;
     }
-    if (!sysno) {
 
+    *more = 1;
+    if (!sysno)
+    {
        sysno = &sysno0;
 
         if (match_criteria && *match_criteria) {
@@ -597,7 +631,8 @@ ZEBRA_RES zebra_extract_record_stream(ZebraHandle zh,
                                                zh->m_record_id);
                if (!matchStr)
                 {
-                    yaz_log(YLOG_WARN, "Bad match criteria (recordID)");
+                    yaz_log (YLOG_LOG, "error %s %s " ZINT_FORMAT, recordType,
+                             pr_fname, (zint) start_offset);
                    return ZEBRA_FAIL;
                 }
             }
@@ -640,6 +675,11 @@ ZEBRA_RES zebra_extract_record_stream(ZebraHandle zh,
         *sysno = rec->sysno;
 
        recordAttr = rec_init_attr (zh->reg->zei, rec);
+       if (extractCtrl.staticrank < 0)
+        {
+            yaz_log(YLOG_WARN, "Negative staticrank for record. Set to 0");
+           extractCtrl.staticrank = 0;
+        }
        recordAttr->staticrank = extractCtrl.staticrank;
 
         if (matchStr)
@@ -672,6 +712,10 @@ ZEBRA_RES zebra_extract_record_stream(ZebraHandle zh,
        
        recordAttr = rec_init_attr (zh->reg->zei, rec);
 
+        /* decrease total size */
+        zebraExplain_recordBytesIncrement (zh->reg->zei,
+                                           - recordAttr->recordSize);
+
        zebra_rec_keys_set_buf(delkeys,
                               rec->info[recInfo_delKeys],
                               rec->size[recInfo_delKeys],
@@ -714,8 +758,8 @@ ZEBRA_RES zebra_extract_record_stream(ZebraHandle zh,
         else
         {
            if (show_progress)
-                   yaz_log(YLOG_LOG, "update %s %s " ZINT_FORMAT, recordType,
-                            pr_fname, (zint) ZINT_FORMAT);
+                yaz_log(YLOG_LOG, "update %s %s " ZINT_FORMAT, recordType,
+                        pr_fname, (zint) start_offset);
            recordAttr->staticrank = extractCtrl.staticrank;
             extract_flush_sort_keys(zh, *sysno, 1, zh->reg->sortKeys);
             extract_flush_record_keys(zh, *sysno, 1, zh->reg->keys, 
@@ -755,18 +799,8 @@ ZEBRA_RES zebra_extract_record_stream(ZebraHandle zh,
                           &rec->info[recInfo_sortKeys],
                           &rec->size[recInfo_sortKeys]);
 
-    /* save file size of original record */
-    zebraExplain_recordBytesIncrement (zh->reg->zei,
-                                      - recordAttr->recordSize);
     if (stream)
     {
-        off_t end_offset = stream->endf(stream, 0);
-
-        if (!end_offset)
-            end_offset = stream->tellf(stream);
-        else
-            stream->seekf(stream, end_offset);
-
         recordAttr->recordSize = end_offset - start_offset;
         zebraExplain_recordBytesIncrement(zh->reg->zei,
                                           recordAttr->recordSize);
@@ -1054,8 +1088,7 @@ ZEBRA_RES zebra_rec_keys_to_snippets(ZebraHandle zh,
        struct it_key key;
        while (zebra_rec_keys_read(reckeys, &str, &slen, &key))
        {
-           char dst_buf[IT_MAX_WORD];
-           char *dst_term = dst_buf;
+           char *dst_term = 0;
            int ord;
             zint seqno;
            int index_type;
@@ -1149,6 +1182,20 @@ static void extract_add_sort_string(RecWord *p, const char *str, int length)
     zebra_rec_keys_write(zh->reg->sortKeys, str, length, &key);
 }
 
+static void extract_add_staticrank_string(RecWord *p,
+                                          const char *str, int length)
+{
+    char valz[40];
+    struct recExtractCtrl *ctrl = p->extractCtrl;
+
+    if (length > sizeof(valz)-1)
+        length = sizeof(valz)-1;
+
+    memcpy(valz, str, length);
+    valz[length] = '\0';
+    ctrl->staticrank = atozint(valz);
+}
+
 static void extract_add_string(RecWord *p, const char *string, int length)
 {
     ZebraHandle zh = p->extractCtrl->handle;
@@ -1157,9 +1204,7 @@ static void extract_add_string(RecWord *p, const char *string, int length)
     if (!p->index_name)
         return;
 
-    if (zebra_maps_is_sort(zh->reg->zebra_maps, p->index_type))
-       extract_add_sort_string(p, string, length);
-    else
+    if (zebra_maps_is_index(zh->reg->zebra_maps, p->index_type))
     {
        extract_add_index_string(p, zinfo_index_category_index,
                                  string, length);
@@ -1173,6 +1218,14 @@ static void extract_add_string(RecWord *p, const char *string, int length)
                 &word, zinfo_index_category_alwaysmatches, "", 0);
         }
     }
+    else if (zebra_maps_is_sort(zh->reg->zebra_maps, p->index_type))
+    {
+       extract_add_sort_string(p, string, length);
+    }
+    else if (zebra_maps_is_staticrank(zh->reg->zebra_maps, p->index_type))
+    {
+       extract_add_staticrank_string(p, string, length);
+    }
 }
 
 static void extract_add_incomplete_field(RecWord *p)
@@ -1180,20 +1233,12 @@ static void extract_add_incomplete_field(RecWord *p)
     ZebraHandle zh = p->extractCtrl->handle;
     const char *b = p->term_buf;
     int remain = p->term_len;
+    int first = 1;
     const char **map = 0;
     
     if (remain > 0)
        map = zebra_maps_input(zh->reg->zebra_maps, p->index_type, &b, remain, 0);
 
-    if (map)
-    {   
-        if (zebra_maps_is_first_in_field(zh->reg->zebra_maps, p->index_type))
-        {
-             /* first in field marker */
-            extract_add_string(p, FIRST_IN_FIELD_STR, FIRST_IN_FIELD_LEN);
-            p->seqno++;
-        }
-    }
     while (map)
     {
        char buf[IT_MAX_WORD+1];
@@ -1226,6 +1271,17 @@ static void extract_add_incomplete_field(RecWord *p)
        }
        if (!i)
            return;
+
+        if (first)
+        {   
+            first = 0;
+            if (zebra_maps_is_first_in_field(zh->reg->zebra_maps, p->index_type))
+            {
+                /* first in field marker */
+                extract_add_string(p, FIRST_IN_FIELD_STR, FIRST_IN_FIELD_LEN);
+                p->seqno++;
+            }
+        }
        extract_add_string (p, buf, i);
         p->seqno++;
     }
@@ -1349,24 +1405,30 @@ static void extract_schema_add(struct recExtractCtrl *p, Odr_oid *oid)
 void extract_flush_sort_keys(ZebraHandle zh, zint sysno,
                              int cmd, zebra_rec_keys_t reckeys)
 {
+#if 0
+    yaz_log(YLOG_LOG, "extract_flush_sort_keys cmd=%d sysno=" ZINT_FORMAT,
+            cmd, sysno);
+    extract_rec_keys_log(zh, cmd, reckeys, YLOG_LOG);
+#endif
+
     if (zebra_rec_keys_rewind(reckeys))
     {
-        SortIdx sortIdx = zh->reg->sortIdx;
+        zebra_sort_index_t si = zh->reg->sort_index;
        size_t slen;
        const char *str;
        struct it_key key_in;
 
-        sortIdx_sysno (sortIdx, sysno);
+        zebra_sort_sysno(si, sysno);
 
        while (zebra_rec_keys_read(reckeys, &str, &slen, &key_in))
         {
             int ord = CAST_ZINT_TO_INT(key_in.mem[0]);
             
-            sortIdx_type(sortIdx, ord);
+            zebra_sort_type(si, ord);
             if (cmd == 1)
-                sortIdx_add(sortIdx, str, slen);
+                zebra_sort_add(si, str, slen);
             else
-                sortIdx_add(sortIdx, "", 1);
+                zebra_sort_delete(si);
         }
     }
 }