Factorized char normalization code out to normalize7bit.[hc] .
[pazpar2-moved-to-github.git] / src / logic.c
index 624a474..5a014aa 100644 (file)
@@ -1,4 +1,4 @@
-/* $Id: logic.c,v 1.22 2007-04-26 11:03:54 marc Exp $
+/* $Id: logic.c,v 1.26 2007-04-27 12:17:04 marc Exp $
    Copyright (c) 2006-2007, Index Data.
 
 This file is part of Pazpar2.
@@ -70,6 +70,7 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA
 #include "database.h"
 #include "client.h"
 #include "settings.h"
+#include "normalize7bit.h"
 
 #define MAX_CHUNK 15
 
@@ -121,75 +122,6 @@ void pull_terms(NMEM nmem, struct ccl_rpn_node *n, char **termlist, int *num)
     }
 }
 
-char *normalize_mergekey(char *buf, int skiparticle)
-{
-    char *p = buf, *pout = buf;
-
-    if (skiparticle)
-    {
-        char firstword[64];
-        char articles[] = "the den der die des an a "; // must end in space
-
-        while (*p && !isalnum(*p))
-            p++;
-        pout = firstword;
-        while (*p && *p != ' ' && pout - firstword < 62)
-            *(pout++) = tolower(*(p++));
-        *(pout++) = ' ';
-        *(pout++) = '\0';
-        if (!strstr(articles, firstword))
-            p = buf;
-        pout = buf;
-    }
-
-    while (*p)
-    {
-        while (*p && !isalnum(*p))
-            p++;
-        while (isalnum(*p))
-            *(pout++) = tolower(*(p++));
-        if (*p)
-            *(pout++) = ' ';
-        while (*p && !isalnum(*p))
-            p++;
-    }
-    if (buf != pout)
-        do {
-            *(pout--) = '\0';
-        }
-        while (pout > buf && *pout == ' ');
-
-    return buf;
-}
-
-// Extract what appears to be years from buf, storing highest and
-// lowest values.
-static int extract_years(const char *buf, int *first, int *last)
-{
-    *first = -1;
-    *last = -1;
-    while (*buf)
-    {
-        const char *e;
-        int len;
-
-        while (*buf && !isdigit(*buf))
-            buf++;
-        len = 0;
-        for (e = buf; *e && isdigit(*e); e++)
-            len++;
-        if (len == 4)
-        {
-            int value = atoi(buf);
-            if (*first < 0 || value < *first)
-                *first = value;
-            if (*last < 0 || value > *last)
-                *last = value;
-        }
-        buf = e;
-    }
-    return *first;
-}
 
 
 static void add_facet(struct session *s, const char *type, const char *value)
@@ -291,9 +223,7 @@ xmlDoc *normalize_record(struct session_database *sdb, Z_External *rec)
             return 0;
         }
         }
-#endif
-
-#if 0
+#else
         // do it another way to detect transformation errors right now
         // but does not seem to work either!
         {
@@ -953,7 +883,7 @@ struct record *ingest_record(struct client *cl, Z_External *rec,
 {
     xmlDoc *xdoc = normalize_record(client_get_database(cl), rec);
     xmlNode *root, *n;
-    struct record *res;
+    struct record *record;
     struct record_cluster *cluster;
     struct session *se = client_get_session(cl);
     xmlChar *mergekey, *mergekey_norm;
@@ -972,21 +902,28 @@ struct record *ingest_record(struct client *cl, Z_External *rec,
         return 0;
     }
 
-    res = nmem_malloc(se->nmem, sizeof(struct record));
-    res->next = 0;
-    res->client = cl;
-    res->metadata = nmem_malloc(se->nmem,
+#if 0
+    record = nmem_malloc(se->nmem, sizeof(struct record));
+    record->next = 0;
+    record->client = cl;
+    record->metadata = nmem_malloc(se->nmem,
             sizeof(struct record_metadata*) * service->num_metadata);
-    memset(res->metadata, 0, 
+    memset(record->metadata, 0, 
            sizeof(struct record_metadata*) * service->num_metadata);
 
+#else
+    record = record_create(se->nmem, 
+                           service->num_metadata, service->num_sortkeys);
+    record_assign_client(record, cl);
+#endif
+
     mergekey_norm = (xmlChar *) nmem_strdup(se->nmem, (char*) mergekey);
     xmlFree(mergekey);
-    normalize_mergekey((char *) mergekey_norm, 0);
+    normalize7bit_mergekey((char *) mergekey_norm, 0);
 
     cluster = reclist_insert(se->reclist, 
                              global_parameters.server->service, 
-                             res, (char *) mergekey_norm, 
+                             record, (char *) mergekey_norm, 
                              &se->total_merged);
     if (global_parameters.dump_records)
         yaz_log(YLOG_LOG, "Cluster id %d from %s (#%d)", cluster->recid,
@@ -999,6 +936,8 @@ struct record *ingest_record(struct client *cl, Z_External *rec,
     }
     relevance_newrec(se->relevance, cluster);
 
+
+    // now parsing XML record and adding data to cluster or record metadata
     for (n = root->children; n; n = n->next)
     {
         if (type)
@@ -1013,7 +952,8 @@ struct record *ingest_record(struct client *cl, Z_External *rec,
         {
             struct conf_metadata *ser_md = 0;
             struct conf_sortkey *ser_sk = 0;
-            struct record_metadata **wheretoput, *newm;
+            struct record_metadata **wheretoput = 0;
+            struct record_metadata *rec_md = 0;
             int md_field_id = -1;
             int sk_field_id = -1;
             int first, last;
@@ -1024,6 +964,7 @@ struct record *ingest_record(struct client *cl, Z_External *rec,
             if (!type || !value)
                 continue;
 
+#if 0
             // First, find out what field we're looking at
             for (md_field_id = 0; md_field_id < service->num_metadata;
                  md_field_id++)
@@ -1031,10 +972,13 @@ struct record *ingest_record(struct client *cl, Z_External *rec,
                             service->metadata[md_field_id].name))
                 {
                     ser_md = &service->metadata[md_field_id];
-                    if (ser_md->sortkey_offset >= 0)
-                        ser_sk = &service->sortkeys[ser_md->sortkey_offset];
+                    if (ser_md->sortkey_offset >= 0){
+                        sk_field_id = ser_md->sortkey_offset;
+                        ser_sk = &service->sortkeys[sk_field_id];
+                    }
                     break;
                 }
+
             if (!ser_md)
             {
                 yaz_log(YLOG_WARN, 
@@ -1042,29 +986,61 @@ struct record *ingest_record(struct client *cl, Z_External *rec,
                 continue;
             }
 
-            // Find out where we are putting it
+#else
+            md_field_id 
+                = conf_service_metadata_field_id(service, (const char *) type);
+            if (md_field_id < 0)
+            {
+                yaz_log(YLOG_WARN, 
+                        "Ignoring unknown metadata element: %s", type);
+                continue;
+            }
+
+            ser_md = &service->metadata[md_field_id];
+
+            if (ser_md->sortkey_offset >= 0){
+                sk_field_id = ser_md->sortkey_offset;
+                ser_sk = &service->sortkeys[sk_field_id];
+            }
+#endif
+
+            // Find out where we are putting it - based on merge or not
             if (ser_md->merge == Metadata_merge_no)
-                wheretoput = &res->metadata[md_field_id];
+                wheretoput = &record->metadata[md_field_id];
             else
                 wheretoput = &cluster->metadata[md_field_id];
             
-            // Put it there
-            newm = nmem_malloc(se->nmem, sizeof(struct record_metadata));
-            newm->next = 0;
+            // create new record_metadata
+#if 0
+            rec_md = nmem_malloc(se->nmem, sizeof(struct record_metadata));
+            rec_md->next = 0;
+#else
+            rec_md = record_metadata_create(se->nmem);
+#endif
+
+            // and polulate with data:
+            // type based charmapping decisions follow here
             if (ser_md->type == Metadata_type_generic)
             {
+
+#if 0
                 char *p, *pe;
                 for (p = (char *) value; *p && isspace(*p); p++)
                     ;
                 for (pe = p + strlen(p) - 1;
                         pe > p && strchr(" ,/.:([", *pe); pe--)
                     *pe = '\0';
-                newm->data.text = nmem_strdup(se->nmem, p);
+#else
+                char * p = (char *) value;
+                p = normalize7bit_generic(p, " ,/.:([");
+#endif
+                
+                rec_md->data.text = nmem_strdup(se->nmem, p);
 
             }
             else if (ser_md->type == Metadata_type_year)
             {
-                if (extract_years((char *) value, &first, &last) < 0)
+                if (extract7bit_years((char *) value, &first, &last) < 0)
                     continue;
             }
             else
@@ -1073,62 +1049,79 @@ struct record *ingest_record(struct client *cl, Z_External *rec,
                         "Unknown type in metadata element %s", type);
                 continue;
             }
+
+#if 0  // this test does not belong here.
+       // the condition is enforced in the constructor 
+       // inside conf_metadata_assign()
+       // and will _never_ occur
             if (ser_md->type == Metadata_type_year 
                 && ser_md->merge != Metadata_merge_range)
             {
                 yaz_log(YLOG_WARN, "Only range merging supported for years");
                 continue;
             }
+# endif
+
+
+            // and polulate with data:
+            // assign cluster or record based on merge action
             if (ser_md->merge == Metadata_merge_unique)
             {
                 struct record_metadata *mnode;
                 for (mnode = *wheretoput; mnode; mnode = mnode->next)
                     if (!strcmp((const char *) mnode->data.text, 
-                                newm->data.text))
+                                rec_md->data.text))
                         break;
                 if (!mnode)
                 {
-                    newm->next = *wheretoput;
-                    *wheretoput = newm;
+                    rec_md->next = *wheretoput;
+                    *wheretoput = rec_md;
                 }
             }
             else if (ser_md->merge == Metadata_merge_longest)
             {
                 if (!*wheretoput 
-                    || strlen(newm->data.text) 
+                    || strlen(rec_md->data.text) 
                        > strlen((*wheretoput)->data.text))
                 {
-                    *wheretoput = newm;
+                    *wheretoput = rec_md;
                     if (ser_sk)
                     {
-                        char *s = nmem_strdup(se->nmem, newm->data.text);
-                        if (!cluster->sortkeys[ser_md->sortkey_offset])
-                            cluster->sortkeys[ser_md->sortkey_offset] = 
+                        char *s = nmem_strdup(se->nmem, rec_md->data.text);
+                        if (!cluster->sortkeys[sk_field_id])
+                            cluster->sortkeys[sk_field_id] = 
                                 nmem_malloc(se->nmem, 
                                             sizeof(union data_types));
-                        normalize_mergekey(s,
+                        normalize7bit_mergekey(s,
                              (ser_sk->type == Metadata_sortkey_skiparticle));
-                        cluster->sortkeys[ser_md->sortkey_offset]->text = s;
+                        cluster->sortkeys[sk_field_id]->text = s;
                     }
                 }
             }
             else if (ser_md->merge == Metadata_merge_all 
                      || ser_md->merge == Metadata_merge_no)
             {
-                newm->next = *wheretoput;
-                *wheretoput = newm;
+                rec_md->next = *wheretoput;
+                *wheretoput = rec_md;
             }
             else if (ser_md->merge == Metadata_merge_range)
             {
+
+#if 0           // this assert does not belong here.
+                // the condition is enforced in the constructor 
+                // inside conf_metadata_assign()
+                // and will _never_ occur
                 assert(ser_md->type == Metadata_type_year);
+#endif
+
                 if (!*wheretoput)
                 {
-                    *wheretoput = newm;
+                    *wheretoput = rec_md;
                     (*wheretoput)->data.number.min = first;
                     (*wheretoput)->data.number.max = last;
                     if (ser_sk)
-                        cluster->sortkeys[ser_md->sortkey_offset] 
-                            = &newm->data;
+                        cluster->sortkeys[sk_field_id] 
+                            = &rec_md->data;
                 }
                 else
                 {
@@ -1138,23 +1131,32 @@ struct record *ingest_record(struct client *cl, Z_External *rec,
                         (*wheretoput)->data.number.max = last;
                 }
 #ifdef GAGA
-                if (sk)
+                if (ser_sk)
                 {
                     union data_types *sdata 
-                        = cluster->sortkeys[md->sortkey_offset];
+                        = cluster->sortkeys[sk_field_id];
                     yaz_log(YLOG_LOG, "SK range: %d-%d",
                             sdata->number.min, sdata->number.max);
                 }
 #endif
             }
+
+#if 0      // this else is only entered when Metadata_merge_no
+           // but I believe then we should _not_ pollute with log messages 
             else
+
                 yaz_log(YLOG_WARN,
                         "Don't know how to merge on element name %s",
                         ser_md->name);
+#endif
+
 
+            // ranking of _all_ fields enabled ... 
             if (ser_md->rank)
                 relevance_countwords(se->relevance, cluster, 
                                      (char *) value, ser_md->rank);
+
+            // construct facets ... 
             if (ser_md->termlist)
             {
                 if (ser_md->type == Metadata_type_year)
@@ -1171,6 +1173,8 @@ struct record *ingest_record(struct client *cl, Z_External *rec,
                 else
                     add_facet(se, (char *) type, (char *) value);
             }
+
+            // cleaning up
             xmlFree(type);
             xmlFree(value);
             type = value = 0;
@@ -1189,7 +1193,7 @@ struct record *ingest_record(struct client *cl, Z_External *rec,
     relevance_donerecord(se->relevance, cluster);
     se->total_records++;
 
-    return res;
+    return record;
 }