X-Git-Url: http://git.indexdata.com/?a=blobdiff_plain;f=src%2Flogic.c;h=c76ba2892772682b972e8fa98a72b40d5caa58a7;hb=8b9b24543393aabb69c0efb0ee9b1390ee9d22f2;hp=1ceffce21b5a296067b5ea7d074c9a865b77e439;hpb=7a99aea06e5d23ce1320c4e3a368543c6a7ab1e4;p=pazpar2-moved-to-github.git diff --git a/src/logic.c b/src/logic.c index 1ceffce..c76ba28 100644 --- a/src/logic.c +++ b/src/logic.c @@ -1,7 +1,5 @@ -/* $Id: logic.c,v 1.38 2007-06-07 12:27:03 adam Exp $ - Copyright (c) 2006-2007, Index Data. - -This file is part of Pazpar2. +/* This file is part of Pazpar2. + Copyright (C) 2006-2009 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 @@ -14,22 +12,28 @@ 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 Pazpar2; see the file LICENSE. If not, write to the -Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA -02111-1307, USA. - */ +along with this program; if not, write to the Free Software +Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA + +*/ /** \file logic.c \brief high-level logic; mostly user sessions and settings */ +#if HAVE_CONFIG_H +#include +#endif + #include #include #include +#if HAVE_SYS_TIME_H #include +#endif +#if HAVE_UNISTD_H #include -#include -#include +#endif #include #include #include @@ -45,56 +49,56 @@ Free Software Foundation, 59 Temple Place - Suite 330, Boston, MA #include #include #include -#if YAZ_VERSIONL >= 0x020163 #include -#endif - -#if HAVE_CONFIG_H -#include "cconfig.h" -#endif +#include #define USE_TIMING 0 #if USE_TIMING #include #endif -#include - +#include "parameters.h" #include "pazpar2.h" #include "eventl.h" #include "http.h" #include "termlists.h" #include "reclists.h" #include "relevance.h" -#include "config.h" #include "database.h" #include "client.h" #include "settings.h" #include "normalize7bit.h" +#include "marcmap.h" + +#define TERMLIST_HIGH_SCORE 25 #define MAX_CHUNK 15 // Note: Some things in this structure will eventually move to configuration struct parameters global_parameters = { - "", - "", - "", - 0, - 0, /* dump_records */ - 0, /* debug_mode */ - 30, - "81", - "Index Data PazPar2", - VERSION, - 600, // 10 minutes - 60, + 0, // dump_records + 0, // debug_mode 100, - MAX_CHUNK, - 0, - 0 }; +static void log_xml_doc(xmlDoc *doc) +{ + FILE *lf = yaz_log_file(); + xmlChar *result = 0; + int len = 0; +#if LIBXML_VERSION >= 20600 + xmlDocDumpFormatMemory(doc, &result, &len, 1); +#else + xmlDocDumpMemory(doc, &result, &len); +#endif + if (lf && len) + { + fwrite(result, 1, len, lf); + fprintf(lf, "\n"); + } + xmlFree(result); +} // Recursively traverse query structure to extract terms. void pull_terms(NMEM nmem, struct ccl_rpn_node *n, char **termlist, int *num) @@ -105,20 +109,20 @@ void pull_terms(NMEM nmem, struct ccl_rpn_node *n, char **termlist, int *num) switch (n->kind) { - case CCL_RPN_AND: - case CCL_RPN_OR: - case CCL_RPN_NOT: - case CCL_RPN_PROX: - pull_terms(nmem, n->u.p[0], termlist, num); - pull_terms(nmem, n->u.p[1], termlist, num); - break; - case CCL_RPN_TERM: - nmem_strsplit(nmem, " ", n->u.t.term, &words, &numwords); - for (i = 0; i < numwords; i++) - termlist[(*num)++] = words[i]; - break; - default: // NOOP - break; + case CCL_RPN_AND: + case CCL_RPN_OR: + case CCL_RPN_NOT: + case CCL_RPN_PROX: + pull_terms(nmem, n->u.p[0], termlist, num); + pull_terms(nmem, n->u.p[1], termlist, num); + break; + case CCL_RPN_TERM: + nmem_strsplit(nmem, " ", n->u.t.term, &words, &numwords); + for (i = 0; i < numwords; i++) + termlist[(*num)++] = words[i]; + break; + default: // NOOP + break; } } @@ -143,174 +147,163 @@ static void add_facet(struct session *s, const char *type, const char *value) s->termlists[i].name = nmem_strdup(s->nmem, type); s->termlists[i].termlist - = termlist_create(s->nmem, s->expected_maxrecs, 15); + = termlist_create(s->nmem, s->expected_maxrecs, + TERMLIST_HIGH_SCORE); s->num_termlists = i + 1; } termlist_insert(s->termlists[i].termlist, value); } -xmlDoc *normalize_record(struct session_database *sdb, Z_External *rec) +xmlDoc *record_to_xml(struct session_database *sdb, const char *rec) { - struct database_retrievalmap *m; struct database *db = sdb->database; xmlDoc *rdoc = 0; - const Odr_oid *oid = rec->direct_reference; - /* convert response record to XML somehow */ - if (rec->which == Z_External_octet && oid - && !oid_oidcmp(oid, yaz_oid_recsyn_xml)) + rdoc = xmlParseMemory(rec, strlen(rec)); + + if (!rdoc) + { + yaz_log(YLOG_FATAL, "Non-wellformed XML received from %s", + db->url); + return 0; + } + + if (global_parameters.dump_records) + { + yaz_log(YLOG_LOG, "Un-normalized record from %s", db->url); + log_xml_doc(rdoc); + } + + return rdoc; +} + +#define MAX_XSLT_ARGS 16 + +// Add static values from session database settings if applicable +static void insert_settings_parameters(struct session_database *sdb, + struct session *se, char **parms) +{ + struct conf_service *service = se->service; + int i; + int nparms = 0; + int offset = 0; + + for (i = 0; i < service->num_metadata; i++) { - /* xml already */ - rdoc = xmlParseMemory((char*) rec->u.octet_aligned->buf, - rec->u.octet_aligned->len); - if (!rdoc) + struct conf_metadata *md = &service->metadata[i]; + int setting; + + if (md->setting == Metadata_setting_parameter && + (setting = settings_offset(service, md->name)) > 0) { - yaz_log(YLOG_FATAL, "Non-wellformed XML received from %s", - db->url); - return 0; + const char *val = session_setting_oneval(sdb, setting); + if (val && nparms < MAX_XSLT_ARGS) + { + char *buf; + int len = strlen(val); + buf = nmem_malloc(se->nmem, len + 3); + buf[0] = '\''; + strcpy(buf + 1, val); + buf[len+1] = '\''; + buf[len+2] = '\0'; + parms[offset++] = md->name; + parms[offset++] = buf; + nparms++; + } } } - else if (oid && yaz_oid_is_iso2709(oid)) + parms[offset] = 0; +} + +// Add static values from session database settings if applicable +static void insert_settings_values(struct session_database *sdb, xmlDoc *doc, + struct conf_service *service) +{ + int i; + + for (i = 0; i < service->num_metadata; i++) { - /* ISO2709 gets converted to MARCXML */ - if (!sdb->yaz_marc) + struct conf_metadata *md = &service->metadata[i]; + int offset; + + if (md->setting == Metadata_setting_postproc && + (offset = settings_offset(service, md->name)) > 0) { - yaz_log(YLOG_FATAL, "Unable to handle ISO2709 record"); - return 0; + const char *val = session_setting_oneval(sdb, offset); + if (val) + { + xmlNode *r = xmlDocGetRootElement(doc); + xmlNode *n = xmlNewTextChild(r, 0, (xmlChar *) "metadata", + (xmlChar *) val); + xmlSetProp(n, (xmlChar *) "type", (xmlChar *) md->name); + } } - else + } +} + +xmlDoc *normalize_record(struct session_database *sdb, struct session *se, + const char *rec) +{ + struct database_retrievalmap *m; + xmlDoc *rdoc = record_to_xml(sdb, rec); + if (rdoc) + { + for (m = sdb->map; m; m = m->next) { - xmlNode *res; - char *buf; - int len; + xmlDoc *new = 0; - if (rec->which != Z_External_octet) { - yaz_log(YLOG_WARN, "Unexpected external branch, probably BER %s", - db->url); - return 0; - } - buf = (char*) rec->u.octet_aligned->buf; - len = rec->u.octet_aligned->len; - if (yaz_marc_read_iso2709(sdb->yaz_marc, buf, len) < 0) - { - yaz_log(YLOG_WARN, "Failed to decode MARC %s", db->url); - return 0; + xmlNodePtr root = 0; + char *parms[MAX_XSLT_ARGS*2+1]; + + insert_settings_parameters(sdb, se, parms); + + if (m->stylesheet) + { + new = xsltApplyStylesheet(m->stylesheet, rdoc, (const char **) parms); + } + else if (m->marcmap) + { + new = marcmap_apply(m->marcmap, rdoc); + } + + root = xmlDocGetRootElement(new); + + if (!new || !root || !(root->children)) + { + yaz_log(YLOG_WARN, "XSLT transformation failed from %s", + sdb->database->url); + xmlFreeDoc(new); + xmlFreeDoc(rdoc); + return 0; + } } - yaz_marc_write_using_libxml2(sdb->yaz_marc, 1); - if (yaz_marc_write_xml(sdb->yaz_marc, &res, - "http://www.loc.gov/MARC21/slim", 0, 0) < 0) - { - yaz_log(YLOG_WARN, "Failed to encode as XML %s", - db->url); - return 0; - } - rdoc = xmlNewDoc((xmlChar *) "1.0"); - xmlDocSetRootElement(rdoc, res); + xmlFreeDoc(rdoc); + rdoc = new; } - } - else - { - char oid_name_buf[OID_STR_MAX]; - const char *oid_name = yaz_oid_to_string_buf(oid, 0, oid_name_buf); - yaz_log(YLOG_FATAL, - "Unable to handle record of type %s from %s", - oid_name, db->url); - return 0; - } - - if (global_parameters.dump_records){ - fprintf(stderr, - "Input Record (normalized) from %s\n----------------\n", - db->url); -#if LIBXML_VERSION >= 20600 - xmlDocFormatDump(stderr, rdoc, 1); -#else - xmlDocDump(stderr, rdoc); -#endif - } - for (m = sdb->map; m; m = m->next){ - xmlDoc *new = 0; + insert_settings_values(sdb, rdoc, se->service); + if (global_parameters.dump_records) { - xmlNodePtr root = 0; - new = xsltApplyStylesheet(m->stylesheet, rdoc, 0); - root= xmlDocGetRootElement(new); - if (!new || !root || !(root->children)) - { - yaz_log(YLOG_WARN, "XSLT transformation failed from %s", + yaz_log(YLOG_LOG, "Normalized record from %s", sdb->database->url); - xmlFreeDoc(new); - xmlFreeDoc(rdoc); - return 0; - } + log_xml_doc(rdoc); } - - xmlFreeDoc(rdoc); - rdoc = new; - } - if (global_parameters.dump_records) - { - fprintf(stderr, "Record from %s\n----------------\n", - sdb->database->url); -#if LIBXML_VERSION >= 20600 - xmlDocFormatDump(stderr, rdoc, 1); -#else - xmlDocDump(stderr, rdoc); -#endif } return rdoc; } // Retrieve first defined value for 'name' for given database. // Will be extended to take into account user associated with session -char *session_setting_oneval(struct session_database *db, int offset) +const char *session_setting_oneval(struct session_database *db, int offset) { if (!db->settings[offset]) return ""; return db->settings[offset]->value; } - - -// Initialize YAZ Map structures for MARC-based targets -static int prepare_yazmarc(struct session_database *sdb) -{ - char *s; - - if (!sdb->settings) - { - yaz_log(YLOG_WARN, "No settings for %s", sdb->database->url); - return -1; - } - if ((s = session_setting_oneval(sdb, PZ_NATIVESYNTAX)) - && !strncmp(s, "iso2709", 7)) - { - char *encoding = "marc-8s", *e; - yaz_iconv_t cm; - - // See if a native encoding is specified - if ((e = strchr(s, ';'))) - encoding = e + 1; - - sdb->yaz_marc = yaz_marc_create(); - yaz_marc_subfield_str(sdb->yaz_marc, "\t"); - - cm = yaz_iconv_open("utf-8", encoding); - if (!cm) - { - yaz_log(YLOG_FATAL, - "Unable to map from %s to UTF-8 for target %s", - encoding, sdb->database->url); - return -1; - } - yaz_marc_iconv(sdb->yaz_marc, cm); - } - return 0; -} - // Prepare XSLT stylesheets for record normalization // Structures are allocated on the session_wide nmem to avoid having // to recompute this for every search. This would lead @@ -318,7 +311,7 @@ static int prepare_yazmarc(struct session_database *sdb) // setting. However, this is not a realistic use scenario. static int prepare_map(struct session *se, struct session_database *sdb) { - char *s; + const char *s; if (!sdb->settings) { @@ -330,18 +323,59 @@ static int prepare_map(struct session *se, struct session_database *sdb) char **stylesheets; struct database_retrievalmap **m = &sdb->map; int num, i; + char auto_stylesheet[256]; + if (!strcmp(s, "auto")) + { + const char *request_syntax = session_setting_oneval( + sdb, PZ_REQUESTSYNTAX); + if (request_syntax) + { + char *cp; + yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet), + "%s.xsl", request_syntax); + for (cp = auto_stylesheet; *cp; cp++) + { + /* deliberately only consider ASCII */ + if (*cp > 32 && *cp < 127) + *cp = tolower(*cp); + } + s = auto_stylesheet; + } + else + { + yaz_log(YLOG_WARN, "No pz:requestsyntax for auto stylesheet"); + } + } nmem_strsplit(se->session_nmem, ",", s, &stylesheets, &num); for (i = 0; i < num; i++) { (*m) = nmem_malloc(se->session_nmem, sizeof(**m)); (*m)->next = 0; - if (!((*m)->stylesheet = conf_load_stylesheet(stylesheets[i]))) + + // XSLT + if (!strcmp(&stylesheets[i][strlen(stylesheets[i])-4], ".xsl")) + { + (*m)->marcmap = NULL; + if (!((*m)->stylesheet = conf_load_stylesheet(se->service, stylesheets[i]))) + { + yaz_log(YLOG_FATAL|YLOG_ERRNO, "Unable to load stylesheet: %s", + stylesheets[i]); + return -1; + } + } + // marcmap + else if (!strcmp(&stylesheets[i][strlen(stylesheets[i])-5], ".mmap")) { - yaz_log(YLOG_FATAL, "Unable to load stylesheet: %s", - stylesheets[i]); - return -1; + (*m)->stylesheet = NULL; + if (!((*m)->marcmap = marcmap_load(stylesheets[i], se->session_nmem))) + { + yaz_log(YLOG_FATAL|YLOG_ERRNO, "Unable to load marcmap: %s", + stylesheets[i]); + return -1; + } } + m = &(*m)->next; } } @@ -362,11 +396,6 @@ static int prepare_session_database(struct session *se, "No settings associated with %s", sdb->database->url); return -1; } - if (sdb->settings[PZ_NATIVESYNTAX] && !sdb->yaz_marc) - { - if (prepare_yazmarc(sdb) < 0) - return -1; - } if (sdb->settings[PZ_XSLT] && !sdb->map) { if (prepare_map(se, sdb) < 0) @@ -375,21 +404,51 @@ static int prepare_session_database(struct session *se, return 0; } +// called if watch should be removed because http_channel is to be destroyed +static void session_watch_cancel(void *data, struct http_channel *c, + void *data2) +{ + struct session_watchentry *ent = data; + + ent->fun = 0; + ent->data = 0; + ent->obs = 0; +} -void session_set_watch(struct session *s, int what, - session_watchfun fun, void *data) +// set watch. Returns 0=OK, -1 if watch is already set +int session_set_watch(struct session *s, int what, + session_watchfun fun, void *data, + struct http_channel *chan) { + if (s->watchlist[what].fun) + return -1; s->watchlist[what].fun = fun; s->watchlist[what].data = data; + s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what], + session_watch_cancel); + return 0; } void session_alert_watch(struct session *s, int what) { - if (!s->watchlist[what].fun) - return; - (*s->watchlist[what].fun)(s->watchlist[what].data); - s->watchlist[what].fun = 0; - s->watchlist[what].data = 0; + if (s->watchlist[what].fun) + { + /* our watch is no longer associated with http_channel */ + void *data; + session_watchfun fun; + + http_remove_observer(s->watchlist[what].obs); + fun = s->watchlist[what].fun; + data = s->watchlist[what].data; + + /* reset watch before fun is invoked - in case fun wants to set + it again */ + s->watchlist[what].fun = 0; + s->watchlist[what].data = 0; + s->watchlist[what].obs = 0; + + fun(data); + } } //callback for grep_databases @@ -465,67 +524,74 @@ static struct database_criterion *parse_filter(NMEM m, const char *buf) return res; } -char *search(struct session *se, char *query, char *filter) +enum pazpar2_error_code search(struct session *se, + const char *query, const char *filter, + const char **addinfo) { int live_channels = 0; + int no_working = 0; + int no_failed = 0; struct client *cl; struct database_criterion *criteria; yaz_log(YLOG_DEBUG, "Search"); + *addinfo = 0; nmem_reset(se->nmem); + se->relevance = 0; + se->total_records = se->total_hits = se->total_merged = 0; + se->reclist = 0; + se->num_termlists = 0; criteria = parse_filter(se->nmem, filter); - se->requestid++; live_channels = select_targets(se, criteria); if (live_channels) { - int maxrecs = live_channels * global_parameters.toget; - se->num_termlists = 0; + int maxrecs = live_channels * global_parameters.toget; // This is buggy!!! se->reclist = reclist_create(se->nmem, maxrecs); - // This will be initialized in send_search() - se->total_records = se->total_hits = se->total_merged = 0; se->expected_maxrecs = maxrecs; } else - return "NOTARGETS"; - - se->relevance = 0; + return PAZPAR2_NO_TARGETS; for (cl = se->clients; cl; cl = client_next_in_session(cl)) { if (prepare_session_database(se, client_get_database(cl)) < 0) - return "CONFIG_ERROR"; - // Query must parse for all targets - if (client_parse_query(cl, query) < 0) - return "QUERY"; + { + *addinfo = client_get_database(cl)->database->url; + return PAZPAR2_CONFIG_TARGET; + } + // Parse query for target + if (client_parse_query(cl, query) < 0) + no_failed++; + else + { + no_working++; + if (client_prep_connection(cl, se->service->z3950_connect_timeout, + se->service->z3950_session_timeout)) + client_start_search(cl); + } } - for (cl = se->clients; cl; cl = client_next_in_session(cl)) - client_prep_connection(cl); - - return 0; + // If no queries could be mapped, we signal an error + if (no_working == 0) + { + *addinfo = "query"; + return PAZPAR2_MALFORMED_PARAMETER_VALUE; + } + return PAZPAR2_NO_ERROR; } // Creates a new session_database object for a database static void session_init_databases_fun(void *context, struct database *db) { struct session *se = (struct session *) context; + struct conf_service *service = se->service; struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new)); - int num = settings_num(); + int num = settings_num(service); int i; new->database = db; - new->yaz_marc = 0; -#ifdef HAVE_ICU - if (global_parameters.server && global_parameters.server->icu_chn) - new->pct = pp2_charset_create(global_parameters.server->icu_chn); - else - new->pct = pp2_charset_create(0); -#else // HAVE_ICU - new->pct = pp2_charset_create(0); -#endif // HAVE_ICU - new->map = 0; new->settings = nmem_malloc(se->session_nmem, sizeof(struct settings *) * num); @@ -547,10 +613,6 @@ static void session_database_destroy(struct session_database *sdb) for (m = sdb->map; m; m = m->next) xsltFreeStylesheet(m->stylesheet); - if (sdb->yaz_marc) - yaz_marc_destroy(sdb->yaz_marc); - if (sdb->pct) - pp2_charset_destroy(sdb->pct); } // Initialize session_database list -- this represents this session's view @@ -558,7 +620,7 @@ static void session_database_destroy(struct session_database *sdb) void session_init_databases(struct session *se) { se->databases = 0; - grep_databases(se, 0, session_init_databases_fun); + predef_grep_databases(se, se->service, 0, session_init_databases_fun); } // Probably session_init_databases_fun should be refactored instead of @@ -566,7 +628,9 @@ void session_init_databases(struct session *se) static struct session_database *load_session_database(struct session *se, char *id) { - struct database *db = find_database(id, 0); + struct database *db = find_database(id, 0, se->service); + + resolve_database(db); session_init_databases_fun((void*) se, db); // New sdb is head of se->databases list @@ -590,8 +654,9 @@ void session_apply_setting(struct session *se, char *dbname, char *setting, char *value) { struct session_database *sdb = find_session_database(se, dbname); + struct conf_service *service = se->service; struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new)); - int offset = settings_offset_cprefix(setting); + int offset = settings_offset_cprefix(service, setting); if (offset < 0) { @@ -600,10 +665,10 @@ void session_apply_setting(struct session *se, char *dbname, char *setting, } // Jakub: This breaks the filter setting. /*if (offset == PZ_ID) - { - yaz_log(YLOG_WARN, "No need to set pz:id setting. Ignoring"); - return; - }*/ + { + yaz_log(YLOG_WARN, "No need to set pz:id setting. Ignoring"); + return; + }*/ new->precedence = 0; new->target = dbname; new->name = setting; @@ -615,23 +680,16 @@ void session_apply_setting(struct session *se, char *dbname, char *setting, // (happens when a search starts and client connections are prepared) switch (offset) { - case PZ_NATIVESYNTAX: - if (sdb->yaz_marc) - { - yaz_marc_destroy(sdb->yaz_marc); - sdb->yaz_marc = 0; - } - break; - case PZ_XSLT: - if (sdb->map) - { - struct database_retrievalmap *m; - // We don't worry about the map structure -- it's in nmem - for (m = sdb->map; m; m = m->next) - xsltFreeStylesheet(m->stylesheet); - sdb->map = 0; - } - break; + case PZ_XSLT: + if (sdb->map) + { + struct database_retrievalmap *m; + // We don't worry about the map structure -- it's in nmem + for (m = sdb->map; m; m = m->next) + xsltFreeStylesheet(m->stylesheet); + sdb->map = 0; + } + break; } } @@ -639,51 +697,59 @@ void destroy_session(struct session *s) { struct session_database *sdb; - yaz_log(YLOG_LOG, "Destroying session"); while (s->clients) client_destroy(s->clients); for (sdb = s->databases; sdb; sdb = sdb->next) session_database_destroy(sdb); nmem_destroy(s->nmem); + service_destroy(s->service); wrbuf_destroy(s->wrbuf); } -struct session *new_session(NMEM nmem) +struct session *new_session(NMEM nmem, struct conf_service *service) { int i; struct session *session = nmem_malloc(nmem, sizeof(*session)); yaz_log(YLOG_DEBUG, "New Pazpar2 session"); - + + session->service = service; + session->relevance = 0; session->total_hits = 0; session->total_records = 0; + session->number_of_warnings_unknown_elements = 0; + session->number_of_warnings_unknown_metadata = 0; session->num_termlists = 0; session->reclist = 0; - session->requestid = -1; session->clients = 0; session->expected_maxrecs = 0; session->session_nmem = nmem; session->nmem = nmem_create(); session->wrbuf = wrbuf_alloc(); - session_init_databases(session); + session->databases = 0; for (i = 0; i <= SESSION_WATCH_MAX; i++) { session->watchlist[i].data = 0; session->watchlist[i].fun = 0; } - return session; } -struct hitsbytarget *hitsbytarget(struct session *se, int *count) +struct hitsbytarget *hitsbytarget(struct session *se, int *count, NMEM nmem) { - static struct hitsbytarget res[1000]; // FIXME MM + struct hitsbytarget *res = 0; struct client *cl; + size_t sz = 0; + + for (cl = se->clients; cl; cl = client_next_in_session(cl)) + sz++; + res = nmem_malloc(nmem, sizeof(*res) * sz); *count = 0; for (cl = se->clients; cl; cl = client_next_in_session(cl)) { - char *name = session_setting_oneval(client_get_database(cl), PZ_NAME); + const char *name = session_setting_oneval(client_get_database(cl), + PZ_NAME); res[*count].id = client_get_database(cl)->database->url; res[*count].name = *name ? name : "Unknown"; @@ -694,7 +760,6 @@ struct hitsbytarget *hitsbytarget(struct session *se, int *count) res[*count].connected = client_get_connection(cl) ? 1 : 0; (*count)++; } - return res; } @@ -721,14 +786,24 @@ void report_nmem_stats(void) } #endif -struct record_cluster *show_single(struct session *s, int id) +struct record_cluster *show_single(struct session *s, const char *id, + struct record_cluster **prev_r, + struct record_cluster **next_r) { struct record_cluster *r; reclist_rewind(s->reclist); + *prev_r = 0; + *next_r = 0; while ((r = reclist_read_record(s->reclist))) - if (r->recid == id) + { + if (!strcmp(r->recid, id)) + { + *next_r = reclist_read_record(s->reclist); return r; + } + *prev_r = r; + } return 0; } @@ -737,41 +812,51 @@ struct record_cluster **show(struct session *s, struct reclist_sortparms *sp, NMEM nmem_show) { struct record_cluster **recs = nmem_malloc(nmem_show, *num - * sizeof(struct record_cluster *)); + * sizeof(struct record_cluster *)); struct reclist_sortparms *spp; int i; #if USE_TIMING yaz_timing_t t = yaz_timing_create(); #endif - for (spp = sp; spp; spp = spp->next) - if (spp->type == Metadata_sortkey_relevance) - { - relevance_prepare_read(s->relevance, s->reclist); - break; - } - reclist_sort(s->reclist, sp); - - *total = s->reclist->num_records; - *sumhits = s->total_hits; - - for (i = 0; i < start; i++) - if (!reclist_read_record(s->reclist)) - { - *num = 0; - recs = 0; - break; - } - - for (i = 0; i < *num; i++) + if (!s->relevance) { - struct record_cluster *r = reclist_read_record(s->reclist); - if (!r) + *num = 0; + *total = 0; + *sumhits = 0; + recs = 0; + } + else + { + for (spp = sp; spp; spp = spp->next) + if (spp->type == Metadata_sortkey_relevance) + { + relevance_prepare_read(s->relevance, s->reclist); + break; + } + reclist_sort(s->reclist, sp); + + *total = s->reclist->num_records; + *sumhits = s->total_hits; + + for (i = 0; i < start; i++) + if (!reclist_read_record(s->reclist)) + { + *num = 0; + recs = 0; + break; + } + + for (i = 0; i < *num; i++) { - *num = i; - break; + struct record_cluster *r = reclist_read_record(s->reclist); + if (!r) + { + *num = i; + break; + } + recs[i] = r; } - recs[i] = r; } #if USE_TIMING yaz_timing_stop(t); @@ -795,14 +880,12 @@ void statistics(struct session *se, struct statistics *stat) stat->num_no_connection++; switch (client_get_state(cl)) { - case Client_Connecting: stat->num_connecting++; break; - case Client_Initializing: stat->num_initializing++; break; - case Client_Searching: stat->num_searching++; break; - case Client_Presenting: stat->num_presenting++; break; - case Client_Idle: stat->num_idle++; break; - case Client_Failed: stat->num_failed++; break; - case Client_Error: stat->num_error++; break; - default: break; + case Client_Connecting: stat->num_connecting++; break; + case Client_Working: stat->num_working++; break; + case Client_Idle: stat->num_idle++; break; + case Client_Failed: stat->num_failed++; break; + case Client_Error: stat->num_error++; break; + default: break; } count++; } @@ -812,101 +895,261 @@ void statistics(struct session *se, struct statistics *stat) stat->num_clients = count; } -void start_http_listener(void) + +// Master list of connections we're handling events to +static IOCHAN channel_list = 0; /* thread pr */ + +void pazpar2_add_channel(IOCHAN chan) +{ + chan->next = channel_list; + channel_list = chan; +} + +void pazpar2_event_loop() { - char hp[128] = ""; - struct conf_server *ser = global_parameters.server; + event_loop(&channel_list); +} - if (*global_parameters.listener_override) - strcpy(hp, global_parameters.listener_override); - else +static struct record_metadata *record_metadata_init( + NMEM nmem, char *value, enum conf_metadata_type type) +{ + struct record_metadata *rec_md = record_metadata_create(nmem); + if (type == Metadata_type_generic) { - strcpy(hp, ser->host ? ser->host : ""); - if (ser->port) - { - if (*hp) - strcat(hp, ":"); - sprintf(hp + strlen(hp), "%d", ser->port); - } + char * p = value; + p = normalize7bit_generic(p, " ,/.:(["); + + rec_md->data.text.disp = nmem_strdup(nmem, p); + rec_md->data.text.sort = 0; + } + else if (type == Metadata_type_year || type == Metadata_type_date) + { + int first, last; + int longdate = 0; + + if (type == Metadata_type_date) + longdate = 1; + if (extract7bit_dates((char *) value, &first, &last, longdate) < 0) + return 0; + + rec_md->data.number.min = first; + rec_md->data.number.max = last; } - http_init(hp); + else + return 0; + return rec_md; } -void start_proxy(void) +static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no, + struct conf_service *service, NMEM nmem) { - char hp[128] = ""; - struct conf_server *ser = global_parameters.server; - - if (*global_parameters.proxy_override) - strcpy(hp, global_parameters.proxy_override); - else if (ser->proxy_host || ser->proxy_port) + char *mergekey_norm = 0; + xmlNode *root = xmlDocGetRootElement(doc); + WRBUF norm_wr = wrbuf_alloc(); + xmlNode *n; + + /* create mergekey based on mergekey attribute from XSL (if any) */ + xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey"); + if (mergekey) { - strcpy(hp, ser->proxy_host ? ser->proxy_host : ""); - if (ser->proxy_port) + const char *norm_str; + pp2_relevance_token_t prt = + pp2_relevance_tokenize( + service->mergekey_pct, + (const char *) mergekey); + + while ((norm_str = pp2_relevance_token_next(prt))) { - if (*hp) - strcat(hp, ":"); - sprintf(hp + strlen(hp), "%d", ser->proxy_port); + if (*norm_str) + { + if (wrbuf_len(norm_wr)) + wrbuf_puts(norm_wr, " "); + wrbuf_puts(norm_wr, norm_str); + } + } + pp2_relevance_token_destroy(prt); + xmlFree(mergekey); + } + /* append (if any) mergekey=yes metadata values */ + for (n = root->children; n; n = n->next) + { + if (n->type != XML_ELEMENT_NODE) + continue; + if (!strcmp((const char *) n->name, "metadata")) + { + struct conf_metadata *ser_md = 0; + int md_field_id = -1; + + xmlChar *type = xmlGetProp(n, (xmlChar *) "type"); + + if (!type) + continue; + + md_field_id + = conf_service_metadata_field_id(service, + (const char *) type); + if (md_field_id >= 0) + { + ser_md = &service->metadata[md_field_id]; + if (ser_md->mergekey == Metadata_mergekey_yes) + { + xmlChar *value = xmlNodeListGetString(doc, n->children, 1); + if (value) + { + const char *norm_str; + pp2_relevance_token_t prt = + pp2_relevance_tokenize( + service->mergekey_pct, + (const char *) value); + + while ((norm_str = pp2_relevance_token_next(prt))) + { + if (*norm_str) + { + if (wrbuf_len(norm_wr)) + wrbuf_puts(norm_wr, " "); + wrbuf_puts(norm_wr, norm_str); + } + } + xmlFree(value); + pp2_relevance_token_destroy(prt); + } + } + } + xmlFree(type); } } - else - return; - http_set_proxyaddr(hp, ser->myurl ? ser->myurl : ""); + /* generate unique key if none is not generated already or is empty */ + if (wrbuf_len(norm_wr) == 0) + { + wrbuf_printf(norm_wr, "%s-%d", + client_get_database(cl)->database->url, record_no); + } + if (wrbuf_len(norm_wr) > 0) + mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr)); + wrbuf_destroy(norm_wr); + return mergekey_norm; } - -// Master list of connections we're handling events to -static IOCHAN channel_list = 0; -void pazpar2_add_channel(IOCHAN chan) +static const char *str_tok_n(const char *s, const char *delim, + const char **res, size_t *len) { - chan->next = channel_list; - channel_list = chan; + *res = s; + while (*s && !strchr(delim, *s)) + s++; + *len = s - *res; + if (*len == 0) + return 0; + if (*s && strchr(delim, *s)) + s++; + return s; } -void pazpar2_event_loop() +/** \brief see if metadata for pz:recordfilter exists + \param root xml root element of normalized record + \param sdb session database for client + \retval 0 if there is no metadata for pz:recordfilter + \retval 1 if there is metadata for pz:recordfilter + + If there is no pz:recordfilter defined, this function returns 1 + as well. +*/ + +static int check_record_filter(xmlNode *root, struct session_database *sdb) { - event_loop(&channel_list); + int match = 0; + xmlNode *n; + const char *s; + s = session_setting_oneval(sdb, PZ_RECORDFILTER); + + if (!s || !*s) + return 1; + + for (n = root->children; n; n = n->next) + { + if (n->type != XML_ELEMENT_NODE) + continue; + if (!strcmp((const char *) n->name, "metadata")) + { + xmlChar *type = xmlGetProp(n, (xmlChar *) "type"); + if (type) + { + const char *s1 = s; + size_t len; + const char *value; + while ((s1 = str_tok_n(s1, ",", &value, &len)) != 0) + { + if (len == strlen((const char *)type) && + !memcmp((const char *) type, s, len)) + { + xmlChar *value = xmlNodeGetContent(n); + if (value && *value) + { + xmlFree(value); + match = 1; + } + } + } + xmlFree(type); + } + } + } + return match; } -struct record *ingest_record(struct client *cl, Z_External *rec, + +/** \brief ingest XML record + \param cl client holds the result set for record + \param rec record buffer (0 terminated) + \param record_no record position (1, 2, ..) + \returns resulting record or NULL on failure +*/ +struct record *ingest_record(struct client *cl, const char *rec, int record_no) { - xmlDoc *xdoc = normalize_record(client_get_database(cl), rec); + struct session_database *sdb = client_get_database(cl); + struct session *se = client_get_session(cl); + xmlDoc *xdoc = normalize_record(sdb, se, rec); xmlNode *root, *n; struct record *record; struct record_cluster *cluster; - struct session *se = client_get_session(cl); - xmlChar *mergekey, *mergekey_norm; + const char *mergekey_norm; xmlChar *type = 0; xmlChar *value = 0; - struct conf_service *service = global_parameters.server->service; + struct conf_service *service = se->service; if (!xdoc) return 0; root = xmlDocGetRootElement(xdoc); - if (!(mergekey = xmlGetProp(root, (xmlChar *) "mergekey"))) + + if (!check_record_filter(root, sdb)) { - yaz_log(YLOG_WARN, "No mergekey found in record"); + yaz_log(YLOG_WARN, "Filtered out record no %d from %s", record_no, + sdb->database->url); xmlFreeDoc(xdoc); return 0; } + mergekey_norm = get_mergekey(xdoc, cl, record_no, service, se->nmem); + if (!mergekey_norm) + { + yaz_log(YLOG_WARN, "Got no mergekey"); + xmlFreeDoc(xdoc); + return 0; + } record = record_create(se->nmem, - service->num_metadata, service->num_sortkeys, cl); - - mergekey_norm = (xmlChar *) nmem_strdup(se->nmem, (char*) mergekey); - xmlFree(mergekey); - normalize7bit_mergekey((char *) mergekey_norm, 0); + service->num_metadata, service->num_sortkeys, cl, + record_no); cluster = reclist_insert(se->reclist, - global_parameters.server->service, + service, record, (char *) mergekey_norm, &se->total_merged); if (global_parameters.dump_records) - yaz_log(YLOG_LOG, "Cluster id %d from %s (#%d)", cluster->recid, - client_get_database(cl)->database->url, record_no); + yaz_log(YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid, + sdb->database->url, record_no); if (!cluster) { /* no room for record */ @@ -914,17 +1157,17 @@ struct record *ingest_record(struct client *cl, Z_External *rec, return 0; } 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) { + pp2_relevance_token_t prt; if (type) xmlFree(type); if (value) xmlFree(value); type = value = 0; - + if (n->type != XML_ELEMENT_NODE) continue; if (!strcmp((const char *) n->name, "metadata")) @@ -935,61 +1178,51 @@ struct record *ingest_record(struct client *cl, Z_External *rec, struct record_metadata *rec_md = 0; int md_field_id = -1; int sk_field_id = -1; - int first, last; - + type = xmlGetProp(n, (xmlChar *) "type"); - value = xmlNodeListGetString(xdoc, n->children, 0); - - if (!type || !value) + value = xmlNodeListGetString(xdoc, n->children, 1); + + if (!type || !value || !*value) continue; - + 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); + if (se->number_of_warnings_unknown_metadata == 0) + { + yaz_log(YLOG_WARN, + "Ignoring unknown metadata element: %s", type); + } + se->number_of_warnings_unknown_metadata++; 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]; } - // Find out where we are putting it - based on merge or not - if (ser_md->merge == Metadata_merge_no) - wheretoput = &record->metadata[md_field_id]; - else - wheretoput = &cluster->metadata[md_field_id]; - - // create new record_metadata - rec_md = record_metadata_create(se->nmem); - - // and polulate with data: - // type based charmapping decisions follow here - if (ser_md->type == Metadata_type_generic) - { - - char * p = (char *) value; - p = normalize7bit_generic(p, " ,/.:(["); - - rec_md->data.text = nmem_strdup(se->nmem, p); - - } - else if (ser_md->type == Metadata_type_year) - { - if (extract7bit_years((char *) value, &first, &last) < 0) - continue; - } - else + // non-merged metadata + rec_md = record_metadata_init(se->nmem, (char *) value, + ser_md->type); + if (!rec_md) { - yaz_log(YLOG_WARN, - "Unknown type in metadata element %s", type); + yaz_log(YLOG_WARN, "bad metadata data '%s' for element '%s'", + value, type); continue; } + wheretoput = &record->metadata[md_field_id]; + while (*wheretoput) + wheretoput = &(*wheretoput)->next; + *wheretoput = rec_md; + + // merged metadata + rec_md = record_metadata_init(se->nmem, (char *) value, + ser_md->type); + wheretoput = &cluster->metadata[md_field_id]; // and polulate with data: // assign cluster or record based on merge action @@ -997,8 +1230,8 @@ struct record *ingest_record(struct client *cl, Z_External *rec, { struct record_metadata *mnode; for (mnode = *wheretoput; mnode; mnode = mnode->next) - if (!strcmp((const char *) mnode->data.text, - rec_md->data.text)) + if (!strcmp((const char *) mnode->data.text.disp, + rec_md->data.text.disp)) break; if (!mnode) { @@ -1009,25 +1242,50 @@ struct record *ingest_record(struct client *cl, Z_External *rec, else if (ser_md->merge == Metadata_merge_longest) { if (!*wheretoput - || strlen(rec_md->data.text) - > strlen((*wheretoput)->data.text)) + || strlen(rec_md->data.text.disp) + > strlen((*wheretoput)->data.text.disp)) { *wheretoput = rec_md; if (ser_sk) { - char *s = nmem_strdup(se->nmem, rec_md->data.text); + const char *sort_str = 0; + int skip_article = + ser_sk->type == Metadata_sortkey_skiparticle; + if (!cluster->sortkeys[sk_field_id]) cluster->sortkeys[sk_field_id] = nmem_malloc(se->nmem, sizeof(union data_types)); - normalize7bit_mergekey(s, - (ser_sk->type == Metadata_sortkey_skiparticle)); - cluster->sortkeys[sk_field_id]->text = s; + + prt = pp2_relevance_tokenize( + service->sort_pct, + rec_md->data.text.disp); + + pp2_relevance_token_next(prt); + + sort_str = pp2_get_sort(prt, skip_article); + + cluster->sortkeys[sk_field_id]->text.disp = + rec_md->data.text.disp; + if (!sort_str) + { + sort_str = rec_md->data.text.disp; + yaz_log(YLOG_WARN, + "Could not make sortkey. Bug #1858"); + } + cluster->sortkeys[sk_field_id]->text.sort = + nmem_strdup(se->nmem, sort_str); +#if 0 + yaz_log(YLOG_LOG, "text disp=%s", + cluster->sortkeys[sk_field_id]->text.disp); + yaz_log(YLOG_LOG, "text sort=%s", + cluster->sortkeys[sk_field_id]->text.sort); +#endif + pp2_relevance_token_destroy(prt); } } } - else if (ser_md->merge == Metadata_merge_all - || ser_md->merge == Metadata_merge_no) + else if (ser_md->merge == Metadata_merge_all) { rec_md->next = *wheretoput; *wheretoput = rec_md; @@ -1037,28 +1295,19 @@ struct record *ingest_record(struct client *cl, Z_External *rec, if (!*wheretoput) { *wheretoput = rec_md; - (*wheretoput)->data.number.min = first; - (*wheretoput)->data.number.max = last; if (ser_sk) cluster->sortkeys[sk_field_id] = &rec_md->data; } else { - if (first < (*wheretoput)->data.number.min) - (*wheretoput)->data.number.min = first; - if (last > (*wheretoput)->data.number.max) - (*wheretoput)->data.number.max = last; - } -#ifdef GAGA - if (ser_sk) - { - union data_types *sdata - = cluster->sortkeys[sk_field_id]; - yaz_log(YLOG_LOG, "SK range: %d-%d", - sdata->number.min, sdata->number.max); + int this_min = rec_md->data.number.min; + int this_max = rec_md->data.number.max; + if (this_min < (*wheretoput)->data.number.min) + (*wheretoput)->data.number.min = this_min; + if (this_max > (*wheretoput)->data.number.max) + (*wheretoput)->data.number.max = this_max; } -#endif } @@ -1073,11 +1322,11 @@ struct record *ingest_record(struct client *cl, Z_External *rec, if (ser_md->type == Metadata_type_year) { char year[64]; - sprintf(year, "%d", last); + sprintf(year, "%d", rec_md->data.number.max); add_facet(se, (char *) type, year); - if (first != last) + if (rec_md->data.number.max != rec_md->data.number.min) { - sprintf(year, "%d", first); + sprintf(year, "%d", rec_md->data.number.min); add_facet(se, (char *) type, year); } } @@ -1091,8 +1340,12 @@ struct record *ingest_record(struct client *cl, Z_External *rec, type = value = 0; } else - yaz_log(YLOG_WARN, - "Unexpected element %s in internal record", n->name); + { + if (se->number_of_warnings_unknown_elements == 0) + yaz_log(YLOG_WARN, + "Unexpected element in internal record: %s", n->name); + se->number_of_warnings_unknown_elements++; + } } if (type) xmlFree(type); @@ -1112,7 +1365,9 @@ struct record *ingest_record(struct client *cl, Z_External *rec, /* * Local variables: * c-basic-offset: 4 + * c-file-style: "Stroustrup" * indent-tabs-mode: nil * End: * vim: shiftwidth=4 tabstop=8 expandtab */ +