1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2012 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 sessions=%d", delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), no_sessions);
118 int sessions_count(void)
120 return session_use(0);
123 int session_count_total(void)
126 if (!g_session_mutex)
128 yaz_mutex_enter(g_session_mutex);
129 total = no_session_total;
130 yaz_mutex_leave(g_session_mutex);
134 static void log_xml_doc(xmlDoc *doc)
136 FILE *lf = yaz_log_file();
139 #if LIBXML_VERSION >= 20600
140 xmlDocDumpFormatMemory(doc, &result, &len, 1);
142 xmlDocDumpMemory(doc, &result, &len);
146 (void) fwrite(result, 1, len, lf);
152 static void session_enter(struct session *s)
154 yaz_mutex_enter(s->session_mutex);
157 static void session_leave(struct session *s)
159 yaz_mutex_leave(s->session_mutex);
162 static void session_normalize_facet(struct session *s, const char *type,
167 struct conf_service *service = s->service;
168 pp2_charset_token_t prt;
169 const char *facet_component;
171 const char *icu_chain_id = 0;
173 for (i = 0; i < service->num_metadata; i++)
174 if (!strcmp((service->metadata + i)->name, type))
175 icu_chain_id = (service->metadata + i)->facetrule;
177 icu_chain_id = "facet";
178 prt = pp2_charset_token_create(service->charsets, icu_chain_id);
181 yaz_log(YLOG_FATAL, "Unknown ICU chain '%s' for facet of type '%s'",
183 wrbuf_destroy(facet_wrbuf);
184 wrbuf_destroy(display_wrbuf);
187 pp2_charset_token_first(prt, value, 0);
188 while ((facet_component = pp2_charset_token_next(prt)))
190 const char *display_component;
191 if (*facet_component)
193 if (wrbuf_len(facet_wrbuf))
194 wrbuf_puts(facet_wrbuf, " ");
195 wrbuf_puts(facet_wrbuf, facet_component);
197 display_component = pp2_get_display(prt);
198 if (display_component)
200 if (wrbuf_len(display_wrbuf))
201 wrbuf_puts(display_wrbuf, " ");
202 wrbuf_puts(display_wrbuf, display_component);
205 pp2_charset_token_destroy(prt);
208 void add_facet(struct session *s, const char *type, const char *value, int count)
210 WRBUF facet_wrbuf = wrbuf_alloc();
211 WRBUF display_wrbuf = wrbuf_alloc();
213 session_normalize_facet(s, type, value, display_wrbuf, facet_wrbuf);
215 if (wrbuf_len(facet_wrbuf))
218 for (i = 0; i < s->num_termlists; i++)
219 if (!strcmp(s->termlists[i].name, type))
221 if (i == s->num_termlists)
223 if (i == SESSION_MAX_TERMLISTS)
225 session_log(s, YLOG_FATAL, "Too many termlists");
226 wrbuf_destroy(facet_wrbuf);
227 wrbuf_destroy(display_wrbuf);
231 s->termlists[i].name = nmem_strdup(s->nmem, type);
232 s->termlists[i].termlist
233 = termlist_create(s->nmem, TERMLIST_HIGH_SCORE);
234 s->num_termlists = i + 1;
238 session_log(s, YLOG_DEBUG, "Facets for %s: %s norm:%s (%d)", type, value, wrbuf_cstr(facet_wrbuf), count);
240 termlist_insert(s->termlists[i].termlist, wrbuf_cstr(display_wrbuf),
241 wrbuf_cstr(facet_wrbuf), count);
243 wrbuf_destroy(facet_wrbuf);
244 wrbuf_destroy(display_wrbuf);
247 static xmlDoc *record_to_xml(struct session *se,
248 struct session_database *sdb, const char *rec)
250 struct database *db = sdb->database;
253 rdoc = xmlParseMemory(rec, strlen(rec));
257 session_log(se, YLOG_FATAL, "Non-wellformed XML received from %s",
262 if (global_parameters.dump_records)
264 session_log(se, YLOG_LOG, "Un-normalized record from %s", db->id);
271 #define MAX_XSLT_ARGS 16
273 // Add static values from session database settings if applicable
274 static void insert_settings_parameters(struct session_database *sdb,
275 struct conf_service *service,
283 for (i = 0; i < service->num_metadata; i++)
285 struct conf_metadata *md = &service->metadata[i];
288 if (md->setting == Metadata_setting_parameter &&
289 (setting = settings_lookup_offset(service, md->name)) >= 0)
291 const char *val = session_setting_oneval(sdb, setting);
292 if (val && nparms < MAX_XSLT_ARGS)
295 int len = strlen(val);
296 buf = nmem_malloc(nmem, len + 3);
298 strcpy(buf + 1, val);
301 parms[offset++] = md->name;
302 parms[offset++] = buf;
310 // Add static values from session database settings if applicable
311 static void insert_settings_values(struct session_database *sdb, xmlDoc *doc,
312 struct conf_service *service)
316 for (i = 0; i < service->num_metadata; i++)
318 struct conf_metadata *md = &service->metadata[i];
321 if (md->setting == Metadata_setting_postproc &&
322 (offset = settings_lookup_offset(service, md->name)) >= 0)
324 const char *val = session_setting_oneval(sdb, offset);
327 xmlNode *r = xmlDocGetRootElement(doc);
328 xmlNode *n = xmlNewTextChild(r, 0, (xmlChar *) "metadata",
330 xmlSetProp(n, (xmlChar *) "type", (xmlChar *) md->name);
336 static xmlDoc *normalize_record(struct session *se,
337 struct session_database *sdb,
338 struct conf_service *service,
339 const char *rec, NMEM nmem)
341 xmlDoc *rdoc = record_to_xml(se, sdb, rec);
345 char *parms[MAX_XSLT_ARGS*2+1];
347 insert_settings_parameters(sdb, service, parms, nmem);
349 if (normalize_record_transform(sdb->map, &rdoc, (const char **)parms))
351 session_log(se, YLOG_WARN, "Normalize failed from %s",
356 insert_settings_values(sdb, rdoc, service);
358 if (global_parameters.dump_records)
360 session_log(se, YLOG_LOG, "Normalized record from %s",
369 void session_settings_dump(struct session *se,
370 struct session_database *db,
375 int i, num = db->num_settings;
376 for (i = 0; i < num; i++)
378 struct setting *s = db->settings[i];
379 for (;s ; s = s->next)
381 wrbuf_puts(w, "<set name=\"");
382 wrbuf_xmlputs(w, s->name);
383 wrbuf_puts(w, "\" value=\"");
384 wrbuf_xmlputs(w, s->value);
385 wrbuf_puts(w, "\"/>");
393 // Retrieve first defined value for 'name' for given database.
394 // Will be extended to take into account user associated with session
395 const char *session_setting_oneval(struct session_database *db, int offset)
397 if (offset >= db->num_settings || !db->settings[offset])
399 return db->settings[offset]->value;
402 // Prepare XSLT stylesheets for record normalization
403 // Structures are allocated on the session_wide nmem to avoid having
404 // to recompute this for every search. This would lead
405 // to leaking if a single session was to repeatedly change the PZ_XSLT
406 // setting. However, this is not a realistic use scenario.
407 static int prepare_map(struct session *se, struct session_database *sdb)
411 if (sdb->settings && sdb->settings[PZ_XSLT] && !sdb->map &&
412 (s = session_setting_oneval(sdb, PZ_XSLT)))
414 char auto_stylesheet[256];
416 if (!strcmp(s, "auto"))
418 const char *request_syntax = session_setting_oneval(
419 sdb, PZ_REQUESTSYNTAX);
423 yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet),
424 "%s.xsl", request_syntax);
425 for (cp = auto_stylesheet; *cp; cp++)
427 /* deliberately only consider ASCII */
428 if (*cp > 32 && *cp < 127)
435 session_log(se, YLOG_WARN,
436 "No pz:requestsyntax for auto stylesheet");
439 sdb->map = normalize_cache_get(se->normalize_cache,
447 // called if watch should be removed because http_channel is to be destroyed
448 static void session_watch_cancel(void *data, struct http_channel *c,
451 struct session_watchentry *ent = data;
458 // set watch. Returns 0=OK, -1 if watch is already set
459 int session_set_watch(struct session *s, int what,
460 session_watchfun fun, void *data,
461 struct http_channel *chan)
465 if (s->watchlist[what].fun)
470 s->watchlist[what].fun = fun;
471 s->watchlist[what].data = data;
472 s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
473 session_watch_cancel);
480 void session_alert_watch(struct session *s, int what)
484 if (s->watchlist[what].fun)
486 /* our watch is no longer associated with http_channel */
488 session_watchfun fun;
490 http_remove_observer(s->watchlist[what].obs);
491 fun = s->watchlist[what].fun;
492 data = s->watchlist[what].data;
494 /* reset watch before fun is invoked - in case fun wants to set
496 s->watchlist[what].fun = 0;
497 s->watchlist[what].data = 0;
498 s->watchlist[what].obs = 0;
501 session_log(s, YLOG_DEBUG,
502 "Alert Watch: %d calling function: %p", what, fun);
509 //callback for grep_databases
510 static void select_targets_callback(struct session *se,
511 struct session_database *db)
514 struct client_list *l;
516 for (l = se->clients_cached; l; l = l->next)
517 if (client_get_database(l->client) == db)
524 cl = client_create(db->database->id);
525 client_set_database(cl, db);
527 l = xmalloc(sizeof(*l));
529 l->next = se->clients_cached;
530 se->clients_cached = l;
532 /* set session always. If may be 0 if client is not active */
533 client_set_session(cl, se);
535 l = xmalloc(sizeof(*l));
537 l->next = se->clients_active;
538 se->clients_active = l;
541 static void session_reset_active_clients(struct session *se,
542 struct client_list *new_list)
544 struct client_list *l;
547 l = se->clients_active;
548 se->clients_active = new_list;
553 struct client_list *l_next = l->next;
555 client_lock(l->client);
556 client_set_session(l->client, 0); /* mark client inactive */
557 client_unlock(l->client);
564 static void session_remove_cached_clients(struct session *se)
566 struct client_list *l;
568 session_reset_active_clients(se, 0);
571 l = se->clients_cached;
572 se->clients_cached = 0;
577 struct client_list *l_next = l->next;
578 client_lock(l->client);
579 client_set_session(l->client, 0);
580 client_set_database(l->client, 0);
581 client_unlock(l->client);
582 client_destroy(l->client);
588 // Associates a set of clients with a session;
589 // Note: Session-databases represent databases with per-session
591 static int select_targets(struct session *se, const char *filter)
593 return session_grep_databases(se, filter, select_targets_callback);
596 int session_active_clients(struct session *s)
598 struct client_list *l;
601 for (l = s->clients_active; l; l = l->next)
602 if (client_is_active(l->client))
608 int session_is_preferred_clients_ready(struct session *s)
610 struct client_list *l;
613 for (l = s->clients_active; l; l = l->next)
614 if (client_is_active_preferred(l->client))
616 session_log(s, YLOG_DEBUG, "Has %d active preferred clients.", res);
620 void session_sort(struct session *se, const char *field, int increasing)
622 struct session_sorted_results *sr;
623 struct client_list *l;
627 /* see if we already have sorted for this critieria */
628 for (sr = se->sorted_results; sr; sr = sr->next)
630 if (!strcmp(field, sr->field) && increasing == sr->increasing)
635 yaz_log(YLOG_LOG, "search_sort: field=%s increasing=%d already fetched",
640 yaz_log(YLOG_LOG, "search_sort: field=%s increasing=%d must fetch",
642 sr = nmem_malloc(se->nmem, sizeof(*sr));
643 sr->field = nmem_strdup(se->nmem, field);
644 sr->increasing = increasing;
645 sr->next = se->sorted_results;
646 se->sorted_results = sr;
648 for (l = se->clients_active; l; l = l->next)
650 struct client *cl = l->client;
652 int ret = client_prep_connection(cl, se->service->z3950_operation_timeout,
653 se->service->z3950_session_timeout,
654 se->service->server->iochan_man,
657 client_start_search(cl);
662 enum pazpar2_error_code session_search(struct session *se,
664 const char *startrecs,
668 const char **addinfo,
669 const char *sort_field, int increasing)
671 int live_channels = 0;
673 int no_failed_query = 0;
674 int no_failed_limit = 0;
675 struct client_list *l, *l0;
677 facet_limits_t facet_limits;
679 session_log(se, YLOG_DEBUG, "Search");
683 if (se->settings_modified)
684 session_remove_cached_clients(se);
686 session_reset_active_clients(se, 0);
689 reclist_destroy(se->reclist);
691 se->settings_modified = 0;
692 relevance_destroy(&se->relevance);
693 nmem_reset(se->nmem);
694 se->total_records = se->total_merged = 0;
695 se->num_termlists = 0;
697 /* reset list of sorted results and clear to relevance search */
698 se->sorted_results = nmem_malloc(se->nmem, sizeof(*se->sorted_results));
699 se->sorted_results->field = nmem_strdup(se->nmem, sort_field);
700 se->sorted_results->increasing = increasing;
701 se->sorted_results->next = 0;
703 live_channels = select_targets(se, filter);
707 return PAZPAR2_NO_TARGETS;
709 se->reclist = reclist_create(se->nmem);
711 yaz_gettimeofday(&tval);
715 facet_limits = facet_limits_create(limit);
720 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
723 l0 = se->clients_active;
724 se->clients_active = 0;
727 for (l = l0; l; l = l->next)
730 struct client *cl = l->client;
732 if (prepare_map(se, client_get_database(cl)) < 0)
735 parse_ret = client_parse_query(cl, query, facet_limits, startrecs,
739 else if (parse_ret == -2)
744 client_prep_connection(cl, se->service->z3950_operation_timeout,
745 se->service->z3950_session_timeout,
746 se->service->server->iochan_man,
748 if (parse_ret == 1 && r == 2)
750 session_log(se, YLOG_LOG, "client REUSE %s", client_get_id(cl));
755 session_log(se, YLOG_LOG, "client NEW %s", client_get_id(cl));
756 client_start_search(cl);
761 facet_limits_destroy(facet_limits);
762 session_reset_active_clients(se, l0);
766 if (no_failed_query > 0)
769 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
771 else if (no_failed_limit > 0)
774 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
777 return PAZPAR2_NO_TARGETS;
779 yaz_log(YLOG_LOG, "session_start_search done");
780 return PAZPAR2_NO_ERROR;
783 // Creates a new session_database object for a database
784 static void session_init_databases_fun(void *context, struct database *db)
786 struct session *se = (struct session *) context;
787 struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
793 assert(db->settings);
794 new->settings = nmem_malloc(se->session_nmem,
795 sizeof(struct settings *) * db->num_settings);
796 new->num_settings = db->num_settings;
797 for (i = 0; i < db->num_settings; i++)
799 struct setting *setting = db->settings[i];
800 new->settings[i] = setting;
802 new->next = se->databases;
806 // Doesn't free memory associated with sdb -- nmem takes care of that
807 static void session_database_destroy(struct session_database *sdb)
812 // Initialize session_database list -- this represents this session's view
813 // of the database list -- subject to modification by the settings ws command
814 void session_init_databases(struct session *se)
817 predef_grep_databases(se, se->service, session_init_databases_fun);
820 // Probably session_init_databases_fun should be refactored instead of
822 static struct session_database *load_session_database(struct session *se,
825 struct database *db = new_database(id, se->session_nmem);
827 session_init_databases_fun((void*) se, db);
829 // New sdb is head of se->databases list
830 return se->databases;
833 // Find an existing session database. If not found, load it
834 static struct session_database *find_session_database(struct session *se,
837 struct session_database *sdb;
839 for (sdb = se->databases; sdb; sdb = sdb->next)
840 if (!strcmp(sdb->database->id, id))
842 return load_session_database(se, id);
845 // Apply a session override to a database
846 void session_apply_setting(struct session *se, char *dbname, char *setting,
849 struct session_database *sdb = find_session_database(se, dbname);
850 struct conf_service *service = se->service;
851 struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
852 int offset = settings_create_offset(service, setting);
854 expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
857 new->target = dbname;
860 new->next = sdb->settings[offset];
861 sdb->settings[offset] = new;
863 se->settings_modified = 1;
865 // Force later recompute of settings-driven data structures
866 // (happens when a search starts and client connections are prepared)
878 void session_destroy(struct session *se)
880 struct session_database *sdb;
881 session_log(se, YLOG_DEBUG, "Destroying");
883 session_remove_cached_clients(se);
885 for (sdb = se->databases; sdb; sdb = sdb->next)
886 session_database_destroy(sdb);
887 normalize_cache_destroy(se->normalize_cache);
888 relevance_destroy(&se->relevance);
889 reclist_destroy(se->reclist);
890 nmem_destroy(se->nmem);
891 service_destroy(se->service);
892 yaz_mutex_destroy(&se->session_mutex);
895 size_t session_get_memory_status(struct session *session) {
899 session_enter(session);
900 session_nmem = nmem_total(session->nmem);
901 session_leave(session);
906 struct session *new_session(NMEM nmem, struct conf_service *service,
910 struct session *session = nmem_malloc(nmem, sizeof(*session));
914 sprintf(tmp_str, "session#%u", session_id);
916 session->session_id = session_id;
917 session_log(session, YLOG_DEBUG, "New");
918 session->service = service;
919 session->relevance = 0;
920 session->total_records = 0;
921 session->number_of_warnings_unknown_elements = 0;
922 session->number_of_warnings_unknown_metadata = 0;
923 session->num_termlists = 0;
924 session->reclist = 0;
925 session->clients_active = 0;
926 session->clients_cached = 0;
927 session->settings_modified = 0;
928 session->session_nmem = nmem;
929 session->nmem = nmem_create();
930 session->databases = 0;
931 for (i = 0; i <= SESSION_WATCH_MAX; i++)
933 session->watchlist[i].data = 0;
934 session->watchlist[i].fun = 0;
936 session->normalize_cache = normalize_cache_create();
937 session->session_mutex = 0;
938 pazpar2_mutex_create(&session->session_mutex, tmp_str);
943 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf);
945 static struct hitsbytarget *hitsbytarget_nb(struct session *se,
946 int *count, NMEM nmem)
948 struct hitsbytarget *res = 0;
949 struct client_list *l;
952 for (l = se->clients_active; l; l = l->next)
955 res = nmem_malloc(nmem, sizeof(*res) * sz);
957 for (l = se->clients_active; l; l = l->next)
959 struct client *cl = l->client;
960 WRBUF w = wrbuf_alloc();
961 const char *name = session_setting_oneval(client_get_database(cl),
964 res[*count].id = client_get_id(cl);
965 res[*count].name = *name ? name : "Unknown";
966 res[*count].hits = client_get_hits(cl);
967 res[*count].records = client_get_num_records(cl);
968 res[*count].diagnostic =
969 client_get_diagnostic(cl, &res[*count].addinfo);
970 res[*count].state = client_get_state_str(cl);
971 res[*count].connected = client_get_connection(cl) ? 1 : 0;
972 session_settings_dump(se, client_get_database(cl), w);
973 res[*count].settings_xml = nmem_strdup(nmem, wrbuf_cstr(w));
976 res[*count].suggestions_xml = nmem_strdup(nmem, client_get_suggestions_xml(cl, w));
983 struct hitsbytarget *get_hitsbytarget(struct session *se, int *count, NMEM nmem)
985 struct hitsbytarget *p;
987 p = hitsbytarget_nb(se, count, nmem);
992 struct termlist_score **get_termlist_score(struct session *se,
993 const char *name, int *num)
996 struct termlist_score **tl = 0;
999 for (i = 0; i < se->num_termlists; i++)
1000 if (!strcmp((const char *) se->termlists[i].name, name))
1002 tl = termlist_highscore(se->termlists[i].termlist, num);
1009 // Compares two hitsbytarget nodes by hitcount
1010 static int cmp_ht(const void *p1, const void *p2)
1012 const struct hitsbytarget *h1 = p1;
1013 const struct hitsbytarget *h2 = p2;
1014 return h2->hits - h1->hits;
1017 static int targets_termlist_nb(WRBUF wrbuf, struct session *se, int num,
1020 struct hitsbytarget *ht;
1023 ht = hitsbytarget_nb(se, &count, nmem);
1024 qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
1025 for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
1028 // do only print terms which have display names
1030 wrbuf_puts(wrbuf, "<term>\n");
1032 wrbuf_puts(wrbuf, "<id>");
1033 wrbuf_xmlputs(wrbuf, ht[i].id);
1034 wrbuf_puts(wrbuf, "</id>\n");
1036 wrbuf_puts(wrbuf, "<name>");
1037 if (!ht[i].name || !ht[i].name[0])
1038 wrbuf_xmlputs(wrbuf, "NO TARGET NAME");
1040 wrbuf_xmlputs(wrbuf, ht[i].name);
1041 wrbuf_puts(wrbuf, "</name>\n");
1043 wrbuf_printf(wrbuf, "<frequency>" ODR_INT_PRINTF "</frequency>\n",
1046 wrbuf_puts(wrbuf, "<state>");
1047 wrbuf_xmlputs(wrbuf, ht[i].state);
1048 wrbuf_puts(wrbuf, "</state>\n");
1050 wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n",
1052 wrbuf_puts(wrbuf, "</term>\n");
1057 void perform_termlist(struct http_channel *c, struct session *se,
1058 const char *name, int num)
1061 NMEM nmem_tmp = nmem_create();
1068 nmem_strsplit(nmem_tmp, ",", name, &names, &num_names);
1072 for (j = 0; j < num_names; j++)
1076 for (i = 0; i < se->num_termlists; i++)
1078 tname = se->termlists[i].name;
1079 if (!strcmp(names[j], tname) || !strcmp(names[j], "*"))
1081 struct termlist_score **p = 0;
1084 wrbuf_puts(c->wrbuf, "<list name=\"");
1085 wrbuf_xmlputs(c->wrbuf, tname);
1086 wrbuf_puts(c->wrbuf, "\">\n");
1088 p = termlist_highscore(se->termlists[i].termlist, &len);
1092 for (i = 0; i < len && i < num; i++)
1094 // prevent sending empty term elements
1095 if (!p[i]->display_term || !p[i]->display_term[0])
1098 wrbuf_puts(c->wrbuf, "<term>");
1099 wrbuf_puts(c->wrbuf, "<name>");
1100 wrbuf_xmlputs(c->wrbuf, p[i]->display_term);
1101 wrbuf_puts(c->wrbuf, "</name>");
1103 wrbuf_printf(c->wrbuf,
1104 "<frequency>%d</frequency>",
1106 wrbuf_puts(c->wrbuf, "</term>\n");
1109 wrbuf_puts(c->wrbuf, "</list>\n");
1113 if (!strcmp(names[j], tname) || !strcmp(names[j], "*"))
1115 wrbuf_puts(c->wrbuf, "<list name=\"");
1116 wrbuf_xmlputs(c->wrbuf, tname);
1117 wrbuf_puts(c->wrbuf, "\">\n");
1119 targets_termlist_nb(c->wrbuf, se, num, c->nmem);
1120 wrbuf_puts(c->wrbuf, "</list>\n");
1124 nmem_destroy(nmem_tmp);
1127 #ifdef MISSING_HEADERS
1128 void report_nmem_stats(void)
1130 size_t in_use, is_free;
1132 nmem_get_memory_in_use(&in_use);
1133 nmem_get_memory_free(&is_free);
1135 yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
1136 (long) in_use, (long) is_free);
1140 struct record_cluster *show_single_start(struct session *se, const char *id,
1141 struct record_cluster **prev_r,
1142 struct record_cluster **next_r)
1144 struct record_cluster *r = 0;
1151 reclist_enter(se->reclist);
1152 while ((r = reclist_read_record(se->reclist)))
1154 if (!strcmp(r->recid, id))
1156 *next_r = reclist_read_record(se->reclist);
1161 reclist_leave(se->reclist);
1168 void show_single_stop(struct session *se, struct record_cluster *rec)
1173 struct record_cluster **show_range_start(struct session *se,
1174 struct reclist_sortparms *sp,
1175 int start, int *num, int *total, Odr_int *sumhits)
1177 struct record_cluster **recs;
1178 struct reclist_sortparms *spp;
1181 yaz_timing_t t = yaz_timing_create();
1184 recs = nmem_malloc(se->nmem, *num * sizeof(struct record_cluster *));
1194 struct client_list *l;
1196 for (spp = sp; spp; spp = spp->next)
1197 if (spp->type == Metadata_sortkey_relevance)
1199 relevance_prepare_read(se->relevance, se->reclist);
1202 reclist_sort(se->reclist, sp);
1204 reclist_enter(se->reclist);
1205 *total = reclist_get_num_records(se->reclist);
1208 for (l = se->clients_active; l; l = l->next)
1209 *sumhits += client_get_hits(l->client);
1211 for (i = 0; i < start; i++)
1212 if (!reclist_read_record(se->reclist))
1219 for (i = 0; i < *num; i++)
1221 struct record_cluster *r = reclist_read_record(se->reclist);
1229 reclist_leave(se->reclist);
1233 yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
1234 yaz_timing_get_real(t), yaz_timing_get_user(t),
1235 yaz_timing_get_sys(t));
1236 yaz_timing_destroy(&t);
1241 void show_range_stop(struct session *se, struct record_cluster **recs)
1246 void statistics(struct session *se, struct statistics *stat)
1248 struct client_list *l;
1251 memset(stat, 0, sizeof(*stat));
1253 for (l = se->clients_active; l; l = l->next)
1255 struct client *cl = l->client;
1256 if (!client_get_connection(cl))
1257 stat->num_no_connection++;
1258 stat->num_hits += client_get_hits(cl);
1259 switch (client_get_state(cl))
1261 case Client_Connecting: stat->num_connecting++; break;
1262 case Client_Working: stat->num_working++; break;
1263 case Client_Idle: stat->num_idle++; break;
1264 case Client_Failed: stat->num_failed++; break;
1265 case Client_Error: stat->num_error++; break;
1270 stat->num_records = se->total_records;
1272 stat->num_clients = count;
1275 static struct record_metadata *record_metadata_init(
1276 NMEM nmem, const char *value, enum conf_metadata_type type,
1277 struct _xmlAttr *attr)
1279 struct record_metadata *rec_md = record_metadata_create(nmem);
1280 struct record_metadata_attr **attrp = &rec_md->attributes;
1282 for (; attr; attr = attr->next)
1284 if (attr->children && attr->children->content)
1286 if (strcmp((const char *) attr->name, "type"))
1287 { /* skip the "type" attribute.. Its value is already part of
1288 the element in output (md-%s) and so repeating it here
1290 *attrp = nmem_malloc(nmem, sizeof(**attrp));
1292 nmem_strdup(nmem, (const char *) attr->name);
1294 nmem_strdup(nmem, (const char *) attr->children->content);
1295 attrp = &(*attrp)->next;
1301 if (type == Metadata_type_generic)
1303 char *p = nmem_strdup(nmem, value);
1305 p = normalize7bit_generic(p, " ,/.:([");
1307 rec_md->data.text.disp = p;
1308 rec_md->data.text.sort = 0;
1310 else if (type == Metadata_type_year || type == Metadata_type_date)
1315 if (type == Metadata_type_date)
1317 if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
1320 rec_md->data.number.min = first;
1321 rec_md->data.number.max = last;
1328 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
1329 struct conf_service *service, WRBUF norm_wr)
1333 for (n = root->children; n; n = n->next)
1335 if (n->type != XML_ELEMENT_NODE)
1337 if (!strcmp((const char *) n->name, "metadata"))
1339 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1341 yaz_log(YLOG_FATAL, "Missing type attribute on metadata element. Skipping!");
1343 else if (!strcmp(name, (const char *) type))
1345 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
1348 const char *norm_str;
1349 pp2_charset_token_t prt =
1350 pp2_charset_token_create(service->charsets, "mergekey");
1352 pp2_charset_token_first(prt, (const char *) value, 0);
1353 if (wrbuf_len(norm_wr) > 0)
1354 wrbuf_puts(norm_wr, " ");
1355 wrbuf_puts(norm_wr, name);
1357 pp2_charset_token_next(prt)))
1361 wrbuf_puts(norm_wr, " ");
1362 wrbuf_puts(norm_wr, norm_str);
1366 pp2_charset_token_destroy(prt);
1376 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
1377 struct conf_service *service, NMEM nmem)
1379 char *mergekey_norm = 0;
1380 xmlNode *root = xmlDocGetRootElement(doc);
1381 WRBUF norm_wr = wrbuf_alloc();
1383 /* consider mergekey from XSL first */
1384 xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
1387 const char *norm_str;
1388 pp2_charset_token_t prt =
1389 pp2_charset_token_create(service->charsets, "mergekey");
1391 pp2_charset_token_first(prt, (const char *) mergekey, 0);
1392 while ((norm_str = pp2_charset_token_next(prt)))
1396 if (wrbuf_len(norm_wr))
1397 wrbuf_puts(norm_wr, " ");
1398 wrbuf_puts(norm_wr, norm_str);
1401 pp2_charset_token_destroy(prt);
1406 /* no mergekey defined in XSL. Look for mergekey metadata instead */
1408 for (field_id = 0; field_id < service->num_metadata; field_id++)
1410 struct conf_metadata *ser_md = &service->metadata[field_id];
1411 if (ser_md->mergekey != Metadata_mergekey_no)
1413 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1415 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1417 /* no mergekey on this one and it is required..
1418 Generate unique key instead */
1419 wrbuf_rewind(norm_wr);
1426 /* generate unique key if none is not generated already or is empty */
1427 if (wrbuf_len(norm_wr) == 0)
1429 wrbuf_printf(norm_wr, "position: %s-%d",
1430 client_get_id(cl), record_no);
1434 const char *lead = "content: ";
1435 wrbuf_insert(norm_wr, 0, lead, strlen(lead));
1437 if (wrbuf_len(norm_wr) > 0)
1438 mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1439 wrbuf_destroy(norm_wr);
1440 return mergekey_norm;
1443 /** \brief see if metadata for pz:recordfilter exists
1444 \param root xml root element of normalized record
1445 \param sdb session database for client
1446 \retval 0 if there is no metadata for pz:recordfilter
1447 \retval 1 if there is metadata for pz:recordfilter
1449 If there is no pz:recordfilter defined, this function returns 1
1453 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1458 s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1463 for (n = root->children; n; n = n->next)
1465 if (n->type != XML_ELEMENT_NODE)
1467 if (!strcmp((const char *) n->name, "metadata"))
1469 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1476 if ((eq = strchr(s, '=')))
1478 else if ((eq = strchr(s, '~')))
1484 if (len == strlen((const char *)type) &&
1485 !memcmp((const char *) type, s, len))
1487 xmlChar *value = xmlNodeGetContent(n);
1488 if (value && *value)
1491 (substring && strstr((const char *) value, eq+1)) ||
1492 (!substring && !strcmp((const char *) value, eq + 1)))
1505 static int ingest_to_cluster(struct client *cl,
1509 const char *mergekey_norm);
1511 /** \brief ingest XML record
1512 \param cl client holds the result set for record
1513 \param rec record buffer (0 terminated)
1514 \param record_no record position (1, 2, ..)
1515 \param nmem working NMEM
1520 int ingest_record(struct client *cl, const char *rec,
1521 int record_no, NMEM nmem)
1523 struct session *se = client_get_session(cl);
1525 struct session_database *sdb = client_get_database(cl);
1526 struct conf_service *service = se->service;
1527 xmlDoc *xdoc = normalize_record(se, sdb, service, rec, nmem);
1529 const char *mergekey_norm;
1534 root = xmlDocGetRootElement(xdoc);
1536 if (!check_record_filter(root, sdb))
1538 session_log(se, YLOG_LOG, "Filtered out record no %d from %s",
1539 record_no, sdb->database->id);
1544 mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem);
1547 session_log(se, YLOG_WARN, "Got no mergekey");
1552 if (client_get_session(cl) == se)
1553 ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1560 static int check_limit_local(struct client *cl,
1561 struct record *record,
1564 int skip_record = 0;
1565 struct session *se = client_get_session(cl);
1566 struct conf_service *service = se->service;
1567 NMEM nmem_tmp = nmem_create();
1568 struct session_database *sdb = client_get_database(cl);
1570 while (!skip_record)
1572 struct conf_metadata *ser_md = 0;
1573 struct record_metadata *rec_md = 0;
1579 client_get_facet_limit_local(cl, sdb, &l, nmem_tmp, &num_v,
1584 md_field_id = conf_service_metadata_field_id(service, name);
1585 if (md_field_id < 0)
1590 ser_md = &service->metadata[md_field_id];
1591 rec_md = record->metadata[md_field_id];
1592 yaz_log(YLOG_LOG, "check limit local %s", name);
1593 for (i = 0; i < num_v; )
1597 if (ser_md->type == Metadata_type_year
1598 || ser_md->type == Metadata_type_date)
1600 int y = atoi(values[i]);
1601 if (y >= rec_md->data.number.min
1602 && y <= rec_md->data.number.max)
1607 yaz_log(YLOG_LOG, "cmp: '%s' '%s'",
1608 rec_md->data.text.disp, values[i]);
1609 if (!strcmp(rec_md->data.text.disp, values[i]))
1614 rec_md = rec_md->next;
1618 rec_md = record->metadata[md_field_id];
1628 nmem_destroy(nmem_tmp);
1632 static int ingest_to_cluster(struct client *cl,
1636 const char *mergekey_norm)
1641 struct session *se = client_get_session(cl);
1642 struct conf_service *service = se->service;
1643 int term_factor = 1;
1644 struct record_cluster *cluster;
1645 struct session_database *sdb = client_get_database(cl);
1646 struct record *record = record_create(se->nmem,
1647 service->num_metadata,
1648 service->num_sortkeys, cl,
1651 for (n = root->children; n; n = n->next)
1659 if (n->type != XML_ELEMENT_NODE)
1661 if (!strcmp((const char *) n->name, "metadata"))
1663 struct conf_metadata *ser_md = 0;
1664 struct record_metadata **wheretoput = 0;
1665 struct record_metadata *rec_md = 0;
1666 int md_field_id = -1;
1668 type = xmlGetProp(n, (xmlChar *) "type");
1669 value = xmlNodeListGetString(xdoc, n->children, 1);
1671 if (!type || !value || !*value)
1675 = conf_service_metadata_field_id(service, (const char *) type);
1676 if (md_field_id < 0)
1678 if (se->number_of_warnings_unknown_metadata == 0)
1680 session_log(se, YLOG_WARN,
1681 "Ignoring unknown metadata element: %s", type);
1683 se->number_of_warnings_unknown_metadata++;
1687 ser_md = &service->metadata[md_field_id];
1689 // non-merged metadata
1690 rec_md = record_metadata_init(se->nmem, (const char *) value,
1691 ser_md->type, n->properties);
1694 session_log(se, YLOG_WARN, "bad metadata data '%s' "
1695 "for element '%s'", value, type);
1698 wheretoput = &record->metadata[md_field_id];
1700 wheretoput = &(*wheretoput)->next;
1701 *wheretoput = rec_md;
1705 if (check_limit_local(cl, record, record_no))
1707 session_log(se, YLOG_LOG, "Facet filtered out record no %d from %s",
1708 record_no, sdb->database->id);
1715 cluster = reclist_insert(se->reclist, service, record,
1716 mergekey_norm, &se->total_merged);
1721 const char *use_term_factor_str =
1722 session_setting_oneval(sdb, PZ_TERMLIST_TERM_FACTOR);
1723 if (use_term_factor_str && use_term_factor_str[0] == '1')
1725 int maxrecs = client_get_maxrecs(cl);
1726 int hits = (int) client_get_hits(cl);
1727 term_factor = MAX(hits, maxrecs) / MAX(1, maxrecs);
1728 assert(term_factor >= 1);
1729 yaz_log(YLOG_DEBUG, "Using term factor: %d (%d / %d)", term_factor, MAX(hits, maxrecs), MAX(1, maxrecs));
1733 if (global_parameters.dump_records)
1734 session_log(se, YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1735 sdb->database->id, record_no);
1738 relevance_newrec(se->relevance, cluster);
1740 // now parsing XML record and adding data to cluster or record metadata
1741 for (n = root->children; n; n = n->next)
1743 pp2_charset_token_t prt;
1750 if (n->type != XML_ELEMENT_NODE)
1752 if (!strcmp((const char *) n->name, "metadata"))
1754 struct conf_metadata *ser_md = 0;
1755 struct conf_sortkey *ser_sk = 0;
1756 struct record_metadata **wheretoput = 0;
1757 struct record_metadata *rec_md = 0;
1758 int md_field_id = -1;
1759 int sk_field_id = -1;
1761 type = xmlGetProp(n, (xmlChar *) "type");
1762 value = xmlNodeListGetString(xdoc, n->children, 1);
1764 if (!type || !value || !*value)
1768 = conf_service_metadata_field_id(service, (const char *) type);
1769 if (md_field_id < 0)
1772 ser_md = &service->metadata[md_field_id];
1774 if (ser_md->sortkey_offset >= 0)
1776 sk_field_id = ser_md->sortkey_offset;
1777 ser_sk = &service->sortkeys[sk_field_id];
1781 rec_md = record_metadata_init(se->nmem, (const char *) value,
1786 wheretoput = &cluster->metadata[md_field_id];
1788 // and polulate with data:
1789 // assign cluster or record based on merge action
1790 if (ser_md->merge == Metadata_merge_unique)
1794 if (!strcmp((const char *) (*wheretoput)->data.text.disp,
1795 rec_md->data.text.disp))
1797 wheretoput = &(*wheretoput)->next;
1800 *wheretoput = rec_md;
1802 else if (ser_md->merge == Metadata_merge_longest)
1805 || strlen(rec_md->data.text.disp)
1806 > strlen((*wheretoput)->data.text.disp))
1808 *wheretoput = rec_md;
1811 const char *sort_str = 0;
1813 ser_sk->type == Metadata_sortkey_skiparticle;
1815 if (!cluster->sortkeys[sk_field_id])
1816 cluster->sortkeys[sk_field_id] =
1817 nmem_malloc(se->nmem,
1818 sizeof(union data_types));
1821 pp2_charset_token_create(service->charsets, "sort");
1823 pp2_charset_token_first(prt, rec_md->data.text.disp,
1826 pp2_charset_token_next(prt);
1828 sort_str = pp2_get_sort(prt);
1830 cluster->sortkeys[sk_field_id]->text.disp =
1831 rec_md->data.text.disp;
1834 sort_str = rec_md->data.text.disp;
1835 session_log(se, YLOG_WARN,
1836 "Could not make sortkey. Bug #1858");
1838 cluster->sortkeys[sk_field_id]->text.sort =
1839 nmem_strdup(se->nmem, sort_str);
1840 pp2_charset_token_destroy(prt);
1844 else if (ser_md->merge == Metadata_merge_all)
1847 wheretoput = &(*wheretoput)->next;
1848 *wheretoput = rec_md;
1850 else if (ser_md->merge == Metadata_merge_range)
1854 *wheretoput = rec_md;
1856 cluster->sortkeys[sk_field_id]
1861 int this_min = rec_md->data.number.min;
1862 int this_max = rec_md->data.number.max;
1863 if (this_min < (*wheretoput)->data.number.min)
1864 (*wheretoput)->data.number.min = this_min;
1865 if (this_max > (*wheretoput)->data.number.max)
1866 (*wheretoput)->data.number.max = this_max;
1871 // ranking of _all_ fields enabled ...
1873 relevance_countwords(se->relevance, cluster,
1874 (char *) value, ser_md->rank,
1877 // construct facets ... unless the client already has reported them
1878 if (ser_md->termlist && !client_has_facet(cl, (char *) type))
1880 if (ser_md->type == Metadata_type_year)
1883 sprintf(year, "%d", rec_md->data.number.max);
1885 add_facet(se, (char *) type, year, term_factor);
1886 if (rec_md->data.number.max != rec_md->data.number.min)
1888 sprintf(year, "%d", rec_md->data.number.min);
1889 add_facet(se, (char *) type, year, term_factor);
1893 add_facet(se, (char *) type, (char *) value, term_factor);
1903 if (se->number_of_warnings_unknown_elements == 0)
1904 session_log(se, YLOG_WARN,
1905 "Unexpected element in internal record: %s", n->name);
1906 se->number_of_warnings_unknown_elements++;
1914 relevance_donerecord(se->relevance, cluster);
1915 se->total_records++;
1920 void session_log(struct session *s, int level, const char *fmt, ...)
1926 yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
1927 yaz_log(level, "Session %u: %s", s->session_id, buf);
1935 * c-file-style: "Stroustrup"
1936 * indent-tabs-mode: nil
1938 * vim: shiftwidth=4 tabstop=8 expandtab