1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2011 Index Data
4 Pazpar2 is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
9 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 \brief high-level logic; mostly user sessions and settings
46 #include <yaz/marcdisp.h>
47 #include <yaz/comstack.h>
48 #include <yaz/tcpip.h>
49 #include <yaz/proto.h>
50 #include <yaz/readconf.h>
51 #include <yaz/pquery.h>
52 #include <yaz/otherinfo.h>
53 #include <yaz/yaz-util.h>
55 #include <yaz/query-charset.h>
56 #include <yaz/querytowrbuf.h>
57 #include <yaz/oid_db.h>
58 #include <yaz/snprintf.h>
59 #include <yaz/gettimeofday.h>
63 #include <yaz/timing.h>
67 #include "parameters.h"
71 #include "termlists.h"
73 #include "relevance.h"
77 #include "normalize7bit.h"
79 #define TERMLIST_HIGH_SCORE 25
83 #define MAX(a,b) ((a)>(b)?(a):(b))
85 // Note: Some things in this structure will eventually move to configuration
86 struct parameters global_parameters =
90 0, // predictable sessions
94 struct client *client;
95 struct client_list *next;
98 /* session counting (1) , disable client counting (0) */
99 static YAZ_MUTEX g_session_mutex = 0;
100 static int no_sessions = 0;
101 static int no_session_total = 0;
103 static int session_use(int delta)
106 if (!g_session_mutex)
107 yaz_mutex_create(&g_session_mutex);
108 yaz_mutex_enter(g_session_mutex);
109 no_sessions += delta;
111 no_session_total += delta;
112 sessions = no_sessions;
113 yaz_mutex_leave(g_session_mutex);
114 yaz_log(YLOG_DEBUG, "%s sesions=%d", delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), no_sessions);
118 int sessions_count(void) {
119 return session_use(0);
122 int session_count_total(void) {
124 if (!g_session_mutex)
126 yaz_mutex_enter(g_session_mutex);
127 total = no_session_total;
128 yaz_mutex_leave(g_session_mutex);
133 static void log_xml_doc(xmlDoc *doc)
135 FILE *lf = yaz_log_file();
138 #if LIBXML_VERSION >= 20600
139 xmlDocDumpFormatMemory(doc, &result, &len, 1);
141 xmlDocDumpMemory(doc, &result, &len);
145 (void) fwrite(result, 1, len, lf);
151 static void session_enter(struct session *s)
153 yaz_mutex_enter(s->session_mutex);
156 static void session_leave(struct session *s)
158 yaz_mutex_leave(s->session_mutex);
161 // Recursively traverse query structure to extract terms.
162 void pull_terms(NMEM nmem, struct ccl_rpn_node *n, char **termlist, int *num)
174 pull_terms(nmem, n->u.p[0], termlist, num);
175 pull_terms(nmem, n->u.p[1], termlist, num);
178 nmem_strsplit(nmem, " ", n->u.t.term, &words, &numwords);
179 for (i = 0; i < numwords; i++)
180 termlist[(*num)++] = words[i];
188 void add_facet(struct session *s, const char *type, const char *value, int count)
190 struct conf_service *service = s->service;
191 pp2_relevance_token_t prt;
192 const char *facet_component;
193 WRBUF facet_wrbuf = wrbuf_alloc();
194 prt = pp2_relevance_tokenize(service->facet_pct);
196 pp2_relevance_first(prt, value, 0);
197 while ((facet_component = pp2_relevance_token_next(prt)))
199 if (*facet_component)
201 if (wrbuf_len(facet_wrbuf))
202 wrbuf_puts(facet_wrbuf, " ");
203 wrbuf_puts(facet_wrbuf, facet_component);
206 pp2_relevance_token_destroy(prt);
208 if (wrbuf_len(facet_wrbuf))
211 for (i = 0; i < s->num_termlists; i++)
212 if (!strcmp(s->termlists[i].name, type))
214 if (i == s->num_termlists)
216 if (i == SESSION_MAX_TERMLISTS)
218 session_log(s, YLOG_FATAL, "Too many termlists");
219 wrbuf_destroy(facet_wrbuf);
223 s->termlists[i].name = nmem_strdup(s->nmem, type);
224 s->termlists[i].termlist
225 = termlist_create(s->nmem, TERMLIST_HIGH_SCORE);
226 s->num_termlists = i + 1;
230 session_log(s, YLOG_DEBUG, "Facets for %s: %s norm:%s (%d)", type, value, wrbuf_cstr(facet_wrbuf), count);
232 termlist_insert(s->termlists[i].termlist, wrbuf_cstr(facet_wrbuf),
235 wrbuf_destroy(facet_wrbuf);
238 static xmlDoc *record_to_xml(struct session *se,
239 struct session_database *sdb, const char *rec)
241 struct database *db = sdb->database;
244 rdoc = xmlParseMemory(rec, strlen(rec));
248 session_log(se, YLOG_FATAL, "Non-wellformed XML received from %s",
253 if (global_parameters.dump_records)
255 session_log(se, YLOG_LOG, "Un-normalized record from %s", db->url);
262 #define MAX_XSLT_ARGS 16
264 // Add static values from session database settings if applicable
265 static void insert_settings_parameters(struct session_database *sdb,
266 struct conf_service *service,
274 for (i = 0; i < service->num_metadata; i++)
276 struct conf_metadata *md = &service->metadata[i];
279 if (md->setting == Metadata_setting_parameter &&
280 (setting = settings_lookup_offset(service, md->name)) >= 0)
282 const char *val = session_setting_oneval(sdb, setting);
283 if (val && nparms < MAX_XSLT_ARGS)
286 int len = strlen(val);
287 buf = nmem_malloc(nmem, len + 3);
289 strcpy(buf + 1, val);
292 parms[offset++] = md->name;
293 parms[offset++] = buf;
301 // Add static values from session database settings if applicable
302 static void insert_settings_values(struct session_database *sdb, xmlDoc *doc,
303 struct conf_service *service)
307 for (i = 0; i < service->num_metadata; i++)
309 struct conf_metadata *md = &service->metadata[i];
312 if (md->setting == Metadata_setting_postproc &&
313 (offset = settings_lookup_offset(service, md->name)) >= 0)
315 const char *val = session_setting_oneval(sdb, offset);
318 xmlNode *r = xmlDocGetRootElement(doc);
319 xmlNode *n = xmlNewTextChild(r, 0, (xmlChar *) "metadata",
321 xmlSetProp(n, (xmlChar *) "type", (xmlChar *) md->name);
327 static xmlDoc *normalize_record(struct session *se,
328 struct session_database *sdb,
329 struct conf_service *service,
330 const char *rec, NMEM nmem)
332 xmlDoc *rdoc = record_to_xml(se, sdb, rec);
336 char *parms[MAX_XSLT_ARGS*2+1];
338 insert_settings_parameters(sdb, service, parms, nmem);
340 if (normalize_record_transform(sdb->map, &rdoc, (const char **)parms))
342 session_log(se, YLOG_WARN, "Normalize failed from %s",
347 insert_settings_values(sdb, rdoc, service);
349 if (global_parameters.dump_records)
351 session_log(se, YLOG_LOG, "Normalized record from %s",
360 void session_settings_dump(struct session *se,
361 struct session_database *db,
366 int i, num = db->num_settings;
367 for (i = 0; i < num; i++)
369 struct setting *s = db->settings[i];
370 for (;s ; s = s->next)
372 wrbuf_puts(w, "<set name=\"");
373 wrbuf_xmlputs(w, s->name);
374 wrbuf_puts(w, "\" value=\"");
375 wrbuf_xmlputs(w, s->value);
376 wrbuf_puts(w, "\"/>");
384 // Retrieve first defined value for 'name' for given database.
385 // Will be extended to take into account user associated with session
386 const char *session_setting_oneval(struct session_database *db, int offset)
388 if (offset >= db->num_settings || !db->settings[offset])
390 return db->settings[offset]->value;
393 // Prepare XSLT stylesheets for record normalization
394 // Structures are allocated on the session_wide nmem to avoid having
395 // to recompute this for every search. This would lead
396 // to leaking if a single session was to repeatedly change the PZ_XSLT
397 // setting. However, this is not a realistic use scenario.
398 static int prepare_map(struct session *se, struct session_database *sdb)
404 session_log(se, YLOG_WARN, "No settings on %s", sdb->database->url);
407 if ((s = session_setting_oneval(sdb, PZ_XSLT)))
409 char auto_stylesheet[256];
411 if (!strcmp(s, "auto"))
413 const char *request_syntax = session_setting_oneval(
414 sdb, PZ_REQUESTSYNTAX);
418 yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet),
419 "%s.xsl", request_syntax);
420 for (cp = auto_stylesheet; *cp; cp++)
422 /* deliberately only consider ASCII */
423 if (*cp > 32 && *cp < 127)
430 session_log(se, YLOG_WARN,
431 "No pz:requestsyntax for auto stylesheet");
434 sdb->map = normalize_cache_get(se->normalize_cache,
435 se->service->server->config, s);
442 // This analyzes settings and recomputes any supporting data structures
444 static int prepare_session_database(struct session *se,
445 struct session_database *sdb)
449 session_log(se, YLOG_WARN,
450 "No settings associated with %s", sdb->database->url);
453 if (sdb->settings[PZ_XSLT] && !sdb->map)
455 if (prepare_map(se, sdb) < 0)
461 // called if watch should be removed because http_channel is to be destroyed
462 static void session_watch_cancel(void *data, struct http_channel *c,
465 struct session_watchentry *ent = data;
472 // set watch. Returns 0=OK, -1 if watch is already set
473 int session_set_watch(struct session *s, int what,
474 session_watchfun fun, void *data,
475 struct http_channel *chan)
479 if (s->watchlist[what].fun)
484 s->watchlist[what].fun = fun;
485 s->watchlist[what].data = data;
486 s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
487 session_watch_cancel);
494 void session_alert_watch(struct session *s, int what)
498 if (s->watchlist[what].fun)
500 /* our watch is no longer associated with http_channel */
502 session_watchfun fun;
504 http_remove_observer(s->watchlist[what].obs);
505 fun = s->watchlist[what].fun;
506 data = s->watchlist[what].data;
508 /* reset watch before fun is invoked - in case fun wants to set
510 s->watchlist[what].fun = 0;
511 s->watchlist[what].data = 0;
512 s->watchlist[what].obs = 0;
515 session_log(s, YLOG_DEBUG,
516 "Alert Watch: %d calling function: %p", what, fun);
523 //callback for grep_databases
524 static void select_targets_callback(void *context, struct session_database *db)
526 struct session *se = (struct session*) context;
527 struct client *cl = client_create();
528 struct client_list *l;
529 client_set_database(cl, db);
531 client_set_session(cl, se);
533 l = xmalloc(sizeof(*l));
535 l->next = se->clients;
539 static void session_remove_clients(struct session *se)
541 struct client_list *l;
550 struct client_list *l_next = l->next;
551 client_lock(l->client);
552 client_set_session(l->client, 0);
553 client_set_database(l->client, 0);
554 client_unlock(l->client);
555 client_destroy(l->client);
561 // Associates a set of clients with a session;
562 // Note: Session-databases represent databases with per-session
564 static int select_targets(struct session *se, const char *filter)
566 return session_grep_databases(se, filter, select_targets_callback);
569 int session_active_clients(struct session *s)
571 struct client_list *l;
574 for (l = s->clients; l; l = l->next)
575 if (client_is_active(l->client))
581 int session_is_preferred_clients_ready(struct session *s)
583 struct client_list *l;
586 for (l = s->clients; l; l = l->next)
587 if (client_is_active_preferred(l->client))
589 session_log(s, YLOG_DEBUG, "Has %d active preferred clients.", res);
593 enum pazpar2_error_code search(struct session *se,
595 const char *startrecs, const char *maxrecs,
597 const char **addinfo)
599 int live_channels = 0;
602 struct client_list *l;
605 session_log(se, YLOG_DEBUG, "Search");
609 session_remove_clients(se);
612 reclist_destroy(se->reclist);
614 relevance_destroy(&se->relevance);
615 nmem_reset(se->nmem);
616 se->total_records = se->total_hits = se->total_merged = 0;
617 se->num_termlists = 0;
618 live_channels = select_targets(se, filter);
622 return PAZPAR2_NO_TARGETS;
624 se->reclist = reclist_create(se->nmem);
626 yaz_gettimeofday(&tval);
630 for (l = se->clients; l; l = l->next)
632 struct client *cl = l->client;
635 client_set_maxrecs(cl, atoi(maxrecs));
637 client_set_startrecs(cl, atoi(startrecs));
638 if (prepare_session_database(se, client_get_database(cl)) < 0)
640 else if (client_parse_query(cl, query) < 0)
645 if (client_prep_connection(cl, se->service->z3950_operation_timeout,
646 se->service->z3950_session_timeout,
647 se->service->server->iochan_man,
649 client_start_search(cl);
658 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
661 return PAZPAR2_NO_TARGETS;
663 return PAZPAR2_NO_ERROR;
666 // Creates a new session_database object for a database
667 static void session_init_databases_fun(void *context, struct database *db)
669 struct session *se = (struct session *) context;
670 struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
676 assert(db->settings);
677 new->settings = nmem_malloc(se->session_nmem,
678 sizeof(struct settings *) * db->num_settings);
679 new->num_settings = db->num_settings;
680 for (i = 0; i < db->num_settings; i++)
682 struct setting *setting = db->settings[i];
683 new->settings[i] = setting;
685 new->next = se->databases;
689 // Doesn't free memory associated with sdb -- nmem takes care of that
690 static void session_database_destroy(struct session_database *sdb)
695 // Initialize session_database list -- this represents this session's view
696 // of the database list -- subject to modification by the settings ws command
697 void session_init_databases(struct session *se)
700 predef_grep_databases(se, se->service, session_init_databases_fun);
703 // Probably session_init_databases_fun should be refactored instead of
705 static struct session_database *load_session_database(struct session *se,
708 struct database *db = new_database(id, se->session_nmem);
710 resolve_database(se->service, db);
712 session_init_databases_fun((void*) se, db);
714 // New sdb is head of se->databases list
715 return se->databases;
718 // Find an existing session database. If not found, load it
719 static struct session_database *find_session_database(struct session *se,
722 struct session_database *sdb;
724 for (sdb = se->databases; sdb; sdb = sdb->next)
725 if (!strcmp(sdb->database->url, id))
727 return load_session_database(se, id);
730 // Apply a session override to a database
731 void session_apply_setting(struct session *se, char *dbname, char *setting,
734 struct session_database *sdb = find_session_database(se, dbname);
735 struct conf_service *service = se->service;
736 struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
737 int offset = settings_create_offset(service, setting);
739 expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
742 new->target = dbname;
745 new->next = sdb->settings[offset];
746 sdb->settings[offset] = new;
748 // Force later recompute of settings-driven data structures
749 // (happens when a search starts and client connections are prepared)
761 void session_destroy(struct session *se) {
762 struct session_database *sdb;
763 session_log(se, YLOG_DEBUG, "Destroying");
765 session_remove_clients(se);
767 for (sdb = se->databases; sdb; sdb = sdb->next)
768 session_database_destroy(sdb);
769 normalize_cache_destroy(se->normalize_cache);
770 relevance_destroy(&se->relevance);
771 reclist_destroy(se->reclist);
772 nmem_destroy(se->nmem);
773 service_destroy(se->service);
774 yaz_mutex_destroy(&se->session_mutex);
775 wrbuf_destroy(se->wrbuf);
778 /* Depreciated: use session_destroy */
779 void destroy_session(struct session *se)
784 size_t session_get_memory_status(struct session *session) {
788 session_enter(session);
789 session_nmem = nmem_total(session->nmem);
790 session_leave(session);
795 struct session *new_session(NMEM nmem, struct conf_service *service,
799 struct session *session = nmem_malloc(nmem, sizeof(*session));
803 sprintf(tmp_str, "session#%u", session_id);
805 session->session_id = session_id;
806 session_log(session, YLOG_DEBUG, "New");
807 session->service = service;
808 session->relevance = 0;
809 session->total_hits = 0;
810 session->total_records = 0;
811 session->number_of_warnings_unknown_elements = 0;
812 session->number_of_warnings_unknown_metadata = 0;
813 session->num_termlists = 0;
814 session->reclist = 0;
815 session->clients = 0;
816 session->session_nmem = nmem;
817 session->nmem = nmem_create();
818 session->wrbuf = wrbuf_alloc();
819 session->databases = 0;
820 for (i = 0; i <= SESSION_WATCH_MAX; i++)
822 session->watchlist[i].data = 0;
823 session->watchlist[i].fun = 0;
825 session->normalize_cache = normalize_cache_create();
826 session->session_mutex = 0;
827 pazpar2_mutex_create(&session->session_mutex, tmp_str);
832 struct hitsbytarget *hitsbytarget(struct session *se, int *count, NMEM nmem)
834 struct hitsbytarget *res = 0;
835 struct client_list *l;
839 for (l = se->clients; l; l = l->next)
842 res = nmem_malloc(nmem, sizeof(*res) * sz);
844 for (l = se->clients; l; l = l->next)
846 struct client *cl = l->client;
847 WRBUF w = wrbuf_alloc();
848 const char *name = session_setting_oneval(client_get_database(cl),
851 res[*count].id = client_get_database(cl)->database->url;
852 res[*count].name = *name ? name : "Unknown";
853 res[*count].hits = client_get_hits(cl);
854 res[*count].records = client_get_num_records(cl);
855 res[*count].diagnostic = client_get_diagnostic(cl);
856 res[*count].state = client_get_state_str(cl);
857 res[*count].connected = client_get_connection(cl) ? 1 : 0;
858 session_settings_dump(se, client_get_database(cl), w);
859 res[*count].settings_xml = nmem_strdup(nmem, wrbuf_cstr(w));
867 struct termlist_score **get_termlist_score(struct session *se,
868 const char *name, int *num)
871 struct termlist_score **tl = 0;
874 for (i = 0; i < se->num_termlists; i++)
875 if (!strcmp((const char *) se->termlists[i].name, name))
877 tl = termlist_highscore(se->termlists[i].termlist, num);
884 #ifdef MISSING_HEADERS
885 void report_nmem_stats(void)
887 size_t in_use, is_free;
889 nmem_get_memory_in_use(&in_use);
890 nmem_get_memory_free(&is_free);
892 yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
893 (long) in_use, (long) is_free);
897 struct record_cluster *show_single_start(struct session *se, const char *id,
898 struct record_cluster **prev_r,
899 struct record_cluster **next_r)
901 struct record_cluster *r = 0;
908 reclist_enter(se->reclist);
909 while ((r = reclist_read_record(se->reclist)))
911 if (!strcmp(r->recid, id))
913 *next_r = reclist_read_record(se->reclist);
918 reclist_leave(se->reclist);
925 void show_single_stop(struct session *se, struct record_cluster *rec)
930 struct record_cluster **show_range_start(struct session *se,
931 struct reclist_sortparms *sp,
932 int start, int *num, int *total, Odr_int *sumhits)
934 struct record_cluster **recs;
935 struct reclist_sortparms *spp;
938 yaz_timing_t t = yaz_timing_create();
941 recs = nmem_malloc(se->nmem, *num * sizeof(struct record_cluster *));
951 for (spp = sp; spp; spp = spp->next)
952 if (spp->type == Metadata_sortkey_relevance)
954 relevance_prepare_read(se->relevance, se->reclist);
957 reclist_sort(se->reclist, sp);
959 reclist_enter(se->reclist);
960 *total = reclist_get_num_records(se->reclist);
961 *sumhits = se->total_hits;
963 for (i = 0; i < start; i++)
964 if (!reclist_read_record(se->reclist))
971 for (i = 0; i < *num; i++)
973 struct record_cluster *r = reclist_read_record(se->reclist);
981 reclist_leave(se->reclist);
985 yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
986 yaz_timing_get_real(t), yaz_timing_get_user(t),
987 yaz_timing_get_sys(t));
988 yaz_timing_destroy(&t);
993 void show_range_stop(struct session *se, struct record_cluster **recs)
998 void statistics(struct session *se, struct statistics *stat)
1000 struct client_list *l;
1003 memset(stat, 0, sizeof(*stat));
1004 for (l = se->clients; l; l = l->next)
1006 struct client *cl = l->client;
1007 if (!client_get_connection(cl))
1008 stat->num_no_connection++;
1009 switch (client_get_state(cl))
1011 case Client_Connecting: stat->num_connecting++; break;
1012 case Client_Working: stat->num_working++; break;
1013 case Client_Idle: stat->num_idle++; break;
1014 case Client_Failed: stat->num_failed++; break;
1015 case Client_Error: stat->num_error++; break;
1020 stat->num_hits = se->total_hits;
1021 stat->num_records = se->total_records;
1023 stat->num_clients = count;
1026 static struct record_metadata *record_metadata_init(
1027 NMEM nmem, const char *value, enum conf_metadata_type type,
1028 struct _xmlAttr *attr)
1030 struct record_metadata *rec_md = record_metadata_create(nmem);
1031 struct record_metadata_attr **attrp = &rec_md->attributes;
1033 for (; attr; attr = attr->next)
1035 if (attr->children && attr->children->content)
1037 if (strcmp((const char *) attr->name, "type"))
1038 { /* skip the "type" attribute.. Its value is already part of
1039 the element in output (md-%s) and so repeating it here
1041 *attrp = nmem_malloc(nmem, sizeof(**attrp));
1043 nmem_strdup(nmem, (const char *) attr->name);
1045 nmem_strdup(nmem, (const char *) attr->children->content);
1046 attrp = &(*attrp)->next;
1052 if (type == Metadata_type_generic)
1054 char *p = nmem_strdup(nmem, value);
1056 p = normalize7bit_generic(p, " ,/.:([");
1058 rec_md->data.text.disp = p;
1059 rec_md->data.text.sort = 0;
1061 else if (type == Metadata_type_year || type == Metadata_type_date)
1066 if (type == Metadata_type_date)
1068 if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
1071 rec_md->data.number.min = first;
1072 rec_md->data.number.max = last;
1079 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
1080 struct conf_service *service, WRBUF norm_wr)
1084 for (n = root->children; n; n = n->next)
1086 if (n->type != XML_ELEMENT_NODE)
1088 if (!strcmp((const char *) n->name, "metadata"))
1090 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1092 yaz_log(YLOG_FATAL, "Missing type attribute on metadata element. Skipping!");
1094 else if (!strcmp(name, (const char *) type))
1096 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
1099 const char *norm_str;
1100 pp2_relevance_token_t prt =
1101 pp2_relevance_tokenize(service->mergekey_pct);
1103 pp2_relevance_first(prt, (const char *) value, 0);
1104 if (wrbuf_len(norm_wr) > 0)
1105 wrbuf_puts(norm_wr, " ");
1106 wrbuf_puts(norm_wr, name);
1108 pp2_relevance_token_next(prt)))
1112 wrbuf_puts(norm_wr, " ");
1113 wrbuf_puts(norm_wr, norm_str);
1117 pp2_relevance_token_destroy(prt);
1127 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
1128 struct conf_service *service, NMEM nmem)
1130 char *mergekey_norm = 0;
1131 xmlNode *root = xmlDocGetRootElement(doc);
1132 WRBUF norm_wr = wrbuf_alloc();
1134 /* consider mergekey from XSL first */
1135 xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
1138 const char *norm_str;
1139 pp2_relevance_token_t prt =
1140 pp2_relevance_tokenize(service->mergekey_pct);
1142 pp2_relevance_first(prt, (const char *) mergekey, 0);
1143 while ((norm_str = pp2_relevance_token_next(prt)))
1147 if (wrbuf_len(norm_wr))
1148 wrbuf_puts(norm_wr, " ");
1149 wrbuf_puts(norm_wr, norm_str);
1152 pp2_relevance_token_destroy(prt);
1157 /* no mergekey defined in XSL. Look for mergekey metadata instead */
1159 for (field_id = 0; field_id < service->num_metadata; field_id++)
1161 struct conf_metadata *ser_md = &service->metadata[field_id];
1162 if (ser_md->mergekey != Metadata_mergekey_no)
1164 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1166 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1168 /* no mergekey on this one and it is required..
1169 Generate unique key instead */
1170 wrbuf_rewind(norm_wr);
1177 /* generate unique key if none is not generated already or is empty */
1178 if (wrbuf_len(norm_wr) == 0)
1180 wrbuf_printf(norm_wr, "%s-%d",
1181 client_get_database(cl)->database->url, record_no);
1183 if (wrbuf_len(norm_wr) > 0)
1184 mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1185 wrbuf_destroy(norm_wr);
1186 return mergekey_norm;
1189 /** \brief see if metadata for pz:recordfilter exists
1190 \param root xml root element of normalized record
1191 \param sdb session database for client
1192 \retval 0 if there is no metadata for pz:recordfilter
1193 \retval 1 if there is metadata for pz:recordfilter
1195 If there is no pz:recordfilter defined, this function returns 1
1199 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1204 s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1209 for (n = root->children; n; n = n->next)
1211 if (n->type != XML_ELEMENT_NODE)
1213 if (!strcmp((const char *) n->name, "metadata"))
1215 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1222 if ((eq = strchr(s, '=')))
1224 else if ((eq = strchr(s, '~')))
1230 if (len == strlen((const char *)type) &&
1231 !memcmp((const char *) type, s, len))
1233 xmlChar *value = xmlNodeGetContent(n);
1234 if (value && *value)
1237 (substring && strstr((const char *) value, eq+1)) ||
1238 (!substring && !strcmp((const char *) value, eq + 1)))
1251 static int ingest_to_cluster(struct client *cl,
1255 const char *mergekey_norm);
1257 /** \brief ingest XML record
1258 \param cl client holds the result set for record
1259 \param rec record buffer (0 terminated)
1260 \param record_no record position (1, 2, ..)
1261 \param nmem working NMEM
1266 int ingest_record(struct client *cl, const char *rec,
1267 int record_no, NMEM nmem)
1269 struct session *se = client_get_session(cl);
1271 struct session_database *sdb = client_get_database(cl);
1272 struct conf_service *service = se->service;
1273 xmlDoc *xdoc = normalize_record(se, sdb, service, rec, nmem);
1275 const char *mergekey_norm;
1280 root = xmlDocGetRootElement(xdoc);
1282 if (!check_record_filter(root, sdb))
1284 session_log(se, YLOG_LOG, "Filtered out record no %d from %s",
1285 record_no, sdb->database->url);
1290 mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem);
1293 session_log(se, YLOG_WARN, "Got no mergekey");
1298 if (client_get_session(cl) == se)
1299 ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1306 static int ingest_to_cluster(struct client *cl,
1310 const char *mergekey_norm)
1315 struct session_database *sdb = client_get_database(cl);
1316 struct session *se = client_get_session(cl);
1317 struct conf_service *service = se->service;
1318 struct record *record = record_create(se->nmem,
1319 service->num_metadata,
1320 service->num_sortkeys, cl,
1322 struct record_cluster *cluster = reclist_insert(se->reclist,
1328 const char *use_term_factor_str = session_setting_oneval(sdb, PZ_TERMLIST_TERM_FACTOR);
1329 int use_term_factor = 0;
1330 int term_factor = 1;
1331 if (use_term_factor_str && use_term_factor_str[0] != 0)
1332 use_term_factor = atoi(use_term_factor_str);
1333 if (use_term_factor) {
1334 int maxrecs = client_get_maxrecs(cl);
1335 int hits = (int) client_get_hits(cl);
1336 term_factor = MAX(hits, maxrecs) / MAX(1, maxrecs);
1337 assert(term_factor >= 1);
1338 yaz_log(YLOG_DEBUG, "Using term factor: %d (%d / %d)", term_factor, MAX(hits, maxrecs), MAX(1, maxrecs));
1343 if (global_parameters.dump_records)
1344 session_log(se, YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1345 sdb->database->url, record_no);
1346 relevance_newrec(se->relevance, cluster);
1348 // now parsing XML record and adding data to cluster or record metadata
1349 for (n = root->children; n; n = n->next)
1351 pp2_relevance_token_t prt;
1358 if (n->type != XML_ELEMENT_NODE)
1360 if (!strcmp((const char *) n->name, "metadata"))
1362 struct conf_metadata *ser_md = 0;
1363 struct conf_sortkey *ser_sk = 0;
1364 struct record_metadata **wheretoput = 0;
1365 struct record_metadata *rec_md = 0;
1366 int md_field_id = -1;
1367 int sk_field_id = -1;
1369 type = xmlGetProp(n, (xmlChar *) "type");
1370 value = xmlNodeListGetString(xdoc, n->children, 1);
1372 if (!type || !value || !*value)
1376 = conf_service_metadata_field_id(service, (const char *) type);
1377 if (md_field_id < 0)
1379 if (se->number_of_warnings_unknown_metadata == 0)
1381 session_log(se, YLOG_WARN,
1382 "Ignoring unknown metadata element: %s", type);
1384 se->number_of_warnings_unknown_metadata++;
1388 ser_md = &service->metadata[md_field_id];
1390 if (ser_md->sortkey_offset >= 0){
1391 sk_field_id = ser_md->sortkey_offset;
1392 ser_sk = &service->sortkeys[sk_field_id];
1395 // non-merged metadata
1396 rec_md = record_metadata_init(se->nmem, (const char *) value,
1397 ser_md->type, n->properties);
1400 session_log(se, YLOG_WARN, "bad metadata data '%s' "
1401 "for element '%s'", value, type);
1404 wheretoput = &record->metadata[md_field_id];
1406 wheretoput = &(*wheretoput)->next;
1407 *wheretoput = rec_md;
1410 rec_md = record_metadata_init(se->nmem, (const char *) value,
1412 wheretoput = &cluster->metadata[md_field_id];
1414 // and polulate with data:
1415 // assign cluster or record based on merge action
1416 if (ser_md->merge == Metadata_merge_unique)
1418 struct record_metadata *mnode;
1419 for (mnode = *wheretoput; mnode; mnode = mnode->next)
1420 if (!strcmp((const char *) mnode->data.text.disp,
1421 rec_md->data.text.disp))
1425 rec_md->next = *wheretoput;
1426 *wheretoput = rec_md;
1429 else if (ser_md->merge == Metadata_merge_longest)
1432 || strlen(rec_md->data.text.disp)
1433 > strlen((*wheretoput)->data.text.disp))
1435 *wheretoput = rec_md;
1438 const char *sort_str = 0;
1440 ser_sk->type == Metadata_sortkey_skiparticle;
1442 if (!cluster->sortkeys[sk_field_id])
1443 cluster->sortkeys[sk_field_id] =
1444 nmem_malloc(se->nmem,
1445 sizeof(union data_types));
1447 prt = pp2_relevance_tokenize(service->sort_pct);
1449 pp2_relevance_first(prt, rec_md->data.text.disp,
1452 pp2_relevance_token_next(prt);
1454 sort_str = pp2_get_sort(prt);
1456 cluster->sortkeys[sk_field_id]->text.disp =
1457 rec_md->data.text.disp;
1460 sort_str = rec_md->data.text.disp;
1461 session_log(se, YLOG_WARN,
1462 "Could not make sortkey. Bug #1858");
1464 cluster->sortkeys[sk_field_id]->text.sort =
1465 nmem_strdup(se->nmem, sort_str);
1466 pp2_relevance_token_destroy(prt);
1470 else if (ser_md->merge == Metadata_merge_all)
1472 rec_md->next = *wheretoput;
1473 *wheretoput = rec_md;
1475 else if (ser_md->merge == Metadata_merge_range)
1479 *wheretoput = rec_md;
1481 cluster->sortkeys[sk_field_id]
1486 int this_min = rec_md->data.number.min;
1487 int this_max = rec_md->data.number.max;
1488 if (this_min < (*wheretoput)->data.number.min)
1489 (*wheretoput)->data.number.min = this_min;
1490 if (this_max > (*wheretoput)->data.number.max)
1491 (*wheretoput)->data.number.max = this_max;
1496 // ranking of _all_ fields enabled ...
1498 relevance_countwords(se->relevance, cluster,
1499 (char *) value, ser_md->rank,
1502 // construct facets ... unless the client already has reported them
1503 if (ser_md->termlist && !client_has_facet(cl, (char *) type))
1505 if (ser_md->type == Metadata_type_year)
1508 sprintf(year, "%d", rec_md->data.number.max);
1510 add_facet(se, (char *) type, year, term_factor);
1511 if (rec_md->data.number.max != rec_md->data.number.min)
1513 sprintf(year, "%d", rec_md->data.number.min);
1514 add_facet(se, (char *) type, year, term_factor);
1518 add_facet(se, (char *) type, (char *) value, term_factor);
1528 if (se->number_of_warnings_unknown_elements == 0)
1529 session_log(se, YLOG_WARN,
1530 "Unexpected element in internal record: %s", n->name);
1531 se->number_of_warnings_unknown_elements++;
1539 relevance_donerecord(se->relevance, cluster);
1540 se->total_records++;
1545 void session_log(struct session *s, int level, const char *fmt, ...)
1551 yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
1552 yaz_log(level, "Session (%u): %s", s->session_id, buf);
1560 * c-file-style: "Stroustrup"
1561 * indent-tabs-mode: nil
1563 * vim: shiftwidth=4 tabstop=8 expandtab