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_charset_token_t prt;
192 const char *facet_component;
193 WRBUF facet_wrbuf = wrbuf_alloc();
194 WRBUF display_wrbuf = wrbuf_alloc();
196 const char *icu_chain_id = 0;
198 for (i = 0; i < service->num_metadata; i++)
199 if (!strcmp((service->metadata + i)->name, type))
200 icu_chain_id = (service->metadata + i)->facetrule;
202 icu_chain_id = "facet";
203 prt = pp2_charset_token_create(service->charsets, icu_chain_id);
206 yaz_log(YLOG_FATAL, "Unknown ICU chain '%s' for facet of type '%s'",
208 wrbuf_destroy(facet_wrbuf);
209 wrbuf_destroy(display_wrbuf);
212 pp2_charset_token_first(prt, value, 0);
213 while ((facet_component = pp2_charset_token_next(prt)))
215 const char *display_component;
216 if (*facet_component)
218 if (wrbuf_len(facet_wrbuf))
219 wrbuf_puts(facet_wrbuf, " ");
220 wrbuf_puts(facet_wrbuf, facet_component);
222 display_component = pp2_get_display(prt);
223 if (display_component)
225 if (wrbuf_len(display_wrbuf))
226 wrbuf_puts(display_wrbuf, " ");
227 wrbuf_puts(display_wrbuf, display_component);
230 pp2_charset_token_destroy(prt);
232 if (wrbuf_len(facet_wrbuf))
235 for (i = 0; i < s->num_termlists; i++)
236 if (!strcmp(s->termlists[i].name, type))
238 if (i == s->num_termlists)
240 if (i == SESSION_MAX_TERMLISTS)
242 session_log(s, YLOG_FATAL, "Too many termlists");
243 wrbuf_destroy(facet_wrbuf);
244 wrbuf_destroy(display_wrbuf);
248 s->termlists[i].name = nmem_strdup(s->nmem, type);
249 s->termlists[i].termlist
250 = termlist_create(s->nmem, TERMLIST_HIGH_SCORE);
251 s->num_termlists = i + 1;
255 session_log(s, YLOG_DEBUG, "Facets for %s: %s norm:%s (%d)", type, value, wrbuf_cstr(facet_wrbuf), count);
257 termlist_insert(s->termlists[i].termlist, wrbuf_cstr(display_wrbuf),
258 wrbuf_cstr(facet_wrbuf), count);
260 wrbuf_destroy(facet_wrbuf);
261 wrbuf_destroy(display_wrbuf);
264 static xmlDoc *record_to_xml(struct session *se,
265 struct session_database *sdb, const char *rec)
267 struct database *db = sdb->database;
270 rdoc = xmlParseMemory(rec, strlen(rec));
274 session_log(se, YLOG_FATAL, "Non-wellformed XML received from %s",
279 if (global_parameters.dump_records)
281 session_log(se, YLOG_LOG, "Un-normalized record from %s", db->url);
288 #define MAX_XSLT_ARGS 16
290 // Add static values from session database settings if applicable
291 static void insert_settings_parameters(struct session_database *sdb,
292 struct conf_service *service,
300 for (i = 0; i < service->num_metadata; i++)
302 struct conf_metadata *md = &service->metadata[i];
305 if (md->setting == Metadata_setting_parameter &&
306 (setting = settings_lookup_offset(service, md->name)) >= 0)
308 const char *val = session_setting_oneval(sdb, setting);
309 if (val && nparms < MAX_XSLT_ARGS)
312 int len = strlen(val);
313 buf = nmem_malloc(nmem, len + 3);
315 strcpy(buf + 1, val);
318 parms[offset++] = md->name;
319 parms[offset++] = buf;
327 // Add static values from session database settings if applicable
328 static void insert_settings_values(struct session_database *sdb, xmlDoc *doc,
329 struct conf_service *service)
333 for (i = 0; i < service->num_metadata; i++)
335 struct conf_metadata *md = &service->metadata[i];
338 if (md->setting == Metadata_setting_postproc &&
339 (offset = settings_lookup_offset(service, md->name)) >= 0)
341 const char *val = session_setting_oneval(sdb, offset);
344 xmlNode *r = xmlDocGetRootElement(doc);
345 xmlNode *n = xmlNewTextChild(r, 0, (xmlChar *) "metadata",
347 xmlSetProp(n, (xmlChar *) "type", (xmlChar *) md->name);
353 static xmlDoc *normalize_record(struct session *se,
354 struct session_database *sdb,
355 struct conf_service *service,
356 const char *rec, NMEM nmem)
358 xmlDoc *rdoc = record_to_xml(se, sdb, rec);
362 char *parms[MAX_XSLT_ARGS*2+1];
364 insert_settings_parameters(sdb, service, parms, nmem);
366 if (normalize_record_transform(sdb->map, &rdoc, (const char **)parms))
368 session_log(se, YLOG_WARN, "Normalize failed from %s",
373 insert_settings_values(sdb, rdoc, service);
375 if (global_parameters.dump_records)
377 session_log(se, YLOG_LOG, "Normalized record from %s",
386 void session_settings_dump(struct session *se,
387 struct session_database *db,
392 int i, num = db->num_settings;
393 for (i = 0; i < num; i++)
395 struct setting *s = db->settings[i];
396 for (;s ; s = s->next)
398 wrbuf_puts(w, "<set name=\"");
399 wrbuf_xmlputs(w, s->name);
400 wrbuf_puts(w, "\" value=\"");
401 wrbuf_xmlputs(w, s->value);
402 wrbuf_puts(w, "\"/>");
410 // Retrieve first defined value for 'name' for given database.
411 // Will be extended to take into account user associated with session
412 const char *session_setting_oneval(struct session_database *db, int offset)
414 if (offset >= db->num_settings || !db->settings[offset])
416 return db->settings[offset]->value;
419 // Prepare XSLT stylesheets for record normalization
420 // Structures are allocated on the session_wide nmem to avoid having
421 // to recompute this for every search. This would lead
422 // to leaking if a single session was to repeatedly change the PZ_XSLT
423 // setting. However, this is not a realistic use scenario.
424 static int prepare_map(struct session *se, struct session_database *sdb)
430 session_log(se, YLOG_WARN, "No settings on %s", sdb->database->url);
433 if ((s = session_setting_oneval(sdb, PZ_XSLT)))
435 char auto_stylesheet[256];
437 if (!strcmp(s, "auto"))
439 const char *request_syntax = session_setting_oneval(
440 sdb, PZ_REQUESTSYNTAX);
444 yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet),
445 "%s.xsl", request_syntax);
446 for (cp = auto_stylesheet; *cp; cp++)
448 /* deliberately only consider ASCII */
449 if (*cp > 32 && *cp < 127)
456 session_log(se, YLOG_WARN,
457 "No pz:requestsyntax for auto stylesheet");
460 sdb->map = normalize_cache_get(se->normalize_cache,
461 se->service->server->config, s);
468 // This analyzes settings and recomputes any supporting data structures
470 static int prepare_session_database(struct session *se,
471 struct session_database *sdb)
475 session_log(se, YLOG_WARN,
476 "No settings associated with %s", sdb->database->url);
479 if (sdb->settings[PZ_XSLT] && !sdb->map)
481 if (prepare_map(se, sdb) < 0)
487 // called if watch should be removed because http_channel is to be destroyed
488 static void session_watch_cancel(void *data, struct http_channel *c,
491 struct session_watchentry *ent = data;
498 // set watch. Returns 0=OK, -1 if watch is already set
499 int session_set_watch(struct session *s, int what,
500 session_watchfun fun, void *data,
501 struct http_channel *chan)
505 if (s->watchlist[what].fun)
510 s->watchlist[what].fun = fun;
511 s->watchlist[what].data = data;
512 s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
513 session_watch_cancel);
520 void session_alert_watch(struct session *s, int what)
524 if (s->watchlist[what].fun)
526 /* our watch is no longer associated with http_channel */
528 session_watchfun fun;
530 http_remove_observer(s->watchlist[what].obs);
531 fun = s->watchlist[what].fun;
532 data = s->watchlist[what].data;
534 /* reset watch before fun is invoked - in case fun wants to set
536 s->watchlist[what].fun = 0;
537 s->watchlist[what].data = 0;
538 s->watchlist[what].obs = 0;
541 session_log(s, YLOG_DEBUG,
542 "Alert Watch: %d calling function: %p", what, fun);
549 //callback for grep_databases
550 static void select_targets_callback(void *context, struct session_database *db)
552 struct session *se = (struct session*) context;
553 struct client *cl = client_create();
554 struct client_list *l;
555 client_set_database(cl, db);
557 client_set_session(cl, se);
559 l = xmalloc(sizeof(*l));
561 l->next = se->clients;
565 static void session_remove_clients(struct session *se)
567 struct client_list *l;
576 struct client_list *l_next = l->next;
577 client_lock(l->client);
578 client_set_session(l->client, 0);
579 client_set_database(l->client, 0);
580 client_unlock(l->client);
581 client_destroy(l->client);
587 // Associates a set of clients with a session;
588 // Note: Session-databases represent databases with per-session
590 static int select_targets(struct session *se, const char *filter)
592 return session_grep_databases(se, filter, select_targets_callback);
595 int session_active_clients(struct session *s)
597 struct client_list *l;
600 for (l = s->clients; l; l = l->next)
601 if (client_is_active(l->client))
607 int session_is_preferred_clients_ready(struct session *s)
609 struct client_list *l;
612 for (l = s->clients; l; l = l->next)
613 if (client_is_active_preferred(l->client))
615 session_log(s, YLOG_DEBUG, "Has %d active preferred clients.", res);
619 enum pazpar2_error_code search(struct session *se,
621 const char *startrecs, const char *maxrecs,
624 const char **addinfo)
626 int live_channels = 0;
629 struct client_list *l;
631 facet_limits_t facet_limits;
633 session_log(se, YLOG_DEBUG, "Search");
637 session_remove_clients(se);
640 reclist_destroy(se->reclist);
642 relevance_destroy(&se->relevance);
643 nmem_reset(se->nmem);
644 se->total_records = se->total_hits = se->total_merged = 0;
645 se->num_termlists = 0;
646 live_channels = select_targets(se, filter);
650 return PAZPAR2_NO_TARGETS;
652 se->reclist = reclist_create(se->nmem);
654 yaz_gettimeofday(&tval);
658 facet_limits = facet_limits_create(limit);
663 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
665 for (l = se->clients; l; l = l->next)
667 struct client *cl = l->client;
670 client_set_maxrecs(cl, atoi(maxrecs));
672 client_set_startrecs(cl, atoi(startrecs));
673 if (prepare_session_database(se, client_get_database(cl)) < 0)
675 else if (client_parse_query(cl, query, facet_limits) < 0)
680 if (client_prep_connection(cl, se->service->z3950_operation_timeout,
681 se->service->z3950_session_timeout,
682 se->service->server->iochan_man,
684 client_start_search(cl);
687 facet_limits_destroy(facet_limits);
694 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
697 return PAZPAR2_NO_TARGETS;
699 return PAZPAR2_NO_ERROR;
702 // Creates a new session_database object for a database
703 static void session_init_databases_fun(void *context, struct database *db)
705 struct session *se = (struct session *) context;
706 struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
712 assert(db->settings);
713 new->settings = nmem_malloc(se->session_nmem,
714 sizeof(struct settings *) * db->num_settings);
715 new->num_settings = db->num_settings;
716 for (i = 0; i < db->num_settings; i++)
718 struct setting *setting = db->settings[i];
719 new->settings[i] = setting;
721 new->next = se->databases;
725 // Doesn't free memory associated with sdb -- nmem takes care of that
726 static void session_database_destroy(struct session_database *sdb)
731 // Initialize session_database list -- this represents this session's view
732 // of the database list -- subject to modification by the settings ws command
733 void session_init_databases(struct session *se)
736 predef_grep_databases(se, se->service, session_init_databases_fun);
739 // Probably session_init_databases_fun should be refactored instead of
741 static struct session_database *load_session_database(struct session *se,
744 struct database *db = new_database(id, se->session_nmem);
746 resolve_database(se->service, db);
748 session_init_databases_fun((void*) se, db);
750 // New sdb is head of se->databases list
751 return se->databases;
754 // Find an existing session database. If not found, load it
755 static struct session_database *find_session_database(struct session *se,
758 struct session_database *sdb;
760 for (sdb = se->databases; sdb; sdb = sdb->next)
761 if (!strcmp(sdb->database->url, id))
763 return load_session_database(se, id);
766 // Apply a session override to a database
767 void session_apply_setting(struct session *se, char *dbname, char *setting,
770 struct session_database *sdb = find_session_database(se, dbname);
771 struct conf_service *service = se->service;
772 struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
773 int offset = settings_create_offset(service, setting);
775 expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
778 new->target = dbname;
781 new->next = sdb->settings[offset];
782 sdb->settings[offset] = new;
784 // Force later recompute of settings-driven data structures
785 // (happens when a search starts and client connections are prepared)
797 void session_destroy(struct session *se) {
798 struct session_database *sdb;
799 session_log(se, YLOG_DEBUG, "Destroying");
801 session_remove_clients(se);
803 for (sdb = se->databases; sdb; sdb = sdb->next)
804 session_database_destroy(sdb);
805 normalize_cache_destroy(se->normalize_cache);
806 relevance_destroy(&se->relevance);
807 reclist_destroy(se->reclist);
808 nmem_destroy(se->nmem);
809 service_destroy(se->service);
810 yaz_mutex_destroy(&se->session_mutex);
813 /* Depreciated: use session_destroy */
814 void destroy_session(struct session *se)
819 size_t session_get_memory_status(struct session *session) {
823 session_enter(session);
824 session_nmem = nmem_total(session->nmem);
825 session_leave(session);
830 struct session *new_session(NMEM nmem, struct conf_service *service,
834 struct session *session = nmem_malloc(nmem, sizeof(*session));
838 sprintf(tmp_str, "session#%u", session_id);
840 session->session_id = session_id;
841 session_log(session, YLOG_DEBUG, "New");
842 session->service = service;
843 session->relevance = 0;
844 session->total_hits = 0;
845 session->total_records = 0;
846 session->number_of_warnings_unknown_elements = 0;
847 session->number_of_warnings_unknown_metadata = 0;
848 session->num_termlists = 0;
849 session->reclist = 0;
850 session->clients = 0;
851 session->session_nmem = nmem;
852 session->nmem = nmem_create();
853 session->databases = 0;
854 for (i = 0; i <= SESSION_WATCH_MAX; i++)
856 session->watchlist[i].data = 0;
857 session->watchlist[i].fun = 0;
859 session->normalize_cache = normalize_cache_create();
860 session->session_mutex = 0;
861 pazpar2_mutex_create(&session->session_mutex, tmp_str);
866 struct hitsbytarget *hitsbytarget(struct session *se, int *count, NMEM nmem)
868 struct hitsbytarget *res = 0;
869 struct client_list *l;
873 for (l = se->clients; l; l = l->next)
876 res = nmem_malloc(nmem, sizeof(*res) * sz);
878 for (l = se->clients; l; l = l->next)
880 struct client *cl = l->client;
881 WRBUF w = wrbuf_alloc();
882 const char *name = session_setting_oneval(client_get_database(cl),
885 res[*count].id = client_get_database(cl)->database->url;
886 res[*count].name = *name ? name : "Unknown";
887 res[*count].hits = client_get_hits(cl);
888 res[*count].records = client_get_num_records(cl);
889 res[*count].diagnostic = client_get_diagnostic(cl);
890 res[*count].state = client_get_state_str(cl);
891 res[*count].connected = client_get_connection(cl) ? 1 : 0;
892 session_settings_dump(se, client_get_database(cl), w);
893 res[*count].settings_xml = nmem_strdup(nmem, wrbuf_cstr(w));
901 struct termlist_score **get_termlist_score(struct session *se,
902 const char *name, int *num)
905 struct termlist_score **tl = 0;
908 for (i = 0; i < se->num_termlists; i++)
909 if (!strcmp((const char *) se->termlists[i].name, name))
911 tl = termlist_highscore(se->termlists[i].termlist, num);
918 #ifdef MISSING_HEADERS
919 void report_nmem_stats(void)
921 size_t in_use, is_free;
923 nmem_get_memory_in_use(&in_use);
924 nmem_get_memory_free(&is_free);
926 yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
927 (long) in_use, (long) is_free);
931 struct record_cluster *show_single_start(struct session *se, const char *id,
932 struct record_cluster **prev_r,
933 struct record_cluster **next_r)
935 struct record_cluster *r = 0;
942 reclist_enter(se->reclist);
943 while ((r = reclist_read_record(se->reclist)))
945 if (!strcmp(r->recid, id))
947 *next_r = reclist_read_record(se->reclist);
952 reclist_leave(se->reclist);
959 void show_single_stop(struct session *se, struct record_cluster *rec)
964 struct record_cluster **show_range_start(struct session *se,
965 struct reclist_sortparms *sp,
966 int start, int *num, int *total, Odr_int *sumhits)
968 struct record_cluster **recs;
969 struct reclist_sortparms *spp;
972 yaz_timing_t t = yaz_timing_create();
975 recs = nmem_malloc(se->nmem, *num * sizeof(struct record_cluster *));
985 for (spp = sp; spp; spp = spp->next)
986 if (spp->type == Metadata_sortkey_relevance)
988 relevance_prepare_read(se->relevance, se->reclist);
991 reclist_sort(se->reclist, sp);
993 reclist_enter(se->reclist);
994 *total = reclist_get_num_records(se->reclist);
995 *sumhits = se->total_hits;
997 for (i = 0; i < start; i++)
998 if (!reclist_read_record(se->reclist))
1005 for (i = 0; i < *num; i++)
1007 struct record_cluster *r = reclist_read_record(se->reclist);
1015 reclist_leave(se->reclist);
1019 yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
1020 yaz_timing_get_real(t), yaz_timing_get_user(t),
1021 yaz_timing_get_sys(t));
1022 yaz_timing_destroy(&t);
1027 void show_range_stop(struct session *se, struct record_cluster **recs)
1032 void statistics(struct session *se, struct statistics *stat)
1034 struct client_list *l;
1037 memset(stat, 0, sizeof(*stat));
1038 for (l = se->clients; l; l = l->next)
1040 struct client *cl = l->client;
1041 if (!client_get_connection(cl))
1042 stat->num_no_connection++;
1043 switch (client_get_state(cl))
1045 case Client_Connecting: stat->num_connecting++; break;
1046 case Client_Working: stat->num_working++; break;
1047 case Client_Idle: stat->num_idle++; break;
1048 case Client_Failed: stat->num_failed++; break;
1049 case Client_Error: stat->num_error++; break;
1054 stat->num_hits = se->total_hits;
1055 stat->num_records = se->total_records;
1057 stat->num_clients = count;
1060 static struct record_metadata *record_metadata_init(
1061 NMEM nmem, const char *value, enum conf_metadata_type type,
1062 struct _xmlAttr *attr)
1064 struct record_metadata *rec_md = record_metadata_create(nmem);
1065 struct record_metadata_attr **attrp = &rec_md->attributes;
1067 for (; attr; attr = attr->next)
1069 if (attr->children && attr->children->content)
1071 if (strcmp((const char *) attr->name, "type"))
1072 { /* skip the "type" attribute.. Its value is already part of
1073 the element in output (md-%s) and so repeating it here
1075 *attrp = nmem_malloc(nmem, sizeof(**attrp));
1077 nmem_strdup(nmem, (const char *) attr->name);
1079 nmem_strdup(nmem, (const char *) attr->children->content);
1080 attrp = &(*attrp)->next;
1086 if (type == Metadata_type_generic)
1088 char *p = nmem_strdup(nmem, value);
1090 p = normalize7bit_generic(p, " ,/.:([");
1092 rec_md->data.text.disp = p;
1093 rec_md->data.text.sort = 0;
1095 else if (type == Metadata_type_year || type == Metadata_type_date)
1100 if (type == Metadata_type_date)
1102 if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
1105 rec_md->data.number.min = first;
1106 rec_md->data.number.max = last;
1113 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
1114 struct conf_service *service, WRBUF norm_wr)
1118 for (n = root->children; n; n = n->next)
1120 if (n->type != XML_ELEMENT_NODE)
1122 if (!strcmp((const char *) n->name, "metadata"))
1124 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1126 yaz_log(YLOG_FATAL, "Missing type attribute on metadata element. Skipping!");
1128 else if (!strcmp(name, (const char *) type))
1130 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
1133 const char *norm_str;
1134 pp2_charset_token_t prt =
1135 pp2_charset_token_create(service->charsets, "mergekey");
1137 pp2_charset_token_first(prt, (const char *) value, 0);
1138 if (wrbuf_len(norm_wr) > 0)
1139 wrbuf_puts(norm_wr, " ");
1140 wrbuf_puts(norm_wr, name);
1142 pp2_charset_token_next(prt)))
1146 wrbuf_puts(norm_wr, " ");
1147 wrbuf_puts(norm_wr, norm_str);
1151 pp2_charset_token_destroy(prt);
1161 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
1162 struct conf_service *service, NMEM nmem)
1164 char *mergekey_norm = 0;
1165 xmlNode *root = xmlDocGetRootElement(doc);
1166 WRBUF norm_wr = wrbuf_alloc();
1168 /* consider mergekey from XSL first */
1169 xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
1172 const char *norm_str;
1173 pp2_charset_token_t prt =
1174 pp2_charset_token_create(service->charsets, "mergekey");
1176 pp2_charset_token_first(prt, (const char *) mergekey, 0);
1177 while ((norm_str = pp2_charset_token_next(prt)))
1181 if (wrbuf_len(norm_wr))
1182 wrbuf_puts(norm_wr, " ");
1183 wrbuf_puts(norm_wr, norm_str);
1186 pp2_charset_token_destroy(prt);
1191 /* no mergekey defined in XSL. Look for mergekey metadata instead */
1193 for (field_id = 0; field_id < service->num_metadata; field_id++)
1195 struct conf_metadata *ser_md = &service->metadata[field_id];
1196 if (ser_md->mergekey != Metadata_mergekey_no)
1198 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1200 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1202 /* no mergekey on this one and it is required..
1203 Generate unique key instead */
1204 wrbuf_rewind(norm_wr);
1211 /* generate unique key if none is not generated already or is empty */
1212 if (wrbuf_len(norm_wr) == 0)
1214 wrbuf_printf(norm_wr, "%s-%d",
1215 client_get_database(cl)->database->url, record_no);
1217 if (wrbuf_len(norm_wr) > 0)
1218 mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1219 wrbuf_destroy(norm_wr);
1220 return mergekey_norm;
1223 /** \brief see if metadata for pz:recordfilter exists
1224 \param root xml root element of normalized record
1225 \param sdb session database for client
1226 \retval 0 if there is no metadata for pz:recordfilter
1227 \retval 1 if there is metadata for pz:recordfilter
1229 If there is no pz:recordfilter defined, this function returns 1
1233 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1238 s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1243 for (n = root->children; n; n = n->next)
1245 if (n->type != XML_ELEMENT_NODE)
1247 if (!strcmp((const char *) n->name, "metadata"))
1249 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1256 if ((eq = strchr(s, '=')))
1258 else if ((eq = strchr(s, '~')))
1264 if (len == strlen((const char *)type) &&
1265 !memcmp((const char *) type, s, len))
1267 xmlChar *value = xmlNodeGetContent(n);
1268 if (value && *value)
1271 (substring && strstr((const char *) value, eq+1)) ||
1272 (!substring && !strcmp((const char *) value, eq + 1)))
1285 static int ingest_to_cluster(struct client *cl,
1289 const char *mergekey_norm);
1291 /** \brief ingest XML record
1292 \param cl client holds the result set for record
1293 \param rec record buffer (0 terminated)
1294 \param record_no record position (1, 2, ..)
1295 \param nmem working NMEM
1300 int ingest_record(struct client *cl, const char *rec,
1301 int record_no, NMEM nmem)
1303 struct session *se = client_get_session(cl);
1305 struct session_database *sdb = client_get_database(cl);
1306 struct conf_service *service = se->service;
1307 xmlDoc *xdoc = normalize_record(se, sdb, service, rec, nmem);
1309 const char *mergekey_norm;
1314 root = xmlDocGetRootElement(xdoc);
1316 if (!check_record_filter(root, sdb))
1318 session_log(se, YLOG_LOG, "Filtered out record no %d from %s",
1319 record_no, sdb->database->url);
1324 mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem);
1327 session_log(se, YLOG_WARN, "Got no mergekey");
1332 if (client_get_session(cl) == se)
1333 ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1340 static int ingest_to_cluster(struct client *cl,
1344 const char *mergekey_norm)
1349 struct session_database *sdb = client_get_database(cl);
1350 struct session *se = client_get_session(cl);
1351 struct conf_service *service = se->service;
1352 struct record *record = record_create(se->nmem,
1353 service->num_metadata,
1354 service->num_sortkeys, cl,
1356 struct record_cluster *cluster = reclist_insert(se->reclist,
1362 const char *use_term_factor_str = session_setting_oneval(sdb, PZ_TERMLIST_TERM_FACTOR);
1363 int use_term_factor = 0;
1364 int term_factor = 1;
1365 if (use_term_factor_str && use_term_factor_str[0] != 0)
1366 use_term_factor = atoi(use_term_factor_str);
1367 if (use_term_factor) {
1368 int maxrecs = client_get_maxrecs(cl);
1369 int hits = (int) client_get_hits(cl);
1370 term_factor = MAX(hits, maxrecs) / MAX(1, maxrecs);
1371 assert(term_factor >= 1);
1372 yaz_log(YLOG_DEBUG, "Using term factor: %d (%d / %d)", term_factor, MAX(hits, maxrecs), MAX(1, maxrecs));
1377 if (global_parameters.dump_records)
1378 session_log(se, YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1379 sdb->database->url, record_no);
1380 relevance_newrec(se->relevance, cluster);
1382 // now parsing XML record and adding data to cluster or record metadata
1383 for (n = root->children; n; n = n->next)
1385 pp2_charset_token_t prt;
1392 if (n->type != XML_ELEMENT_NODE)
1394 if (!strcmp((const char *) n->name, "metadata"))
1396 struct conf_metadata *ser_md = 0;
1397 struct conf_sortkey *ser_sk = 0;
1398 struct record_metadata **wheretoput = 0;
1399 struct record_metadata *rec_md = 0;
1400 int md_field_id = -1;
1401 int sk_field_id = -1;
1403 type = xmlGetProp(n, (xmlChar *) "type");
1404 value = xmlNodeListGetString(xdoc, n->children, 1);
1406 if (!type || !value || !*value)
1410 = conf_service_metadata_field_id(service, (const char *) type);
1411 if (md_field_id < 0)
1413 if (se->number_of_warnings_unknown_metadata == 0)
1415 session_log(se, YLOG_WARN,
1416 "Ignoring unknown metadata element: %s", type);
1418 se->number_of_warnings_unknown_metadata++;
1422 ser_md = &service->metadata[md_field_id];
1424 if (ser_md->sortkey_offset >= 0){
1425 sk_field_id = ser_md->sortkey_offset;
1426 ser_sk = &service->sortkeys[sk_field_id];
1429 // non-merged metadata
1430 rec_md = record_metadata_init(se->nmem, (const char *) value,
1431 ser_md->type, n->properties);
1434 session_log(se, YLOG_WARN, "bad metadata data '%s' "
1435 "for element '%s'", value, type);
1438 wheretoput = &record->metadata[md_field_id];
1440 wheretoput = &(*wheretoput)->next;
1441 *wheretoput = rec_md;
1444 rec_md = record_metadata_init(se->nmem, (const char *) value,
1446 wheretoput = &cluster->metadata[md_field_id];
1448 // and polulate with data:
1449 // assign cluster or record based on merge action
1450 if (ser_md->merge == Metadata_merge_unique)
1454 if (!strcmp((const char *) (*wheretoput)->data.text.disp,
1455 rec_md->data.text.disp))
1457 wheretoput = &(*wheretoput)->next;
1460 *wheretoput = rec_md;
1462 else if (ser_md->merge == Metadata_merge_longest)
1465 || strlen(rec_md->data.text.disp)
1466 > strlen((*wheretoput)->data.text.disp))
1468 *wheretoput = rec_md;
1471 const char *sort_str = 0;
1473 ser_sk->type == Metadata_sortkey_skiparticle;
1475 if (!cluster->sortkeys[sk_field_id])
1476 cluster->sortkeys[sk_field_id] =
1477 nmem_malloc(se->nmem,
1478 sizeof(union data_types));
1481 pp2_charset_token_create(service->charsets, "sort");
1483 pp2_charset_token_first(prt, rec_md->data.text.disp,
1486 pp2_charset_token_next(prt);
1488 sort_str = pp2_get_sort(prt);
1490 cluster->sortkeys[sk_field_id]->text.disp =
1491 rec_md->data.text.disp;
1494 sort_str = rec_md->data.text.disp;
1495 session_log(se, YLOG_WARN,
1496 "Could not make sortkey. Bug #1858");
1498 cluster->sortkeys[sk_field_id]->text.sort =
1499 nmem_strdup(se->nmem, sort_str);
1500 pp2_charset_token_destroy(prt);
1504 else if (ser_md->merge == Metadata_merge_all)
1507 wheretoput = &(*wheretoput)->next;
1508 *wheretoput = rec_md;
1510 else if (ser_md->merge == Metadata_merge_range)
1514 *wheretoput = rec_md;
1516 cluster->sortkeys[sk_field_id]
1521 int this_min = rec_md->data.number.min;
1522 int this_max = rec_md->data.number.max;
1523 if (this_min < (*wheretoput)->data.number.min)
1524 (*wheretoput)->data.number.min = this_min;
1525 if (this_max > (*wheretoput)->data.number.max)
1526 (*wheretoput)->data.number.max = this_max;
1531 // ranking of _all_ fields enabled ...
1533 relevance_countwords(se->relevance, cluster,
1534 (char *) value, ser_md->rank,
1537 // construct facets ... unless the client already has reported them
1538 if (ser_md->termlist && !client_has_facet(cl, (char *) type))
1540 if (ser_md->type == Metadata_type_year)
1543 sprintf(year, "%d", rec_md->data.number.max);
1545 add_facet(se, (char *) type, year, term_factor);
1546 if (rec_md->data.number.max != rec_md->data.number.min)
1548 sprintf(year, "%d", rec_md->data.number.min);
1549 add_facet(se, (char *) type, year, term_factor);
1553 add_facet(se, (char *) type, (char *) value, term_factor);
1563 if (se->number_of_warnings_unknown_elements == 0)
1564 session_log(se, YLOG_WARN,
1565 "Unexpected element in internal record: %s", n->name);
1566 se->number_of_warnings_unknown_elements++;
1574 relevance_donerecord(se->relevance, cluster);
1575 se->total_records++;
1580 void session_log(struct session *s, int level, const char *fmt, ...)
1586 yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
1587 yaz_log(level, "Session (%u): %s", s->session_id, buf);
1595 * c-file-style: "Stroustrup"
1596 * indent-tabs-mode: nil
1598 * vim: shiftwidth=4 tabstop=8 expandtab