1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2010 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
45 #include <yaz/marcdisp.h>
46 #include <yaz/comstack.h>
47 #include <yaz/tcpip.h>
48 #include <yaz/proto.h>
49 #include <yaz/readconf.h>
50 #include <yaz/pquery.h>
51 #include <yaz/otherinfo.h>
52 #include <yaz/yaz-util.h>
54 #include <yaz/query-charset.h>
55 #include <yaz/querytowrbuf.h>
56 #include <yaz/oid_db.h>
57 #include <yaz/snprintf.h>
58 #include <yaz/gettimeofday.h>
62 #include <yaz/timing.h>
66 #include "parameters.h"
70 #include "termlists.h"
72 #include "relevance.h"
76 #include "normalize7bit.h"
78 #define TERMLIST_HIGH_SCORE 25
82 // Note: Some things in this structure will eventually move to configuration
83 struct parameters global_parameters =
90 struct client *client;
91 struct client_list *next;
94 static void log_xml_doc(xmlDoc *doc)
96 FILE *lf = yaz_log_file();
99 #if LIBXML_VERSION >= 20600
100 xmlDocDumpFormatMemory(doc, &result, &len, 1);
102 xmlDocDumpMemory(doc, &result, &len);
106 (void) fwrite(result, 1, len, lf);
112 static void session_enter(struct session *s)
114 yaz_mutex_enter(s->session_mutex);
117 static void session_leave(struct session *s)
119 yaz_mutex_leave(s->session_mutex);
122 // Recursively traverse query structure to extract terms.
123 void pull_terms(NMEM nmem, struct ccl_rpn_node *n, char **termlist, int *num)
135 pull_terms(nmem, n->u.p[0], termlist, num);
136 pull_terms(nmem, n->u.p[1], termlist, num);
139 nmem_strsplit(nmem, " ", n->u.t.term, &words, &numwords);
140 for (i = 0; i < numwords; i++)
141 termlist[(*num)++] = words[i];
149 void add_facet(struct session *s, const char *type, const char *value, int count)
151 struct conf_service *service = s->service;
152 pp2_relevance_token_t prt;
153 const char *facet_component;
154 WRBUF facet_wrbuf = wrbuf_alloc();
155 prt = pp2_relevance_tokenize(service->facet_pct);
157 pp2_relevance_first(prt, value, 0);
158 while ((facet_component = pp2_relevance_token_next(prt)))
160 if (*facet_component)
162 if (wrbuf_len(facet_wrbuf))
163 wrbuf_puts(facet_wrbuf, " ");
164 wrbuf_puts(facet_wrbuf, facet_component);
167 pp2_relevance_token_destroy(prt);
169 if (wrbuf_len(facet_wrbuf))
172 for (i = 0; i < s->num_termlists; i++)
173 if (!strcmp(s->termlists[i].name, type))
175 if (i == s->num_termlists)
177 if (i == SESSION_MAX_TERMLISTS)
179 session_log(s, YLOG_FATAL, "Too many termlists");
180 wrbuf_destroy(facet_wrbuf);
184 s->termlists[i].name = nmem_strdup(s->nmem, type);
185 s->termlists[i].termlist
186 = termlist_create(s->nmem, TERMLIST_HIGH_SCORE);
187 s->num_termlists = i + 1;
190 session_log(s, YLOG_DEBUG, "Session: facets for %s: %s norm:%s (%d)",
191 type, value, wrbuf_cstr(facet_wrbuf), count);
192 termlist_insert(s->termlists[i].termlist, wrbuf_cstr(facet_wrbuf),
195 wrbuf_destroy(facet_wrbuf);
198 static xmlDoc *record_to_xml(struct session *se,
199 struct session_database *sdb, const char *rec)
201 struct database *db = sdb->database;
204 rdoc = xmlParseMemory(rec, strlen(rec));
208 session_log(se, YLOG_FATAL, "Non-wellformed XML received from %s",
213 if (global_parameters.dump_records)
215 session_log(se, YLOG_LOG, "Un-normalized record from %s", db->url);
222 #define MAX_XSLT_ARGS 16
224 // Add static values from session database settings if applicable
225 static void insert_settings_parameters(struct session_database *sdb,
226 struct conf_service *service,
234 for (i = 0; i < service->num_metadata; i++)
236 struct conf_metadata *md = &service->metadata[i];
239 if (md->setting == Metadata_setting_parameter &&
240 (setting = settings_lookup_offset(service, md->name)) >= 0)
242 const char *val = session_setting_oneval(sdb, setting);
243 if (val && nparms < MAX_XSLT_ARGS)
246 int len = strlen(val);
247 buf = nmem_malloc(nmem, len + 3);
249 strcpy(buf + 1, val);
252 parms[offset++] = md->name;
253 parms[offset++] = buf;
261 // Add static values from session database settings if applicable
262 static void insert_settings_values(struct session_database *sdb, xmlDoc *doc,
263 struct conf_service *service)
267 for (i = 0; i < service->num_metadata; i++)
269 struct conf_metadata *md = &service->metadata[i];
272 if (md->setting == Metadata_setting_postproc &&
273 (offset = settings_lookup_offset(service, md->name)) >= 0)
275 const char *val = session_setting_oneval(sdb, offset);
278 xmlNode *r = xmlDocGetRootElement(doc);
279 xmlNode *n = xmlNewTextChild(r, 0, (xmlChar *) "metadata",
281 xmlSetProp(n, (xmlChar *) "type", (xmlChar *) md->name);
287 static xmlDoc *normalize_record(struct session *se,
288 struct session_database *sdb,
289 struct conf_service *service,
290 const char *rec, NMEM nmem)
292 xmlDoc *rdoc = record_to_xml(se, sdb, rec);
296 char *parms[MAX_XSLT_ARGS*2+1];
298 insert_settings_parameters(sdb, service, parms, nmem);
300 if (normalize_record_transform(sdb->map, &rdoc, (const char **)parms))
302 session_log(se, YLOG_WARN, "Normalize failed from %s",
307 insert_settings_values(sdb, rdoc, service);
309 if (global_parameters.dump_records)
311 session_log(se, YLOG_LOG, "Normalized record from %s",
320 void session_settings_dump(struct session *se,
321 struct session_database *db,
326 int i, num = db->num_settings;
327 for (i = 0; i < num; i++)
329 struct setting *s = db->settings[i];
330 for (;s ; s = s->next)
332 wrbuf_puts(w, "<set name=\"");
333 wrbuf_xmlputs(w, s->name);
334 wrbuf_puts(w, "\" value=\"");
335 wrbuf_xmlputs(w, s->value);
336 wrbuf_puts(w, "\"/>");
344 // Retrieve first defined value for 'name' for given database.
345 // Will be extended to take into account user associated with session
346 const char *session_setting_oneval(struct session_database *db, int offset)
348 if (offset >= db->num_settings || !db->settings[offset])
350 return db->settings[offset]->value;
353 // Prepare XSLT stylesheets for record normalization
354 // Structures are allocated on the session_wide nmem to avoid having
355 // to recompute this for every search. This would lead
356 // to leaking if a single session was to repeatedly change the PZ_XSLT
357 // setting. However, this is not a realistic use scenario.
358 static int prepare_map(struct session *se, struct session_database *sdb)
364 session_log(se, YLOG_WARN, "No settings on %s", sdb->database->url);
367 if ((s = session_setting_oneval(sdb, PZ_XSLT)))
369 char auto_stylesheet[256];
371 if (!strcmp(s, "auto"))
373 const char *request_syntax = session_setting_oneval(
374 sdb, PZ_REQUESTSYNTAX);
378 yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet),
379 "%s.xsl", request_syntax);
380 for (cp = auto_stylesheet; *cp; cp++)
382 /* deliberately only consider ASCII */
383 if (*cp > 32 && *cp < 127)
390 session_log(se, YLOG_WARN,
391 "No pz:requestsyntax for auto stylesheet");
394 sdb->map = normalize_cache_get(se->normalize_cache,
395 se->service->server->config, s);
402 // This analyzes settings and recomputes any supporting data structures
404 static int prepare_session_database(struct session *se,
405 struct session_database *sdb)
409 session_log(se, YLOG_WARN,
410 "No settings associated with %s", sdb->database->url);
413 if (sdb->settings[PZ_XSLT] && !sdb->map)
415 if (prepare_map(se, sdb) < 0)
421 // called if watch should be removed because http_channel is to be destroyed
422 static void session_watch_cancel(void *data, struct http_channel *c,
425 struct session_watchentry *ent = data;
432 // set watch. Returns 0=OK, -1 if watch is already set
433 int session_set_watch(struct session *s, int what,
434 session_watchfun fun, void *data,
435 struct http_channel *chan)
439 if (s->watchlist[what].fun)
444 s->watchlist[what].fun = fun;
445 s->watchlist[what].data = data;
446 s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
447 session_watch_cancel);
454 void session_alert_watch(struct session *s, int what)
458 if (s->watchlist[what].fun)
460 /* our watch is no longer associated with http_channel */
462 session_watchfun fun;
464 http_remove_observer(s->watchlist[what].obs);
465 fun = s->watchlist[what].fun;
466 data = s->watchlist[what].data;
468 /* reset watch before fun is invoked - in case fun wants to set
470 s->watchlist[what].fun = 0;
471 s->watchlist[what].data = 0;
472 s->watchlist[what].obs = 0;
475 session_log(s, YLOG_DEBUG,
476 "session_alert_watch: %d calling function: %p", what, fun);
483 //callback for grep_databases
484 static void select_targets_callback(void *context, struct session_database *db)
486 struct session *se = (struct session*) context;
487 struct client *cl = client_create();
488 struct client_list *l;
489 client_set_database(cl, db);
491 client_set_session(cl, se);
492 l = xmalloc(sizeof(*l));
494 l->next = se->clients;
498 static void session_remove_clients(struct session *se)
500 struct client_list *l;
509 struct client_list *l_next = l->next;
510 client_lock(l->client);
511 client_set_session(l->client, 0);
512 client_set_database(l->client, 0);
513 client_unlock(l->client);
514 client_destroy(l->client);
520 // Associates a set of clients with a session;
521 // Note: Session-databases represent databases with per-session
523 static int select_targets(struct session *se, const char *filter)
525 return session_grep_databases(se, filter, select_targets_callback);
528 int session_active_clients(struct session *s)
530 struct client_list *l;
533 for (l = s->clients; l; l = l->next)
534 if (client_is_active(l->client))
540 int session_is_preferred_clients_ready(struct session *s)
542 struct client_list *l;
545 for (l = s->clients; l; l = l->next)
546 if (client_is_active_preferred(l->client))
548 session_log(s, YLOG_DEBUG, "Session has %d active preferred clients.", res);
554 enum pazpar2_error_code search(struct session *se,
556 const char *startrecs, const char *maxrecs,
558 const char **addinfo)
560 int live_channels = 0;
563 struct client_list *l;
566 session_log(se, YLOG_DEBUG, "Search");
570 session_remove_clients(se);
573 reclist_destroy(se->reclist);
575 relevance_destroy(&se->relevance);
576 nmem_reset(se->nmem);
577 se->total_records = se->total_hits = se->total_merged = 0;
578 se->num_termlists = 0;
579 live_channels = select_targets(se, filter);
583 return PAZPAR2_NO_TARGETS;
585 se->reclist = reclist_create(se->nmem);
587 yaz_gettimeofday(&tval);
591 for (l = se->clients; l; l = l->next)
593 struct client *cl = l->client;
596 client_set_maxrecs(cl, atoi(maxrecs));
598 client_set_startrecs(cl, atoi(startrecs));
599 if (prepare_session_database(se, client_get_database(cl)) < 0)
601 else if (client_parse_query(cl, query) < 0)
606 if (client_prep_connection(cl, se->service->z3950_operation_timeout,
607 se->service->z3950_session_timeout,
608 se->service->server->iochan_man,
610 client_start_search(cl);
619 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
622 return PAZPAR2_NO_TARGETS;
624 return PAZPAR2_NO_ERROR;
627 // Creates a new session_database object for a database
628 static void session_init_databases_fun(void *context, struct database *db)
630 struct session *se = (struct session *) context;
631 struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
637 assert(db->settings);
638 new->settings = nmem_malloc(se->session_nmem,
639 sizeof(struct settings *) * db->num_settings);
640 new->num_settings = db->num_settings;
641 for (i = 0; i < db->num_settings; i++)
643 struct setting *setting = db->settings[i];
644 new->settings[i] = setting;
646 new->next = se->databases;
650 // Doesn't free memory associated with sdb -- nmem takes care of that
651 static void session_database_destroy(struct session_database *sdb)
656 // Initialize session_database list -- this represents this session's view
657 // of the database list -- subject to modification by the settings ws command
658 void session_init_databases(struct session *se)
661 predef_grep_databases(se, se->service, session_init_databases_fun);
664 // Probably session_init_databases_fun should be refactored instead of
666 static struct session_database *load_session_database(struct session *se,
669 struct database *db = new_database(id, se->session_nmem);
671 resolve_database(se->service, db);
673 session_init_databases_fun((void*) se, db);
675 // New sdb is head of se->databases list
676 return se->databases;
679 // Find an existing session database. If not found, load it
680 static struct session_database *find_session_database(struct session *se,
683 struct session_database *sdb;
685 for (sdb = se->databases; sdb; sdb = sdb->next)
686 if (!strcmp(sdb->database->url, id))
688 return load_session_database(se, id);
691 // Apply a session override to a database
692 void session_apply_setting(struct session *se, char *dbname, char *setting,
695 struct session_database *sdb = find_session_database(se, dbname);
696 struct conf_service *service = se->service;
697 struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
698 int offset = settings_create_offset(service, setting);
700 expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
703 new->target = dbname;
706 new->next = sdb->settings[offset];
707 sdb->settings[offset] = new;
709 // Force later recompute of settings-driven data structures
710 // (happens when a search starts and client connections are prepared)
722 void destroy_session(struct session *se)
724 struct session_database *sdb;
726 session_log(se, YLOG_DEBUG, "Pazpar2 session destroy");
727 session_remove_clients(se);
729 for (sdb = se->databases; sdb; sdb = sdb->next)
730 session_database_destroy(sdb);
731 normalize_cache_destroy(se->normalize_cache);
732 relevance_destroy(&se->relevance);
733 reclist_destroy(se->reclist);
734 nmem_destroy(se->nmem);
735 service_destroy(se->service);
736 yaz_mutex_destroy(&se->session_mutex);
737 wrbuf_destroy(se->wrbuf);
740 struct session *new_session(NMEM nmem, struct conf_service *service,
744 struct session *session = nmem_malloc(nmem, sizeof(*session));
748 sprintf(tmp_str, "session#%u", session_id);
750 session->session_id = session_id;
751 session_log(session, YLOG_DEBUG, "New session");
752 session->service = service;
753 session->relevance = 0;
754 session->total_hits = 0;
755 session->total_records = 0;
756 session->number_of_warnings_unknown_elements = 0;
757 session->number_of_warnings_unknown_metadata = 0;
758 session->num_termlists = 0;
759 session->reclist = 0;
760 session->clients = 0;
761 session->session_nmem = nmem;
762 session->nmem = nmem_create();
763 session->wrbuf = wrbuf_alloc();
764 session->databases = 0;
765 for (i = 0; i <= SESSION_WATCH_MAX; i++)
767 session->watchlist[i].data = 0;
768 session->watchlist[i].fun = 0;
770 session->normalize_cache = normalize_cache_create();
771 session->session_mutex = 0;
772 pazpar2_mutex_create(&session->session_mutex, tmp_str);
777 struct hitsbytarget *hitsbytarget(struct session *se, int *count, NMEM nmem)
779 struct hitsbytarget *res = 0;
780 struct client_list *l;
784 for (l = se->clients; l; l = l->next)
787 res = nmem_malloc(nmem, sizeof(*res) * sz);
789 for (l = se->clients; l; l = l->next)
791 struct client *cl = l->client;
792 WRBUF w = wrbuf_alloc();
793 const char *name = session_setting_oneval(client_get_database(cl),
796 res[*count].id = client_get_database(cl)->database->url;
797 res[*count].name = *name ? name : "Unknown";
798 res[*count].hits = client_get_hits(cl);
799 res[*count].records = client_get_num_records(cl);
800 res[*count].diagnostic = client_get_diagnostic(cl);
801 res[*count].state = client_get_state_str(cl);
802 res[*count].connected = client_get_connection(cl) ? 1 : 0;
803 session_settings_dump(se, client_get_database(cl), w);
804 res[*count].settings_xml = w;
811 struct termlist_score **termlist(struct session *se, const char *name, int *num)
814 struct termlist_score **tl = 0;
817 for (i = 0; i < se->num_termlists; i++)
818 if (!strcmp((const char *) se->termlists[i].name, name))
820 tl = termlist_highscore(se->termlists[i].termlist, num);
827 #ifdef MISSING_HEADERS
828 void report_nmem_stats(void)
830 size_t in_use, is_free;
832 nmem_get_memory_in_use(&in_use);
833 nmem_get_memory_free(&is_free);
835 yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
836 (long) in_use, (long) is_free);
840 struct record_cluster *show_single_start(struct session *se, const char *id,
841 struct record_cluster **prev_r,
842 struct record_cluster **next_r)
844 struct record_cluster *r;
847 reclist_enter(se->reclist);
850 while ((r = reclist_read_record(se->reclist)))
852 if (!strcmp(r->recid, id))
854 *next_r = reclist_read_record(se->reclist);
859 reclist_leave(se->reclist);
865 void show_single_stop(struct session *se, struct record_cluster *rec)
870 struct record_cluster **show_range_start(struct session *se,
871 struct reclist_sortparms *sp,
872 int start, int *num, int *total, Odr_int *sumhits)
874 struct record_cluster **recs;
875 struct reclist_sortparms *spp;
878 yaz_timing_t t = yaz_timing_create();
881 recs = nmem_malloc(se->nmem, *num * sizeof(struct record_cluster *));
891 for (spp = sp; spp; spp = spp->next)
892 if (spp->type == Metadata_sortkey_relevance)
894 relevance_prepare_read(se->relevance, se->reclist);
897 reclist_sort(se->reclist, sp);
899 reclist_enter(se->reclist);
900 *total = reclist_get_num_records(se->reclist);
901 *sumhits = se->total_hits;
903 for (i = 0; i < start; i++)
904 if (!reclist_read_record(se->reclist))
911 for (i = 0; i < *num; i++)
913 struct record_cluster *r = reclist_read_record(se->reclist);
921 reclist_leave(se->reclist);
925 yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
926 yaz_timing_get_real(t), yaz_timing_get_user(t),
927 yaz_timing_get_sys(t));
928 yaz_timing_destroy(&t);
933 void show_range_stop(struct session *se, struct record_cluster **recs)
938 void statistics(struct session *se, struct statistics *stat)
940 struct client_list *l;
943 memset(stat, 0, sizeof(*stat));
944 for (l = se->clients; l; l = l->next)
946 struct client *cl = l->client;
947 if (!client_get_connection(cl))
948 stat->num_no_connection++;
949 switch (client_get_state(cl))
951 case Client_Connecting: stat->num_connecting++; break;
952 case Client_Working: stat->num_working++; break;
953 case Client_Idle: stat->num_idle++; break;
954 case Client_Failed: stat->num_failed++; break;
955 case Client_Error: stat->num_error++; break;
960 stat->num_hits = se->total_hits;
961 stat->num_records = se->total_records;
963 stat->num_clients = count;
966 static struct record_metadata *record_metadata_init(
967 NMEM nmem, const char *value, enum conf_metadata_type type,
968 struct _xmlAttr *attr)
970 struct record_metadata *rec_md = record_metadata_create(nmem);
971 struct record_metadata_attr **attrp = &rec_md->attributes;
973 for (; attr; attr = attr->next)
975 if (attr->children && attr->children->content)
977 if (strcmp((const char *) attr->name, "type"))
978 { /* skip the "type" attribute.. Its value is already part of
979 the element in output (md-%s) and so repeating it here
981 *attrp = nmem_malloc(nmem, sizeof(**attrp));
983 nmem_strdup(nmem, (const char *) attr->name);
985 nmem_strdup(nmem, (const char *) attr->children->content);
986 attrp = &(*attrp)->next;
992 if (type == Metadata_type_generic)
994 char *p = nmem_strdup(nmem, value);
996 p = normalize7bit_generic(p, " ,/.:([");
998 rec_md->data.text.disp = p;
999 rec_md->data.text.sort = 0;
1001 else if (type == Metadata_type_year || type == Metadata_type_date)
1006 if (type == Metadata_type_date)
1008 if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
1011 rec_md->data.number.min = first;
1012 rec_md->data.number.max = last;
1019 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
1020 struct conf_service *service, WRBUF norm_wr)
1024 for (n = root->children; n; n = n->next)
1026 if (n->type != XML_ELEMENT_NODE)
1028 if (!strcmp((const char *) n->name, "metadata"))
1030 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1032 yaz_log(YLOG_FATAL, "Missing type attribute on metadata element. Skipping!");
1034 else if (!strcmp(name, (const char *) type))
1036 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
1039 const char *norm_str;
1040 pp2_relevance_token_t prt =
1041 pp2_relevance_tokenize(service->mergekey_pct);
1043 pp2_relevance_first(prt, (const char *) value, 0);
1044 if (wrbuf_len(norm_wr) > 0)
1045 wrbuf_puts(norm_wr, " ");
1046 wrbuf_puts(norm_wr, name);
1048 pp2_relevance_token_next(prt)))
1052 wrbuf_puts(norm_wr, " ");
1053 wrbuf_puts(norm_wr, norm_str);
1057 pp2_relevance_token_destroy(prt);
1067 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
1068 struct conf_service *service, NMEM nmem)
1070 char *mergekey_norm = 0;
1071 xmlNode *root = xmlDocGetRootElement(doc);
1072 WRBUF norm_wr = wrbuf_alloc();
1074 /* consider mergekey from XSL first */
1075 xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
1078 const char *norm_str;
1079 pp2_relevance_token_t prt =
1080 pp2_relevance_tokenize(service->mergekey_pct);
1082 pp2_relevance_first(prt, (const char *) mergekey, 0);
1083 while ((norm_str = pp2_relevance_token_next(prt)))
1087 if (wrbuf_len(norm_wr))
1088 wrbuf_puts(norm_wr, " ");
1089 wrbuf_puts(norm_wr, norm_str);
1092 pp2_relevance_token_destroy(prt);
1097 /* no mergekey defined in XSL. Look for mergekey metadata instead */
1099 for (field_id = 0; field_id < service->num_metadata; field_id++)
1101 struct conf_metadata *ser_md = &service->metadata[field_id];
1102 if (ser_md->mergekey != Metadata_mergekey_no)
1104 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1106 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1108 /* no mergekey on this one and it is required..
1109 Generate unique key instead */
1110 wrbuf_rewind(norm_wr);
1117 /* generate unique key if none is not generated already or is empty */
1118 if (wrbuf_len(norm_wr) == 0)
1120 wrbuf_printf(norm_wr, "%s-%d",
1121 client_get_database(cl)->database->url, record_no);
1123 if (wrbuf_len(norm_wr) > 0)
1124 mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1125 wrbuf_destroy(norm_wr);
1126 return mergekey_norm;
1129 /** \brief see if metadata for pz:recordfilter exists
1130 \param root xml root element of normalized record
1131 \param sdb session database for client
1132 \retval 0 if there is no metadata for pz:recordfilter
1133 \retval 1 if there is metadata for pz:recordfilter
1135 If there is no pz:recordfilter defined, this function returns 1
1139 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1144 s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1149 for (n = root->children; n; n = n->next)
1151 if (n->type != XML_ELEMENT_NODE)
1153 if (!strcmp((const char *) n->name, "metadata"))
1155 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1162 if ((eq = strchr(s, '=')))
1164 else if ((eq = strchr(s, '~')))
1170 if (len == strlen((const char *)type) &&
1171 !memcmp((const char *) type, s, len))
1173 xmlChar *value = xmlNodeGetContent(n);
1174 if (value && *value)
1177 (substring && strstr((const char *) value, eq+1)) ||
1178 (!substring && !strcmp((const char *) value, eq + 1)))
1191 static int ingest_to_cluster(struct client *cl,
1195 const char *mergekey_norm);
1197 /** \brief ingest XML record
1198 \param cl client holds the result set for record
1199 \param rec record buffer (0 terminated)
1200 \param record_no record position (1, 2, ..)
1201 \param nmem working NMEM
1205 int ingest_record(struct client *cl, const char *rec,
1206 int record_no, NMEM nmem)
1208 struct session *se = client_get_session(cl);
1210 struct session_database *sdb = client_get_database(cl);
1211 struct conf_service *service = se->service;
1212 xmlDoc *xdoc = normalize_record(se, sdb, service, rec, nmem);
1214 const char *mergekey_norm;
1219 root = xmlDocGetRootElement(xdoc);
1221 if (!check_record_filter(root, sdb))
1223 session_log(se, YLOG_WARN, "Filtered out record no %d from %s",
1224 record_no, sdb->database->url);
1229 mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem);
1232 session_log(se, YLOG_WARN, "Got no mergekey");
1237 if (client_get_session(cl) == se)
1238 ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1245 static int ingest_to_cluster(struct client *cl,
1249 const char *mergekey_norm)
1254 struct session_database *sdb = client_get_database(cl);
1255 struct session *se = client_get_session(cl);
1256 struct conf_service *service = se->service;
1257 struct record *record = record_create(se->nmem,
1258 service->num_metadata,
1259 service->num_sortkeys, cl,
1261 struct record_cluster *cluster = reclist_insert(se->reclist,
1268 if (global_parameters.dump_records)
1269 session_log(se, YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1270 sdb->database->url, record_no);
1271 relevance_newrec(se->relevance, cluster);
1273 // now parsing XML record and adding data to cluster or record metadata
1274 for (n = root->children; n; n = n->next)
1276 pp2_relevance_token_t prt;
1283 if (n->type != XML_ELEMENT_NODE)
1285 if (!strcmp((const char *) n->name, "metadata"))
1287 struct conf_metadata *ser_md = 0;
1288 struct conf_sortkey *ser_sk = 0;
1289 struct record_metadata **wheretoput = 0;
1290 struct record_metadata *rec_md = 0;
1291 int md_field_id = -1;
1292 int sk_field_id = -1;
1294 type = xmlGetProp(n, (xmlChar *) "type");
1295 value = xmlNodeListGetString(xdoc, n->children, 1);
1297 if (!type || !value || !*value)
1301 = conf_service_metadata_field_id(service, (const char *) type);
1302 if (md_field_id < 0)
1304 if (se->number_of_warnings_unknown_metadata == 0)
1306 session_log(se, YLOG_WARN,
1307 "Ignoring unknown metadata element: %s", type);
1309 se->number_of_warnings_unknown_metadata++;
1313 ser_md = &service->metadata[md_field_id];
1315 if (ser_md->sortkey_offset >= 0){
1316 sk_field_id = ser_md->sortkey_offset;
1317 ser_sk = &service->sortkeys[sk_field_id];
1320 // non-merged metadata
1321 rec_md = record_metadata_init(se->nmem, (const char *) value,
1322 ser_md->type, n->properties);
1325 session_log(se, YLOG_WARN, "bad metadata data '%s' "
1326 "for element '%s'", value, type);
1329 wheretoput = &record->metadata[md_field_id];
1331 wheretoput = &(*wheretoput)->next;
1332 *wheretoput = rec_md;
1335 rec_md = record_metadata_init(se->nmem, (const char *) value,
1337 wheretoput = &cluster->metadata[md_field_id];
1339 // and polulate with data:
1340 // assign cluster or record based on merge action
1341 if (ser_md->merge == Metadata_merge_unique)
1343 struct record_metadata *mnode;
1344 for (mnode = *wheretoput; mnode; mnode = mnode->next)
1345 if (!strcmp((const char *) mnode->data.text.disp,
1346 rec_md->data.text.disp))
1350 rec_md->next = *wheretoput;
1351 *wheretoput = rec_md;
1354 else if (ser_md->merge == Metadata_merge_longest)
1357 || strlen(rec_md->data.text.disp)
1358 > strlen((*wheretoput)->data.text.disp))
1360 *wheretoput = rec_md;
1363 const char *sort_str = 0;
1365 ser_sk->type == Metadata_sortkey_skiparticle;
1367 if (!cluster->sortkeys[sk_field_id])
1368 cluster->sortkeys[sk_field_id] =
1369 nmem_malloc(se->nmem,
1370 sizeof(union data_types));
1372 prt = pp2_relevance_tokenize(service->sort_pct);
1374 pp2_relevance_first(prt, rec_md->data.text.disp,
1377 pp2_relevance_token_next(prt);
1379 sort_str = pp2_get_sort(prt);
1381 cluster->sortkeys[sk_field_id]->text.disp =
1382 rec_md->data.text.disp;
1385 sort_str = rec_md->data.text.disp;
1386 session_log(se, YLOG_WARN,
1387 "Could not make sortkey. Bug #1858");
1389 cluster->sortkeys[sk_field_id]->text.sort =
1390 nmem_strdup(se->nmem, sort_str);
1391 pp2_relevance_token_destroy(prt);
1395 else if (ser_md->merge == Metadata_merge_all)
1397 rec_md->next = *wheretoput;
1398 *wheretoput = rec_md;
1400 else if (ser_md->merge == Metadata_merge_range)
1404 *wheretoput = rec_md;
1406 cluster->sortkeys[sk_field_id]
1411 int this_min = rec_md->data.number.min;
1412 int this_max = rec_md->data.number.max;
1413 if (this_min < (*wheretoput)->data.number.min)
1414 (*wheretoput)->data.number.min = this_min;
1415 if (this_max > (*wheretoput)->data.number.max)
1416 (*wheretoput)->data.number.max = this_max;
1421 // ranking of _all_ fields enabled ...
1423 relevance_countwords(se->relevance, cluster,
1424 (char *) value, ser_md->rank,
1427 // construct facets ... unless the client already has reported them
1428 if (ser_md->termlist && !client_has_facet(cl, (char *) type))
1431 if (ser_md->type == Metadata_type_year)
1434 sprintf(year, "%d", rec_md->data.number.max);
1435 add_facet(se, (char *) type, year, 1);
1436 if (rec_md->data.number.max != rec_md->data.number.min)
1438 sprintf(year, "%d", rec_md->data.number.min);
1439 add_facet(se, (char *) type, year, 1);
1443 add_facet(se, (char *) type, (char *) value, 1);
1453 if (se->number_of_warnings_unknown_elements == 0)
1454 session_log(se, YLOG_WARN,
1455 "Unexpected element in internal record: %s", n->name);
1456 se->number_of_warnings_unknown_elements++;
1464 relevance_donerecord(se->relevance, cluster);
1465 se->total_records++;
1470 void session_log(struct session *s, int level, const char *fmt, ...)
1476 yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
1477 yaz_log(level, "%u %s", s->session_id, buf);
1485 * c-file-style: "Stroustrup"
1486 * indent-tabs-mode: nil
1488 * vim: shiftwidth=4 tabstop=8 expandtab