1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2011 Index Data
4 Pazpar2 is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
9 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 \brief high-level logic; mostly user sessions and settings
46 #include <yaz/marcdisp.h>
47 #include <yaz/comstack.h>
48 #include <yaz/tcpip.h>
49 #include <yaz/proto.h>
50 #include <yaz/readconf.h>
51 #include <yaz/pquery.h>
52 #include <yaz/otherinfo.h>
53 #include <yaz/yaz-util.h>
55 #include <yaz/query-charset.h>
56 #include <yaz/querytowrbuf.h>
57 #include <yaz/oid_db.h>
58 #include <yaz/snprintf.h>
59 #include <yaz/gettimeofday.h>
63 #include <yaz/timing.h>
67 #include "parameters.h"
71 #include "termlists.h"
73 #include "relevance.h"
77 #include "normalize7bit.h"
79 #define TERMLIST_HIGH_SCORE 25
83 #define MAX(a,b) ((a)>(b)?(a):(b))
85 // Note: Some things in this structure will eventually move to configuration
86 struct parameters global_parameters =
90 0, // predictable sessions
94 struct client *client;
95 struct client_list *next;
98 /* session counting (1) , disable client counting (0) */
99 static YAZ_MUTEX g_session_mutex = 0;
100 static int no_sessions = 0;
101 static int no_session_total = 0;
103 static int session_use(int delta)
106 if (!g_session_mutex)
107 yaz_mutex_create(&g_session_mutex);
108 yaz_mutex_enter(g_session_mutex);
109 no_sessions += delta;
111 no_session_total += delta;
112 sessions = no_sessions;
113 yaz_mutex_leave(g_session_mutex);
114 yaz_log(YLOG_DEBUG, "%s sesions=%d", delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), no_sessions);
118 int sessions_count(void) {
119 return session_use(0);
122 int session_count_total(void) {
124 if (!g_session_mutex)
126 yaz_mutex_enter(g_session_mutex);
127 total = no_session_total;
128 yaz_mutex_leave(g_session_mutex);
133 static void log_xml_doc(xmlDoc *doc)
135 FILE *lf = yaz_log_file();
138 #if LIBXML_VERSION >= 20600
139 xmlDocDumpFormatMemory(doc, &result, &len, 1);
141 xmlDocDumpMemory(doc, &result, &len);
145 (void) fwrite(result, 1, len, lf);
151 static void session_enter(struct session *s)
153 yaz_mutex_enter(s->session_mutex);
156 static void session_leave(struct session *s)
158 yaz_mutex_leave(s->session_mutex);
161 // Recursively traverse query structure to extract terms.
162 void pull_terms(NMEM nmem, struct ccl_rpn_node *n, char **termlist, int *num)
174 pull_terms(nmem, n->u.p[0], termlist, num);
175 pull_terms(nmem, n->u.p[1], termlist, num);
178 nmem_strsplit(nmem, " ", n->u.t.term, &words, &numwords);
179 for (i = 0; i < numwords; i++)
180 termlist[(*num)++] = words[i];
188 void add_facet(struct session *s, const char *type, const char *value, int count)
190 struct conf_service *service = s->service;
191 pp2_relevance_token_t prt;
192 const char *facet_component;
193 WRBUF facet_wrbuf = wrbuf_alloc();
194 prt = pp2_relevance_tokenize(service->facet_pct);
196 pp2_relevance_first(prt, value, 0);
197 while ((facet_component = pp2_relevance_token_next(prt)))
199 if (*facet_component)
201 if (wrbuf_len(facet_wrbuf))
202 wrbuf_puts(facet_wrbuf, " ");
203 wrbuf_puts(facet_wrbuf, facet_component);
206 pp2_relevance_token_destroy(prt);
208 if (wrbuf_len(facet_wrbuf))
211 for (i = 0; i < s->num_termlists; i++)
212 if (!strcmp(s->termlists[i].name, type))
214 if (i == s->num_termlists)
216 if (i == SESSION_MAX_TERMLISTS)
218 session_log(s, YLOG_FATAL, "Too many termlists");
219 wrbuf_destroy(facet_wrbuf);
223 s->termlists[i].name = nmem_strdup(s->nmem, type);
224 s->termlists[i].termlist
225 = termlist_create(s->nmem, TERMLIST_HIGH_SCORE);
226 s->num_termlists = i + 1;
230 session_log(s, YLOG_DEBUG, "Facets for %s: %s norm:%s (%d)", type, value, wrbuf_cstr(facet_wrbuf), count);
232 termlist_insert(s->termlists[i].termlist, wrbuf_cstr(facet_wrbuf),
235 wrbuf_destroy(facet_wrbuf);
238 static xmlDoc *record_to_xml(struct session *se,
239 struct session_database *sdb, const char *rec)
241 struct database *db = sdb->database;
244 rdoc = xmlParseMemory(rec, strlen(rec));
248 session_log(se, YLOG_FATAL, "Non-wellformed XML received from %s",
253 if (global_parameters.dump_records)
255 session_log(se, YLOG_LOG, "Un-normalized record from %s", db->url);
262 #define MAX_XSLT_ARGS 16
264 // Add static values from session database settings if applicable
265 static void insert_settings_parameters(struct session_database *sdb,
266 struct conf_service *service,
274 for (i = 0; i < service->num_metadata; i++)
276 struct conf_metadata *md = &service->metadata[i];
279 if (md->setting == Metadata_setting_parameter &&
280 (setting = settings_lookup_offset(service, md->name)) >= 0)
282 const char *val = session_setting_oneval(sdb, setting);
283 if (val && nparms < MAX_XSLT_ARGS)
286 int len = strlen(val);
287 buf = nmem_malloc(nmem, len + 3);
289 strcpy(buf + 1, val);
292 parms[offset++] = md->name;
293 parms[offset++] = buf;
301 // Add static values from session database settings if applicable
302 static void insert_settings_values(struct session_database *sdb, xmlDoc *doc,
303 struct conf_service *service)
307 for (i = 0; i < service->num_metadata; i++)
309 struct conf_metadata *md = &service->metadata[i];
312 if (md->setting == Metadata_setting_postproc &&
313 (offset = settings_lookup_offset(service, md->name)) >= 0)
315 const char *val = session_setting_oneval(sdb, offset);
318 xmlNode *r = xmlDocGetRootElement(doc);
319 xmlNode *n = xmlNewTextChild(r, 0, (xmlChar *) "metadata",
321 xmlSetProp(n, (xmlChar *) "type", (xmlChar *) md->name);
327 static xmlDoc *normalize_record(struct session *se,
328 struct session_database *sdb,
329 struct conf_service *service,
330 const char *rec, NMEM nmem)
332 xmlDoc *rdoc = record_to_xml(se, sdb, rec);
336 char *parms[MAX_XSLT_ARGS*2+1];
338 insert_settings_parameters(sdb, service, parms, nmem);
340 if (normalize_record_transform(sdb->map, &rdoc, (const char **)parms))
342 session_log(se, YLOG_WARN, "Normalize failed from %s",
347 insert_settings_values(sdb, rdoc, service);
349 if (global_parameters.dump_records)
351 session_log(se, YLOG_LOG, "Normalized record from %s",
360 void session_settings_dump(struct session *se,
361 struct session_database *db,
366 int i, num = db->num_settings;
367 for (i = 0; i < num; i++)
369 struct setting *s = db->settings[i];
370 for (;s ; s = s->next)
372 wrbuf_puts(w, "<set name=\"");
373 wrbuf_xmlputs(w, s->name);
374 wrbuf_puts(w, "\" value=\"");
375 wrbuf_xmlputs(w, s->value);
376 wrbuf_puts(w, "\"/>");
384 // Retrieve first defined value for 'name' for given database.
385 // Will be extended to take into account user associated with session
386 const char *session_setting_oneval(struct session_database *db, int offset)
388 if (offset >= db->num_settings || !db->settings[offset])
390 return db->settings[offset]->value;
393 // Prepare XSLT stylesheets for record normalization
394 // Structures are allocated on the session_wide nmem to avoid having
395 // to recompute this for every search. This would lead
396 // to leaking if a single session was to repeatedly change the PZ_XSLT
397 // setting. However, this is not a realistic use scenario.
398 static int prepare_map(struct session *se, struct session_database *sdb)
404 session_log(se, YLOG_WARN, "No settings on %s", sdb->database->url);
407 if ((s = session_setting_oneval(sdb, PZ_XSLT)))
409 char auto_stylesheet[256];
411 if (!strcmp(s, "auto"))
413 const char *request_syntax = session_setting_oneval(
414 sdb, PZ_REQUESTSYNTAX);
418 yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet),
419 "%s.xsl", request_syntax);
420 for (cp = auto_stylesheet; *cp; cp++)
422 /* deliberately only consider ASCII */
423 if (*cp > 32 && *cp < 127)
430 session_log(se, YLOG_WARN,
431 "No pz:requestsyntax for auto stylesheet");
434 sdb->map = normalize_cache_get(se->normalize_cache,
435 se->service->server->config, s);
442 // This analyzes settings and recomputes any supporting data structures
444 static int prepare_session_database(struct session *se,
445 struct session_database *sdb)
449 session_log(se, YLOG_WARN,
450 "No settings associated with %s", sdb->database->url);
453 if (sdb->settings[PZ_XSLT] && !sdb->map)
455 if (prepare_map(se, sdb) < 0)
461 // called if watch should be removed because http_channel is to be destroyed
462 static void session_watch_cancel(void *data, struct http_channel *c,
465 struct session_watchentry *ent = data;
472 // set watch. Returns 0=OK, -1 if watch is already set
473 int session_set_watch(struct session *s, int what,
474 session_watchfun fun, void *data,
475 struct http_channel *chan)
479 if (s->watchlist[what].fun)
484 s->watchlist[what].fun = fun;
485 s->watchlist[what].data = data;
486 s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
487 session_watch_cancel);
494 void session_alert_watch(struct session *s, int what)
498 if (s->watchlist[what].fun)
500 /* our watch is no longer associated with http_channel */
502 session_watchfun fun;
504 http_remove_observer(s->watchlist[what].obs);
505 fun = s->watchlist[what].fun;
506 data = s->watchlist[what].data;
508 /* reset watch before fun is invoked - in case fun wants to set
510 s->watchlist[what].fun = 0;
511 s->watchlist[what].data = 0;
512 s->watchlist[what].obs = 0;
515 session_log(s, YLOG_DEBUG,
516 "Alert Watch: %d calling function: %p", what, fun);
523 //callback for grep_databases
524 static void select_targets_callback(void *context, struct session_database *db)
526 struct session *se = (struct session*) context;
527 struct client *cl = client_create();
528 struct client_list *l;
529 client_set_database(cl, db);
531 client_set_session(cl, se);
533 l = xmalloc(sizeof(*l));
535 l->next = se->clients;
539 static void session_remove_clients(struct session *se)
541 struct client_list *l;
550 struct client_list *l_next = l->next;
551 client_lock(l->client);
552 client_set_session(l->client, 0);
553 client_set_database(l->client, 0);
554 client_unlock(l->client);
555 client_destroy(l->client);
561 // Associates a set of clients with a session;
562 // Note: Session-databases represent databases with per-session
564 static int select_targets(struct session *se, const char *filter)
566 return session_grep_databases(se, filter, select_targets_callback);
569 int session_active_clients(struct session *s)
571 struct client_list *l;
574 for (l = s->clients; l; l = l->next)
575 if (client_is_active(l->client))
581 int session_is_preferred_clients_ready(struct session *s)
583 struct client_list *l;
586 for (l = s->clients; l; l = l->next)
587 if (client_is_active_preferred(l->client))
589 session_log(s, YLOG_DEBUG, "Has %d active preferred clients.", res);
593 enum pazpar2_error_code search(struct session *se,
595 const char *startrecs, const char *maxrecs,
598 const char **addinfo)
600 int live_channels = 0;
603 struct client_list *l;
605 facet_limits_t facet_limits;
607 session_log(se, YLOG_DEBUG, "Search");
611 session_remove_clients(se);
614 reclist_destroy(se->reclist);
616 relevance_destroy(&se->relevance);
617 nmem_reset(se->nmem);
618 se->total_records = se->total_hits = se->total_merged = 0;
619 se->num_termlists = 0;
620 live_channels = select_targets(se, filter);
624 return PAZPAR2_NO_TARGETS;
626 se->reclist = reclist_create(se->nmem);
628 yaz_gettimeofday(&tval);
632 facet_limits = facet_limits_create(limit);
637 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
639 for (l = se->clients; l; l = l->next)
641 struct client *cl = l->client;
644 client_set_maxrecs(cl, atoi(maxrecs));
646 client_set_startrecs(cl, atoi(startrecs));
647 if (prepare_session_database(se, client_get_database(cl)) < 0)
649 else if (client_parse_query(cl, query, facet_limits) < 0)
654 if (client_prep_connection(cl, se->service->z3950_operation_timeout,
655 se->service->z3950_session_timeout,
656 se->service->server->iochan_man,
658 client_start_search(cl);
661 facet_limits_destroy(facet_limits);
668 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
671 return PAZPAR2_NO_TARGETS;
673 return PAZPAR2_NO_ERROR;
676 // Creates a new session_database object for a database
677 static void session_init_databases_fun(void *context, struct database *db)
679 struct session *se = (struct session *) context;
680 struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
686 assert(db->settings);
687 new->settings = nmem_malloc(se->session_nmem,
688 sizeof(struct settings *) * db->num_settings);
689 new->num_settings = db->num_settings;
690 for (i = 0; i < db->num_settings; i++)
692 struct setting *setting = db->settings[i];
693 new->settings[i] = setting;
695 new->next = se->databases;
699 // Doesn't free memory associated with sdb -- nmem takes care of that
700 static void session_database_destroy(struct session_database *sdb)
705 // Initialize session_database list -- this represents this session's view
706 // of the database list -- subject to modification by the settings ws command
707 void session_init_databases(struct session *se)
710 predef_grep_databases(se, se->service, session_init_databases_fun);
713 // Probably session_init_databases_fun should be refactored instead of
715 static struct session_database *load_session_database(struct session *se,
718 struct database *db = new_database(id, se->session_nmem);
720 resolve_database(se->service, db);
722 session_init_databases_fun((void*) se, db);
724 // New sdb is head of se->databases list
725 return se->databases;
728 // Find an existing session database. If not found, load it
729 static struct session_database *find_session_database(struct session *se,
732 struct session_database *sdb;
734 for (sdb = se->databases; sdb; sdb = sdb->next)
735 if (!strcmp(sdb->database->url, id))
737 return load_session_database(se, id);
740 // Apply a session override to a database
741 void session_apply_setting(struct session *se, char *dbname, char *setting,
744 struct session_database *sdb = find_session_database(se, dbname);
745 struct conf_service *service = se->service;
746 struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
747 int offset = settings_create_offset(service, setting);
749 expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
752 new->target = dbname;
755 new->next = sdb->settings[offset];
756 sdb->settings[offset] = new;
758 // Force later recompute of settings-driven data structures
759 // (happens when a search starts and client connections are prepared)
771 void session_destroy(struct session *se) {
772 struct session_database *sdb;
773 session_log(se, YLOG_DEBUG, "Destroying");
775 session_remove_clients(se);
777 for (sdb = se->databases; sdb; sdb = sdb->next)
778 session_database_destroy(sdb);
779 normalize_cache_destroy(se->normalize_cache);
780 relevance_destroy(&se->relevance);
781 reclist_destroy(se->reclist);
782 nmem_destroy(se->nmem);
783 service_destroy(se->service);
784 yaz_mutex_destroy(&se->session_mutex);
785 wrbuf_destroy(se->wrbuf);
788 /* Depreciated: use session_destroy */
789 void destroy_session(struct session *se)
794 size_t session_get_memory_status(struct session *session) {
798 session_enter(session);
799 session_nmem = nmem_total(session->nmem);
800 session_leave(session);
805 struct session *new_session(NMEM nmem, struct conf_service *service,
809 struct session *session = nmem_malloc(nmem, sizeof(*session));
813 sprintf(tmp_str, "session#%u", session_id);
815 session->session_id = session_id;
816 session_log(session, YLOG_DEBUG, "New");
817 session->service = service;
818 session->relevance = 0;
819 session->total_hits = 0;
820 session->total_records = 0;
821 session->number_of_warnings_unknown_elements = 0;
822 session->number_of_warnings_unknown_metadata = 0;
823 session->num_termlists = 0;
824 session->reclist = 0;
825 session->clients = 0;
826 session->session_nmem = nmem;
827 session->nmem = nmem_create();
828 session->wrbuf = wrbuf_alloc();
829 session->databases = 0;
830 for (i = 0; i <= SESSION_WATCH_MAX; i++)
832 session->watchlist[i].data = 0;
833 session->watchlist[i].fun = 0;
835 session->normalize_cache = normalize_cache_create();
836 session->session_mutex = 0;
837 pazpar2_mutex_create(&session->session_mutex, tmp_str);
842 struct hitsbytarget *hitsbytarget(struct session *se, int *count, NMEM nmem)
844 struct hitsbytarget *res = 0;
845 struct client_list *l;
849 for (l = se->clients; l; l = l->next)
852 res = nmem_malloc(nmem, sizeof(*res) * sz);
854 for (l = se->clients; l; l = l->next)
856 struct client *cl = l->client;
857 WRBUF w = wrbuf_alloc();
858 const char *name = session_setting_oneval(client_get_database(cl),
861 res[*count].id = client_get_database(cl)->database->url;
862 res[*count].name = *name ? name : "Unknown";
863 res[*count].hits = client_get_hits(cl);
864 res[*count].records = client_get_num_records(cl);
865 res[*count].diagnostic = client_get_diagnostic(cl);
866 res[*count].state = client_get_state_str(cl);
867 res[*count].connected = client_get_connection(cl) ? 1 : 0;
868 session_settings_dump(se, client_get_database(cl), w);
869 res[*count].settings_xml = nmem_strdup(nmem, wrbuf_cstr(w));
877 struct termlist_score **get_termlist_score(struct session *se,
878 const char *name, int *num)
881 struct termlist_score **tl = 0;
884 for (i = 0; i < se->num_termlists; i++)
885 if (!strcmp((const char *) se->termlists[i].name, name))
887 tl = termlist_highscore(se->termlists[i].termlist, num);
894 #ifdef MISSING_HEADERS
895 void report_nmem_stats(void)
897 size_t in_use, is_free;
899 nmem_get_memory_in_use(&in_use);
900 nmem_get_memory_free(&is_free);
902 yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
903 (long) in_use, (long) is_free);
907 struct record_cluster *show_single_start(struct session *se, const char *id,
908 struct record_cluster **prev_r,
909 struct record_cluster **next_r)
911 struct record_cluster *r = 0;
918 reclist_enter(se->reclist);
919 while ((r = reclist_read_record(se->reclist)))
921 if (!strcmp(r->recid, id))
923 *next_r = reclist_read_record(se->reclist);
928 reclist_leave(se->reclist);
935 void show_single_stop(struct session *se, struct record_cluster *rec)
940 struct record_cluster **show_range_start(struct session *se,
941 struct reclist_sortparms *sp,
942 int start, int *num, int *total, Odr_int *sumhits)
944 struct record_cluster **recs;
945 struct reclist_sortparms *spp;
948 yaz_timing_t t = yaz_timing_create();
951 recs = nmem_malloc(se->nmem, *num * sizeof(struct record_cluster *));
961 for (spp = sp; spp; spp = spp->next)
962 if (spp->type == Metadata_sortkey_relevance)
964 relevance_prepare_read(se->relevance, se->reclist);
967 reclist_sort(se->reclist, sp);
969 reclist_enter(se->reclist);
970 *total = reclist_get_num_records(se->reclist);
971 *sumhits = se->total_hits;
973 for (i = 0; i < start; i++)
974 if (!reclist_read_record(se->reclist))
981 for (i = 0; i < *num; i++)
983 struct record_cluster *r = reclist_read_record(se->reclist);
991 reclist_leave(se->reclist);
995 yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
996 yaz_timing_get_real(t), yaz_timing_get_user(t),
997 yaz_timing_get_sys(t));
998 yaz_timing_destroy(&t);
1003 void show_range_stop(struct session *se, struct record_cluster **recs)
1008 void statistics(struct session *se, struct statistics *stat)
1010 struct client_list *l;
1013 memset(stat, 0, sizeof(*stat));
1014 for (l = se->clients; l; l = l->next)
1016 struct client *cl = l->client;
1017 if (!client_get_connection(cl))
1018 stat->num_no_connection++;
1019 switch (client_get_state(cl))
1021 case Client_Connecting: stat->num_connecting++; break;
1022 case Client_Working: stat->num_working++; break;
1023 case Client_Idle: stat->num_idle++; break;
1024 case Client_Failed: stat->num_failed++; break;
1025 case Client_Error: stat->num_error++; break;
1030 stat->num_hits = se->total_hits;
1031 stat->num_records = se->total_records;
1033 stat->num_clients = count;
1036 static struct record_metadata *record_metadata_init(
1037 NMEM nmem, const char *value, enum conf_metadata_type type,
1038 struct _xmlAttr *attr)
1040 struct record_metadata *rec_md = record_metadata_create(nmem);
1041 struct record_metadata_attr **attrp = &rec_md->attributes;
1043 for (; attr; attr = attr->next)
1045 if (attr->children && attr->children->content)
1047 if (strcmp((const char *) attr->name, "type"))
1048 { /* skip the "type" attribute.. Its value is already part of
1049 the element in output (md-%s) and so repeating it here
1051 *attrp = nmem_malloc(nmem, sizeof(**attrp));
1053 nmem_strdup(nmem, (const char *) attr->name);
1055 nmem_strdup(nmem, (const char *) attr->children->content);
1056 attrp = &(*attrp)->next;
1062 if (type == Metadata_type_generic)
1064 char *p = nmem_strdup(nmem, value);
1066 p = normalize7bit_generic(p, " ,/.:([");
1068 rec_md->data.text.disp = p;
1069 rec_md->data.text.sort = 0;
1071 else if (type == Metadata_type_year || type == Metadata_type_date)
1076 if (type == Metadata_type_date)
1078 if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
1081 rec_md->data.number.min = first;
1082 rec_md->data.number.max = last;
1089 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
1090 struct conf_service *service, WRBUF norm_wr)
1094 for (n = root->children; n; n = n->next)
1096 if (n->type != XML_ELEMENT_NODE)
1098 if (!strcmp((const char *) n->name, "metadata"))
1100 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1102 yaz_log(YLOG_FATAL, "Missing type attribute on metadata element. Skipping!");
1104 else if (!strcmp(name, (const char *) type))
1106 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
1109 const char *norm_str;
1110 pp2_relevance_token_t prt =
1111 pp2_relevance_tokenize(service->mergekey_pct);
1113 pp2_relevance_first(prt, (const char *) value, 0);
1114 if (wrbuf_len(norm_wr) > 0)
1115 wrbuf_puts(norm_wr, " ");
1116 wrbuf_puts(norm_wr, name);
1118 pp2_relevance_token_next(prt)))
1122 wrbuf_puts(norm_wr, " ");
1123 wrbuf_puts(norm_wr, norm_str);
1127 pp2_relevance_token_destroy(prt);
1137 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
1138 struct conf_service *service, NMEM nmem)
1140 char *mergekey_norm = 0;
1141 xmlNode *root = xmlDocGetRootElement(doc);
1142 WRBUF norm_wr = wrbuf_alloc();
1144 /* consider mergekey from XSL first */
1145 xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
1148 const char *norm_str;
1149 pp2_relevance_token_t prt =
1150 pp2_relevance_tokenize(service->mergekey_pct);
1152 pp2_relevance_first(prt, (const char *) mergekey, 0);
1153 while ((norm_str = pp2_relevance_token_next(prt)))
1157 if (wrbuf_len(norm_wr))
1158 wrbuf_puts(norm_wr, " ");
1159 wrbuf_puts(norm_wr, norm_str);
1162 pp2_relevance_token_destroy(prt);
1167 /* no mergekey defined in XSL. Look for mergekey metadata instead */
1169 for (field_id = 0; field_id < service->num_metadata; field_id++)
1171 struct conf_metadata *ser_md = &service->metadata[field_id];
1172 if (ser_md->mergekey != Metadata_mergekey_no)
1174 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1176 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1178 /* no mergekey on this one and it is required..
1179 Generate unique key instead */
1180 wrbuf_rewind(norm_wr);
1187 /* generate unique key if none is not generated already or is empty */
1188 if (wrbuf_len(norm_wr) == 0)
1190 wrbuf_printf(norm_wr, "%s-%d",
1191 client_get_database(cl)->database->url, record_no);
1193 if (wrbuf_len(norm_wr) > 0)
1194 mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1195 wrbuf_destroy(norm_wr);
1196 return mergekey_norm;
1199 /** \brief see if metadata for pz:recordfilter exists
1200 \param root xml root element of normalized record
1201 \param sdb session database for client
1202 \retval 0 if there is no metadata for pz:recordfilter
1203 \retval 1 if there is metadata for pz:recordfilter
1205 If there is no pz:recordfilter defined, this function returns 1
1209 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1214 s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1219 for (n = root->children; n; n = n->next)
1221 if (n->type != XML_ELEMENT_NODE)
1223 if (!strcmp((const char *) n->name, "metadata"))
1225 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1232 if ((eq = strchr(s, '=')))
1234 else if ((eq = strchr(s, '~')))
1240 if (len == strlen((const char *)type) &&
1241 !memcmp((const char *) type, s, len))
1243 xmlChar *value = xmlNodeGetContent(n);
1244 if (value && *value)
1247 (substring && strstr((const char *) value, eq+1)) ||
1248 (!substring && !strcmp((const char *) value, eq + 1)))
1261 static int ingest_to_cluster(struct client *cl,
1265 const char *mergekey_norm);
1267 /** \brief ingest XML record
1268 \param cl client holds the result set for record
1269 \param rec record buffer (0 terminated)
1270 \param record_no record position (1, 2, ..)
1271 \param nmem working NMEM
1276 int ingest_record(struct client *cl, const char *rec,
1277 int record_no, NMEM nmem)
1279 struct session *se = client_get_session(cl);
1281 struct session_database *sdb = client_get_database(cl);
1282 struct conf_service *service = se->service;
1283 xmlDoc *xdoc = normalize_record(se, sdb, service, rec, nmem);
1285 const char *mergekey_norm;
1290 root = xmlDocGetRootElement(xdoc);
1292 if (!check_record_filter(root, sdb))
1294 session_log(se, YLOG_LOG, "Filtered out record no %d from %s",
1295 record_no, sdb->database->url);
1300 mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem);
1303 session_log(se, YLOG_WARN, "Got no mergekey");
1308 if (client_get_session(cl) == se)
1309 ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1316 static int ingest_to_cluster(struct client *cl,
1320 const char *mergekey_norm)
1325 struct session_database *sdb = client_get_database(cl);
1326 struct session *se = client_get_session(cl);
1327 struct conf_service *service = se->service;
1328 struct record *record = record_create(se->nmem,
1329 service->num_metadata,
1330 service->num_sortkeys, cl,
1332 struct record_cluster *cluster = reclist_insert(se->reclist,
1338 const char *use_term_factor_str = session_setting_oneval(sdb, PZ_TERMLIST_TERM_FACTOR);
1339 int use_term_factor = 0;
1340 int term_factor = 1;
1341 if (use_term_factor_str && use_term_factor_str[0] != 0)
1342 use_term_factor = atoi(use_term_factor_str);
1343 if (use_term_factor) {
1344 int maxrecs = client_get_maxrecs(cl);
1345 int hits = (int) client_get_hits(cl);
1346 term_factor = MAX(hits, maxrecs) / MAX(1, maxrecs);
1347 assert(term_factor >= 1);
1348 yaz_log(YLOG_DEBUG, "Using term factor: %d (%d / %d)", term_factor, MAX(hits, maxrecs), MAX(1, maxrecs));
1353 if (global_parameters.dump_records)
1354 session_log(se, YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1355 sdb->database->url, record_no);
1356 relevance_newrec(se->relevance, cluster);
1358 // now parsing XML record and adding data to cluster or record metadata
1359 for (n = root->children; n; n = n->next)
1361 pp2_relevance_token_t prt;
1368 if (n->type != XML_ELEMENT_NODE)
1370 if (!strcmp((const char *) n->name, "metadata"))
1372 struct conf_metadata *ser_md = 0;
1373 struct conf_sortkey *ser_sk = 0;
1374 struct record_metadata **wheretoput = 0;
1375 struct record_metadata *rec_md = 0;
1376 int md_field_id = -1;
1377 int sk_field_id = -1;
1379 type = xmlGetProp(n, (xmlChar *) "type");
1380 value = xmlNodeListGetString(xdoc, n->children, 1);
1382 if (!type || !value || !*value)
1386 = conf_service_metadata_field_id(service, (const char *) type);
1387 if (md_field_id < 0)
1389 if (se->number_of_warnings_unknown_metadata == 0)
1391 session_log(se, YLOG_WARN,
1392 "Ignoring unknown metadata element: %s", type);
1394 se->number_of_warnings_unknown_metadata++;
1398 ser_md = &service->metadata[md_field_id];
1400 if (ser_md->sortkey_offset >= 0){
1401 sk_field_id = ser_md->sortkey_offset;
1402 ser_sk = &service->sortkeys[sk_field_id];
1405 // non-merged metadata
1406 rec_md = record_metadata_init(se->nmem, (const char *) value,
1407 ser_md->type, n->properties);
1410 session_log(se, YLOG_WARN, "bad metadata data '%s' "
1411 "for element '%s'", value, type);
1414 wheretoput = &record->metadata[md_field_id];
1416 wheretoput = &(*wheretoput)->next;
1417 *wheretoput = rec_md;
1420 rec_md = record_metadata_init(se->nmem, (const char *) value,
1422 wheretoput = &cluster->metadata[md_field_id];
1424 // and polulate with data:
1425 // assign cluster or record based on merge action
1426 if (ser_md->merge == Metadata_merge_unique)
1428 struct record_metadata *mnode;
1429 for (mnode = *wheretoput; mnode; mnode = mnode->next)
1430 if (!strcmp((const char *) mnode->data.text.disp,
1431 rec_md->data.text.disp))
1435 rec_md->next = *wheretoput;
1436 *wheretoput = rec_md;
1439 else if (ser_md->merge == Metadata_merge_longest)
1442 || strlen(rec_md->data.text.disp)
1443 > strlen((*wheretoput)->data.text.disp))
1445 *wheretoput = rec_md;
1448 const char *sort_str = 0;
1450 ser_sk->type == Metadata_sortkey_skiparticle;
1452 if (!cluster->sortkeys[sk_field_id])
1453 cluster->sortkeys[sk_field_id] =
1454 nmem_malloc(se->nmem,
1455 sizeof(union data_types));
1457 prt = pp2_relevance_tokenize(service->sort_pct);
1459 pp2_relevance_first(prt, rec_md->data.text.disp,
1462 pp2_relevance_token_next(prt);
1464 sort_str = pp2_get_sort(prt);
1466 cluster->sortkeys[sk_field_id]->text.disp =
1467 rec_md->data.text.disp;
1470 sort_str = rec_md->data.text.disp;
1471 session_log(se, YLOG_WARN,
1472 "Could not make sortkey. Bug #1858");
1474 cluster->sortkeys[sk_field_id]->text.sort =
1475 nmem_strdup(se->nmem, sort_str);
1476 pp2_relevance_token_destroy(prt);
1480 else if (ser_md->merge == Metadata_merge_all)
1482 rec_md->next = *wheretoput;
1483 *wheretoput = rec_md;
1485 else if (ser_md->merge == Metadata_merge_range)
1489 *wheretoput = rec_md;
1491 cluster->sortkeys[sk_field_id]
1496 int this_min = rec_md->data.number.min;
1497 int this_max = rec_md->data.number.max;
1498 if (this_min < (*wheretoput)->data.number.min)
1499 (*wheretoput)->data.number.min = this_min;
1500 if (this_max > (*wheretoput)->data.number.max)
1501 (*wheretoput)->data.number.max = this_max;
1506 // ranking of _all_ fields enabled ...
1508 relevance_countwords(se->relevance, cluster,
1509 (char *) value, ser_md->rank,
1512 // construct facets ... unless the client already has reported them
1513 if (ser_md->termlist && !client_has_facet(cl, (char *) type))
1515 if (ser_md->type == Metadata_type_year)
1518 sprintf(year, "%d", rec_md->data.number.max);
1520 add_facet(se, (char *) type, year, term_factor);
1521 if (rec_md->data.number.max != rec_md->data.number.min)
1523 sprintf(year, "%d", rec_md->data.number.min);
1524 add_facet(se, (char *) type, year, term_factor);
1528 add_facet(se, (char *) type, (char *) value, term_factor);
1538 if (se->number_of_warnings_unknown_elements == 0)
1539 session_log(se, YLOG_WARN,
1540 "Unexpected element in internal record: %s", n->name);
1541 se->number_of_warnings_unknown_elements++;
1549 relevance_donerecord(se->relevance, cluster);
1550 se->total_records++;
1555 void session_log(struct session *s, int level, const char *fmt, ...)
1561 yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
1562 yaz_log(level, "Session (%u): %s", s->session_id, buf);
1570 * c-file-style: "Stroustrup"
1571 * indent-tabs-mode: nil
1573 * vim: shiftwidth=4 tabstop=8 expandtab