Returns service XML now
[pazpar2-moved-to-github.git] / src / pazpar2_config.c
index b2064f9..49a73d7 100644 (file)
@@ -1,5 +1,5 @@
 /* This file is part of Pazpar2.
-   Copyright (C) 2006-2012 Index Data
+   Copyright (C) 2006-2013 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
@@ -50,7 +50,7 @@ struct conf_config
 {
     NMEM nmem; /* for conf_config and servers memory */
     struct conf_server *servers;
-    
+
     int no_threads;
     WRBUF confdir;
     iochan_man_t iochan_man;
@@ -63,53 +63,35 @@ struct service_xslt
     xsltStylesheetPtr xsp;
     struct service_xslt *next;
 };
-    
-static void conf_metadata_assign(NMEM nmem, 
-                                 struct conf_metadata * metadata,
-                                 const char *name,
-                                 enum conf_metadata_type type,
-                                 enum conf_metadata_merge merge,
-                                 enum conf_setting_type setting,
-                                 int brief,
-                                 int termlist,
-                                 const char *rank,
-                                 int sortkey_offset,
-                                 enum conf_metadata_mergekey mt,
-                                 const char *facetrule,
-                                 const char *limitmap)
-{
-    assert(nmem && metadata && name);
-    
-    metadata->name = nmem_strdup(nmem, name);
 
-    metadata->type = type;
+static char *xml_context(const xmlNode *ptr, char *res, size_t len)
+{
+    xmlAttr *attr = ptr->properties;
+    size_t off = len - 1;
 
-    // enforcing that type_year is always range_merge
-    if (metadata->type == Metadata_type_year)
-        metadata->merge = Metadata_merge_range;
-    else
-        metadata->merge = merge;    
-
-    metadata->setting = setting;
-    metadata->brief = brief;   
-    metadata->termlist = termlist;
-    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);
-}
+    res[off] = '\0';
+    for (; attr; attr = attr->next)
+    {
+        size_t l = strlen((const char *) attr->name);
+        if (off <= l + 1)
+            break;
+        off = off - l;
+        memcpy(res + off, attr->name, l);
+        res[--off] = '@';
+    } 
+    while (ptr && ptr->type == XML_ELEMENT_NODE)
+    {
+        size_t l = strlen((const char *) ptr->name);
+        if (off <= l + 1)
+            break;
 
+        off = off - l;
+        memcpy(res + off, ptr->name, l);
+        res[--off] = '/';
 
-static void conf_sortkey_assign(NMEM nmem, 
-                                struct conf_sortkey * sortkey,
-                                const char *name,
-                                enum conf_sortkey_type type)
-{
-    assert(nmem && sortkey && name);
-    
-    sortkey->name = nmem_strdup(nmem, name);
-    sortkey->type = type;
+        ptr = ptr->parent;
+    }
+    return res + off;
 }
 
 struct conf_service *service_init(struct conf_server *server,
@@ -127,14 +109,21 @@ struct conf_service *service_init(struct conf_server *server,
     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->rank_debug = 0;
+    service->rank_follow = 0.0;
+    service->rank_lead = 0.0;
+    service->rank_length = 2;
 
     service->charsets = 0;
 
     service->id = service_id ? nmem_strdup(nmem, service_id) : 0;
+
     // Setup a dictionary from server.
     service->dictionary = 0;
 
@@ -150,18 +139,21 @@ struct conf_service *service_init(struct conf_server *server,
 
     service->metadata = 0;
     if (service->num_metadata)
-        service->metadata 
-            = nmem_malloc(nmem, 
+        service->metadata
+            = nmem_malloc(nmem,
                           sizeof(struct conf_metadata) * service->num_metadata);
     service->num_sortkeys = num_sortkeys;
+
+    service->default_sort = nmem_strdup(nmem, "relevance");
     service->sortkeys = 0;
     if (service->num_sortkeys)
-        service->sortkeys 
-            = nmem_malloc(nmem, 
+        service->sortkeys
+            = nmem_malloc(nmem,
                           sizeof(struct conf_sortkey) * service->num_sortkeys);
 
+    service->xml_node = 0;
 
-    return service; 
+    return service;
 }
 
 static struct conf_metadata* conf_service_add_metadata(
@@ -177,38 +169,61 @@ static struct conf_metadata* conf_service_add_metadata(
     int sortkey_offset,
     enum conf_metadata_mergekey mt,
     const char *facetrule,
-    const char *limitmap
+    const char *limitmap,
+    const char *limitcluster
     )
 {
     struct conf_metadata * md = 0;
+    NMEM nmem = service->nmem;
 
-    if (!service || !service->metadata || !service->num_metadata
+    if (!service->metadata || !service->num_metadata
         || field_id < 0  || !(field_id < service->num_metadata))
         return 0;
 
     md = service->metadata + field_id;
-    conf_metadata_assign(service->nmem, md, name, type, merge, setting,
-                         brief, termlist, rank, sortkey_offset,
-                         mt, facetrule, limitmap);
+    assert(nmem && md && name);
+
+    md->name = nmem_strdup(nmem, name);
+
+    md->type = type;
+
+    // enforcing that type_year is always range_merge
+    if (md->type == Metadata_type_year)
+        md->merge = Metadata_merge_range;
+    else
+        md->merge = merge;
+
+    md->setting = setting;
+    md->brief = brief;
+    md->termlist = termlist;
+    md->rank = nmem_strdup_null(nmem, rank);
+    md->sortkey_offset = sortkey_offset;
+    md->mergekey = mt;
+    md->facetrule = nmem_strdup_null(nmem, facetrule);
+    md->limitmap = nmem_strdup_null(nmem, limitmap);
+    md->limitcluster = nmem_strdup_null(nmem, limitcluster);
     return md;
 }
 
-static struct conf_sortkey * conf_service_add_sortkey(
+static struct conf_sortkey *conf_service_add_sortkey(
     struct conf_service *service,
     int field_id,
     const char *name,
     enum conf_sortkey_type type)
 {
-    struct conf_sortkey * sk = 0;
+    struct conf_sortkey *sk = 0;
+    NMEM nmem = service->nmem;
 
-    if (!service || !service->sortkeys || !service->num_sortkeys
+    if (!service->sortkeys || !service->num_sortkeys
         || field_id < 0 || !(field_id < service->num_sortkeys))
         return 0;
 
-    //sk = &((service->sortkeys)[field_id]);
     sk = service->sortkeys + field_id;
-    conf_sortkey_assign(service->nmem, sk, name, type);
 
+    assert(nmem && sk && name);
+
+    sk->name = nmem_strdup(nmem, name);
+    sk->type = type;
     return sk;
 }
 
@@ -219,7 +234,7 @@ 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++)
         if (!strcmp(name, (service->metadata[i]).name))
             return i;
@@ -258,7 +273,10 @@ void service_destroy(struct conf_service *service)
         if (!pazpar2_decref(&service->ref_count, service->mutex))
         {
             service_xslt_destroy(service);
+            if (service->xml_node)
+                xmlFreeNode(service->xml_node);
             pp2_charset_fact_destroy(service->charsets);
+            ccl_qual_rm(&service->ccl_bibset);
             yaz_mutex_destroy(&service->mutex);
             nmem_destroy(service->nmem);
         }
@@ -292,9 +310,13 @@ static int parse_metadata(struct conf_service *service, xmlNode *n,
     xmlChar *xml_setting = 0;
     xmlChar *xml_mergekey = 0;
     xmlChar *xml_limitmap = 0;
+    xmlChar *xml_limitcluster = 0;
     xmlChar *xml_icu_chain = 0;
 
     struct _xmlAttr *attr;
+
+    assert(service);
+
     for (attr = n->properties; attr; attr = attr->next)
     {
         if (!xmlStrcmp(attr->name, BAD_CAST "name") &&
@@ -330,13 +352,16 @@ static int parse_metadata(struct conf_service *service, xmlNode *n,
         else if (!xmlStrcmp(attr->name, BAD_CAST "limitmap") &&
                  attr->children && attr->children->type == XML_TEXT_NODE)
             xml_limitmap = attr->children->content;
+        else if (!xmlStrcmp(attr->name, BAD_CAST "limitcluster") &&
+                 attr->children && attr->children->type == XML_TEXT_NODE)
+            xml_limitcluster = attr->children->content;
         else
         {
             yaz_log(YLOG_FATAL, "Unknown metadata attribute '%s'", attr->name);
             return -1;
         }
     }
-    
+
     // now do the parsing logic
     if (!xml_name)
     {
@@ -353,7 +378,7 @@ static int parse_metadata(struct conf_service *service, xmlNode *n,
             return -1;
         }
     }
-    
+
     if (xml_termlist)
     {
         if (!strcmp((const char *) xml_termlist, "yes"))
@@ -364,7 +389,7 @@ static int parse_metadata(struct conf_service *service, xmlNode *n,
             return -1;
         }
     }
-    
+
     if (xml_type)
     {
         if (!strcmp((const char *) xml_type, "generic"))
@@ -375,12 +400,12 @@ static int parse_metadata(struct conf_service *service, xmlNode *n,
             type = Metadata_type_date;
         else
         {
-            yaz_log(YLOG_FATAL, 
+            yaz_log(YLOG_FATAL,
                     "Unknown value for metadata/type: %s", xml_type);
             return -1;
         }
     }
-    
+
     if (xml_merge)
     {
         if (!strcmp((const char *) xml_merge, "no"))
@@ -393,14 +418,16 @@ static int parse_metadata(struct conf_service *service, xmlNode *n,
             merge = Metadata_merge_range;
         else if (!strcmp((const char *) xml_merge, "all"))
             merge = Metadata_merge_all;
+        else if (!strcmp((const char *) xml_merge, "first"))
+            merge = Metadata_merge_first;
         else
         {
-            yaz_log(YLOG_FATAL, 
+            yaz_log(YLOG_FATAL,
                     "Unknown value for metadata/merge: %s", xml_merge);
             return -1;
         }
     }
-    
+
     if (xml_setting)
     {
         if (!strcmp((const char *) xml_setting, "no"))
@@ -416,14 +443,14 @@ static int parse_metadata(struct conf_service *service, xmlNode *n,
             return -1;
         }
     }
-    
+
     // add a sortkey if so specified
     if (xml_sortkey && strcmp((const char *) xml_sortkey, "no"))
     {
         enum conf_sortkey_type sk_type;
         if (merge == Metadata_merge_no)
         {
-            yaz_log(YLOG_FATAL, 
+            yaz_log(YLOG_FATAL,
                     "Can't specify sortkey on a non-merged field");
             return -1;
         }
@@ -434,19 +461,19 @@ static int parse_metadata(struct conf_service *service, xmlNode *n,
         else
         {
             yaz_log(YLOG_FATAL,
-                    "Unknown sortkey in metadata element: %s", 
+                    "Unknown sortkey in metadata element: %s",
                     xml_sortkey);
             return -1;
         }
         sortkey_offset = *sk_node;
-        
+
         conf_service_add_sortkey(service, *sk_node,
-                                 (const char *) xml_name, sk_type);        
+                                 (const char *) xml_name, sk_type);
         (*sk_node)++;
     }
     else
         sortkey_offset = -1;
-    
+
     if (xml_mergekey)
     {
         if (!strcmp((const char *) xml_mergekey, "required"))
@@ -470,7 +497,8 @@ static int parse_metadata(struct conf_service *service, xmlNode *n,
                               (const char *) xml_rank, sortkey_offset,
                               mergekey_type,
                               (const char *) xml_icu_chain,
-                              (const char *) xml_limitmap);
+                              (const char *) xml_limitmap,
+                              (const char *) xml_limitcluster);
     (*md_node)++;
     return 0;
 }
@@ -487,7 +515,7 @@ static struct conf_service *service_create_static(struct conf_server *server,
     int num_metadata = 0;
     int num_sortkeys = 0;
     int got_settings = 0;
-    
+
     // count num_metadata and num_sortkeys
     for (n = node->children; n; n = n->next)
         if (n->type == XML_ELEMENT_NODE && !strcmp((const char *)
@@ -542,6 +570,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"))
@@ -579,18 +630,86 @@ static struct conf_service *service_create_static(struct conf_server *server,
             if (service_xslt_config(service, n))
                 return 0;
         }
-        else if (!strcmp((const char *) n->name, (const char *) "set"))
+        else if (!strcmp((const char *) n->name, "rank"))
         {
-            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);
+            char *rank_cluster = (char *) xmlGetProp(n, (xmlChar *) "cluster");
+            char *rank_debug = (char *) xmlGetProp(n, (xmlChar *) "debug");
+            char *rank_follow = (char *) xmlGetProp(n, (xmlChar *) "follow");
+            char *rank_lead = (char *) xmlGetProp(n, (xmlChar *) "lead");
+            char *rank_length= (char *) xmlGetProp(n, (xmlChar *) "length");
+            if (rank_cluster)
+            {
+                if (!strcmp(rank_cluster, "yes"))
+                    service->rank_cluster = 1;
+                else if (!strcmp(rank_cluster, "no"))
+                    service->rank_cluster = 0;
+                else 
+                {
+                    yaz_log(YLOG_FATAL, "service: rank@cluster boolean");
+                    return 0;
+                }
+            }
+            if (rank_debug)
+            {
+                if (!strcmp(rank_debug, "yes"))
+                    service->rank_debug = 1;
+                else if (!strcmp(rank_debug, "no"))
+                    service->rank_debug = 0;
+                else
+                {
+                    yaz_log(YLOG_FATAL, "service: rank@debug boolean");
+                    return 0;
+                }
+            }
+            if (rank_follow)
+            {
+                service->rank_follow = atof(rank_follow);
+            }
+            if (rank_lead)
+            {
+                service->rank_lead = atof(rank_lead);
+            }
+            if (rank_length)
+            {
+                if (!strcmp(rank_length, "linear"))
+                    service->rank_length = 2;
+                else if (!strcmp(rank_length, "log"))
+                    service->rank_length = 1; 
+                else if (!strcmp(rank_length, "none"))
+                    service->rank_length = 0;
+                else
+                {
+                    yaz_log(YLOG_FATAL, "service: rank@length linear|log|none");
+                    return 0;
+                }
+            }
+            xmlFree(rank_cluster);
+            xmlFree(rank_debug);
+            xmlFree(rank_follow);
+            xmlFree(rank_lead);
+            xmlFree(rank_length);
+        }
+        else if (!strcmp((const char *) n->name, "sort-default"))
+        {
+            char *default_sort = (char *) xmlGetProp(n, (xmlChar *) "field");
+
+            if (default_sort && strcmp(default_sort, "")) {
+                service->default_sort = nmem_strdup(service->nmem, default_sort);
+                yaz_log(YLOG_LOG, "service %s: default sort order configured to: %s",
+                        service_id ? service_id : "unnamed", default_sort);
+            }
+            else
+            {
+                yaz_log(YLOG_FATAL, "default sort order is invalid: %s", default_sort);
+                return 0;
             }
+            xmlFree(default_sort);
         }
         else
         {
-            yaz_log(YLOG_FATAL, "Bad element: %s", n->name);
+            char tmp[80];
+            yaz_log(YLOG_FATAL, "Bad element: %s . Context: %s", n->name,
+                    xml_context(n, tmp, sizeof tmp));
             return 0;
         }
     }
@@ -627,6 +746,7 @@ static struct conf_service *service_create_static(struct conf_server *server,
             }
         }
     }
+    service->xml_node = xmlCopyNode(node, 1);
     return service;
 }
 
@@ -651,7 +771,7 @@ static int inherit_server_settings(struct conf_service *s)
             init_settings(s);
         }
     }
-    
+
     /* use relevance/sort/mergekey/facet from server if not defined
        for this service.. */
     if (!s->charsets)
@@ -689,7 +809,7 @@ static struct conf_server *server_create(struct conf_config *config,
     struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server));
     xmlChar *server_id = xmlGetProp(node, (xmlChar *) "id");
 
-    server->host = 0;
+    server->host = "@";
     server->port = 0;
     server->proxy_host = 0;
     server->proxy_port = 0;
@@ -718,10 +838,12 @@ static struct conf_server *server_create(struct conf_config *config,
         {
             xmlChar *port = xmlGetProp(n, (xmlChar *) "port");
             xmlChar *host = xmlGetProp(n, (xmlChar *) "host");
+
             if (port)
-                server->port = atoi((const char *) port);
+                server->port = nmem_strdup(nmem, (const char *) port);
             if (host)
                 server->host = nmem_strdup(nmem, (const char *) host);
+
             xmlFree(port);
             xmlFree(host);
         }
@@ -783,8 +905,8 @@ static struct conf_server *server_create(struct conf_config *config,
             {
                 yaz_log(YLOG_FATAL, "ICU chain definition error");
                 return 0;
-            }            
-        }            
+            }
+        }
         else if (!strcmp((const char *) n->name, "service"))
         {
             char *service_id = (char *)
@@ -825,6 +947,11 @@ static struct conf_server *server_create(struct conf_config *config,
             return 0;
         }
     }
+    if (!server->port)
+    {
+        yaz_log(YLOG_FATAL, "No listening port given");
+        return 0;
+    }
     if (server->service)
     {
         struct conf_service *s;
@@ -941,7 +1068,7 @@ struct conf_config *config_create(const char *fname, int verbose)
     config->database_hosts = database_hosts_create();
 
     config->confdir = wrbuf_alloc();
-    if ((p = strrchr(fname, 
+    if ((p = strrchr(fname,
 #ifdef WIN32
                      '\\'
 #else
@@ -953,7 +1080,7 @@ struct conf_config *config_create(const char *fname, int verbose)
         wrbuf_write(config->confdir, fname, len);
     }
     wrbuf_puts(config->confdir, "");
-    
+
     n = xmlDocGetRootElement(doc);
     r = yaz_xml_include_simple(n, wrbuf_cstr(config->confdir));
     if (r == 0) /* OK */
@@ -999,7 +1126,7 @@ void config_destroy(struct conf_config *config)
     if (config)
     {
         struct conf_server *server = config->servers;
-        iochan_man_destroy(&config->iochan_man);    
+        iochan_man_destroy(&config->iochan_man);
         while (server)
         {
             struct conf_server *s_next = server->next;
@@ -1022,7 +1149,7 @@ void config_stop_listeners(struct conf_config *conf)
 void config_process_events(struct conf_config *conf)
 {
     struct conf_server *ser;
-    
+
     for (ser = conf->servers; ser; ser = ser->next)
     {
         struct conf_service *s = ser->service;
@@ -1046,28 +1173,27 @@ int config_start_listeners(struct conf_config *conf,
     conf->iochan_man = iochan_man_create(conf->no_threads);
     for (ser = conf->servers; ser; ser = ser->next)
     {
-        WRBUF w = wrbuf_alloc();
+        WRBUF w;
         int r;
 
         ser->iochan_man = conf->iochan_man;
         if (listener_override)
         {
-            wrbuf_puts(w, listener_override);
-            listener_override = 0; /* only first server is overriden */
-        }
-        else
-        {
-            if (ser->host)
-                wrbuf_puts(w, ser->host);
-            if (ser->port)
+            const char *cp = strrchr(listener_override, ':');
+            if (cp)
             {
-                if (wrbuf_len(w))
-                    wrbuf_puts(w, ":");
-                wrbuf_printf(w, "%d", ser->port);
+                ser->host = nmem_strdupn(conf->nmem, listener_override,
+                                         cp - listener_override);
+                ser->port = nmem_strdup(conf->nmem, cp + 1);
             }
+            else
+            {
+                ser->host = "@";
+                ser->port = nmem_strdup(conf->nmem, listener_override);
+            }
+            listener_override = 0; /* only first server is overriden */
         }
-        r = http_init(wrbuf_cstr(w), ser, record_fname);
-        wrbuf_destroy(w);
+        r = http_init(ser, record_fname);
         if (r)
             return -1;