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 =
93 struct client *client;
94 struct client_list *next;
97 static void log_xml_doc(xmlDoc *doc)
99 FILE *lf = yaz_log_file();
102 #if LIBXML_VERSION >= 20600
103 xmlDocDumpFormatMemory(doc, &result, &len, 1);
105 xmlDocDumpMemory(doc, &result, &len);
109 (void) fwrite(result, 1, len, lf);
115 static void session_enter(struct session *s)
117 yaz_mutex_enter(s->session_mutex);
120 static void session_leave(struct session *s)
122 yaz_mutex_leave(s->session_mutex);
125 // Recursively traverse query structure to extract terms.
126 void pull_terms(NMEM nmem, struct ccl_rpn_node *n, char **termlist, int *num)
138 pull_terms(nmem, n->u.p[0], termlist, num);
139 pull_terms(nmem, n->u.p[1], termlist, num);
142 nmem_strsplit(nmem, " ", n->u.t.term, &words, &numwords);
143 for (i = 0; i < numwords; i++)
144 termlist[(*num)++] = words[i];
152 void add_facet(struct session *s, const char *type, const char *value, int count)
154 struct conf_service *service = s->service;
155 pp2_relevance_token_t prt;
156 const char *facet_component;
157 WRBUF facet_wrbuf = wrbuf_alloc();
158 prt = pp2_relevance_tokenize(service->facet_pct);
160 pp2_relevance_first(prt, value, 0);
161 while ((facet_component = pp2_relevance_token_next(prt)))
163 if (*facet_component)
165 if (wrbuf_len(facet_wrbuf))
166 wrbuf_puts(facet_wrbuf, " ");
167 wrbuf_puts(facet_wrbuf, facet_component);
170 pp2_relevance_token_destroy(prt);
172 if (wrbuf_len(facet_wrbuf))
175 for (i = 0; i < s->num_termlists; i++)
176 if (!strcmp(s->termlists[i].name, type))
178 if (i == s->num_termlists)
180 if (i == SESSION_MAX_TERMLISTS)
182 session_log(s, YLOG_FATAL, "Too many termlists");
183 wrbuf_destroy(facet_wrbuf);
187 s->termlists[i].name = nmem_strdup(s->nmem, type);
188 s->termlists[i].termlist
189 = termlist_create(s->nmem, TERMLIST_HIGH_SCORE);
190 s->num_termlists = i + 1;
193 session_log(s, YLOG_DEBUG, "Session: facets for %s: %s norm:%s (%d)",
194 type, value, wrbuf_cstr(facet_wrbuf), count);
195 termlist_insert(s->termlists[i].termlist, wrbuf_cstr(facet_wrbuf),
198 wrbuf_destroy(facet_wrbuf);
201 static xmlDoc *record_to_xml(struct session *se,
202 struct session_database *sdb, const char *rec)
204 struct database *db = sdb->database;
207 rdoc = xmlParseMemory(rec, strlen(rec));
211 session_log(se, YLOG_FATAL, "Non-wellformed XML received from %s",
216 if (global_parameters.dump_records)
218 session_log(se, YLOG_LOG, "Un-normalized record from %s", db->url);
225 #define MAX_XSLT_ARGS 16
227 // Add static values from session database settings if applicable
228 static void insert_settings_parameters(struct session_database *sdb,
229 struct conf_service *service,
237 for (i = 0; i < service->num_metadata; i++)
239 struct conf_metadata *md = &service->metadata[i];
242 if (md->setting == Metadata_setting_parameter &&
243 (setting = settings_lookup_offset(service, md->name)) >= 0)
245 const char *val = session_setting_oneval(sdb, setting);
246 if (val && nparms < MAX_XSLT_ARGS)
249 int len = strlen(val);
250 buf = nmem_malloc(nmem, len + 3);
252 strcpy(buf + 1, val);
255 parms[offset++] = md->name;
256 parms[offset++] = buf;
264 // Add static values from session database settings if applicable
265 static void insert_settings_values(struct session_database *sdb, xmlDoc *doc,
266 struct conf_service *service)
270 for (i = 0; i < service->num_metadata; i++)
272 struct conf_metadata *md = &service->metadata[i];
275 if (md->setting == Metadata_setting_postproc &&
276 (offset = settings_lookup_offset(service, md->name)) >= 0)
278 const char *val = session_setting_oneval(sdb, offset);
281 xmlNode *r = xmlDocGetRootElement(doc);
282 xmlNode *n = xmlNewTextChild(r, 0, (xmlChar *) "metadata",
284 xmlSetProp(n, (xmlChar *) "type", (xmlChar *) md->name);
290 static xmlDoc *normalize_record(struct session *se,
291 struct session_database *sdb,
292 struct conf_service *service,
293 const char *rec, NMEM nmem)
295 xmlDoc *rdoc = record_to_xml(se, sdb, rec);
299 char *parms[MAX_XSLT_ARGS*2+1];
301 insert_settings_parameters(sdb, service, parms, nmem);
303 if (normalize_record_transform(sdb->map, &rdoc, (const char **)parms))
305 session_log(se, YLOG_WARN, "Normalize failed from %s",
310 insert_settings_values(sdb, rdoc, service);
312 if (global_parameters.dump_records)
314 session_log(se, YLOG_LOG, "Normalized record from %s",
323 void session_settings_dump(struct session *se,
324 struct session_database *db,
329 int i, num = db->num_settings;
330 for (i = 0; i < num; i++)
332 struct setting *s = db->settings[i];
333 for (;s ; s = s->next)
335 wrbuf_puts(w, "<set name=\"");
336 wrbuf_xmlputs(w, s->name);
337 wrbuf_puts(w, "\" value=\"");
338 wrbuf_xmlputs(w, s->value);
339 wrbuf_puts(w, "\"/>");
347 // Retrieve first defined value for 'name' for given database.
348 // Will be extended to take into account user associated with session
349 const char *session_setting_oneval(struct session_database *db, int offset)
351 if (offset >= db->num_settings || !db->settings[offset])
353 return db->settings[offset]->value;
356 // Prepare XSLT stylesheets for record normalization
357 // Structures are allocated on the session_wide nmem to avoid having
358 // to recompute this for every search. This would lead
359 // to leaking if a single session was to repeatedly change the PZ_XSLT
360 // setting. However, this is not a realistic use scenario.
361 static int prepare_map(struct session *se, struct session_database *sdb)
367 session_log(se, YLOG_WARN, "No settings on %s", sdb->database->url);
370 if ((s = session_setting_oneval(sdb, PZ_XSLT)))
372 char auto_stylesheet[256];
374 if (!strcmp(s, "auto"))
376 const char *request_syntax = session_setting_oneval(
377 sdb, PZ_REQUESTSYNTAX);
381 yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet),
382 "%s.xsl", request_syntax);
383 for (cp = auto_stylesheet; *cp; cp++)
385 /* deliberately only consider ASCII */
386 if (*cp > 32 && *cp < 127)
393 session_log(se, YLOG_WARN,
394 "No pz:requestsyntax for auto stylesheet");
397 sdb->map = normalize_cache_get(se->normalize_cache,
398 se->service->server->config, s);
405 // This analyzes settings and recomputes any supporting data structures
407 static int prepare_session_database(struct session *se,
408 struct session_database *sdb)
412 session_log(se, YLOG_WARN,
413 "No settings associated with %s", sdb->database->url);
416 if (sdb->settings[PZ_XSLT] && !sdb->map)
418 if (prepare_map(se, sdb) < 0)
424 // called if watch should be removed because http_channel is to be destroyed
425 static void session_watch_cancel(void *data, struct http_channel *c,
428 struct session_watchentry *ent = data;
435 // set watch. Returns 0=OK, -1 if watch is already set
436 int session_set_watch(struct session *s, int what,
437 session_watchfun fun, void *data,
438 struct http_channel *chan)
442 if (s->watchlist[what].fun)
447 s->watchlist[what].fun = fun;
448 s->watchlist[what].data = data;
449 s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
450 session_watch_cancel);
457 void session_alert_watch(struct session *s, int what)
461 if (s->watchlist[what].fun)
463 /* our watch is no longer associated with http_channel */
465 session_watchfun fun;
467 http_remove_observer(s->watchlist[what].obs);
468 fun = s->watchlist[what].fun;
469 data = s->watchlist[what].data;
471 /* reset watch before fun is invoked - in case fun wants to set
473 s->watchlist[what].fun = 0;
474 s->watchlist[what].data = 0;
475 s->watchlist[what].obs = 0;
478 session_log(s, YLOG_DEBUG,
479 "session_alert_watch: %d calling function: %p", what, fun);
486 //callback for grep_databases
487 static void select_targets_callback(void *context, struct session_database *db)
489 struct session *se = (struct session*) context;
490 struct client *cl = client_create();
491 struct client_list *l;
492 client_set_database(cl, db);
494 client_set_session(cl, se);
496 l = xmalloc(sizeof(*l));
498 l->next = se->clients;
502 static void session_remove_clients(struct session *se)
504 struct client_list *l;
513 struct client_list *l_next = l->next;
514 client_lock(l->client);
515 client_set_session(l->client, 0);
516 client_set_database(l->client, 0);
517 client_unlock(l->client);
518 client_destroy(l->client);
524 // Associates a set of clients with a session;
525 // Note: Session-databases represent databases with per-session
527 static int select_targets(struct session *se, const char *filter)
529 return session_grep_databases(se, filter, select_targets_callback);
532 int session_active_clients(struct session *s)
534 struct client_list *l;
537 for (l = s->clients; l; l = l->next)
538 if (client_is_active(l->client))
544 int session_is_preferred_clients_ready(struct session *s)
546 struct client_list *l;
549 for (l = s->clients; l; l = l->next)
550 if (client_is_active_preferred(l->client))
552 session_log(s, YLOG_DEBUG, "Session has %d active preferred clients.", res);
558 enum pazpar2_error_code search(struct session *se,
560 const char *startrecs, const char *maxrecs,
562 const char **addinfo)
564 int live_channels = 0;
567 struct client_list *l;
570 session_log(se, YLOG_DEBUG, "Search");
574 session_remove_clients(se);
577 reclist_destroy(se->reclist);
579 relevance_destroy(&se->relevance);
580 nmem_reset(se->nmem);
581 se->total_records = se->total_hits = se->total_merged = 0;
582 se->num_termlists = 0;
583 live_channels = select_targets(se, filter);
587 return PAZPAR2_NO_TARGETS;
589 se->reclist = reclist_create(se->nmem);
591 yaz_gettimeofday(&tval);
595 for (l = se->clients; l; l = l->next)
597 struct client *cl = l->client;
600 client_set_maxrecs(cl, atoi(maxrecs));
602 client_set_startrecs(cl, atoi(startrecs));
603 if (prepare_session_database(se, client_get_database(cl)) < 0)
605 else if (client_parse_query(cl, query) < 0)
610 if (client_prep_connection(cl, se->service->z3950_operation_timeout,
611 se->service->z3950_session_timeout,
612 se->service->server->iochan_man,
614 client_start_search(cl);
623 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
626 return PAZPAR2_NO_TARGETS;
628 return PAZPAR2_NO_ERROR;
631 // Creates a new session_database object for a database
632 static void session_init_databases_fun(void *context, struct database *db)
634 struct session *se = (struct session *) context;
635 struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
641 assert(db->settings);
642 new->settings = nmem_malloc(se->session_nmem,
643 sizeof(struct settings *) * db->num_settings);
644 new->num_settings = db->num_settings;
645 for (i = 0; i < db->num_settings; i++)
647 struct setting *setting = db->settings[i];
648 new->settings[i] = setting;
650 new->next = se->databases;
654 // Doesn't free memory associated with sdb -- nmem takes care of that
655 static void session_database_destroy(struct session_database *sdb)
660 // Initialize session_database list -- this represents this session's view
661 // of the database list -- subject to modification by the settings ws command
662 void session_init_databases(struct session *se)
665 predef_grep_databases(se, se->service, session_init_databases_fun);
668 // Probably session_init_databases_fun should be refactored instead of
670 static struct session_database *load_session_database(struct session *se,
673 struct database *db = new_database(id, se->session_nmem);
675 resolve_database(se->service, db);
677 session_init_databases_fun((void*) se, db);
679 // New sdb is head of se->databases list
680 return se->databases;
683 // Find an existing session database. If not found, load it
684 static struct session_database *find_session_database(struct session *se,
687 struct session_database *sdb;
689 for (sdb = se->databases; sdb; sdb = sdb->next)
690 if (!strcmp(sdb->database->url, id))
692 return load_session_database(se, id);
695 // Apply a session override to a database
696 void session_apply_setting(struct session *se, char *dbname, char *setting,
699 struct session_database *sdb = find_session_database(se, dbname);
700 struct conf_service *service = se->service;
701 struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
702 int offset = settings_create_offset(service, setting);
704 expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
707 new->target = dbname;
710 new->next = sdb->settings[offset];
711 sdb->settings[offset] = new;
713 // Force later recompute of settings-driven data structures
714 // (happens when a search starts and client connections are prepared)
726 void destroy_session(struct session *se)
728 struct session_database *sdb;
730 session_log(se, YLOG_DEBUG, "Pazpar2 session destroy");
731 session_remove_clients(se);
733 for (sdb = se->databases; sdb; sdb = sdb->next)
734 session_database_destroy(sdb);
735 normalize_cache_destroy(se->normalize_cache);
736 relevance_destroy(&se->relevance);
737 reclist_destroy(se->reclist);
738 nmem_destroy(se->nmem);
739 service_destroy(se->service);
740 yaz_mutex_destroy(&se->session_mutex);
741 wrbuf_destroy(se->wrbuf);
744 struct session *new_session(NMEM nmem, struct conf_service *service,
748 struct session *session = nmem_malloc(nmem, sizeof(*session));
752 sprintf(tmp_str, "session#%u", session_id);
754 session->session_id = session_id;
755 session_log(session, YLOG_DEBUG, "New session");
756 session->service = service;
757 session->relevance = 0;
758 session->total_hits = 0;
759 session->total_records = 0;
760 session->number_of_warnings_unknown_elements = 0;
761 session->number_of_warnings_unknown_metadata = 0;
762 session->num_termlists = 0;
763 session->reclist = 0;
764 session->clients = 0;
765 session->session_nmem = nmem;
766 session->nmem = nmem_create();
767 session->wrbuf = wrbuf_alloc();
768 session->databases = 0;
769 for (i = 0; i <= SESSION_WATCH_MAX; i++)
771 session->watchlist[i].data = 0;
772 session->watchlist[i].fun = 0;
774 session->normalize_cache = normalize_cache_create();
775 session->session_mutex = 0;
776 pazpar2_mutex_create(&session->session_mutex, tmp_str);
781 struct hitsbytarget *hitsbytarget(struct session *se, int *count, NMEM nmem)
783 struct hitsbytarget *res = 0;
784 struct client_list *l;
788 for (l = se->clients; l; l = l->next)
791 res = nmem_malloc(nmem, sizeof(*res) * sz);
793 for (l = se->clients; l; l = l->next)
795 struct client *cl = l->client;
796 WRBUF w = wrbuf_alloc();
797 const char *name = session_setting_oneval(client_get_database(cl),
800 res[*count].id = client_get_database(cl)->database->url;
801 res[*count].name = *name ? name : "Unknown";
802 res[*count].hits = client_get_hits(cl);
803 res[*count].records = client_get_num_records(cl);
804 res[*count].diagnostic = client_get_diagnostic(cl);
805 res[*count].state = client_get_state_str(cl);
806 res[*count].connected = client_get_connection(cl) ? 1 : 0;
807 session_settings_dump(se, client_get_database(cl), w);
808 res[*count].settings_xml = w;
815 struct termlist_score **termlist(struct session *se, const char *name, int *num)
818 struct termlist_score **tl = 0;
821 for (i = 0; i < se->num_termlists; i++)
822 if (!strcmp((const char *) se->termlists[i].name, name))
824 tl = termlist_highscore(se->termlists[i].termlist, num);
831 #ifdef MISSING_HEADERS
832 void report_nmem_stats(void)
834 size_t in_use, is_free;
836 nmem_get_memory_in_use(&in_use);
837 nmem_get_memory_free(&is_free);
839 yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
840 (long) in_use, (long) is_free);
844 struct record_cluster *show_single_start(struct session *se, const char *id,
845 struct record_cluster **prev_r,
846 struct record_cluster **next_r)
848 struct record_cluster *r = 0;
855 reclist_enter(se->reclist);
856 while ((r = reclist_read_record(se->reclist)))
858 if (!strcmp(r->recid, id))
860 *next_r = reclist_read_record(se->reclist);
865 reclist_leave(se->reclist);
872 void show_single_stop(struct session *se, struct record_cluster *rec)
877 struct record_cluster **show_range_start(struct session *se,
878 struct reclist_sortparms *sp,
879 int start, int *num, int *total, Odr_int *sumhits)
881 struct record_cluster **recs;
882 struct reclist_sortparms *spp;
885 yaz_timing_t t = yaz_timing_create();
888 recs = nmem_malloc(se->nmem, *num * sizeof(struct record_cluster *));
898 for (spp = sp; spp; spp = spp->next)
899 if (spp->type == Metadata_sortkey_relevance)
901 relevance_prepare_read(se->relevance, se->reclist);
904 reclist_sort(se->reclist, sp);
906 reclist_enter(se->reclist);
907 *total = reclist_get_num_records(se->reclist);
908 *sumhits = se->total_hits;
910 for (i = 0; i < start; i++)
911 if (!reclist_read_record(se->reclist))
918 for (i = 0; i < *num; i++)
920 struct record_cluster *r = reclist_read_record(se->reclist);
928 reclist_leave(se->reclist);
932 yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
933 yaz_timing_get_real(t), yaz_timing_get_user(t),
934 yaz_timing_get_sys(t));
935 yaz_timing_destroy(&t);
940 void show_range_stop(struct session *se, struct record_cluster **recs)
945 void statistics(struct session *se, struct statistics *stat)
947 struct client_list *l;
950 memset(stat, 0, sizeof(*stat));
951 for (l = se->clients; l; l = l->next)
953 struct client *cl = l->client;
954 if (!client_get_connection(cl))
955 stat->num_no_connection++;
956 switch (client_get_state(cl))
958 case Client_Connecting: stat->num_connecting++; break;
959 case Client_Working: stat->num_working++; break;
960 case Client_Idle: stat->num_idle++; break;
961 case Client_Failed: stat->num_failed++; break;
962 case Client_Error: stat->num_error++; break;
967 stat->num_hits = se->total_hits;
968 stat->num_records = se->total_records;
970 stat->num_clients = count;
973 static struct record_metadata *record_metadata_init(
974 NMEM nmem, const char *value, enum conf_metadata_type type,
975 struct _xmlAttr *attr)
977 struct record_metadata *rec_md = record_metadata_create(nmem);
978 struct record_metadata_attr **attrp = &rec_md->attributes;
980 for (; attr; attr = attr->next)
982 if (attr->children && attr->children->content)
984 if (strcmp((const char *) attr->name, "type"))
985 { /* skip the "type" attribute.. Its value is already part of
986 the element in output (md-%s) and so repeating it here
988 *attrp = nmem_malloc(nmem, sizeof(**attrp));
990 nmem_strdup(nmem, (const char *) attr->name);
992 nmem_strdup(nmem, (const char *) attr->children->content);
993 attrp = &(*attrp)->next;
999 if (type == Metadata_type_generic)
1001 char *p = nmem_strdup(nmem, value);
1003 p = normalize7bit_generic(p, " ,/.:([");
1005 rec_md->data.text.disp = p;
1006 rec_md->data.text.sort = 0;
1008 else if (type == Metadata_type_year || type == Metadata_type_date)
1013 if (type == Metadata_type_date)
1015 if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
1018 rec_md->data.number.min = first;
1019 rec_md->data.number.max = last;
1026 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
1027 struct conf_service *service, WRBUF norm_wr)
1031 for (n = root->children; n; n = n->next)
1033 if (n->type != XML_ELEMENT_NODE)
1035 if (!strcmp((const char *) n->name, "metadata"))
1037 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1039 yaz_log(YLOG_FATAL, "Missing type attribute on metadata element. Skipping!");
1041 else if (!strcmp(name, (const char *) type))
1043 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
1046 const char *norm_str;
1047 pp2_relevance_token_t prt =
1048 pp2_relevance_tokenize(service->mergekey_pct);
1050 pp2_relevance_first(prt, (const char *) value, 0);
1051 if (wrbuf_len(norm_wr) > 0)
1052 wrbuf_puts(norm_wr, " ");
1053 wrbuf_puts(norm_wr, name);
1055 pp2_relevance_token_next(prt)))
1059 wrbuf_puts(norm_wr, " ");
1060 wrbuf_puts(norm_wr, norm_str);
1064 pp2_relevance_token_destroy(prt);
1074 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
1075 struct conf_service *service, NMEM nmem)
1077 char *mergekey_norm = 0;
1078 xmlNode *root = xmlDocGetRootElement(doc);
1079 WRBUF norm_wr = wrbuf_alloc();
1081 /* consider mergekey from XSL first */
1082 xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
1085 const char *norm_str;
1086 pp2_relevance_token_t prt =
1087 pp2_relevance_tokenize(service->mergekey_pct);
1089 pp2_relevance_first(prt, (const char *) mergekey, 0);
1090 while ((norm_str = pp2_relevance_token_next(prt)))
1094 if (wrbuf_len(norm_wr))
1095 wrbuf_puts(norm_wr, " ");
1096 wrbuf_puts(norm_wr, norm_str);
1099 pp2_relevance_token_destroy(prt);
1104 /* no mergekey defined in XSL. Look for mergekey metadata instead */
1106 for (field_id = 0; field_id < service->num_metadata; field_id++)
1108 struct conf_metadata *ser_md = &service->metadata[field_id];
1109 if (ser_md->mergekey != Metadata_mergekey_no)
1111 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1113 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1115 /* no mergekey on this one and it is required..
1116 Generate unique key instead */
1117 wrbuf_rewind(norm_wr);
1124 /* generate unique key if none is not generated already or is empty */
1125 if (wrbuf_len(norm_wr) == 0)
1127 wrbuf_printf(norm_wr, "%s-%d",
1128 client_get_database(cl)->database->url, record_no);
1130 if (wrbuf_len(norm_wr) > 0)
1131 mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1132 wrbuf_destroy(norm_wr);
1133 return mergekey_norm;
1136 /** \brief see if metadata for pz:recordfilter exists
1137 \param root xml root element of normalized record
1138 \param sdb session database for client
1139 \retval 0 if there is no metadata for pz:recordfilter
1140 \retval 1 if there is metadata for pz:recordfilter
1142 If there is no pz:recordfilter defined, this function returns 1
1146 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1151 s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1156 for (n = root->children; n; n = n->next)
1158 if (n->type != XML_ELEMENT_NODE)
1160 if (!strcmp((const char *) n->name, "metadata"))
1162 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1169 if ((eq = strchr(s, '=')))
1171 else if ((eq = strchr(s, '~')))
1177 if (len == strlen((const char *)type) &&
1178 !memcmp((const char *) type, s, len))
1180 xmlChar *value = xmlNodeGetContent(n);
1181 if (value && *value)
1184 (substring && strstr((const char *) value, eq+1)) ||
1185 (!substring && !strcmp((const char *) value, eq + 1)))
1198 static int ingest_to_cluster(struct client *cl,
1202 const char *mergekey_norm);
1204 /** \brief ingest XML record
1205 \param cl client holds the result set for record
1206 \param rec record buffer (0 terminated)
1207 \param record_no record position (1, 2, ..)
1208 \param nmem working NMEM
1212 int ingest_record(struct client *cl, const char *rec,
1213 int record_no, NMEM nmem)
1215 struct session *se = client_get_session(cl);
1217 struct session_database *sdb = client_get_database(cl);
1218 struct conf_service *service = se->service;
1219 xmlDoc *xdoc = normalize_record(se, sdb, service, rec, nmem);
1221 const char *mergekey_norm;
1226 root = xmlDocGetRootElement(xdoc);
1228 if (!check_record_filter(root, sdb))
1230 session_log(se, YLOG_WARN, "Filtered out record no %d from %s",
1231 record_no, sdb->database->url);
1236 mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem);
1239 session_log(se, YLOG_WARN, "Got no mergekey");
1244 if (client_get_session(cl) == se)
1245 ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1252 static int ingest_to_cluster(struct client *cl,
1256 const char *mergekey_norm)
1261 struct session_database *sdb = client_get_database(cl);
1262 struct session *se = client_get_session(cl);
1263 struct conf_service *service = se->service;
1264 struct record *record = record_create(se->nmem,
1265 service->num_metadata,
1266 service->num_sortkeys, cl,
1268 struct record_cluster *cluster = reclist_insert(se->reclist,
1274 const char *use_term_factor_str = session_setting_oneval(sdb, PZ_TERMLIST_TERM_FACTOR);
1275 // TODO: Work-around to default to use term factor, until other MK2 components supports it
1276 int use_term_factor = 1;
1277 int term_factor = 1;
1278 if (use_term_factor_str && use_term_factor_str[0] != 0)
1279 use_term_factor = atoi(use_term_factor_str);
1280 if (use_term_factor) {
1281 int maxrecs = client_get_maxrecs(cl);
1282 int hits = (int) client_get_hits(cl);
1283 term_factor = MAX(hits, maxrecs) / MAX(1, maxrecs);
1284 assert(term_factor >= 1);
1285 yaz_log(YLOG_DEBUG, "Using term factor: %d (%d / %d)", term_factor, MAX(hits, maxrecs), MAX(1, maxrecs));
1290 if (global_parameters.dump_records)
1291 session_log(se, YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1292 sdb->database->url, record_no);
1293 relevance_newrec(se->relevance, cluster);
1295 // now parsing XML record and adding data to cluster or record metadata
1296 for (n = root->children; n; n = n->next)
1298 pp2_relevance_token_t prt;
1305 if (n->type != XML_ELEMENT_NODE)
1307 if (!strcmp((const char *) n->name, "metadata"))
1309 struct conf_metadata *ser_md = 0;
1310 struct conf_sortkey *ser_sk = 0;
1311 struct record_metadata **wheretoput = 0;
1312 struct record_metadata *rec_md = 0;
1313 int md_field_id = -1;
1314 int sk_field_id = -1;
1316 type = xmlGetProp(n, (xmlChar *) "type");
1317 value = xmlNodeListGetString(xdoc, n->children, 1);
1319 if (!type || !value || !*value)
1323 = conf_service_metadata_field_id(service, (const char *) type);
1324 if (md_field_id < 0)
1326 if (se->number_of_warnings_unknown_metadata == 0)
1328 session_log(se, YLOG_WARN,
1329 "Ignoring unknown metadata element: %s", type);
1331 se->number_of_warnings_unknown_metadata++;
1335 ser_md = &service->metadata[md_field_id];
1337 if (ser_md->sortkey_offset >= 0){
1338 sk_field_id = ser_md->sortkey_offset;
1339 ser_sk = &service->sortkeys[sk_field_id];
1342 // non-merged metadata
1343 rec_md = record_metadata_init(se->nmem, (const char *) value,
1344 ser_md->type, n->properties);
1347 session_log(se, YLOG_WARN, "bad metadata data '%s' "
1348 "for element '%s'", value, type);
1351 wheretoput = &record->metadata[md_field_id];
1353 wheretoput = &(*wheretoput)->next;
1354 *wheretoput = rec_md;
1357 rec_md = record_metadata_init(se->nmem, (const char *) value,
1359 wheretoput = &cluster->metadata[md_field_id];
1361 // and polulate with data:
1362 // assign cluster or record based on merge action
1363 if (ser_md->merge == Metadata_merge_unique)
1365 struct record_metadata *mnode;
1366 for (mnode = *wheretoput; mnode; mnode = mnode->next)
1367 if (!strcmp((const char *) mnode->data.text.disp,
1368 rec_md->data.text.disp))
1372 rec_md->next = *wheretoput;
1373 *wheretoput = rec_md;
1376 else if (ser_md->merge == Metadata_merge_longest)
1379 || strlen(rec_md->data.text.disp)
1380 > strlen((*wheretoput)->data.text.disp))
1382 *wheretoput = rec_md;
1385 const char *sort_str = 0;
1387 ser_sk->type == Metadata_sortkey_skiparticle;
1389 if (!cluster->sortkeys[sk_field_id])
1390 cluster->sortkeys[sk_field_id] =
1391 nmem_malloc(se->nmem,
1392 sizeof(union data_types));
1394 prt = pp2_relevance_tokenize(service->sort_pct);
1396 pp2_relevance_first(prt, rec_md->data.text.disp,
1399 pp2_relevance_token_next(prt);
1401 sort_str = pp2_get_sort(prt);
1403 cluster->sortkeys[sk_field_id]->text.disp =
1404 rec_md->data.text.disp;
1407 sort_str = rec_md->data.text.disp;
1408 session_log(se, YLOG_WARN,
1409 "Could not make sortkey. Bug #1858");
1411 cluster->sortkeys[sk_field_id]->text.sort =
1412 nmem_strdup(se->nmem, sort_str);
1413 pp2_relevance_token_destroy(prt);
1417 else if (ser_md->merge == Metadata_merge_all)
1419 rec_md->next = *wheretoput;
1420 *wheretoput = rec_md;
1422 else if (ser_md->merge == Metadata_merge_range)
1426 *wheretoput = rec_md;
1428 cluster->sortkeys[sk_field_id]
1433 int this_min = rec_md->data.number.min;
1434 int this_max = rec_md->data.number.max;
1435 if (this_min < (*wheretoput)->data.number.min)
1436 (*wheretoput)->data.number.min = this_min;
1437 if (this_max > (*wheretoput)->data.number.max)
1438 (*wheretoput)->data.number.max = this_max;
1443 // ranking of _all_ fields enabled ...
1445 relevance_countwords(se->relevance, cluster,
1446 (char *) value, ser_md->rank,
1449 // construct facets ... unless the client already has reported them
1450 if (ser_md->termlist && !client_has_facet(cl, (char *) type))
1453 if (ser_md->type == Metadata_type_year)
1456 sprintf(year, "%d", rec_md->data.number.max);
1458 add_facet(se, (char *) type, year, term_factor);
1459 if (rec_md->data.number.max != rec_md->data.number.min)
1461 sprintf(year, "%d", rec_md->data.number.min);
1462 add_facet(se, (char *) type, year, term_factor);
1466 add_facet(se, (char *) type, (char *) value, term_factor);
1476 if (se->number_of_warnings_unknown_elements == 0)
1477 session_log(se, YLOG_WARN,
1478 "Unexpected element in internal record: %s", n->name);
1479 se->number_of_warnings_unknown_elements++;
1487 relevance_donerecord(se->relevance, cluster);
1488 se->total_records++;
1493 void session_log(struct session *s, int level, const char *fmt, ...)
1499 yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
1500 yaz_log(level, "%u %s", s->session_id, buf);
1508 * c-file-style: "Stroustrup"
1509 * indent-tabs-mode: nil
1511 * vim: shiftwidth=4 tabstop=8 expandtab