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 WRBUF display_wrbuf = wrbuf_alloc();
195 prt = pp2_relevance_tokenize(service->facet_pct);
197 pp2_relevance_first(prt, value, 0);
198 while ((facet_component = pp2_relevance_token_next(prt)))
200 const char *display_component;
201 if (*facet_component)
203 if (wrbuf_len(facet_wrbuf))
204 wrbuf_puts(facet_wrbuf, " ");
205 wrbuf_puts(facet_wrbuf, facet_component);
207 display_component = pp2_get_display(prt);
208 if (display_component)
210 if (wrbuf_len(display_wrbuf))
211 wrbuf_puts(display_wrbuf, " ");
212 wrbuf_puts(display_wrbuf, display_component);
215 pp2_relevance_token_destroy(prt);
217 yaz_log(YLOG_LOG, "facet norm=%s", wrbuf_cstr(facet_wrbuf));
218 yaz_log(YLOG_LOG, "facet display=%s", wrbuf_cstr(display_wrbuf));
219 if (wrbuf_len(facet_wrbuf))
222 for (i = 0; i < s->num_termlists; i++)
223 if (!strcmp(s->termlists[i].name, type))
225 if (i == s->num_termlists)
227 if (i == SESSION_MAX_TERMLISTS)
229 session_log(s, YLOG_FATAL, "Too many termlists");
230 wrbuf_destroy(facet_wrbuf);
234 s->termlists[i].name = nmem_strdup(s->nmem, type);
235 s->termlists[i].termlist
236 = termlist_create(s->nmem, TERMLIST_HIGH_SCORE);
237 s->num_termlists = i + 1;
241 session_log(s, YLOG_DEBUG, "Facets for %s: %s norm:%s (%d)", type, value, wrbuf_cstr(facet_wrbuf), count);
243 termlist_insert(s->termlists[i].termlist, wrbuf_cstr(display_wrbuf),
244 wrbuf_cstr(facet_wrbuf), count);
246 wrbuf_destroy(facet_wrbuf);
247 wrbuf_destroy(display_wrbuf);
250 static xmlDoc *record_to_xml(struct session *se,
251 struct session_database *sdb, const char *rec)
253 struct database *db = sdb->database;
256 rdoc = xmlParseMemory(rec, strlen(rec));
260 session_log(se, YLOG_FATAL, "Non-wellformed XML received from %s",
265 if (global_parameters.dump_records)
267 session_log(se, YLOG_LOG, "Un-normalized record from %s", db->url);
274 #define MAX_XSLT_ARGS 16
276 // Add static values from session database settings if applicable
277 static void insert_settings_parameters(struct session_database *sdb,
278 struct conf_service *service,
286 for (i = 0; i < service->num_metadata; i++)
288 struct conf_metadata *md = &service->metadata[i];
291 if (md->setting == Metadata_setting_parameter &&
292 (setting = settings_lookup_offset(service, md->name)) >= 0)
294 const char *val = session_setting_oneval(sdb, setting);
295 if (val && nparms < MAX_XSLT_ARGS)
298 int len = strlen(val);
299 buf = nmem_malloc(nmem, len + 3);
301 strcpy(buf + 1, val);
304 parms[offset++] = md->name;
305 parms[offset++] = buf;
313 // Add static values from session database settings if applicable
314 static void insert_settings_values(struct session_database *sdb, xmlDoc *doc,
315 struct conf_service *service)
319 for (i = 0; i < service->num_metadata; i++)
321 struct conf_metadata *md = &service->metadata[i];
324 if (md->setting == Metadata_setting_postproc &&
325 (offset = settings_lookup_offset(service, md->name)) >= 0)
327 const char *val = session_setting_oneval(sdb, offset);
330 xmlNode *r = xmlDocGetRootElement(doc);
331 xmlNode *n = xmlNewTextChild(r, 0, (xmlChar *) "metadata",
333 xmlSetProp(n, (xmlChar *) "type", (xmlChar *) md->name);
339 static xmlDoc *normalize_record(struct session *se,
340 struct session_database *sdb,
341 struct conf_service *service,
342 const char *rec, NMEM nmem)
344 xmlDoc *rdoc = record_to_xml(se, sdb, rec);
348 char *parms[MAX_XSLT_ARGS*2+1];
350 insert_settings_parameters(sdb, service, parms, nmem);
352 if (normalize_record_transform(sdb->map, &rdoc, (const char **)parms))
354 session_log(se, YLOG_WARN, "Normalize failed from %s",
359 insert_settings_values(sdb, rdoc, service);
361 if (global_parameters.dump_records)
363 session_log(se, YLOG_LOG, "Normalized record from %s",
372 void session_settings_dump(struct session *se,
373 struct session_database *db,
378 int i, num = db->num_settings;
379 for (i = 0; i < num; i++)
381 struct setting *s = db->settings[i];
382 for (;s ; s = s->next)
384 wrbuf_puts(w, "<set name=\"");
385 wrbuf_xmlputs(w, s->name);
386 wrbuf_puts(w, "\" value=\"");
387 wrbuf_xmlputs(w, s->value);
388 wrbuf_puts(w, "\"/>");
396 // Retrieve first defined value for 'name' for given database.
397 // Will be extended to take into account user associated with session
398 const char *session_setting_oneval(struct session_database *db, int offset)
400 if (offset >= db->num_settings || !db->settings[offset])
402 return db->settings[offset]->value;
405 // Prepare XSLT stylesheets for record normalization
406 // Structures are allocated on the session_wide nmem to avoid having
407 // to recompute this for every search. This would lead
408 // to leaking if a single session was to repeatedly change the PZ_XSLT
409 // setting. However, this is not a realistic use scenario.
410 static int prepare_map(struct session *se, struct session_database *sdb)
416 session_log(se, YLOG_WARN, "No settings on %s", sdb->database->url);
419 if ((s = session_setting_oneval(sdb, PZ_XSLT)))
421 char auto_stylesheet[256];
423 if (!strcmp(s, "auto"))
425 const char *request_syntax = session_setting_oneval(
426 sdb, PZ_REQUESTSYNTAX);
430 yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet),
431 "%s.xsl", request_syntax);
432 for (cp = auto_stylesheet; *cp; cp++)
434 /* deliberately only consider ASCII */
435 if (*cp > 32 && *cp < 127)
442 session_log(se, YLOG_WARN,
443 "No pz:requestsyntax for auto stylesheet");
446 sdb->map = normalize_cache_get(se->normalize_cache,
447 se->service->server->config, s);
454 // This analyzes settings and recomputes any supporting data structures
456 static int prepare_session_database(struct session *se,
457 struct session_database *sdb)
461 session_log(se, YLOG_WARN,
462 "No settings associated with %s", sdb->database->url);
465 if (sdb->settings[PZ_XSLT] && !sdb->map)
467 if (prepare_map(se, sdb) < 0)
473 // called if watch should be removed because http_channel is to be destroyed
474 static void session_watch_cancel(void *data, struct http_channel *c,
477 struct session_watchentry *ent = data;
484 // set watch. Returns 0=OK, -1 if watch is already set
485 int session_set_watch(struct session *s, int what,
486 session_watchfun fun, void *data,
487 struct http_channel *chan)
491 if (s->watchlist[what].fun)
496 s->watchlist[what].fun = fun;
497 s->watchlist[what].data = data;
498 s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
499 session_watch_cancel);
506 void session_alert_watch(struct session *s, int what)
510 if (s->watchlist[what].fun)
512 /* our watch is no longer associated with http_channel */
514 session_watchfun fun;
516 http_remove_observer(s->watchlist[what].obs);
517 fun = s->watchlist[what].fun;
518 data = s->watchlist[what].data;
520 /* reset watch before fun is invoked - in case fun wants to set
522 s->watchlist[what].fun = 0;
523 s->watchlist[what].data = 0;
524 s->watchlist[what].obs = 0;
527 session_log(s, YLOG_DEBUG,
528 "Alert Watch: %d calling function: %p", what, fun);
535 //callback for grep_databases
536 static void select_targets_callback(void *context, struct session_database *db)
538 struct session *se = (struct session*) context;
539 struct client *cl = client_create();
540 struct client_list *l;
541 client_set_database(cl, db);
543 client_set_session(cl, se);
545 l = xmalloc(sizeof(*l));
547 l->next = se->clients;
551 static void session_remove_clients(struct session *se)
553 struct client_list *l;
562 struct client_list *l_next = l->next;
563 client_lock(l->client);
564 client_set_session(l->client, 0);
565 client_set_database(l->client, 0);
566 client_unlock(l->client);
567 client_destroy(l->client);
573 // Associates a set of clients with a session;
574 // Note: Session-databases represent databases with per-session
576 static int select_targets(struct session *se, const char *filter)
578 return session_grep_databases(se, filter, select_targets_callback);
581 int session_active_clients(struct session *s)
583 struct client_list *l;
586 for (l = s->clients; l; l = l->next)
587 if (client_is_active(l->client))
593 int session_is_preferred_clients_ready(struct session *s)
595 struct client_list *l;
598 for (l = s->clients; l; l = l->next)
599 if (client_is_active_preferred(l->client))
601 session_log(s, YLOG_DEBUG, "Has %d active preferred clients.", res);
605 enum pazpar2_error_code search(struct session *se,
607 const char *startrecs, const char *maxrecs,
610 const char **addinfo)
612 int live_channels = 0;
615 struct client_list *l;
617 facet_limits_t facet_limits;
619 session_log(se, YLOG_DEBUG, "Search");
623 session_remove_clients(se);
626 reclist_destroy(se->reclist);
628 relevance_destroy(&se->relevance);
629 nmem_reset(se->nmem);
630 se->total_records = se->total_hits = se->total_merged = 0;
631 se->num_termlists = 0;
632 live_channels = select_targets(se, filter);
636 return PAZPAR2_NO_TARGETS;
638 se->reclist = reclist_create(se->nmem);
640 yaz_gettimeofday(&tval);
644 facet_limits = facet_limits_create(limit);
649 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
651 for (l = se->clients; l; l = l->next)
653 struct client *cl = l->client;
656 client_set_maxrecs(cl, atoi(maxrecs));
658 client_set_startrecs(cl, atoi(startrecs));
659 if (prepare_session_database(se, client_get_database(cl)) < 0)
661 else if (client_parse_query(cl, query, facet_limits) < 0)
666 if (client_prep_connection(cl, se->service->z3950_operation_timeout,
667 se->service->z3950_session_timeout,
668 se->service->server->iochan_man,
670 client_start_search(cl);
673 facet_limits_destroy(facet_limits);
680 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
683 return PAZPAR2_NO_TARGETS;
685 return PAZPAR2_NO_ERROR;
688 // Creates a new session_database object for a database
689 static void session_init_databases_fun(void *context, struct database *db)
691 struct session *se = (struct session *) context;
692 struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
698 assert(db->settings);
699 new->settings = nmem_malloc(se->session_nmem,
700 sizeof(struct settings *) * db->num_settings);
701 new->num_settings = db->num_settings;
702 for (i = 0; i < db->num_settings; i++)
704 struct setting *setting = db->settings[i];
705 new->settings[i] = setting;
707 new->next = se->databases;
711 // Doesn't free memory associated with sdb -- nmem takes care of that
712 static void session_database_destroy(struct session_database *sdb)
717 // Initialize session_database list -- this represents this session's view
718 // of the database list -- subject to modification by the settings ws command
719 void session_init_databases(struct session *se)
722 predef_grep_databases(se, se->service, session_init_databases_fun);
725 // Probably session_init_databases_fun should be refactored instead of
727 static struct session_database *load_session_database(struct session *se,
730 struct database *db = new_database(id, se->session_nmem);
732 resolve_database(se->service, db);
734 session_init_databases_fun((void*) se, db);
736 // New sdb is head of se->databases list
737 return se->databases;
740 // Find an existing session database. If not found, load it
741 static struct session_database *find_session_database(struct session *se,
744 struct session_database *sdb;
746 for (sdb = se->databases; sdb; sdb = sdb->next)
747 if (!strcmp(sdb->database->url, id))
749 return load_session_database(se, id);
752 // Apply a session override to a database
753 void session_apply_setting(struct session *se, char *dbname, char *setting,
756 struct session_database *sdb = find_session_database(se, dbname);
757 struct conf_service *service = se->service;
758 struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
759 int offset = settings_create_offset(service, setting);
761 expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
764 new->target = dbname;
767 new->next = sdb->settings[offset];
768 sdb->settings[offset] = new;
770 // Force later recompute of settings-driven data structures
771 // (happens when a search starts and client connections are prepared)
783 void session_destroy(struct session *se) {
784 struct session_database *sdb;
785 session_log(se, YLOG_DEBUG, "Destroying");
787 session_remove_clients(se);
789 for (sdb = se->databases; sdb; sdb = sdb->next)
790 session_database_destroy(sdb);
791 normalize_cache_destroy(se->normalize_cache);
792 relevance_destroy(&se->relevance);
793 reclist_destroy(se->reclist);
794 nmem_destroy(se->nmem);
795 service_destroy(se->service);
796 yaz_mutex_destroy(&se->session_mutex);
799 /* Depreciated: use session_destroy */
800 void destroy_session(struct session *se)
805 size_t session_get_memory_status(struct session *session) {
809 session_enter(session);
810 session_nmem = nmem_total(session->nmem);
811 session_leave(session);
816 struct session *new_session(NMEM nmem, struct conf_service *service,
820 struct session *session = nmem_malloc(nmem, sizeof(*session));
824 sprintf(tmp_str, "session#%u", session_id);
826 session->session_id = session_id;
827 session_log(session, YLOG_DEBUG, "New");
828 session->service = service;
829 session->relevance = 0;
830 session->total_hits = 0;
831 session->total_records = 0;
832 session->number_of_warnings_unknown_elements = 0;
833 session->number_of_warnings_unknown_metadata = 0;
834 session->num_termlists = 0;
835 session->reclist = 0;
836 session->clients = 0;
837 session->session_nmem = nmem;
838 session->nmem = nmem_create();
839 session->databases = 0;
840 for (i = 0; i <= SESSION_WATCH_MAX; i++)
842 session->watchlist[i].data = 0;
843 session->watchlist[i].fun = 0;
845 session->normalize_cache = normalize_cache_create();
846 session->session_mutex = 0;
847 pazpar2_mutex_create(&session->session_mutex, tmp_str);
852 struct hitsbytarget *hitsbytarget(struct session *se, int *count, NMEM nmem)
854 struct hitsbytarget *res = 0;
855 struct client_list *l;
859 for (l = se->clients; l; l = l->next)
862 res = nmem_malloc(nmem, sizeof(*res) * sz);
864 for (l = se->clients; l; l = l->next)
866 struct client *cl = l->client;
867 WRBUF w = wrbuf_alloc();
868 const char *name = session_setting_oneval(client_get_database(cl),
871 res[*count].id = client_get_database(cl)->database->url;
872 res[*count].name = *name ? name : "Unknown";
873 res[*count].hits = client_get_hits(cl);
874 res[*count].records = client_get_num_records(cl);
875 res[*count].diagnostic = client_get_diagnostic(cl);
876 res[*count].state = client_get_state_str(cl);
877 res[*count].connected = client_get_connection(cl) ? 1 : 0;
878 session_settings_dump(se, client_get_database(cl), w);
879 res[*count].settings_xml = nmem_strdup(nmem, wrbuf_cstr(w));
887 struct termlist_score **get_termlist_score(struct session *se,
888 const char *name, int *num)
891 struct termlist_score **tl = 0;
894 for (i = 0; i < se->num_termlists; i++)
895 if (!strcmp((const char *) se->termlists[i].name, name))
897 tl = termlist_highscore(se->termlists[i].termlist, num);
904 #ifdef MISSING_HEADERS
905 void report_nmem_stats(void)
907 size_t in_use, is_free;
909 nmem_get_memory_in_use(&in_use);
910 nmem_get_memory_free(&is_free);
912 yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
913 (long) in_use, (long) is_free);
917 struct record_cluster *show_single_start(struct session *se, const char *id,
918 struct record_cluster **prev_r,
919 struct record_cluster **next_r)
921 struct record_cluster *r = 0;
928 reclist_enter(se->reclist);
929 while ((r = reclist_read_record(se->reclist)))
931 if (!strcmp(r->recid, id))
933 *next_r = reclist_read_record(se->reclist);
938 reclist_leave(se->reclist);
945 void show_single_stop(struct session *se, struct record_cluster *rec)
950 struct record_cluster **show_range_start(struct session *se,
951 struct reclist_sortparms *sp,
952 int start, int *num, int *total, Odr_int *sumhits)
954 struct record_cluster **recs;
955 struct reclist_sortparms *spp;
958 yaz_timing_t t = yaz_timing_create();
961 recs = nmem_malloc(se->nmem, *num * sizeof(struct record_cluster *));
971 for (spp = sp; spp; spp = spp->next)
972 if (spp->type == Metadata_sortkey_relevance)
974 relevance_prepare_read(se->relevance, se->reclist);
977 reclist_sort(se->reclist, sp);
979 reclist_enter(se->reclist);
980 *total = reclist_get_num_records(se->reclist);
981 *sumhits = se->total_hits;
983 for (i = 0; i < start; i++)
984 if (!reclist_read_record(se->reclist))
991 for (i = 0; i < *num; i++)
993 struct record_cluster *r = reclist_read_record(se->reclist);
1001 reclist_leave(se->reclist);
1005 yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
1006 yaz_timing_get_real(t), yaz_timing_get_user(t),
1007 yaz_timing_get_sys(t));
1008 yaz_timing_destroy(&t);
1013 void show_range_stop(struct session *se, struct record_cluster **recs)
1018 void statistics(struct session *se, struct statistics *stat)
1020 struct client_list *l;
1023 memset(stat, 0, sizeof(*stat));
1024 for (l = se->clients; l; l = l->next)
1026 struct client *cl = l->client;
1027 if (!client_get_connection(cl))
1028 stat->num_no_connection++;
1029 switch (client_get_state(cl))
1031 case Client_Connecting: stat->num_connecting++; break;
1032 case Client_Working: stat->num_working++; break;
1033 case Client_Idle: stat->num_idle++; break;
1034 case Client_Failed: stat->num_failed++; break;
1035 case Client_Error: stat->num_error++; break;
1040 stat->num_hits = se->total_hits;
1041 stat->num_records = se->total_records;
1043 stat->num_clients = count;
1046 static struct record_metadata *record_metadata_init(
1047 NMEM nmem, const char *value, enum conf_metadata_type type,
1048 struct _xmlAttr *attr)
1050 struct record_metadata *rec_md = record_metadata_create(nmem);
1051 struct record_metadata_attr **attrp = &rec_md->attributes;
1053 for (; attr; attr = attr->next)
1055 if (attr->children && attr->children->content)
1057 if (strcmp((const char *) attr->name, "type"))
1058 { /* skip the "type" attribute.. Its value is already part of
1059 the element in output (md-%s) and so repeating it here
1061 *attrp = nmem_malloc(nmem, sizeof(**attrp));
1063 nmem_strdup(nmem, (const char *) attr->name);
1065 nmem_strdup(nmem, (const char *) attr->children->content);
1066 attrp = &(*attrp)->next;
1072 if (type == Metadata_type_generic)
1074 char *p = nmem_strdup(nmem, value);
1076 p = normalize7bit_generic(p, " ,/.:([");
1078 rec_md->data.text.disp = p;
1079 rec_md->data.text.sort = 0;
1081 else if (type == Metadata_type_year || type == Metadata_type_date)
1086 if (type == Metadata_type_date)
1088 if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
1091 rec_md->data.number.min = first;
1092 rec_md->data.number.max = last;
1099 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
1100 struct conf_service *service, WRBUF norm_wr)
1104 for (n = root->children; n; n = n->next)
1106 if (n->type != XML_ELEMENT_NODE)
1108 if (!strcmp((const char *) n->name, "metadata"))
1110 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1112 yaz_log(YLOG_FATAL, "Missing type attribute on metadata element. Skipping!");
1114 else if (!strcmp(name, (const char *) type))
1116 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
1119 const char *norm_str;
1120 pp2_relevance_token_t prt =
1121 pp2_relevance_tokenize(service->mergekey_pct);
1123 pp2_relevance_first(prt, (const char *) value, 0);
1124 if (wrbuf_len(norm_wr) > 0)
1125 wrbuf_puts(norm_wr, " ");
1126 wrbuf_puts(norm_wr, name);
1128 pp2_relevance_token_next(prt)))
1132 wrbuf_puts(norm_wr, " ");
1133 wrbuf_puts(norm_wr, norm_str);
1137 pp2_relevance_token_destroy(prt);
1147 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
1148 struct conf_service *service, NMEM nmem)
1150 char *mergekey_norm = 0;
1151 xmlNode *root = xmlDocGetRootElement(doc);
1152 WRBUF norm_wr = wrbuf_alloc();
1154 /* consider mergekey from XSL first */
1155 xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
1158 const char *norm_str;
1159 pp2_relevance_token_t prt =
1160 pp2_relevance_tokenize(service->mergekey_pct);
1162 pp2_relevance_first(prt, (const char *) mergekey, 0);
1163 while ((norm_str = pp2_relevance_token_next(prt)))
1167 if (wrbuf_len(norm_wr))
1168 wrbuf_puts(norm_wr, " ");
1169 wrbuf_puts(norm_wr, norm_str);
1172 pp2_relevance_token_destroy(prt);
1177 /* no mergekey defined in XSL. Look for mergekey metadata instead */
1179 for (field_id = 0; field_id < service->num_metadata; field_id++)
1181 struct conf_metadata *ser_md = &service->metadata[field_id];
1182 if (ser_md->mergekey != Metadata_mergekey_no)
1184 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1186 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1188 /* no mergekey on this one and it is required..
1189 Generate unique key instead */
1190 wrbuf_rewind(norm_wr);
1197 /* generate unique key if none is not generated already or is empty */
1198 if (wrbuf_len(norm_wr) == 0)
1200 wrbuf_printf(norm_wr, "%s-%d",
1201 client_get_database(cl)->database->url, record_no);
1203 if (wrbuf_len(norm_wr) > 0)
1204 mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1205 wrbuf_destroy(norm_wr);
1206 return mergekey_norm;
1209 /** \brief see if metadata for pz:recordfilter exists
1210 \param root xml root element of normalized record
1211 \param sdb session database for client
1212 \retval 0 if there is no metadata for pz:recordfilter
1213 \retval 1 if there is metadata for pz:recordfilter
1215 If there is no pz:recordfilter defined, this function returns 1
1219 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1224 s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1229 for (n = root->children; n; n = n->next)
1231 if (n->type != XML_ELEMENT_NODE)
1233 if (!strcmp((const char *) n->name, "metadata"))
1235 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1242 if ((eq = strchr(s, '=')))
1244 else if ((eq = strchr(s, '~')))
1250 if (len == strlen((const char *)type) &&
1251 !memcmp((const char *) type, s, len))
1253 xmlChar *value = xmlNodeGetContent(n);
1254 if (value && *value)
1257 (substring && strstr((const char *) value, eq+1)) ||
1258 (!substring && !strcmp((const char *) value, eq + 1)))
1271 static int ingest_to_cluster(struct client *cl,
1275 const char *mergekey_norm);
1277 /** \brief ingest XML record
1278 \param cl client holds the result set for record
1279 \param rec record buffer (0 terminated)
1280 \param record_no record position (1, 2, ..)
1281 \param nmem working NMEM
1286 int ingest_record(struct client *cl, const char *rec,
1287 int record_no, NMEM nmem)
1289 struct session *se = client_get_session(cl);
1291 struct session_database *sdb = client_get_database(cl);
1292 struct conf_service *service = se->service;
1293 xmlDoc *xdoc = normalize_record(se, sdb, service, rec, nmem);
1295 const char *mergekey_norm;
1300 root = xmlDocGetRootElement(xdoc);
1302 if (!check_record_filter(root, sdb))
1304 session_log(se, YLOG_LOG, "Filtered out record no %d from %s",
1305 record_no, sdb->database->url);
1310 mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem);
1313 session_log(se, YLOG_WARN, "Got no mergekey");
1318 if (client_get_session(cl) == se)
1319 ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1326 static int ingest_to_cluster(struct client *cl,
1330 const char *mergekey_norm)
1335 struct session_database *sdb = client_get_database(cl);
1336 struct session *se = client_get_session(cl);
1337 struct conf_service *service = se->service;
1338 struct record *record = record_create(se->nmem,
1339 service->num_metadata,
1340 service->num_sortkeys, cl,
1342 struct record_cluster *cluster = reclist_insert(se->reclist,
1348 const char *use_term_factor_str = session_setting_oneval(sdb, PZ_TERMLIST_TERM_FACTOR);
1349 int use_term_factor = 0;
1350 int term_factor = 1;
1351 if (use_term_factor_str && use_term_factor_str[0] != 0)
1352 use_term_factor = atoi(use_term_factor_str);
1353 if (use_term_factor) {
1354 int maxrecs = client_get_maxrecs(cl);
1355 int hits = (int) client_get_hits(cl);
1356 term_factor = MAX(hits, maxrecs) / MAX(1, maxrecs);
1357 assert(term_factor >= 1);
1358 yaz_log(YLOG_DEBUG, "Using term factor: %d (%d / %d)", term_factor, MAX(hits, maxrecs), MAX(1, maxrecs));
1363 if (global_parameters.dump_records)
1364 session_log(se, YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1365 sdb->database->url, record_no);
1366 relevance_newrec(se->relevance, cluster);
1368 // now parsing XML record and adding data to cluster or record metadata
1369 for (n = root->children; n; n = n->next)
1371 pp2_relevance_token_t prt;
1378 if (n->type != XML_ELEMENT_NODE)
1380 if (!strcmp((const char *) n->name, "metadata"))
1382 struct conf_metadata *ser_md = 0;
1383 struct conf_sortkey *ser_sk = 0;
1384 struct record_metadata **wheretoput = 0;
1385 struct record_metadata *rec_md = 0;
1386 int md_field_id = -1;
1387 int sk_field_id = -1;
1389 type = xmlGetProp(n, (xmlChar *) "type");
1390 value = xmlNodeListGetString(xdoc, n->children, 1);
1392 if (!type || !value || !*value)
1396 = conf_service_metadata_field_id(service, (const char *) type);
1397 if (md_field_id < 0)
1399 if (se->number_of_warnings_unknown_metadata == 0)
1401 session_log(se, YLOG_WARN,
1402 "Ignoring unknown metadata element: %s", type);
1404 se->number_of_warnings_unknown_metadata++;
1408 ser_md = &service->metadata[md_field_id];
1410 if (ser_md->sortkey_offset >= 0){
1411 sk_field_id = ser_md->sortkey_offset;
1412 ser_sk = &service->sortkeys[sk_field_id];
1415 // non-merged metadata
1416 rec_md = record_metadata_init(se->nmem, (const char *) value,
1417 ser_md->type, n->properties);
1420 session_log(se, YLOG_WARN, "bad metadata data '%s' "
1421 "for element '%s'", value, type);
1424 wheretoput = &record->metadata[md_field_id];
1426 wheretoput = &(*wheretoput)->next;
1427 *wheretoput = rec_md;
1430 rec_md = record_metadata_init(se->nmem, (const char *) value,
1432 wheretoput = &cluster->metadata[md_field_id];
1434 // and polulate with data:
1435 // assign cluster or record based on merge action
1436 if (ser_md->merge == Metadata_merge_unique)
1438 struct record_metadata *mnode;
1439 for (mnode = *wheretoput; mnode; mnode = mnode->next)
1440 if (!strcmp((const char *) mnode->data.text.disp,
1441 rec_md->data.text.disp))
1445 rec_md->next = *wheretoput;
1446 *wheretoput = rec_md;
1449 else if (ser_md->merge == Metadata_merge_longest)
1452 || strlen(rec_md->data.text.disp)
1453 > strlen((*wheretoput)->data.text.disp))
1455 *wheretoput = rec_md;
1458 const char *sort_str = 0;
1460 ser_sk->type == Metadata_sortkey_skiparticle;
1462 if (!cluster->sortkeys[sk_field_id])
1463 cluster->sortkeys[sk_field_id] =
1464 nmem_malloc(se->nmem,
1465 sizeof(union data_types));
1467 prt = pp2_relevance_tokenize(service->sort_pct);
1469 pp2_relevance_first(prt, rec_md->data.text.disp,
1472 pp2_relevance_token_next(prt);
1474 sort_str = pp2_get_sort(prt);
1476 cluster->sortkeys[sk_field_id]->text.disp =
1477 rec_md->data.text.disp;
1480 sort_str = rec_md->data.text.disp;
1481 session_log(se, YLOG_WARN,
1482 "Could not make sortkey. Bug #1858");
1484 cluster->sortkeys[sk_field_id]->text.sort =
1485 nmem_strdup(se->nmem, sort_str);
1486 pp2_relevance_token_destroy(prt);
1490 else if (ser_md->merge == Metadata_merge_all)
1492 rec_md->next = *wheretoput;
1493 *wheretoput = rec_md;
1495 else if (ser_md->merge == Metadata_merge_range)
1499 *wheretoput = rec_md;
1501 cluster->sortkeys[sk_field_id]
1506 int this_min = rec_md->data.number.min;
1507 int this_max = rec_md->data.number.max;
1508 if (this_min < (*wheretoput)->data.number.min)
1509 (*wheretoput)->data.number.min = this_min;
1510 if (this_max > (*wheretoput)->data.number.max)
1511 (*wheretoput)->data.number.max = this_max;
1516 // ranking of _all_ fields enabled ...
1518 relevance_countwords(se->relevance, cluster,
1519 (char *) value, ser_md->rank,
1522 // construct facets ... unless the client already has reported them
1523 if (ser_md->termlist && !client_has_facet(cl, (char *) type))
1525 if (ser_md->type == Metadata_type_year)
1528 sprintf(year, "%d", rec_md->data.number.max);
1530 add_facet(se, (char *) type, year, term_factor);
1531 if (rec_md->data.number.max != rec_md->data.number.min)
1533 sprintf(year, "%d", rec_md->data.number.min);
1534 add_facet(se, (char *) type, year, term_factor);
1538 add_facet(se, (char *) type, (char *) value, term_factor);
1548 if (se->number_of_warnings_unknown_elements == 0)
1549 session_log(se, YLOG_WARN,
1550 "Unexpected element in internal record: %s", n->name);
1551 se->number_of_warnings_unknown_elements++;
1559 relevance_donerecord(se->relevance, cluster);
1560 se->total_records++;
1565 void session_log(struct session *s, int level, const char *fmt, ...)
1571 yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
1572 yaz_log(level, "Session (%u): %s", s->session_id, buf);
1580 * c-file-style: "Stroustrup"
1581 * indent-tabs-mode: nil
1583 * vim: shiftwidth=4 tabstop=8 expandtab