From: Adam Dickmeiss Date: Mon, 14 Apr 2008 13:00:15 +0000 (+0200) Subject: Renamed config.[ch] to pazpar2_config.[ch]. X-Git-Tag: PAZPAR2_1_0_7_2~5 X-Git-Url: http://jsfdemo.indexdata.com/cgi-bin?a=commitdiff_plain;h=5a145dc87e4756afc3e247cded32a9666457f065;p=pazpar2-moved-to-github.git Renamed config.[ch] to pazpar2_config.[ch]. Renamed config.[ch] to pazpar2_config.[ch] . The config.h is usually for autoheaders to use . --- diff --git a/src/Makefile.am b/src/Makefile.am index 7207781..2148f6d 100644 --- a/src/Makefile.am +++ b/src/Makefile.am @@ -22,7 +22,7 @@ CONFIG_CLEAN_FILES=*.log AM_CFLAGS = $(YAZINC) $(ICU_CPPFLAGS) -libpazpar2_a_SOURCES = config.c config.h eventl.c eventl.h \ +libpazpar2_a_SOURCES = pazpar2_config.c pazpar2_config.h eventl.c eventl.h \ http.c http_command.c http_command.h http.h \ icu_I18N.h icu_I18N.c \ logic.c pazpar2.h \ diff --git a/src/config.c b/src/config.c deleted file mode 100644 index f02d169..0000000 --- a/src/config.c +++ /dev/null @@ -1,633 +0,0 @@ -/* This file is part of Pazpar2. - Copyright (C) 2006-2008 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 -Software Foundation; either version 2, or (at your option) any later -version. - -Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY -WARRANTY; without even the implied warranty of MERCHANTABILITY or -FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -for more details. - -You should have received a copy of the GNU General Public License -along with this program; if not, write to the Free Software -Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA - -*/ - -/* $Id: config.c,v 1.42 2007-10-31 05:29:08 quinn Exp $ */ - -#include - -#include -#include -#include -#include -#include - -#if HAVE_CONFIG_H -#include -#endif - -#include -#include -#include - -#define CONFIG_NOEXTERNS -#include "config.h" - - -static NMEM nmem = 0; -static char confdir[256] = "."; - -struct conf_config *config = 0; - - -struct conf_metadata * 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, - int rank, - int sortkey_offset) -{ - if (!nmem || !metadata || !name) - return 0; - - metadata->name = nmem_strdup(nmem, name); - - metadata->type = type; - - // 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 = rank; - metadata->sortkey_offset = sortkey_offset; - return metadata; -} - - -struct conf_sortkey * conf_sortkey_assign(NMEM nmem, - struct conf_sortkey * sortkey, - const char *name, - enum conf_sortkey_type type) -{ - if (!nmem || !sortkey || !name) - return 0; - - sortkey->name = nmem_strdup(nmem, name); - sortkey->type = type; - - return sortkey; -} - - -struct conf_service * conf_service_create(NMEM nmem, - int num_metadata, int num_sortkeys) -{ - struct conf_service * service = 0; - - //assert(nmem); - - service = nmem_malloc(nmem, sizeof(struct conf_service)); - - 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->num_sortkeys = num_sortkeys; - service->sortkeys = 0; - if (service->num_sortkeys) - service->sortkeys - = nmem_malloc(nmem, - sizeof(struct conf_sortkey) * service->num_sortkeys); - - return service; -} - -struct conf_metadata* conf_service_add_metadata(NMEM nmem, - struct conf_service *service, - int field_id, - const char *name, - enum conf_metadata_type type, - enum conf_metadata_merge merge, - enum conf_setting_type setting, - int brief, - int termlist, - int rank, - int sortkey_offset) -{ - struct conf_metadata * md = 0; - - if (!service || !service->metadata || !service->num_metadata - || field_id < 0 || !(field_id < service->num_metadata)) - return 0; - - //md = &((service->metadata)[field_id]); - md = service->metadata + field_id; - md = conf_metadata_assign(nmem, md, name, type, merge, setting, - brief, termlist, rank, sortkey_offset); - return md; -} - - -struct conf_sortkey * conf_service_add_sortkey(NMEM nmem, - struct conf_service *service, - int field_id, - const char *name, - enum conf_sortkey_type type) -{ - struct conf_sortkey * sk = 0; - - if (!service || !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; - sk = conf_sortkey_assign(nmem, sk, name, type); - - return sk; -} - - -int conf_service_metadata_field_id(struct conf_service *service, - const char * name) -{ - int i = 0; - - 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; - } - - return -1; -}; - - -int conf_service_sortkey_field_id(struct conf_service *service, - const char * name) -{ - int i = 0; - - if (!service || !service->sortkeys || !service->num_sortkeys) - return -1; - - for(i = 0; i < service->num_sortkeys; i++) { - if (!strcmp(name, (service->sortkeys[i]).name)) - return i; - } - - return -1; -}; - - - -/* Code to parse configuration file */ -/* ==================================================== */ - -static struct conf_service *parse_service(xmlNode *node) -{ - xmlNode *n; - int md_node = 0; - int sk_node = 0; - - struct conf_service *service = 0; - int num_metadata = 0; - int num_sortkeys = 0; - - // count num_metadata and num_sortkeys - for (n = node->children; n; n = n->next) - if (n->type == XML_ELEMENT_NODE && !strcmp((const char *) - n->name, "metadata")) - { - xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey"); - num_metadata++; - if (sortkey && strcmp((const char *) sortkey, "no")) - num_sortkeys++; - xmlFree(sortkey); - } - - service = conf_service_create(nmem, num_metadata, num_sortkeys); - - for (n = node->children; n; n = n->next) - { - if (n->type != XML_ELEMENT_NODE) - continue; - if (!strcmp((const char *) n->name, (const char *) "metadata")) - { - xmlChar *xml_name = xmlGetProp(n, (xmlChar *) "name"); - xmlChar *xml_brief = xmlGetProp(n, (xmlChar *) "brief"); - xmlChar *xml_sortkey = xmlGetProp(n, (xmlChar *) "sortkey"); - xmlChar *xml_merge = xmlGetProp(n, (xmlChar *) "merge"); - xmlChar *xml_type = xmlGetProp(n, (xmlChar *) "type"); - xmlChar *xml_termlist = xmlGetProp(n, (xmlChar *) "termlist"); - xmlChar *xml_rank = xmlGetProp(n, (xmlChar *) "rank"); - xmlChar *xml_setting = xmlGetProp(n, (xmlChar *) "setting"); - - enum conf_metadata_type type = Metadata_type_generic; - enum conf_metadata_merge merge = Metadata_merge_no; - enum conf_setting_type setting = Metadata_setting_no; - enum conf_sortkey_type sk_type = Metadata_sortkey_relevance; - int brief = 0; - int termlist = 0; - int rank = 0; - int sortkey_offset = 0; - - // now do the parsing logic - if (!xml_name) - { - yaz_log(YLOG_FATAL, "Must specify name in metadata element"); - return 0; - } - if (xml_brief) - { - if (!strcmp((const char *) xml_brief, "yes")) - brief = 1; - else if (strcmp((const char *) xml_brief, "no")) - { - yaz_log(YLOG_FATAL, "metadata/brief must be yes or no"); - return 0; - } - } - else - brief = 0; - - if (xml_termlist) - { - if (!strcmp((const char *) xml_termlist, "yes")) - termlist = 1; - else if (strcmp((const char *) xml_termlist, "no")) - { - yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no"); - return 0; - } - } - else - termlist = 0; - - if (xml_rank) - rank = atoi((const char *) xml_rank); - else - rank = 0; - - if (xml_type) - { - if (!strcmp((const char *) xml_type, "generic")) - type = Metadata_type_generic; - else if (!strcmp((const char *) xml_type, "year")) - type = Metadata_type_year; - else if (!strcmp((const char *) xml_type, "date")) - type = Metadata_type_date; - else - { - yaz_log(YLOG_FATAL, - "Unknown value for metadata/type: %s", xml_type); - return 0; - } - } - else - type = Metadata_type_generic; - - if (xml_merge) - { - if (!strcmp((const char *) xml_merge, "no")) - merge = Metadata_merge_no; - else if (!strcmp((const char *) xml_merge, "unique")) - merge = Metadata_merge_unique; - else if (!strcmp((const char *) xml_merge, "longest")) - merge = Metadata_merge_longest; - else if (!strcmp((const char *) xml_merge, "range")) - merge = Metadata_merge_range; - else if (!strcmp((const char *) xml_merge, "all")) - merge = Metadata_merge_all; - else - { - yaz_log(YLOG_FATAL, - "Unknown value for metadata/merge: %s", xml_merge); - return 0; - } - } - else - merge = Metadata_merge_no; - - if (xml_setting) - { - if (!strcmp((const char *) xml_setting, "no")) - setting = Metadata_setting_no; - else if (!strcmp((const char *) xml_setting, "postproc")) - setting = Metadata_setting_postproc; - else if (!strcmp((const char *) xml_setting, "parameter")) - setting = Metadata_setting_parameter; - else - { - yaz_log(YLOG_FATAL, - "Unknown value for medadata/setting: %s", xml_setting); - return 0; - } - } - - // add a sortkey if so specified - if (xml_sortkey && strcmp((const char *) xml_sortkey, "no")) - { - if (merge == Metadata_merge_no) - { - yaz_log(YLOG_FATAL, - "Can't specify sortkey on a non-merged field"); - return 0; - } - if (!strcmp((const char *) xml_sortkey, "numeric")) - sk_type = Metadata_sortkey_numeric; - else if (!strcmp((const char *) xml_sortkey, "skiparticle")) - sk_type = Metadata_sortkey_skiparticle; - else - { - yaz_log(YLOG_FATAL, - "Unknown sortkey in metadata element: %s", - xml_sortkey); - return 0; - } - sortkey_offset = sk_node; - - conf_service_add_sortkey(nmem, service, sk_node, - (const char *) xml_name, sk_type); - - sk_node++; - } - else - sortkey_offset = -1; - - // metadata known, assign values - conf_service_add_metadata(nmem, service, md_node, - (const char *) xml_name, - type, merge, setting, - brief, termlist, rank, sortkey_offset); - - xmlFree(xml_name); - xmlFree(xml_brief); - xmlFree(xml_sortkey); - xmlFree(xml_merge); - xmlFree(xml_type); - xmlFree(xml_termlist); - xmlFree(xml_rank); - md_node++; - } - else - { - yaz_log(YLOG_FATAL, "Bad element: %s", n->name); - return 0; - } - } - return service; -} - -static char *parse_settings(xmlNode *node) -{ - xmlChar *src = xmlGetProp(node, (xmlChar *) "src"); - char *r; - - if (src) - r = nmem_strdup(nmem, (const char *) src); - else - { - yaz_log(YLOG_FATAL, "Must specify src in targetprofile"); - return 0; - } - xmlFree(src); - return r; -} - -static struct conf_server *parse_server(xmlNode *node) -{ - xmlNode *n; - struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server)); - - server->host = 0; - server->port = 0; - server->proxy_host = 0; - server->proxy_port = 0; - server->myurl = 0; - server->service = 0; - server->next = 0; - server->settings = 0; - server->relevance_pct = 0; - server->sort_pct = 0; - server->mergekey_pct = 0; - - for (n = node->children; n; n = n->next) - { - if (n->type != XML_ELEMENT_NODE) - continue; - if (!strcmp((const char *) n->name, "listen")) - { - xmlChar *port = xmlGetProp(n, (xmlChar *) "port"); - xmlChar *host = xmlGetProp(n, (xmlChar *) "host"); - if (port) - server->port = atoi((const char *) port); - if (host) - server->host = nmem_strdup(nmem, (const char *) host); - xmlFree(port); - xmlFree(host); - } - else if (!strcmp((const char *) n->name, "proxy")) - { - xmlChar *port = xmlGetProp(n, (xmlChar *) "port"); - xmlChar *host = xmlGetProp(n, (xmlChar *) "host"); - xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl"); - if (port) - server->proxy_port = atoi((const char *) port); - if (host) - server->proxy_host = nmem_strdup(nmem, (const char *) host); - if (myurl) - server->myurl = nmem_strdup(nmem, (const char *) myurl); - xmlFree(port); - xmlFree(host); - xmlFree(myurl); - } - else if (!strcmp((const char *) n->name, "settings")) - { - if (server->settings) - { - yaz_log(YLOG_FATAL, "Can't repeat 'settings'"); - return 0; - } - if (!(server->settings = parse_settings(n))) - return 0; - } - else if (!strcmp((const char *) n->name, "relevance")) - { - server->relevance_pct = pp2_charset_create_xml(n->children); - } - else if (!strcmp((const char *) n->name, "sort")) - { - server->sort_pct = pp2_charset_create_xml(n->children); - } - else if (!strcmp((const char *) n->name, "mergekey")) - { - server->mergekey_pct = pp2_charset_create_xml(n->children); - } - else if (!strcmp((const char *) n->name, "service")) - { - struct conf_service *s = parse_service(n); - if (!s) - return 0; - server->service = s; - } - else - { - yaz_log(YLOG_FATAL, "Bad element: %s", n->name); - return 0; - } - } - if (!server->relevance_pct) - server->relevance_pct = pp2_charset_create(0); - if (!server->sort_pct) - server->sort_pct = pp2_charset_create(0); - if (!server->mergekey_pct) - server->mergekey_pct = pp2_charset_create(0); - return server; -} - -xsltStylesheet *conf_load_stylesheet(const char *fname) -{ - char path[256]; - if (*fname == '/') - yaz_snprintf(path, sizeof(path), fname); - else - yaz_snprintf(path, sizeof(path), "%s/%s", confdir, fname); - return xsltParseStylesheetFile((xmlChar *) path); -} - -static struct conf_targetprofiles *parse_targetprofiles(xmlNode *node) -{ - struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r)); - xmlChar *type = xmlGetProp(node, (xmlChar *) "type"); - xmlChar *src = xmlGetProp(node, (xmlChar *) "src"); - - memset(r, 0, sizeof(*r)); - - if (type) - { - if (!strcmp((const char *) type, "local")) - r->type = Targetprofiles_local; - else - { - yaz_log(YLOG_FATAL, "Unknown targetprofile type"); - return 0; - } - } - else - { - yaz_log(YLOG_FATAL, "Must specify type for targetprofile"); - return 0; - } - - if (src) - r->src = nmem_strdup(nmem, (const char *) src); - else - { - yaz_log(YLOG_FATAL, "Must specify src in targetprofile"); - return 0; - } - xmlFree(type); - xmlFree(src); - return r; -} - -static struct conf_config *parse_config(xmlNode *root) -{ - xmlNode *n; - struct conf_config *r = nmem_malloc(nmem, sizeof(struct conf_config)); - - r->servers = 0; - r->targetprofiles = 0; - - for (n = root->children; n; n = n->next) - { - if (n->type != XML_ELEMENT_NODE) - continue; - if (!strcmp((const char *) n->name, "server")) - { - struct conf_server *tmp = parse_server(n); - if (!tmp) - return 0; - tmp->next = r->servers; - r->servers = tmp; - } - else if (!strcmp((const char *) n->name, "targetprofiles")) - { - // It would be fun to be able to fix this sometime - if (r->targetprofiles) - { - yaz_log(YLOG_FATAL, "Can't repeat targetprofiles"); - return 0; - } - if (!(r->targetprofiles = parse_targetprofiles(n))) - return 0; - } - else - { - yaz_log(YLOG_FATAL, "Bad element: %s", n->name); - return 0; - } - } - return r; -} - -int read_config(const char *fname) -{ - xmlDoc *doc = xmlParseFile(fname); - const char *p; - - if (!nmem) // Initialize - { - nmem = nmem_create(); - xmlSubstituteEntitiesDefault(1); - xmlLoadExtDtdDefaultValue = 1; - } - if (!doc) - { - yaz_log(YLOG_FATAL, "Failed to read %s", fname); - exit(1); - } - if ((p = strrchr(fname, '/'))) - { - int len = p - fname; - if (len >= sizeof(confdir)) - len = sizeof(confdir)-1; - strncpy(confdir, fname, len); - confdir[len] = '\0'; - } - config = parse_config(xmlDocGetRootElement(doc)); - xmlFreeDoc(doc); - - if (config) - return 1; - else - return 0; -} - - -/* - * Local variables: - * c-basic-offset: 4 - * indent-tabs-mode: nil - * End: - * vim: shiftwidth=4 tabstop=8 expandtab - */ diff --git a/src/config.h b/src/config.h deleted file mode 100644 index 6f52922..0000000 --- a/src/config.h +++ /dev/null @@ -1,196 +0,0 @@ -/* This file is part of Pazpar2. - Copyright (C) 2006-2008 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 -Software Foundation; either version 2, or (at your option) any later -version. - -Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY -WARRANTY; without even the implied warranty of MERCHANTABILITY or -FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License -for more details. - -You should have received a copy of the GNU General Public License -along with this program; if not, write to the Free Software -Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA - -*/ - -#ifndef CONFIG_H -#define CONFIG_H - -#include -#include -#include - -#include -#include "charsets.h" - -enum conf_metadata_type { - Metadata_type_generic, // Generic text field - Metadata_type_number, // A number - Metadata_type_year, // A number - Metadata_type_date // A number -}; - -enum conf_metadata_merge { - Metadata_merge_no, // Don't merge - Metadata_merge_unique, // Include unique elements in merged block - Metadata_merge_longest, // Include the longest (strlen) value - Metadata_merge_range, // Store value as a range of lowest-highest - Metadata_merge_all // Just include all elements found -}; - -enum conf_sortkey_type { - Metadata_sortkey_relevance, - Metadata_sortkey_numeric, // Standard numerical sorting - Metadata_sortkey_skiparticle, // Skip leading article when sorting - Metadata_sortkey_string // Flat string -}; - -// This controls the ability to insert 'static' values from settings into retrieval recs -enum conf_setting_type { - Metadata_setting_no, - Metadata_setting_postproc, // Insert setting value into normalized record - Metadata_setting_parameter // Expose value to normalization stylesheets -}; - -// Describes known metadata elements and how they are to be manipulated -// An array of these structure provides a 'map' against which -// discovered metadata elements are matched. It also governs storage, -// to minimize number of cycles needed at various tages of processing -struct conf_metadata -{ - char *name; // The field name. Output by normalization stylesheet - int brief; // Is this element to be returned in the brief format? - int termlist;// Is this field to be treated as a termlist for browsing? - int rank; // Rank factor. 0 means don't use this field for ranking, - // 1 is default - // values >1 give additional significance to a field - int sortkey_offset; // -1 if it's not a sortkey, otherwise index - // into service/record_cluster->sortkey array - enum conf_metadata_type type; - enum conf_metadata_merge merge; - enum conf_setting_type setting; // Value is to be taken from session/db settings? -}; - - - -struct conf_metadata * 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, - int rank, - int sortkey_offset); - - - -// Controls sorting -struct conf_sortkey -{ - char *name; - enum conf_sortkey_type type; -}; - -struct conf_sortkey * conf_sortkey_assign(NMEM nmem, - struct conf_sortkey * sortkey, - const char *name, - enum conf_sortkey_type type); - - - -// It is conceivable that there will eventually be several 'services' -// offered from one server, with separate configuration -- possibly -// more than one services associated with the same port. For now, -// however, only a single service is possible. -struct conf_service -{ - int num_metadata; - struct conf_metadata *metadata; - int num_sortkeys; - struct conf_sortkey *sortkeys; - -}; - -struct conf_service * conf_service_create(NMEM nmem, - int num_metadata, int num_sortkeys); - - -struct conf_metadata* conf_service_add_metadata(NMEM nmem, - struct conf_service *service, - int field_id, - const char *name, - enum conf_metadata_type type, - enum conf_metadata_merge merge, - enum conf_setting_type setting, - int brief, - int termlist, - int rank, - int sortkey_offset); - -struct conf_sortkey * conf_service_add_sortkey(NMEM nmem, - struct conf_service *service, - int field_id, - const char *name, - enum conf_sortkey_type type); - - -int conf_service_metadata_field_id(struct conf_service *service, const char * name); - -int conf_service_sortkey_field_id(struct conf_service *service, const char * name); - - -struct conf_server -{ - char *host; - int port; - char *proxy_host; - int proxy_port; - char *myurl; - char *settings; - - pp2_charset_t relevance_pct; - pp2_charset_t sort_pct; - pp2_charset_t mergekey_pct; - - struct conf_service *service; - struct conf_server *next; -}; - -struct conf_targetprofiles -{ - enum { - Targetprofiles_local - } type; - char *src; -}; - -struct conf_config -{ - struct conf_server *servers; - struct conf_targetprofiles *targetprofiles; -}; - -#ifndef CONFIG_NOEXTERNS - -extern struct conf_config *config; - -#endif - -int read_config(const char *fname); -xsltStylesheet *conf_load_stylesheet(const char *fname); - -#endif - -/* - * Local variables: - * c-basic-offset: 4 - * indent-tabs-mode: nil - * End: - * vim: shiftwidth=4 tabstop=8 expandtab - */ diff --git a/src/database.c b/src/database.c index 1484427..30d8a84 100644 --- a/src/database.c +++ b/src/database.c @@ -28,7 +28,6 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA #include "pazpar2.h" #include "host.h" -#include "config.h" #include "settings.h" #include "http.h" #include "zeerex.h" diff --git a/src/http.c b/src/http.c index cdf2c26..e697b4e 100644 --- a/src/http.c +++ b/src/http.c @@ -44,7 +44,6 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA #include #include -#include "cconfig.h" #include "util.h" #include "eventl.h" #include "pazpar2.h" diff --git a/src/http_command.c b/src/http_command.c index 68b56af..9bcf77e 100644 --- a/src/http_command.c +++ b/src/http_command.c @@ -36,7 +36,6 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA #include -#include "config.h" #include "util.h" #include "eventl.h" #include "pazpar2.h" diff --git a/src/logic.c b/src/logic.c index 350d880..07f2254 100644 --- a/src/logic.c +++ b/src/logic.c @@ -63,7 +63,6 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA #include "termlists.h" #include "reclists.h" #include "relevance.h" -#include "config.h" #include "database.h" #include "client.h" #include "settings.h" diff --git a/src/pazpar2.h b/src/pazpar2.h index f27e9bb..509ad9b 100644 --- a/src/pazpar2.h +++ b/src/pazpar2.h @@ -35,7 +35,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA #include "relevance.h" #include "reclists.h" #include "eventl.h" -#include "config.h" +#include "pazpar2_config.h" #include "parameters.h" #include "http.h" diff --git a/src/pazpar2_config.c b/src/pazpar2_config.c new file mode 100644 index 0000000..ca7490d --- /dev/null +++ b/src/pazpar2_config.c @@ -0,0 +1,633 @@ +/* This file is part of Pazpar2. + Copyright (C) 2006-2008 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 +Software Foundation; either version 2, or (at your option) any later +version. + +Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY +WARRANTY; without even the implied warranty of MERCHANTABILITY or +FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +/* $Id: config.c,v 1.42 2007-10-31 05:29:08 quinn Exp $ */ + +#include + +#include +#include +#include +#include +#include + +#if HAVE_CONFIG_H +#include +#endif + +#include +#include +#include + +#define CONFIG_NOEXTERNS +#include "pazpar2_config.h" + + +static NMEM nmem = 0; +static char confdir[256] = "."; + +struct conf_config *config = 0; + + +struct conf_metadata * 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, + int rank, + int sortkey_offset) +{ + if (!nmem || !metadata || !name) + return 0; + + metadata->name = nmem_strdup(nmem, name); + + metadata->type = type; + + // 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 = rank; + metadata->sortkey_offset = sortkey_offset; + return metadata; +} + + +struct conf_sortkey * conf_sortkey_assign(NMEM nmem, + struct conf_sortkey * sortkey, + const char *name, + enum conf_sortkey_type type) +{ + if (!nmem || !sortkey || !name) + return 0; + + sortkey->name = nmem_strdup(nmem, name); + sortkey->type = type; + + return sortkey; +} + + +struct conf_service * conf_service_create(NMEM nmem, + int num_metadata, int num_sortkeys) +{ + struct conf_service * service = 0; + + //assert(nmem); + + service = nmem_malloc(nmem, sizeof(struct conf_service)); + + 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->num_sortkeys = num_sortkeys; + service->sortkeys = 0; + if (service->num_sortkeys) + service->sortkeys + = nmem_malloc(nmem, + sizeof(struct conf_sortkey) * service->num_sortkeys); + + return service; +} + +struct conf_metadata* conf_service_add_metadata(NMEM nmem, + struct conf_service *service, + int field_id, + const char *name, + enum conf_metadata_type type, + enum conf_metadata_merge merge, + enum conf_setting_type setting, + int brief, + int termlist, + int rank, + int sortkey_offset) +{ + struct conf_metadata * md = 0; + + if (!service || !service->metadata || !service->num_metadata + || field_id < 0 || !(field_id < service->num_metadata)) + return 0; + + //md = &((service->metadata)[field_id]); + md = service->metadata + field_id; + md = conf_metadata_assign(nmem, md, name, type, merge, setting, + brief, termlist, rank, sortkey_offset); + return md; +} + + +struct conf_sortkey * conf_service_add_sortkey(NMEM nmem, + struct conf_service *service, + int field_id, + const char *name, + enum conf_sortkey_type type) +{ + struct conf_sortkey * sk = 0; + + if (!service || !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; + sk = conf_sortkey_assign(nmem, sk, name, type); + + return sk; +} + + +int conf_service_metadata_field_id(struct conf_service *service, + const char * name) +{ + int i = 0; + + 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; + } + + return -1; +}; + + +int conf_service_sortkey_field_id(struct conf_service *service, + const char * name) +{ + int i = 0; + + if (!service || !service->sortkeys || !service->num_sortkeys) + return -1; + + for(i = 0; i < service->num_sortkeys; i++) { + if (!strcmp(name, (service->sortkeys[i]).name)) + return i; + } + + return -1; +}; + + + +/* Code to parse configuration file */ +/* ==================================================== */ + +static struct conf_service *parse_service(xmlNode *node) +{ + xmlNode *n; + int md_node = 0; + int sk_node = 0; + + struct conf_service *service = 0; + int num_metadata = 0; + int num_sortkeys = 0; + + // count num_metadata and num_sortkeys + for (n = node->children; n; n = n->next) + if (n->type == XML_ELEMENT_NODE && !strcmp((const char *) + n->name, "metadata")) + { + xmlChar *sortkey = xmlGetProp(n, (xmlChar *) "sortkey"); + num_metadata++; + if (sortkey && strcmp((const char *) sortkey, "no")) + num_sortkeys++; + xmlFree(sortkey); + } + + service = conf_service_create(nmem, num_metadata, num_sortkeys); + + for (n = node->children; n; n = n->next) + { + if (n->type != XML_ELEMENT_NODE) + continue; + if (!strcmp((const char *) n->name, (const char *) "metadata")) + { + xmlChar *xml_name = xmlGetProp(n, (xmlChar *) "name"); + xmlChar *xml_brief = xmlGetProp(n, (xmlChar *) "brief"); + xmlChar *xml_sortkey = xmlGetProp(n, (xmlChar *) "sortkey"); + xmlChar *xml_merge = xmlGetProp(n, (xmlChar *) "merge"); + xmlChar *xml_type = xmlGetProp(n, (xmlChar *) "type"); + xmlChar *xml_termlist = xmlGetProp(n, (xmlChar *) "termlist"); + xmlChar *xml_rank = xmlGetProp(n, (xmlChar *) "rank"); + xmlChar *xml_setting = xmlGetProp(n, (xmlChar *) "setting"); + + enum conf_metadata_type type = Metadata_type_generic; + enum conf_metadata_merge merge = Metadata_merge_no; + enum conf_setting_type setting = Metadata_setting_no; + enum conf_sortkey_type sk_type = Metadata_sortkey_relevance; + int brief = 0; + int termlist = 0; + int rank = 0; + int sortkey_offset = 0; + + // now do the parsing logic + if (!xml_name) + { + yaz_log(YLOG_FATAL, "Must specify name in metadata element"); + return 0; + } + if (xml_brief) + { + if (!strcmp((const char *) xml_brief, "yes")) + brief = 1; + else if (strcmp((const char *) xml_brief, "no")) + { + yaz_log(YLOG_FATAL, "metadata/brief must be yes or no"); + return 0; + } + } + else + brief = 0; + + if (xml_termlist) + { + if (!strcmp((const char *) xml_termlist, "yes")) + termlist = 1; + else if (strcmp((const char *) xml_termlist, "no")) + { + yaz_log(YLOG_FATAL, "metadata/termlist must be yes or no"); + return 0; + } + } + else + termlist = 0; + + if (xml_rank) + rank = atoi((const char *) xml_rank); + else + rank = 0; + + if (xml_type) + { + if (!strcmp((const char *) xml_type, "generic")) + type = Metadata_type_generic; + else if (!strcmp((const char *) xml_type, "year")) + type = Metadata_type_year; + else if (!strcmp((const char *) xml_type, "date")) + type = Metadata_type_date; + else + { + yaz_log(YLOG_FATAL, + "Unknown value for metadata/type: %s", xml_type); + return 0; + } + } + else + type = Metadata_type_generic; + + if (xml_merge) + { + if (!strcmp((const char *) xml_merge, "no")) + merge = Metadata_merge_no; + else if (!strcmp((const char *) xml_merge, "unique")) + merge = Metadata_merge_unique; + else if (!strcmp((const char *) xml_merge, "longest")) + merge = Metadata_merge_longest; + else if (!strcmp((const char *) xml_merge, "range")) + merge = Metadata_merge_range; + else if (!strcmp((const char *) xml_merge, "all")) + merge = Metadata_merge_all; + else + { + yaz_log(YLOG_FATAL, + "Unknown value for metadata/merge: %s", xml_merge); + return 0; + } + } + else + merge = Metadata_merge_no; + + if (xml_setting) + { + if (!strcmp((const char *) xml_setting, "no")) + setting = Metadata_setting_no; + else if (!strcmp((const char *) xml_setting, "postproc")) + setting = Metadata_setting_postproc; + else if (!strcmp((const char *) xml_setting, "parameter")) + setting = Metadata_setting_parameter; + else + { + yaz_log(YLOG_FATAL, + "Unknown value for medadata/setting: %s", xml_setting); + return 0; + } + } + + // add a sortkey if so specified + if (xml_sortkey && strcmp((const char *) xml_sortkey, "no")) + { + if (merge == Metadata_merge_no) + { + yaz_log(YLOG_FATAL, + "Can't specify sortkey on a non-merged field"); + return 0; + } + if (!strcmp((const char *) xml_sortkey, "numeric")) + sk_type = Metadata_sortkey_numeric; + else if (!strcmp((const char *) xml_sortkey, "skiparticle")) + sk_type = Metadata_sortkey_skiparticle; + else + { + yaz_log(YLOG_FATAL, + "Unknown sortkey in metadata element: %s", + xml_sortkey); + return 0; + } + sortkey_offset = sk_node; + + conf_service_add_sortkey(nmem, service, sk_node, + (const char *) xml_name, sk_type); + + sk_node++; + } + else + sortkey_offset = -1; + + // metadata known, assign values + conf_service_add_metadata(nmem, service, md_node, + (const char *) xml_name, + type, merge, setting, + brief, termlist, rank, sortkey_offset); + + xmlFree(xml_name); + xmlFree(xml_brief); + xmlFree(xml_sortkey); + xmlFree(xml_merge); + xmlFree(xml_type); + xmlFree(xml_termlist); + xmlFree(xml_rank); + md_node++; + } + else + { + yaz_log(YLOG_FATAL, "Bad element: %s", n->name); + return 0; + } + } + return service; +} + +static char *parse_settings(xmlNode *node) +{ + xmlChar *src = xmlGetProp(node, (xmlChar *) "src"); + char *r; + + if (src) + r = nmem_strdup(nmem, (const char *) src); + else + { + yaz_log(YLOG_FATAL, "Must specify src in targetprofile"); + return 0; + } + xmlFree(src); + return r; +} + +static struct conf_server *parse_server(xmlNode *node) +{ + xmlNode *n; + struct conf_server *server = nmem_malloc(nmem, sizeof(struct conf_server)); + + server->host = 0; + server->port = 0; + server->proxy_host = 0; + server->proxy_port = 0; + server->myurl = 0; + server->service = 0; + server->next = 0; + server->settings = 0; + server->relevance_pct = 0; + server->sort_pct = 0; + server->mergekey_pct = 0; + + for (n = node->children; n; n = n->next) + { + if (n->type != XML_ELEMENT_NODE) + continue; + if (!strcmp((const char *) n->name, "listen")) + { + xmlChar *port = xmlGetProp(n, (xmlChar *) "port"); + xmlChar *host = xmlGetProp(n, (xmlChar *) "host"); + if (port) + server->port = atoi((const char *) port); + if (host) + server->host = nmem_strdup(nmem, (const char *) host); + xmlFree(port); + xmlFree(host); + } + else if (!strcmp((const char *) n->name, "proxy")) + { + xmlChar *port = xmlGetProp(n, (xmlChar *) "port"); + xmlChar *host = xmlGetProp(n, (xmlChar *) "host"); + xmlChar *myurl = xmlGetProp(n, (xmlChar *) "myurl"); + if (port) + server->proxy_port = atoi((const char *) port); + if (host) + server->proxy_host = nmem_strdup(nmem, (const char *) host); + if (myurl) + server->myurl = nmem_strdup(nmem, (const char *) myurl); + xmlFree(port); + xmlFree(host); + xmlFree(myurl); + } + else if (!strcmp((const char *) n->name, "settings")) + { + if (server->settings) + { + yaz_log(YLOG_FATAL, "Can't repeat 'settings'"); + return 0; + } + if (!(server->settings = parse_settings(n))) + return 0; + } + else if (!strcmp((const char *) n->name, "relevance")) + { + server->relevance_pct = pp2_charset_create_xml(n->children); + } + else if (!strcmp((const char *) n->name, "sort")) + { + server->sort_pct = pp2_charset_create_xml(n->children); + } + else if (!strcmp((const char *) n->name, "mergekey")) + { + server->mergekey_pct = pp2_charset_create_xml(n->children); + } + else if (!strcmp((const char *) n->name, "service")) + { + struct conf_service *s = parse_service(n); + if (!s) + return 0; + server->service = s; + } + else + { + yaz_log(YLOG_FATAL, "Bad element: %s", n->name); + return 0; + } + } + if (!server->relevance_pct) + server->relevance_pct = pp2_charset_create(0); + if (!server->sort_pct) + server->sort_pct = pp2_charset_create(0); + if (!server->mergekey_pct) + server->mergekey_pct = pp2_charset_create(0); + return server; +} + +xsltStylesheet *conf_load_stylesheet(const char *fname) +{ + char path[256]; + if (*fname == '/') + yaz_snprintf(path, sizeof(path), fname); + else + yaz_snprintf(path, sizeof(path), "%s/%s", confdir, fname); + return xsltParseStylesheetFile((xmlChar *) path); +} + +static struct conf_targetprofiles *parse_targetprofiles(xmlNode *node) +{ + struct conf_targetprofiles *r = nmem_malloc(nmem, sizeof(*r)); + xmlChar *type = xmlGetProp(node, (xmlChar *) "type"); + xmlChar *src = xmlGetProp(node, (xmlChar *) "src"); + + memset(r, 0, sizeof(*r)); + + if (type) + { + if (!strcmp((const char *) type, "local")) + r->type = Targetprofiles_local; + else + { + yaz_log(YLOG_FATAL, "Unknown targetprofile type"); + return 0; + } + } + else + { + yaz_log(YLOG_FATAL, "Must specify type for targetprofile"); + return 0; + } + + if (src) + r->src = nmem_strdup(nmem, (const char *) src); + else + { + yaz_log(YLOG_FATAL, "Must specify src in targetprofile"); + return 0; + } + xmlFree(type); + xmlFree(src); + return r; +} + +static struct conf_config *parse_config(xmlNode *root) +{ + xmlNode *n; + struct conf_config *r = nmem_malloc(nmem, sizeof(struct conf_config)); + + r->servers = 0; + r->targetprofiles = 0; + + for (n = root->children; n; n = n->next) + { + if (n->type != XML_ELEMENT_NODE) + continue; + if (!strcmp((const char *) n->name, "server")) + { + struct conf_server *tmp = parse_server(n); + if (!tmp) + return 0; + tmp->next = r->servers; + r->servers = tmp; + } + else if (!strcmp((const char *) n->name, "targetprofiles")) + { + // It would be fun to be able to fix this sometime + if (r->targetprofiles) + { + yaz_log(YLOG_FATAL, "Can't repeat targetprofiles"); + return 0; + } + if (!(r->targetprofiles = parse_targetprofiles(n))) + return 0; + } + else + { + yaz_log(YLOG_FATAL, "Bad element: %s", n->name); + return 0; + } + } + return r; +} + +int read_config(const char *fname) +{ + xmlDoc *doc = xmlParseFile(fname); + const char *p; + + if (!nmem) // Initialize + { + nmem = nmem_create(); + xmlSubstituteEntitiesDefault(1); + xmlLoadExtDtdDefaultValue = 1; + } + if (!doc) + { + yaz_log(YLOG_FATAL, "Failed to read %s", fname); + exit(1); + } + if ((p = strrchr(fname, '/'))) + { + int len = p - fname; + if (len >= sizeof(confdir)) + len = sizeof(confdir)-1; + strncpy(confdir, fname, len); + confdir[len] = '\0'; + } + config = parse_config(xmlDocGetRootElement(doc)); + xmlFreeDoc(doc); + + if (config) + return 1; + else + return 0; +} + + +/* + * Local variables: + * c-basic-offset: 4 + * indent-tabs-mode: nil + * End: + * vim: shiftwidth=4 tabstop=8 expandtab + */ diff --git a/src/pazpar2_config.h b/src/pazpar2_config.h new file mode 100644 index 0000000..2a3dab9 --- /dev/null +++ b/src/pazpar2_config.h @@ -0,0 +1,196 @@ +/* This file is part of Pazpar2. + Copyright (C) 2006-2008 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 +Software Foundation; either version 2, or (at your option) any later +version. + +Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY +WARRANTY; without even the implied warranty of MERCHANTABILITY or +FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License +for more details. + +You should have received a copy of the GNU General Public License +along with this program; if not, write to the Free Software +Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + +*/ + +#ifndef PAZPAR2_CONFIG_H +#define PAZPAR2_CONFIG_H + +#include +#include +#include + +#include +#include "charsets.h" + +enum conf_metadata_type { + Metadata_type_generic, // Generic text field + Metadata_type_number, // A number + Metadata_type_year, // A number + Metadata_type_date // A number +}; + +enum conf_metadata_merge { + Metadata_merge_no, // Don't merge + Metadata_merge_unique, // Include unique elements in merged block + Metadata_merge_longest, // Include the longest (strlen) value + Metadata_merge_range, // Store value as a range of lowest-highest + Metadata_merge_all // Just include all elements found +}; + +enum conf_sortkey_type { + Metadata_sortkey_relevance, + Metadata_sortkey_numeric, // Standard numerical sorting + Metadata_sortkey_skiparticle, // Skip leading article when sorting + Metadata_sortkey_string // Flat string +}; + +// This controls the ability to insert 'static' values from settings into retrieval recs +enum conf_setting_type { + Metadata_setting_no, + Metadata_setting_postproc, // Insert setting value into normalized record + Metadata_setting_parameter // Expose value to normalization stylesheets +}; + +// Describes known metadata elements and how they are to be manipulated +// An array of these structure provides a 'map' against which +// discovered metadata elements are matched. It also governs storage, +// to minimize number of cycles needed at various tages of processing +struct conf_metadata +{ + char *name; // The field name. Output by normalization stylesheet + int brief; // Is this element to be returned in the brief format? + int termlist;// Is this field to be treated as a termlist for browsing? + int rank; // Rank factor. 0 means don't use this field for ranking, + // 1 is default + // values >1 give additional significance to a field + int sortkey_offset; // -1 if it's not a sortkey, otherwise index + // into service/record_cluster->sortkey array + enum conf_metadata_type type; + enum conf_metadata_merge merge; + enum conf_setting_type setting; // Value is to be taken from session/db settings? +}; + + + +struct conf_metadata * 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, + int rank, + int sortkey_offset); + + + +// Controls sorting +struct conf_sortkey +{ + char *name; + enum conf_sortkey_type type; +}; + +struct conf_sortkey * conf_sortkey_assign(NMEM nmem, + struct conf_sortkey * sortkey, + const char *name, + enum conf_sortkey_type type); + + + +// It is conceivable that there will eventually be several 'services' +// offered from one server, with separate configuration -- possibly +// more than one services associated with the same port. For now, +// however, only a single service is possible. +struct conf_service +{ + int num_metadata; + struct conf_metadata *metadata; + int num_sortkeys; + struct conf_sortkey *sortkeys; + +}; + +struct conf_service * conf_service_create(NMEM nmem, + int num_metadata, int num_sortkeys); + + +struct conf_metadata* conf_service_add_metadata(NMEM nmem, + struct conf_service *service, + int field_id, + const char *name, + enum conf_metadata_type type, + enum conf_metadata_merge merge, + enum conf_setting_type setting, + int brief, + int termlist, + int rank, + int sortkey_offset); + +struct conf_sortkey * conf_service_add_sortkey(NMEM nmem, + struct conf_service *service, + int field_id, + const char *name, + enum conf_sortkey_type type); + + +int conf_service_metadata_field_id(struct conf_service *service, const char * name); + +int conf_service_sortkey_field_id(struct conf_service *service, const char * name); + + +struct conf_server +{ + char *host; + int port; + char *proxy_host; + int proxy_port; + char *myurl; + char *settings; + + pp2_charset_t relevance_pct; + pp2_charset_t sort_pct; + pp2_charset_t mergekey_pct; + + struct conf_service *service; + struct conf_server *next; +}; + +struct conf_targetprofiles +{ + enum { + Targetprofiles_local + } type; + char *src; +}; + +struct conf_config +{ + struct conf_server *servers; + struct conf_targetprofiles *targetprofiles; +}; + +#ifndef CONFIG_NOEXTERNS + +extern struct conf_config *config; + +#endif + +int read_config(const char *fname); +xsltStylesheet *conf_load_stylesheet(const char *fname); + +#endif + +/* + * Local variables: + * c-basic-offset: 4 + * indent-tabs-mode: nil + * End: + * vim: shiftwidth=4 tabstop=8 expandtab + */ diff --git a/src/reclists.h b/src/reclists.h index 4ccef8f..c75b53b 100644 --- a/src/reclists.h +++ b/src/reclists.h @@ -20,7 +20,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA #ifndef RECLISTS_H #define RECLISTS_H -#include "config.h" +#include "pazpar2_config.h" #include "record.h" struct reclist diff --git a/src/record.c b/src/record.c index 9864238..08d25f1 100644 --- a/src/record.c +++ b/src/record.c @@ -30,7 +30,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA #endif //#define CONFIG_NOEXTERNS -#include "config.h" +#include "pazpar2_config.h" #include "record.h" diff --git a/src/test_config.c b/src/test_config.c index 68a955b..f6df531 100644 --- a/src/test_config.c +++ b/src/test_config.c @@ -28,7 +28,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA #include -#include "config.h" +#include "pazpar2_config.h" diff --git a/src/test_reclists.c b/src/test_reclists.c index eabf740..c9bc44a 100644 --- a/src/test_reclists.c +++ b/src/test_reclists.c @@ -29,7 +29,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA #include -#include "config.h" +#include "pazpar2_config.h" //#include "record.h" #include "reclists.h" diff --git a/src/test_record.c b/src/test_record.c index 06398b5..89551c3 100644 --- a/src/test_record.c +++ b/src/test_record.c @@ -28,7 +28,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA #include -#include "config.h" +#include "pazpar2_config.h" #include "record.h" diff --git a/src/test_relevance.c b/src/test_relevance.c index a3e120b..daf8083 100644 --- a/src/test_relevance.c +++ b/src/test_relevance.c @@ -29,7 +29,7 @@ Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA #include -#include "config.h" +#include "pazpar2_config.h" #include "relevance.h" #include "record.h" #include "reclists.h"