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 struct session_sorted_results {
101 struct session_sorted_results *next;
104 /* session counting (1) , disable client counting (0) */
105 static YAZ_MUTEX g_session_mutex = 0;
106 static int no_sessions = 0;
107 static int no_session_total = 0;
109 static int session_use(int delta)
112 if (!g_session_mutex)
113 yaz_mutex_create(&g_session_mutex);
114 yaz_mutex_enter(g_session_mutex);
115 no_sessions += delta;
117 no_session_total += delta;
118 sessions = no_sessions;
119 yaz_mutex_leave(g_session_mutex);
120 yaz_log(YLOG_DEBUG, "%s sessions=%d", delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), no_sessions);
124 int sessions_count(void)
126 return session_use(0);
129 int session_count_total(void)
132 if (!g_session_mutex)
134 yaz_mutex_enter(g_session_mutex);
135 total = no_session_total;
136 yaz_mutex_leave(g_session_mutex);
140 static void log_xml_doc(xmlDoc *doc)
142 FILE *lf = yaz_log_file();
145 #if LIBXML_VERSION >= 20600
146 xmlDocDumpFormatMemory(doc, &result, &len, 1);
148 xmlDocDumpMemory(doc, &result, &len);
152 (void) fwrite(result, 1, len, lf);
158 static void session_enter(struct session *s)
160 yaz_mutex_enter(s->session_mutex);
163 static void session_leave(struct session *s)
165 yaz_mutex_leave(s->session_mutex);
168 void add_facet(struct session *s, const char *type, const char *value, int count)
170 struct conf_service *service = s->service;
171 pp2_charset_token_t prt;
172 const char *facet_component;
173 WRBUF facet_wrbuf = wrbuf_alloc();
174 WRBUF display_wrbuf = wrbuf_alloc();
176 const char *icu_chain_id = 0;
178 for (i = 0; i < service->num_metadata; i++)
179 if (!strcmp((service->metadata + i)->name, type))
180 icu_chain_id = (service->metadata + i)->facetrule;
182 icu_chain_id = "facet";
183 prt = pp2_charset_token_create(service->charsets, icu_chain_id);
186 yaz_log(YLOG_FATAL, "Unknown ICU chain '%s' for facet of type '%s'",
188 wrbuf_destroy(facet_wrbuf);
189 wrbuf_destroy(display_wrbuf);
192 pp2_charset_token_first(prt, value, 0);
193 while ((facet_component = pp2_charset_token_next(prt)))
195 const char *display_component;
196 if (*facet_component)
198 if (wrbuf_len(facet_wrbuf))
199 wrbuf_puts(facet_wrbuf, " ");
200 wrbuf_puts(facet_wrbuf, facet_component);
202 display_component = pp2_get_display(prt);
203 if (display_component)
205 if (wrbuf_len(display_wrbuf))
206 wrbuf_puts(display_wrbuf, " ");
207 wrbuf_puts(display_wrbuf, display_component);
210 pp2_charset_token_destroy(prt);
212 if (wrbuf_len(facet_wrbuf))
215 for (i = 0; i < s->num_termlists; i++)
216 if (!strcmp(s->termlists[i].name, type))
218 if (i == s->num_termlists)
220 if (i == SESSION_MAX_TERMLISTS)
222 session_log(s, YLOG_FATAL, "Too many termlists");
223 wrbuf_destroy(facet_wrbuf);
224 wrbuf_destroy(display_wrbuf);
228 s->termlists[i].name = nmem_strdup(s->nmem, type);
229 s->termlists[i].termlist
230 = termlist_create(s->nmem, TERMLIST_HIGH_SCORE);
231 s->num_termlists = i + 1;
235 session_log(s, YLOG_DEBUG, "Facets for %s: %s norm:%s (%d)", type, value, wrbuf_cstr(facet_wrbuf), count);
237 termlist_insert(s->termlists[i].termlist, wrbuf_cstr(display_wrbuf),
238 wrbuf_cstr(facet_wrbuf), count);
240 wrbuf_destroy(facet_wrbuf);
241 wrbuf_destroy(display_wrbuf);
244 static xmlDoc *record_to_xml(struct session *se,
245 struct session_database *sdb, const char *rec)
247 struct database *db = sdb->database;
250 rdoc = xmlParseMemory(rec, strlen(rec));
254 session_log(se, YLOG_FATAL, "Non-wellformed XML received from %s",
259 if (global_parameters.dump_records)
261 session_log(se, YLOG_LOG, "Un-normalized record from %s", db->id);
268 #define MAX_XSLT_ARGS 16
270 // Add static values from session database settings if applicable
271 static void insert_settings_parameters(struct session_database *sdb,
272 struct conf_service *service,
280 for (i = 0; i < service->num_metadata; i++)
282 struct conf_metadata *md = &service->metadata[i];
285 if (md->setting == Metadata_setting_parameter &&
286 (setting = settings_lookup_offset(service, md->name)) >= 0)
288 const char *val = session_setting_oneval(sdb, setting);
289 if (val && nparms < MAX_XSLT_ARGS)
292 int len = strlen(val);
293 buf = nmem_malloc(nmem, len + 3);
295 strcpy(buf + 1, val);
298 parms[offset++] = md->name;
299 parms[offset++] = buf;
307 // Add static values from session database settings if applicable
308 static void insert_settings_values(struct session_database *sdb, xmlDoc *doc,
309 struct conf_service *service)
313 for (i = 0; i < service->num_metadata; i++)
315 struct conf_metadata *md = &service->metadata[i];
318 if (md->setting == Metadata_setting_postproc &&
319 (offset = settings_lookup_offset(service, md->name)) >= 0)
321 const char *val = session_setting_oneval(sdb, offset);
324 xmlNode *r = xmlDocGetRootElement(doc);
325 xmlNode *n = xmlNewTextChild(r, 0, (xmlChar *) "metadata",
327 xmlSetProp(n, (xmlChar *) "type", (xmlChar *) md->name);
333 static xmlDoc *normalize_record(struct session *se,
334 struct session_database *sdb,
335 struct conf_service *service,
336 const char *rec, NMEM nmem)
338 xmlDoc *rdoc = record_to_xml(se, sdb, rec);
342 char *parms[MAX_XSLT_ARGS*2+1];
344 insert_settings_parameters(sdb, service, parms, nmem);
346 if (normalize_record_transform(sdb->map, &rdoc, (const char **)parms))
348 session_log(se, YLOG_WARN, "Normalize failed from %s",
353 insert_settings_values(sdb, rdoc, service);
355 if (global_parameters.dump_records)
357 session_log(se, YLOG_LOG, "Normalized record from %s",
366 void session_settings_dump(struct session *se,
367 struct session_database *db,
372 int i, num = db->num_settings;
373 for (i = 0; i < num; i++)
375 struct setting *s = db->settings[i];
376 for (;s ; s = s->next)
378 wrbuf_puts(w, "<set name=\"");
379 wrbuf_xmlputs(w, s->name);
380 wrbuf_puts(w, "\" value=\"");
381 wrbuf_xmlputs(w, s->value);
382 wrbuf_puts(w, "\"/>");
390 // Retrieve first defined value for 'name' for given database.
391 // Will be extended to take into account user associated with session
392 const char *session_setting_oneval(struct session_database *db, int offset)
394 if (offset >= db->num_settings || !db->settings[offset])
396 return db->settings[offset]->value;
399 // Prepare XSLT stylesheets for record normalization
400 // Structures are allocated on the session_wide nmem to avoid having
401 // to recompute this for every search. This would lead
402 // to leaking if a single session was to repeatedly change the PZ_XSLT
403 // setting. However, this is not a realistic use scenario.
404 static int prepare_map(struct session *se, struct session_database *sdb)
408 if (sdb->settings && sdb->settings[PZ_XSLT] && !sdb->map &&
409 (s = session_setting_oneval(sdb, PZ_XSLT)))
411 char auto_stylesheet[256];
413 if (!strcmp(s, "auto"))
415 const char *request_syntax = session_setting_oneval(
416 sdb, PZ_REQUESTSYNTAX);
420 yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet),
421 "%s.xsl", request_syntax);
422 for (cp = auto_stylesheet; *cp; cp++)
424 /* deliberately only consider ASCII */
425 if (*cp > 32 && *cp < 127)
432 session_log(se, YLOG_WARN,
433 "No pz:requestsyntax for auto stylesheet");
436 sdb->map = normalize_cache_get(se->normalize_cache,
444 // called if watch should be removed because http_channel is to be destroyed
445 static void session_watch_cancel(void *data, struct http_channel *c,
448 struct session_watchentry *ent = data;
455 // set watch. Returns 0=OK, -1 if watch is already set
456 int session_set_watch(struct session *s, int what,
457 session_watchfun fun, void *data,
458 struct http_channel *chan)
462 if (s->watchlist[what].fun)
467 s->watchlist[what].fun = fun;
468 s->watchlist[what].data = data;
469 s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
470 session_watch_cancel);
477 void session_alert_watch(struct session *s, int what)
481 if (s->watchlist[what].fun)
483 /* our watch is no longer associated with http_channel */
485 session_watchfun fun;
487 http_remove_observer(s->watchlist[what].obs);
488 fun = s->watchlist[what].fun;
489 data = s->watchlist[what].data;
491 /* reset watch before fun is invoked - in case fun wants to set
493 s->watchlist[what].fun = 0;
494 s->watchlist[what].data = 0;
495 s->watchlist[what].obs = 0;
498 session_log(s, YLOG_DEBUG,
499 "Alert Watch: %d calling function: %p", what, fun);
506 //callback for grep_databases
507 static void select_targets_callback(struct session *se,
508 struct session_database *db)
511 struct client_list *l;
513 for (l = se->clients_cached; l; l = l->next)
514 if (client_get_database(l->client) == db)
521 cl = client_create(db->database->id);
522 client_set_database(cl, db);
523 client_set_session(cl, se);
525 l = xmalloc(sizeof(*l));
527 l->next = se->clients_cached;
528 se->clients_cached = l;
531 l = xmalloc(sizeof(*l));
533 l->next = se->clients;
537 static void session_remove_clients(struct session *se)
539 struct client_list *l;
548 struct client_list *l_next = l->next;
554 static void session_remove_cached_clients(struct session *se)
556 struct client_list *l;
558 session_remove_clients(se);
561 l = se->clients_cached;
562 se->clients_cached = 0;
567 struct client_list *l_next = l->next;
568 client_lock(l->client);
569 client_set_session(l->client, 0);
570 client_set_database(l->client, 0);
571 client_unlock(l->client);
572 client_destroy(l->client);
578 // Associates a set of clients with a session;
579 // Note: Session-databases represent databases with per-session
581 static int select_targets(struct session *se, const char *filter)
583 return session_grep_databases(se, filter, select_targets_callback);
586 int session_active_clients(struct session *s)
588 struct client_list *l;
591 for (l = s->clients; l; l = l->next)
592 if (client_is_active(l->client))
598 int session_is_preferred_clients_ready(struct session *s)
600 struct client_list *l;
603 for (l = s->clients; l; l = l->next)
604 if (client_is_active_preferred(l->client))
606 session_log(s, YLOG_DEBUG, "Has %d active preferred clients.", res);
610 static const char *get_strategy_plus_sort(struct client *l, const char *field)
612 struct session_database *sdb = client_get_database(l);
615 const char *strategy_plus_sort = 0;
617 for (s = sdb->settings[PZ_SORTMAP]; s; s = s->next)
619 char *p = strchr(s->name + 3, ':');
622 yaz_log(YLOG_WARN, "Malformed sortmap name: %s", s->name);
626 if (!strcmp(p, field))
628 strategy_plus_sort = s->value;
632 return strategy_plus_sort;
635 void session_sort(struct session *se, const char *field, int increasing)
637 struct session_sorted_results *sr;
638 struct client_list *l;
642 /* see if we already have sorted for this critieria */
643 for (sr = se->sorted_results; sr; sr = sr->next)
645 if (!strcmp(field, sr->field) && increasing == sr->increasing)
650 yaz_log(YLOG_LOG, "search_sort: field=%s increasing=%d already fetched",
655 yaz_log(YLOG_LOG, "search_sort: field=%s increasing=%d must fetch",
657 sr = nmem_malloc(se->nmem, sizeof(*sr));
658 sr->field = nmem_strdup(se->nmem, field);
659 sr->increasing = increasing;
660 sr->next = se->sorted_results;
661 se->sorted_results = sr;
663 for (l = se->clients; l; l = l->next)
665 struct client *cl = l->client;
666 const char *strategy_plus_sort = get_strategy_plus_sort(cl, field);
667 if (strategy_plus_sort)
670 if (client_prep_connection(cl, se->service->z3950_operation_timeout,
671 se->service->z3950_session_timeout,
672 se->service->server->iochan_man,
674 client_start_search(cl, strategy_plus_sort, increasing);
680 enum pazpar2_error_code session_search(struct session *se,
682 const char *startrecs,
686 const char **addinfo,
687 const char *sort_field, int increasing)
689 int live_channels = 0;
692 struct client_list *l;
694 facet_limits_t facet_limits;
696 session_log(se, YLOG_DEBUG, "Search");
700 if (se->settings_modified)
701 session_remove_cached_clients(se);
703 session_remove_clients(se);
706 reclist_destroy(se->reclist);
708 se->settings_modified = 0;
709 relevance_destroy(&se->relevance);
710 nmem_reset(se->nmem);
711 se->total_records = se->total_merged = 0;
712 se->num_termlists = 0;
714 /* reset list of sorted results and clear to relevance search */
715 se->sorted_results = nmem_malloc(se->nmem, sizeof(*se->sorted_results));
716 se->sorted_results->field = nmem_strdup(se->nmem, sort_field);
717 se->sorted_results->increasing = increasing;
718 se->sorted_results->next = 0;
720 live_channels = select_targets(se, filter);
724 return PAZPAR2_NO_TARGETS;
726 se->reclist = reclist_create(se->nmem);
728 yaz_gettimeofday(&tval);
732 facet_limits = facet_limits_create(limit);
737 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
739 for (l = se->clients; l; l = l->next)
742 struct client *cl = l->client;
743 const char *strategy_plus_sort = get_strategy_plus_sort(cl, sort_field);
745 if (prepare_map(se, client_get_database(cl)) < 0)
748 parse_ret = client_parse_query(cl, query, facet_limits, startrecs,
752 else if (parse_ret == 0)
754 session_log(se, YLOG_LOG, "client NEW %s", client_get_id(cl));
756 if (client_prep_connection(cl, se->service->z3950_operation_timeout,
757 se->service->z3950_session_timeout,
758 se->service->server->iochan_man,
760 client_start_search(cl, strategy_plus_sort, increasing);
764 session_log(se, YLOG_LOG, "client REUSE %s", client_get_id(cl));
766 if (client_prep_connection(cl, se->service->z3950_operation_timeout,
767 se->service->z3950_session_timeout,
768 se->service->server->iochan_man,
777 facet_limits_destroy(facet_limits);
784 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
787 return PAZPAR2_NO_TARGETS;
789 yaz_log(YLOG_LOG, "session_start_search done");
790 return PAZPAR2_NO_ERROR;
793 // Creates a new session_database object for a database
794 static void session_init_databases_fun(void *context, struct database *db)
796 struct session *se = (struct session *) context;
797 struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
803 assert(db->settings);
804 new->settings = nmem_malloc(se->session_nmem,
805 sizeof(struct settings *) * db->num_settings);
806 new->num_settings = db->num_settings;
807 for (i = 0; i < db->num_settings; i++)
809 struct setting *setting = db->settings[i];
810 new->settings[i] = setting;
812 new->next = se->databases;
816 // Doesn't free memory associated with sdb -- nmem takes care of that
817 static void session_database_destroy(struct session_database *sdb)
822 // Initialize session_database list -- this represents this session's view
823 // of the database list -- subject to modification by the settings ws command
824 void session_init_databases(struct session *se)
827 predef_grep_databases(se, se->service, session_init_databases_fun);
830 // Probably session_init_databases_fun should be refactored instead of
832 static struct session_database *load_session_database(struct session *se,
835 struct database *db = new_database(id, se->session_nmem);
837 session_init_databases_fun((void*) se, db);
839 // New sdb is head of se->databases list
840 return se->databases;
843 // Find an existing session database. If not found, load it
844 static struct session_database *find_session_database(struct session *se,
847 struct session_database *sdb;
849 for (sdb = se->databases; sdb; sdb = sdb->next)
850 if (!strcmp(sdb->database->id, id))
852 return load_session_database(se, id);
855 // Apply a session override to a database
856 void session_apply_setting(struct session *se, char *dbname, char *setting,
859 struct session_database *sdb = find_session_database(se, dbname);
860 struct conf_service *service = se->service;
861 struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
862 int offset = settings_create_offset(service, setting);
864 expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
867 new->target = dbname;
870 new->next = sdb->settings[offset];
871 sdb->settings[offset] = new;
873 se->settings_modified = 1;
875 // Force later recompute of settings-driven data structures
876 // (happens when a search starts and client connections are prepared)
888 void session_destroy(struct session *se)
890 struct session_database *sdb;
891 session_log(se, YLOG_DEBUG, "Destroying");
893 session_remove_cached_clients(se);
895 for (sdb = se->databases; sdb; sdb = sdb->next)
896 session_database_destroy(sdb);
897 normalize_cache_destroy(se->normalize_cache);
898 relevance_destroy(&se->relevance);
899 reclist_destroy(se->reclist);
900 nmem_destroy(se->nmem);
901 service_destroy(se->service);
902 yaz_mutex_destroy(&se->session_mutex);
905 size_t session_get_memory_status(struct session *session) {
909 session_enter(session);
910 session_nmem = nmem_total(session->nmem);
911 session_leave(session);
916 struct session *new_session(NMEM nmem, struct conf_service *service,
920 struct session *session = nmem_malloc(nmem, sizeof(*session));
924 sprintf(tmp_str, "session#%u", session_id);
926 session->session_id = session_id;
927 session_log(session, YLOG_DEBUG, "New");
928 session->service = service;
929 session->relevance = 0;
930 session->total_records = 0;
931 session->number_of_warnings_unknown_elements = 0;
932 session->number_of_warnings_unknown_metadata = 0;
933 session->num_termlists = 0;
934 session->reclist = 0;
935 session->clients = 0;
936 session->clients_cached = 0;
937 session->settings_modified = 0;
938 session->session_nmem = nmem;
939 session->nmem = nmem_create();
940 session->databases = 0;
941 for (i = 0; i <= SESSION_WATCH_MAX; i++)
943 session->watchlist[i].data = 0;
944 session->watchlist[i].fun = 0;
946 session->normalize_cache = normalize_cache_create();
947 session->session_mutex = 0;
948 pazpar2_mutex_create(&session->session_mutex, tmp_str);
953 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf);
955 static struct hitsbytarget *hitsbytarget_nb(struct session *se,
956 int *count, NMEM nmem)
958 struct hitsbytarget *res = 0;
959 struct client_list *l;
962 for (l = se->clients; l; l = l->next)
965 res = nmem_malloc(nmem, sizeof(*res) * sz);
967 for (l = se->clients; l; l = l->next)
969 struct client *cl = l->client;
970 WRBUF w = wrbuf_alloc();
971 const char *name = session_setting_oneval(client_get_database(cl),
974 res[*count].id = client_get_id(cl);
975 res[*count].name = *name ? name : "Unknown";
976 res[*count].hits = client_get_hits(cl);
977 res[*count].records = client_get_num_records(cl);
978 res[*count].diagnostic = client_get_diagnostic(cl);
979 res[*count].state = client_get_state_str(cl);
980 res[*count].connected = client_get_connection(cl) ? 1 : 0;
981 session_settings_dump(se, client_get_database(cl), w);
982 res[*count].settings_xml = nmem_strdup(nmem, wrbuf_cstr(w));
985 res[*count].suggestions_xml = nmem_strdup(nmem, client_get_suggestions_xml(cl, w));
992 struct hitsbytarget *get_hitsbytarget(struct session *se, int *count, NMEM nmem)
994 struct hitsbytarget *p;
996 p = hitsbytarget_nb(se, count, nmem);
1001 struct termlist_score **get_termlist_score(struct session *se,
1002 const char *name, int *num)
1005 struct termlist_score **tl = 0;
1008 for (i = 0; i < se->num_termlists; i++)
1009 if (!strcmp((const char *) se->termlists[i].name, name))
1011 tl = termlist_highscore(se->termlists[i].termlist, num);
1018 // Compares two hitsbytarget nodes by hitcount
1019 static int cmp_ht(const void *p1, const void *p2)
1021 const struct hitsbytarget *h1 = p1;
1022 const struct hitsbytarget *h2 = p2;
1023 return h2->hits - h1->hits;
1026 static int targets_termlist_nb(WRBUF wrbuf, struct session *se, int num,
1029 struct hitsbytarget *ht;
1032 ht = hitsbytarget_nb(se, &count, nmem);
1033 qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
1034 for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
1037 // do only print terms which have display names
1039 wrbuf_puts(wrbuf, "<term>\n");
1041 wrbuf_puts(wrbuf, "<id>");
1042 wrbuf_xmlputs(wrbuf, ht[i].id);
1043 wrbuf_puts(wrbuf, "</id>\n");
1045 wrbuf_puts(wrbuf, "<name>");
1046 if (!ht[i].name || !ht[i].name[0])
1047 wrbuf_xmlputs(wrbuf, "NO TARGET NAME");
1049 wrbuf_xmlputs(wrbuf, ht[i].name);
1050 wrbuf_puts(wrbuf, "</name>\n");
1052 wrbuf_printf(wrbuf, "<frequency>" ODR_INT_PRINTF "</frequency>\n",
1055 wrbuf_puts(wrbuf, "<state>");
1056 wrbuf_xmlputs(wrbuf, ht[i].state);
1057 wrbuf_puts(wrbuf, "</state>\n");
1059 wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n",
1061 wrbuf_puts(wrbuf, "</term>\n");
1066 void perform_termlist(struct http_channel *c, struct session *se,
1067 const char *name, int num)
1070 NMEM nmem_tmp = nmem_create();
1075 nmem_strsplit(nmem_tmp, ",", name, &names, &num_names);
1079 for (j = 0; j < num_names; j++)
1083 wrbuf_puts(c->wrbuf, "<list name=\"");
1084 wrbuf_xmlputs(c->wrbuf, names[j]);
1085 wrbuf_puts(c->wrbuf, "\">\n");
1087 for (i = 0; i < se->num_termlists; i++)
1089 tname = se->termlists[i].name;
1090 if (num_names > 0 && !strcmp(names[j], tname))
1092 struct termlist_score **p = 0;
1094 p = termlist_highscore(se->termlists[i].termlist, &len);
1098 for (i = 0; i < len && i < num; i++)
1100 // prevent sending empty term elements
1101 if (!p[i]->display_term || !p[i]->display_term[0])
1104 wrbuf_puts(c->wrbuf, "<term>");
1105 wrbuf_puts(c->wrbuf, "<name>");
1106 wrbuf_xmlputs(c->wrbuf, p[i]->display_term);
1107 wrbuf_puts(c->wrbuf, "</name>");
1109 wrbuf_printf(c->wrbuf,
1110 "<frequency>%d</frequency>",
1112 wrbuf_puts(c->wrbuf, "</term>\n");
1118 if (num_names > 0 && !strcmp(names[j], tname))
1120 targets_termlist_nb(c->wrbuf, se, num, c->nmem);
1122 wrbuf_puts(c->wrbuf, "</list>\n");
1125 nmem_destroy(nmem_tmp);
1128 #ifdef MISSING_HEADERS
1129 void report_nmem_stats(void)
1131 size_t in_use, is_free;
1133 nmem_get_memory_in_use(&in_use);
1134 nmem_get_memory_free(&is_free);
1136 yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
1137 (long) in_use, (long) is_free);
1141 struct record_cluster *show_single_start(struct session *se, const char *id,
1142 struct record_cluster **prev_r,
1143 struct record_cluster **next_r)
1145 struct record_cluster *r = 0;
1152 reclist_enter(se->reclist);
1153 while ((r = reclist_read_record(se->reclist)))
1155 if (!strcmp(r->recid, id))
1157 *next_r = reclist_read_record(se->reclist);
1162 reclist_leave(se->reclist);
1169 void show_single_stop(struct session *se, struct record_cluster *rec)
1174 struct record_cluster **show_range_start(struct session *se,
1175 struct reclist_sortparms *sp,
1176 int start, int *num, int *total, Odr_int *sumhits)
1178 struct record_cluster **recs;
1179 struct reclist_sortparms *spp;
1182 yaz_timing_t t = yaz_timing_create();
1185 recs = nmem_malloc(se->nmem, *num * sizeof(struct record_cluster *));
1195 struct client_list *l;
1197 for (spp = sp; spp; spp = spp->next)
1198 if (spp->type == Metadata_sortkey_relevance)
1200 relevance_prepare_read(se->relevance, se->reclist);
1203 reclist_sort(se->reclist, sp);
1205 reclist_enter(se->reclist);
1206 *total = reclist_get_num_records(se->reclist);
1209 for (l = se->clients; l; l = l->next)
1210 *sumhits += client_get_hits(l->client);
1212 for (i = 0; i < start; i++)
1213 if (!reclist_read_record(se->reclist))
1220 for (i = 0; i < *num; i++)
1222 struct record_cluster *r = reclist_read_record(se->reclist);
1230 reclist_leave(se->reclist);
1234 yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
1235 yaz_timing_get_real(t), yaz_timing_get_user(t),
1236 yaz_timing_get_sys(t));
1237 yaz_timing_destroy(&t);
1242 void show_range_stop(struct session *se, struct record_cluster **recs)
1247 void statistics(struct session *se, struct statistics *stat)
1249 struct client_list *l;
1252 memset(stat, 0, sizeof(*stat));
1254 for (l = se->clients; l; l = l->next)
1256 struct client *cl = l->client;
1257 if (!client_get_connection(cl))
1258 stat->num_no_connection++;
1259 stat->num_hits += client_get_hits(cl);
1260 switch (client_get_state(cl))
1262 case Client_Connecting: stat->num_connecting++; break;
1263 case Client_Working: stat->num_working++; break;
1264 case Client_Idle: stat->num_idle++; break;
1265 case Client_Failed: stat->num_failed++; break;
1266 case Client_Error: stat->num_error++; break;
1271 stat->num_records = se->total_records;
1273 stat->num_clients = count;
1276 static struct record_metadata *record_metadata_init(
1277 NMEM nmem, const char *value, enum conf_metadata_type type,
1278 struct _xmlAttr *attr)
1280 struct record_metadata *rec_md = record_metadata_create(nmem);
1281 struct record_metadata_attr **attrp = &rec_md->attributes;
1283 for (; attr; attr = attr->next)
1285 if (attr->children && attr->children->content)
1287 if (strcmp((const char *) attr->name, "type"))
1288 { /* skip the "type" attribute.. Its value is already part of
1289 the element in output (md-%s) and so repeating it here
1291 *attrp = nmem_malloc(nmem, sizeof(**attrp));
1293 nmem_strdup(nmem, (const char *) attr->name);
1295 nmem_strdup(nmem, (const char *) attr->children->content);
1296 attrp = &(*attrp)->next;
1302 if (type == Metadata_type_generic)
1304 char *p = nmem_strdup(nmem, value);
1306 p = normalize7bit_generic(p, " ,/.:([");
1308 rec_md->data.text.disp = p;
1309 rec_md->data.text.sort = 0;
1311 else if (type == Metadata_type_year || type == Metadata_type_date)
1316 if (type == Metadata_type_date)
1318 if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
1321 rec_md->data.number.min = first;
1322 rec_md->data.number.max = last;
1329 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
1330 struct conf_service *service, WRBUF norm_wr)
1334 for (n = root->children; n; n = n->next)
1336 if (n->type != XML_ELEMENT_NODE)
1338 if (!strcmp((const char *) n->name, "metadata"))
1340 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1342 yaz_log(YLOG_FATAL, "Missing type attribute on metadata element. Skipping!");
1344 else if (!strcmp(name, (const char *) type))
1346 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
1349 const char *norm_str;
1350 pp2_charset_token_t prt =
1351 pp2_charset_token_create(service->charsets, "mergekey");
1353 pp2_charset_token_first(prt, (const char *) value, 0);
1354 if (wrbuf_len(norm_wr) > 0)
1355 wrbuf_puts(norm_wr, " ");
1356 wrbuf_puts(norm_wr, name);
1358 pp2_charset_token_next(prt)))
1362 wrbuf_puts(norm_wr, " ");
1363 wrbuf_puts(norm_wr, norm_str);
1367 pp2_charset_token_destroy(prt);
1377 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
1378 struct conf_service *service, NMEM nmem)
1380 char *mergekey_norm = 0;
1381 xmlNode *root = xmlDocGetRootElement(doc);
1382 WRBUF norm_wr = wrbuf_alloc();
1384 /* consider mergekey from XSL first */
1385 xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
1388 const char *norm_str;
1389 pp2_charset_token_t prt =
1390 pp2_charset_token_create(service->charsets, "mergekey");
1392 pp2_charset_token_first(prt, (const char *) mergekey, 0);
1393 while ((norm_str = pp2_charset_token_next(prt)))
1397 if (wrbuf_len(norm_wr))
1398 wrbuf_puts(norm_wr, " ");
1399 wrbuf_puts(norm_wr, norm_str);
1402 pp2_charset_token_destroy(prt);
1407 /* no mergekey defined in XSL. Look for mergekey metadata instead */
1409 for (field_id = 0; field_id < service->num_metadata; field_id++)
1411 struct conf_metadata *ser_md = &service->metadata[field_id];
1412 if (ser_md->mergekey != Metadata_mergekey_no)
1414 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1416 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1418 /* no mergekey on this one and it is required..
1419 Generate unique key instead */
1420 wrbuf_rewind(norm_wr);
1427 /* generate unique key if none is not generated already or is empty */
1428 if (wrbuf_len(norm_wr) == 0)
1430 wrbuf_printf(norm_wr, "position: %s-%d",
1431 client_get_id(cl), record_no);
1435 const char *lead = "content: ";
1436 wrbuf_insert(norm_wr, 0, lead, strlen(lead));
1438 if (wrbuf_len(norm_wr) > 0)
1439 mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1440 wrbuf_destroy(norm_wr);
1441 return mergekey_norm;
1444 /** \brief see if metadata for pz:recordfilter exists
1445 \param root xml root element of normalized record
1446 \param sdb session database for client
1447 \retval 0 if there is no metadata for pz:recordfilter
1448 \retval 1 if there is metadata for pz:recordfilter
1450 If there is no pz:recordfilter defined, this function returns 1
1454 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1459 s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1464 for (n = root->children; n; n = n->next)
1466 if (n->type != XML_ELEMENT_NODE)
1468 if (!strcmp((const char *) n->name, "metadata"))
1470 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1477 if ((eq = strchr(s, '=')))
1479 else if ((eq = strchr(s, '~')))
1485 if (len == strlen((const char *)type) &&
1486 !memcmp((const char *) type, s, len))
1488 xmlChar *value = xmlNodeGetContent(n);
1489 if (value && *value)
1492 (substring && strstr((const char *) value, eq+1)) ||
1493 (!substring && !strcmp((const char *) value, eq + 1)))
1506 static int ingest_to_cluster(struct client *cl,
1510 const char *mergekey_norm);
1512 /** \brief ingest XML record
1513 \param cl client holds the result set for record
1514 \param rec record buffer (0 terminated)
1515 \param record_no record position (1, 2, ..)
1516 \param nmem working NMEM
1521 int ingest_record(struct client *cl, const char *rec,
1522 int record_no, NMEM nmem)
1524 struct session *se = client_get_session(cl);
1526 struct session_database *sdb = client_get_database(cl);
1527 struct conf_service *service = se->service;
1528 xmlDoc *xdoc = normalize_record(se, sdb, service, rec, nmem);
1530 const char *mergekey_norm;
1535 root = xmlDocGetRootElement(xdoc);
1537 if (!check_record_filter(root, sdb))
1539 session_log(se, YLOG_LOG, "Filtered out record no %d from %s",
1540 record_no, sdb->database->id);
1545 mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem);
1548 session_log(se, YLOG_WARN, "Got no mergekey");
1553 if (client_get_session(cl) == se)
1554 ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1561 static int ingest_to_cluster(struct client *cl,
1565 const char *mergekey_norm)
1570 struct session *se = client_get_session(cl);
1571 struct conf_service *service = se->service;
1572 int term_factor = 1;
1573 struct record_cluster *cluster;
1574 struct session_database *sdb = client_get_database(cl);
1575 struct record *record = record_create(se->nmem,
1576 service->num_metadata,
1577 service->num_sortkeys, cl,
1580 for (n = root->children; n; n = n->next)
1588 if (n->type != XML_ELEMENT_NODE)
1590 if (!strcmp((const char *) n->name, "metadata"))
1592 struct conf_metadata *ser_md = 0;
1593 struct record_metadata **wheretoput = 0;
1594 struct record_metadata *rec_md = 0;
1595 int md_field_id = -1;
1597 type = xmlGetProp(n, (xmlChar *) "type");
1598 value = xmlNodeListGetString(xdoc, n->children, 1);
1600 if (!type || !value || !*value)
1604 = conf_service_metadata_field_id(service, (const char *) type);
1605 if (md_field_id < 0)
1607 if (se->number_of_warnings_unknown_metadata == 0)
1609 session_log(se, YLOG_WARN,
1610 "Ignoring unknown metadata element: %s", type);
1612 se->number_of_warnings_unknown_metadata++;
1616 ser_md = &service->metadata[md_field_id];
1618 // non-merged metadata
1619 rec_md = record_metadata_init(se->nmem, (const char *) value,
1620 ser_md->type, n->properties);
1623 session_log(se, YLOG_WARN, "bad metadata data '%s' "
1624 "for element '%s'", value, type);
1627 wheretoput = &record->metadata[md_field_id];
1629 wheretoput = &(*wheretoput)->next;
1630 *wheretoput = rec_md;
1634 cluster = reclist_insert(se->reclist, service, record,
1635 mergekey_norm, &se->total_merged);
1640 const char *use_term_factor_str =
1641 session_setting_oneval(sdb, PZ_TERMLIST_TERM_FACTOR);
1642 if (use_term_factor_str && use_term_factor_str[0] == '1')
1644 int maxrecs = client_get_maxrecs(cl);
1645 int hits = (int) client_get_hits(cl);
1646 term_factor = MAX(hits, maxrecs) / MAX(1, maxrecs);
1647 assert(term_factor >= 1);
1648 yaz_log(YLOG_DEBUG, "Using term factor: %d (%d / %d)", term_factor, MAX(hits, maxrecs), MAX(1, maxrecs));
1652 if (global_parameters.dump_records)
1653 session_log(se, YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1654 sdb->database->id, record_no);
1657 relevance_newrec(se->relevance, cluster);
1659 // now parsing XML record and adding data to cluster or record metadata
1660 for (n = root->children; n; n = n->next)
1662 pp2_charset_token_t prt;
1669 if (n->type != XML_ELEMENT_NODE)
1671 if (!strcmp((const char *) n->name, "metadata"))
1673 struct conf_metadata *ser_md = 0;
1674 struct conf_sortkey *ser_sk = 0;
1675 struct record_metadata **wheretoput = 0;
1676 struct record_metadata *rec_md = 0;
1677 int md_field_id = -1;
1678 int sk_field_id = -1;
1680 type = xmlGetProp(n, (xmlChar *) "type");
1681 value = xmlNodeListGetString(xdoc, n->children, 1);
1683 if (!type || !value || !*value)
1687 = conf_service_metadata_field_id(service, (const char *) type);
1688 if (md_field_id < 0)
1691 ser_md = &service->metadata[md_field_id];
1693 if (ser_md->sortkey_offset >= 0)
1695 sk_field_id = ser_md->sortkey_offset;
1696 ser_sk = &service->sortkeys[sk_field_id];
1700 rec_md = record_metadata_init(se->nmem, (const char *) value,
1705 wheretoput = &cluster->metadata[md_field_id];
1707 // and polulate with data:
1708 // assign cluster or record based on merge action
1709 if (ser_md->merge == Metadata_merge_unique)
1713 if (!strcmp((const char *) (*wheretoput)->data.text.disp,
1714 rec_md->data.text.disp))
1716 wheretoput = &(*wheretoput)->next;
1719 *wheretoput = rec_md;
1721 else if (ser_md->merge == Metadata_merge_longest)
1724 || strlen(rec_md->data.text.disp)
1725 > strlen((*wheretoput)->data.text.disp))
1727 *wheretoput = rec_md;
1730 const char *sort_str = 0;
1732 ser_sk->type == Metadata_sortkey_skiparticle;
1734 if (!cluster->sortkeys[sk_field_id])
1735 cluster->sortkeys[sk_field_id] =
1736 nmem_malloc(se->nmem,
1737 sizeof(union data_types));
1740 pp2_charset_token_create(service->charsets, "sort");
1742 pp2_charset_token_first(prt, rec_md->data.text.disp,
1745 pp2_charset_token_next(prt);
1747 sort_str = pp2_get_sort(prt);
1749 cluster->sortkeys[sk_field_id]->text.disp =
1750 rec_md->data.text.disp;
1753 sort_str = rec_md->data.text.disp;
1754 session_log(se, YLOG_WARN,
1755 "Could not make sortkey. Bug #1858");
1757 cluster->sortkeys[sk_field_id]->text.sort =
1758 nmem_strdup(se->nmem, sort_str);
1759 pp2_charset_token_destroy(prt);
1763 else if (ser_md->merge == Metadata_merge_all)
1766 wheretoput = &(*wheretoput)->next;
1767 *wheretoput = rec_md;
1769 else if (ser_md->merge == Metadata_merge_range)
1773 *wheretoput = rec_md;
1775 cluster->sortkeys[sk_field_id]
1780 int this_min = rec_md->data.number.min;
1781 int this_max = rec_md->data.number.max;
1782 if (this_min < (*wheretoput)->data.number.min)
1783 (*wheretoput)->data.number.min = this_min;
1784 if (this_max > (*wheretoput)->data.number.max)
1785 (*wheretoput)->data.number.max = this_max;
1790 // ranking of _all_ fields enabled ...
1792 relevance_countwords(se->relevance, cluster,
1793 (char *) value, ser_md->rank,
1796 // construct facets ... unless the client already has reported them
1797 if (ser_md->termlist && !client_has_facet(cl, (char *) type))
1799 if (ser_md->type == Metadata_type_year)
1802 sprintf(year, "%d", rec_md->data.number.max);
1804 add_facet(se, (char *) type, year, term_factor);
1805 if (rec_md->data.number.max != rec_md->data.number.min)
1807 sprintf(year, "%d", rec_md->data.number.min);
1808 add_facet(se, (char *) type, year, term_factor);
1812 add_facet(se, (char *) type, (char *) value, term_factor);
1822 if (se->number_of_warnings_unknown_elements == 0)
1823 session_log(se, YLOG_WARN,
1824 "Unexpected element in internal record: %s", n->name);
1825 se->number_of_warnings_unknown_elements++;
1833 relevance_donerecord(se->relevance, cluster);
1834 se->total_records++;
1839 void session_log(struct session *s, int level, const char *fmt, ...)
1845 yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
1846 yaz_log(level, "Session (%u): %s", s->session_id, buf);
1854 * c-file-style: "Stroustrup"
1855 * indent-tabs-mode: nil
1857 * vim: shiftwidth=4 tabstop=8 expandtab