Tweak rank/relevance algorithm
[pazpar2-moved-to-github.git] / src / pazpar2_config.c
index 91e1d57..b45d8ec 100644 (file)
@@ -1,5 +1,5 @@
 /* This file is part of Pazpar2.
-   Copyright (C) 2006-2011 Index Data
+   Copyright (C) 2006-2012 Index Data
 
 Pazpar2 is free software; you can redistribute it and/or modify it under
 the terms of the GNU General Public License as published by the Free
@@ -41,6 +41,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
 #include "ppmutex.h"
 #include "incref.h"
 #include "pazpar2_config.h"
+#include "service_xslt.h"
 #include "settings.h"
 #include "eventl.h"
 #include "http.h"
@@ -56,10 +57,13 @@ struct conf_config
     database_hosts_t database_hosts;
 };
 
-
-static char *parse_settings(struct conf_config *config,
-                            NMEM nmem, xmlNode *node);
-
+struct service_xslt
+{
+    char *id;
+    xsltStylesheetPtr xsp;
+    struct service_xslt *next;
+};
+    
 static void conf_metadata_assign(NMEM nmem, 
                                  struct conf_metadata * metadata,
                                  const char *name,
@@ -68,10 +72,11 @@ static void conf_metadata_assign(NMEM nmem,
                                  enum conf_setting_type setting,
                                  int brief,
                                  int termlist,
-                                 int rank,
+                                 const char *rank,
                                  int sortkey_offset,
                                  enum conf_metadata_mergekey mt,
-                                 const char *facetrule)
+                                 const char *facetrule,
+                                 const char *limitmap)
 {
     assert(nmem && metadata && name);
     
@@ -88,10 +93,11 @@ static void conf_metadata_assign(NMEM nmem,
     metadata->setting = setting;
     metadata->brief = brief;   
     metadata->termlist = termlist;
-    metadata->rank = rank;    
+    metadata->rank = nmem_strdup_null(nmem, rank);
     metadata->sortkey_offset = sortkey_offset;
     metadata->mergekey = mt;
     metadata->facetrule = nmem_strdup_null(nmem, facetrule);
+    metadata->limitmap = nmem_strdup_null(nmem, limitmap);
 }
 
 
@@ -106,41 +112,57 @@ static void conf_sortkey_assign(NMEM nmem,
     sortkey->type = type;
 }
 
-
-static struct conf_service *service_init(struct conf_server *server,
+struct conf_service *service_init(struct conf_server *server,
                                          int num_metadata, int num_sortkeys,
                                          const char *service_id)
 {
     struct conf_service * service = 0;
     NMEM nmem = nmem_create();
 
+
     service = nmem_malloc(nmem, sizeof(struct conf_service));
     service->mutex = 0;
     service->ref_count = 1;
     service->nmem = nmem;
     service->next = 0;
     service->databases = 0;
+    service->xslt_list = 0;
+    service->ccl_bibset = 0;
     service->server = server;
     service->session_timeout = 60; /* default session timeout */
     service->z3950_session_timeout = 180;
     service->z3950_operation_timeout = 30;
+    service->rank_cluster = 1;
 
     service->charsets = 0;
 
     service->id = service_id ? nmem_strdup(nmem, service_id) : 0;
+    // Setup a dictionary from server.
+    service->dictionary = 0;
+
+    service->settings = nmem_malloc(nmem, sizeof(*service->settings));
+    service->settings->num_settings = PZ_MAX_EOF;
+    service->settings->settings = nmem_malloc(nmem, sizeof(struct setting*) * service->settings->num_settings);
+    memset(service->settings->settings, 0, sizeof(struct setting*) * service->settings->num_settings);
+    //  inherit_server_settings_values(service);
+
+    service->next = 0;
+
     service->num_metadata = num_metadata;
+
     service->metadata = 0;
     if (service->num_metadata)
-      service->metadata 
-          = nmem_malloc(nmem, 
-                        sizeof(struct conf_metadata) * service->num_metadata);
+        service->metadata 
+            = nmem_malloc(nmem, 
+                          sizeof(struct conf_metadata) * service->num_metadata);
     service->num_sortkeys = num_sortkeys;
     service->sortkeys = 0;
     if (service->num_sortkeys)
         service->sortkeys 
             = nmem_malloc(nmem, 
                           sizeof(struct conf_sortkey) * service->num_sortkeys);
-    service->dictionary = 0;
+
+
     return service; 
 }
 
@@ -153,10 +175,12 @@ static struct conf_metadata* conf_service_add_metadata(
     enum conf_setting_type setting,
     int brief,
     int termlist,
-    int rank,
+    const char *rank,
     int sortkey_offset,
     enum conf_metadata_mergekey mt,
-    const char *facetrule)
+    const char *facetrule,
+    const char *limitmap
+    )
 {
     struct conf_metadata * md = 0;
 
@@ -167,11 +191,10 @@ static struct conf_metadata* conf_service_add_metadata(
     md = service->metadata + field_id;
     conf_metadata_assign(service->nmem, md, name, type, merge, setting,
                          brief, termlist, rank, sortkey_offset,
-                         mt, facetrule);
+                         mt, facetrule, limitmap);
     return md;
 }
 
-
 static struct conf_sortkey * conf_service_add_sortkey(
     struct conf_service *service,
     int field_id,
@@ -181,7 +204,7 @@ static struct conf_sortkey * conf_service_add_sortkey(
     struct conf_sortkey * sk = 0;
 
     if (!service || !service->sortkeys || !service->num_sortkeys
-        || field_id < 0  || !(field_id < service->num_sortkeys))
+        || field_id < 0 || !(field_id < service->num_sortkeys))
         return 0;
 
     //sk = &((service->sortkeys)[field_id]);
@@ -191,7 +214,6 @@ static struct conf_sortkey * conf_service_add_sortkey(
     return sk;
 }
 
-
 int conf_service_metadata_field_id(struct conf_service *service,
                                    const char * name)
 {
@@ -199,16 +221,13 @@ int conf_service_metadata_field_id(struct conf_service *service,
 
     if (!service || !service->metadata || !service->num_metadata)
         return -1;
-
-    for(i = 0; i < service->num_metadata; i++) {
+    
+    for (i = 0; i < service->num_metadata; i++)
         if (!strcmp(name, (service->metadata[i]).name))
             return i;
-    }
-   
     return -1;
 }
 
-
 int conf_service_sortkey_field_id(struct conf_service *service,
                                   const char * name)
 {
@@ -217,11 +236,9 @@ int conf_service_sortkey_field_id(struct conf_service *service,
     if (!service || !service->sortkeys || !service->num_sortkeys)
         return -1;
 
-    for(i = 0; i < service->num_sortkeys; i++) {
+    for (i = 0; i < service->num_sortkeys; i++)
         if (!strcmp(name, (service->sortkeys[i]).name))
             return i;
-    }
-   
     return -1;
 }
 
@@ -242,7 +259,9 @@ void service_destroy(struct conf_service *service)
     {
         if (!pazpar2_decref(&service->ref_count, service->mutex))
         {
+            service_xslt_destroy(service);
             pp2_charset_fact_destroy(service->charsets);
+            ccl_qual_rm(&service->ccl_bibset);
             yaz_mutex_destroy(&service->mutex);
             nmem_destroy(service->nmem);
         }
@@ -265,7 +284,6 @@ static int parse_metadata(struct conf_service *service, xmlNode *n,
     enum conf_metadata_mergekey mergekey_type = Metadata_mergekey_no;
     int brief = 0;
     int termlist = 0;
-    int rank = 0;
     int sortkey_offset = 0;
     xmlChar *xml_name = 0;
     xmlChar *xml_brief = 0;
@@ -276,7 +294,9 @@ static int parse_metadata(struct conf_service *service, xmlNode *n,
     xmlChar *xml_rank = 0;
     xmlChar *xml_setting = 0;
     xmlChar *xml_mergekey = 0;
+    xmlChar *xml_limitmap = 0;
     xmlChar *xml_icu_chain = 0;
+
     struct _xmlAttr *attr;
     for (attr = n->properties; attr; attr = attr->next)
     {
@@ -310,6 +330,9 @@ static int parse_metadata(struct conf_service *service, xmlNode *n,
         else if (!xmlStrcmp(attr->name, BAD_CAST "facetrule") &&
                  attr->children && attr->children->type == XML_TEXT_NODE)
             xml_icu_chain = attr->children->content;
+        else if (!xmlStrcmp(attr->name, BAD_CAST "limitmap") &&
+                 attr->children && attr->children->type == XML_TEXT_NODE)
+            xml_limitmap = attr->children->content;
         else
         {
             yaz_log(YLOG_FATAL, "Unknown metadata attribute '%s'", attr->name);
@@ -345,9 +368,6 @@ static int parse_metadata(struct conf_service *service, xmlNode *n,
         }
     }
     
-    if (xml_rank)
-        rank = atoi((const char *) xml_rank);
-
     if (xml_type)
     {
         if (!strcmp((const char *) xml_type, "generic"))
@@ -449,8 +469,11 @@ static int parse_metadata(struct conf_service *service, xmlNode *n,
     conf_service_add_metadata(service, *md_node,
                               (const char *) xml_name,
                               type, merge, setting,
-                              brief, termlist, rank, sortkey_offset,
-                              mergekey_type, (const char *) xml_icu_chain);
+                              brief, termlist,
+                              (const char *) xml_rank, sortkey_offset,
+                              mergekey_type,
+                              (const char *) xml_icu_chain,
+                              (const char *) xml_limitmap);
     (*md_node)++;
     return 0;
 }
@@ -522,6 +545,29 @@ static struct conf_service *service_create_static(struct conf_server *server,
                 }
             }
         }
+        else if (!strcmp((const char *) n->name, "ccldirective"))
+        {
+            char *name;
+            char *value;
+            if (!service->ccl_bibset)
+                service->ccl_bibset = ccl_qual_mk();
+            name = (char *) xmlGetProp(n, (xmlChar *) "name");
+            if (!name)
+            {
+                yaz_log(YLOG_FATAL, "ccldirective: missing @name");
+                return 0;
+            }
+            value = (char *) xmlGetProp(n, (xmlChar *) "value");
+            if (!value)
+            { 
+                xmlFree(name);
+                yaz_log(YLOG_FATAL, "ccldirective: missing @value");
+                return 0;
+            }
+            ccl_qual_add_special(service->ccl_bibset, name, value);
+            xmlFree(value);
+            xmlFree(name);
+        }
         else if (!strcmp((const char *) n->name, "settings"))
             got_settings++;
         else if (!strcmp((const char *) n->name, "icu_chain"))
@@ -554,6 +600,35 @@ static struct conf_service *service_create_static(struct conf_server *server,
             if (parse_metadata(service, n, &md_node, &sk_node))
                 return 0;
         }
+        else if (!strcmp((const char *) n->name, (const char *) "xslt"))
+        {
+            if (service_xslt_config(service, n))
+                return 0;
+        }
+        else if (!strcmp((const char *) n->name, (const char *) "set"))
+        {
+            xmlChar *name= xmlGetProp(n, (xmlChar *) "name");
+            xmlChar *value = xmlGetProp(n, (xmlChar *) "value");
+            if (service->dictionary && name && value) {
+                yaz_log(YLOG_DEBUG, "service set: %s=%s (Not implemented)", (char *) name, (char *) value);
+                //service_aply_setting(service, name, value);
+            }
+        }
+        else if (!strcmp((const char *) n->name, "rank"))
+        {
+            char *rank_cluster = (char *) xmlGetProp(n, (xmlChar *) "cluster");
+
+            if (rank_cluster && !strcmp(rank_cluster, "yes"))
+                service->rank_cluster = 1;
+            else if (rank_cluster && !strcmp(rank_cluster, "no"))
+                service->rank_cluster = 0;
+            else
+            {
+                yaz_log(YLOG_FATAL, "service: rank@cluster boolean");
+                return 0;
+            }
+            xmlFree(rank_cluster);
+        }
         else
         {
             yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
@@ -573,19 +648,22 @@ static struct conf_service *service_create_static(struct conf_server *server,
                     continue;
                 if (!strcmp((const char *) n->name, "settings"))
                 {
+                    int ret;
                     xmlChar *src = xmlGetProp(n, (xmlChar *) "src");
                     if (src)
                     {
                         WRBUF w = wrbuf_alloc();
                         conf_dir_path(server->config, w, (const char *) src);
-                        settings_read_file(service, wrbuf_cstr(w), pass);
+                        ret = settings_read_file(service, wrbuf_cstr(w), pass);
                         wrbuf_destroy(w);
                         xmlFree(src);
                     }
                     else
                     {
-                        settings_read_node(service, n, pass);
+                        ret = settings_read_node(service, n, pass);
                     }
+                    if (ret)
+                        return 0;
                 }
             }
         }
@@ -593,44 +671,24 @@ static struct conf_service *service_create_static(struct conf_server *server,
     return service;
 }
 
-static char *parse_settings(struct conf_config *config,
-                            NMEM nmem, xmlNode *node)
-{
-    xmlChar *src = xmlGetProp(node, (xmlChar *) "src");
-    char *r;
-
-    if (src)
-    {
-        WRBUF w = wrbuf_alloc();
-        conf_dir_path(config, w, (const char *) src);
-        r = nmem_strdup(nmem, wrbuf_cstr(w));
-        wrbuf_destroy(w);
-    }
-    else
-    {
-        yaz_log(YLOG_FATAL, "Must specify src in targetprofile");
-        return 0;
-    }
-    xmlFree(src);
-    return r;
-}
-
-static void inherit_server_settings(struct conf_service *s)
+static int inherit_server_settings(struct conf_service *s)
 {
+    int ret = 0;
     struct conf_server *server = s->server;
     if (!s->dictionary) /* service has no config settings ? */
     {
-        if (server->server_settings)
+        if (server->settings_fname)
         {
             /* inherit settings from server */
             init_settings(s);
-            settings_read_file(s, server->server_settings, 1);
-            settings_read_file(s, server->server_settings, 2);
+            if (settings_read_file(s, server->settings_fname, 1))
+                ret = -1;
+            if (settings_read_file(s, server->settings_fname, 2))
+                ret = -1;
         }
         else
         {
-            yaz_log(YLOG_WARN, "service '%s' has no settings",
-                    s->id ? s->id : "unnamed");
+            yaz_log(YLOG_WARN, "server '%s' has no settings", s->id ? s->id : "unnamed");
             init_settings(s);
         }
     }
@@ -649,17 +707,16 @@ static void inherit_server_settings(struct conf_service *s)
             s->charsets = pp2_charset_fact_create();
         }
     }
+    return ret;
 }
 
 struct conf_service *service_create(struct conf_server *server,
                                     xmlNode *node)
 {
-    struct conf_service *service = service_create_static(server,
-                                                         node, 0);
+    struct conf_service *service = service_create_static(server, node, 0);
     if (service)
     {
         inherit_server_settings(service);
-        resolve_databases(service);
         assert(service->mutex == 0);
         pazpar2_mutex_create(&service->mutex, "conf");
     }
@@ -682,10 +739,10 @@ static struct conf_server *server_create(struct conf_config *config,
     server->config = config;
     server->next = 0;
     server->charsets = 0;
-    server->server_settings = 0;
     server->http_server = 0;
     server->iochan_man = 0;
-    server->database_hosts = 0;
+    server->database_hosts = config->database_hosts;
+    server->settings_fname = 0;
 
     if (server_id)
     {
@@ -726,13 +783,24 @@ static struct conf_server *server_create(struct conf_config *config,
         }
         else if (!strcmp((const char *) n->name, "settings"))
         {
-            if (server->server_settings)
+            xmlChar *src = xmlGetProp(n, (xmlChar *) "src");
+            WRBUF w;
+            if (!src)
             {
-                yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
+                yaz_log(YLOG_FATAL, "Missing src attribute for settings");
                 return 0;
             }
-            if (!(server->server_settings = parse_settings(config, nmem, n)))
+            if (server->settings_fname)
+            {
+                xmlFree(src);
+                yaz_log(YLOG_FATAL, "Can't repeat 'settings'");
                 return 0;
+            }
+            w = wrbuf_alloc();
+            conf_dir_path(config, w, (const char *) src);
+            server->settings_fname = nmem_strdup(nmem, wrbuf_cstr(w));
+            wrbuf_destroy(w);
+            xmlFree(src);
         }
         else if (!strcmp((const char *) n->name, "icu_chain"))
         {
@@ -911,7 +979,7 @@ struct conf_config *config_create(const char *fname, int verbose)
     config->servers = 0;
     config->no_threads = 0;
     config->iochan_man = 0;
-    config->database_hosts = 0;
+    config->database_hosts = database_hosts_create();
 
     config->confdir = wrbuf_alloc();
     if ((p = strrchr(fname, 
@@ -978,9 +1046,8 @@ void config_destroy(struct conf_config *config)
             struct conf_server *s_next = server->next;
             server_destroy(server);
             server = s_next;
+            database_hosts_destroy(&config->database_hosts);
         }
-        database_hosts_destroy(&config->database_hosts);
-
         wrbuf_destroy(config->confdir);
         nmem_destroy(config->nmem);
     }
@@ -997,22 +1064,18 @@ void config_process_events(struct conf_config *conf)
 {
     struct conf_server *ser;
     
-    conf->database_hosts = database_hosts_create();
     for (ser = conf->servers; ser; ser = ser->next)
     {
         struct conf_service *s = ser->service;
 
-        ser->database_hosts = conf->database_hosts;
-
         for (;s ; s = s->next)
         {
-            resolve_databases(s);
             assert(s->mutex == 0);
             pazpar2_mutex_create(&s->mutex, "service");
         }
         http_mutex_init(ser);
     }
-    iochan_man_events(conf->iochan_man);    
+    iochan_man_events(conf->iochan_man);
 }
 
 int config_start_listeners(struct conf_config *conf,