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
42 #include <yaz/marcdisp.h>
43 #include <yaz/comstack.h>
44 #include <yaz/tcpip.h>
45 #include <yaz/proto.h>
46 #include <yaz/readconf.h>
47 #include <yaz/pquery.h>
48 #include <yaz/otherinfo.h>
49 #include <yaz/yaz-util.h>
51 #include <yaz/query-charset.h>
52 #include <yaz/querytowrbuf.h>
53 #include <yaz/oid_db.h>
54 #include <yaz/snprintf.h>
55 #include <yaz/gettimeofday.h>
59 #include <yaz/timing.h>
63 #include "parameters.h"
67 #include "termlists.h"
69 #include "relevance.h"
73 #include "normalize7bit.h"
75 #define TERMLIST_HIGH_SCORE 25
79 // Note: Some things in this structure will eventually move to configuration
80 struct parameters global_parameters =
87 struct client *client;
88 struct client_list *next;
91 static void log_xml_doc(xmlDoc *doc)
93 FILE *lf = yaz_log_file();
96 #if LIBXML_VERSION >= 20600
97 xmlDocDumpFormatMemory(doc, &result, &len, 1);
99 xmlDocDumpMemory(doc, &result, &len);
103 (void) fwrite(result, 1, len, lf);
109 static void session_enter(struct session *s)
111 yaz_mutex_enter(s->session_mutex);
114 static void session_leave(struct session *s)
116 yaz_mutex_leave(s->session_mutex);
119 // Recursively traverse query structure to extract terms.
120 void pull_terms(NMEM nmem, struct ccl_rpn_node *n, char **termlist, int *num)
132 pull_terms(nmem, n->u.p[0], termlist, num);
133 pull_terms(nmem, n->u.p[1], termlist, num);
136 nmem_strsplit(nmem, " ", n->u.t.term, &words, &numwords);
137 for (i = 0; i < numwords; i++)
138 termlist[(*num)++] = words[i];
146 static void add_facet(struct session *s, const char *type, const char *value)
152 for (i = 0; i < s->num_termlists; i++)
153 if (!strcmp(s->termlists[i].name, type))
155 if (i == s->num_termlists)
157 if (i == SESSION_MAX_TERMLISTS)
159 yaz_log(YLOG_FATAL, "Too many termlists");
163 s->termlists[i].name = nmem_strdup(s->nmem, type);
164 s->termlists[i].termlist
165 = termlist_create(s->nmem, TERMLIST_HIGH_SCORE);
166 s->num_termlists = i + 1;
168 termlist_insert(s->termlists[i].termlist, value);
171 static xmlDoc *record_to_xml(struct session_database *sdb, const char *rec)
173 struct database *db = sdb->database;
176 rdoc = xmlParseMemory(rec, strlen(rec));
180 yaz_log(YLOG_FATAL, "Non-wellformed XML received from %s",
185 if (global_parameters.dump_records)
187 yaz_log(YLOG_LOG, "Un-normalized record from %s", db->url);
194 #define MAX_XSLT_ARGS 16
196 // Add static values from session database settings if applicable
197 static void insert_settings_parameters(struct session_database *sdb,
198 struct conf_service *service,
206 for (i = 0; i < service->num_metadata; i++)
208 struct conf_metadata *md = &service->metadata[i];
211 if (md->setting == Metadata_setting_parameter &&
212 (setting = settings_lookup_offset(service, md->name)) >= 0)
214 const char *val = session_setting_oneval(sdb, setting);
215 if (val && nparms < MAX_XSLT_ARGS)
218 int len = strlen(val);
219 buf = nmem_malloc(nmem, len + 3);
221 strcpy(buf + 1, val);
224 parms[offset++] = md->name;
225 parms[offset++] = buf;
233 // Add static values from session database settings if applicable
234 static void insert_settings_values(struct session_database *sdb, xmlDoc *doc,
235 struct conf_service *service)
239 for (i = 0; i < service->num_metadata; i++)
241 struct conf_metadata *md = &service->metadata[i];
244 if (md->setting == Metadata_setting_postproc &&
245 (offset = settings_lookup_offset(service, md->name)) >= 0)
247 const char *val = session_setting_oneval(sdb, offset);
250 xmlNode *r = xmlDocGetRootElement(doc);
251 xmlNode *n = xmlNewTextChild(r, 0, (xmlChar *) "metadata",
253 xmlSetProp(n, (xmlChar *) "type", (xmlChar *) md->name);
259 static xmlDoc *normalize_record(struct session_database *sdb,
260 struct conf_service *service,
261 const char *rec, NMEM nmem)
263 xmlDoc *rdoc = record_to_xml(sdb, rec);
267 char *parms[MAX_XSLT_ARGS*2+1];
269 insert_settings_parameters(sdb, service, parms, nmem);
271 if (normalize_record_transform(sdb->map, &rdoc, (const char **)parms))
273 yaz_log(YLOG_WARN, "Normalize failed from %s", sdb->database->url);
277 insert_settings_values(sdb, rdoc, service);
279 if (global_parameters.dump_records)
281 yaz_log(YLOG_LOG, "Normalized record from %s",
290 void session_settings_dump(struct session *se,
291 struct session_database *db,
296 int i, num = db->num_settings;
297 for (i = 0; i < num; i++)
299 struct setting *s = db->settings[i];
300 for (;s ; s = s->next)
302 wrbuf_puts(w, "<set name=\"");
303 wrbuf_xmlputs(w, s->name);
304 wrbuf_puts(w, "\" value=\"");
305 wrbuf_xmlputs(w, s->value);
306 wrbuf_puts(w, "\"/>");
314 // Retrieve first defined value for 'name' for given database.
315 // Will be extended to take into account user associated with session
316 const char *session_setting_oneval(struct session_database *db, int offset)
318 if (offset >= db->num_settings || !db->settings[offset])
320 return db->settings[offset]->value;
323 // Prepare XSLT stylesheets for record normalization
324 // Structures are allocated on the session_wide nmem to avoid having
325 // to recompute this for every search. This would lead
326 // to leaking if a single session was to repeatedly change the PZ_XSLT
327 // setting. However, this is not a realistic use scenario.
328 static int prepare_map(struct session *se, struct session_database *sdb)
334 yaz_log(YLOG_WARN, "No settings on %s", sdb->database->url);
337 if ((s = session_setting_oneval(sdb, PZ_XSLT)))
339 char auto_stylesheet[256];
341 if (!strcmp(s, "auto"))
343 const char *request_syntax = session_setting_oneval(
344 sdb, PZ_REQUESTSYNTAX);
348 yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet),
349 "%s.xsl", request_syntax);
350 for (cp = auto_stylesheet; *cp; cp++)
352 /* deliberately only consider ASCII */
353 if (*cp > 32 && *cp < 127)
360 yaz_log(YLOG_WARN, "No pz:requestsyntax for auto stylesheet");
363 sdb->map = normalize_cache_get(se->normalize_cache,
364 se->service->server->config, s);
371 // This analyzes settings and recomputes any supporting data structures
373 static int prepare_session_database(struct session *se,
374 struct session_database *sdb)
379 "No settings associated with %s", sdb->database->url);
382 if (sdb->settings[PZ_XSLT] && !sdb->map)
384 if (prepare_map(se, sdb) < 0)
390 // called if watch should be removed because http_channel is to be destroyed
391 static void session_watch_cancel(void *data, struct http_channel *c,
394 struct session_watchentry *ent = data;
401 // set watch. Returns 0=OK, -1 if watch is already set
402 int session_set_watch(struct session *s, int what,
403 session_watchfun fun, void *data,
404 struct http_channel *chan)
408 if (s->watchlist[what].fun)
413 s->watchlist[what].fun = fun;
414 s->watchlist[what].data = data;
415 s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
416 session_watch_cancel);
423 void session_alert_watch(struct session *s, int what)
427 if (s->watchlist[what].fun)
429 /* our watch is no longer associated with http_channel */
431 session_watchfun fun;
433 http_remove_observer(s->watchlist[what].obs);
434 fun = s->watchlist[what].fun;
435 data = s->watchlist[what].data;
437 /* reset watch before fun is invoked - in case fun wants to set
439 s->watchlist[what].fun = 0;
440 s->watchlist[what].data = 0;
441 s->watchlist[what].obs = 0;
450 //callback for grep_databases
451 static void select_targets_callback(void *context, struct session_database *db)
453 struct session *se = (struct session*) context;
454 struct client *cl = client_create();
455 struct client_list *l;
456 client_set_database(cl, db);
458 client_set_session(cl, se);
459 l = xmalloc(sizeof(*l));
461 l->next = se->clients;
465 static void session_remove_clients(struct session *se)
467 struct client_list *l;
476 struct client_list *l_next = l->next;
477 client_lock(l->client);
478 client_set_session(l->client, 0);
479 client_set_database(l->client, 0);
480 client_unlock(l->client);
481 client_destroy(l->client);
487 // Associates a set of clients with a session;
488 // Note: Session-databases represent databases with per-session
490 static int select_targets(struct session *se, const char *filter)
492 return session_grep_databases(se, filter, select_targets_callback);
495 int session_active_clients(struct session *s)
497 struct client_list *l;
500 for (l = s->clients; l; l = l->next)
501 if (client_is_active(l->client))
508 enum pazpar2_error_code search(struct session *se,
510 const char *startrecs, const char *maxrecs,
512 const char **addinfo)
514 int live_channels = 0;
517 struct client_list *l;
520 yaz_log(YLOG_DEBUG, "Search");
524 session_remove_clients(se);
527 reclist_destroy(se->reclist);
529 relevance_destroy(&se->relevance);
530 nmem_reset(se->nmem);
531 se->total_records = se->total_hits = se->total_merged = 0;
532 se->num_termlists = 0;
533 live_channels = select_targets(se, filter);
537 return PAZPAR2_NO_TARGETS;
539 se->reclist = reclist_create(se->nmem);
541 yaz_gettimeofday(&tval);
545 for (l = se->clients; l; l = l->next)
547 struct client *cl = l->client;
550 client_set_maxrecs(cl, atoi(maxrecs));
552 client_set_startrecs(cl, atoi(startrecs));
553 if (prepare_session_database(se, client_get_database(cl)) < 0)
555 else if (client_parse_query(cl, query) < 0)
560 if (client_prep_connection(cl, se->service->z3950_operation_timeout,
561 se->service->z3950_session_timeout,
562 se->service->server->iochan_man,
564 client_start_search(cl);
573 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
576 return PAZPAR2_NO_TARGETS;
578 return PAZPAR2_NO_ERROR;
581 // Creates a new session_database object for a database
582 static void session_init_databases_fun(void *context, struct database *db)
584 struct session *se = (struct session *) context;
585 struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
591 assert(db->settings);
592 new->settings = nmem_malloc(se->session_nmem,
593 sizeof(struct settings *) * db->num_settings);
594 new->num_settings = db->num_settings;
595 for (i = 0; i < db->num_settings; i++)
597 struct setting *setting = db->settings[i];
598 new->settings[i] = setting;
600 new->next = se->databases;
604 // Doesn't free memory associated with sdb -- nmem takes care of that
605 static void session_database_destroy(struct session_database *sdb)
610 // Initialize session_database list -- this represents this session's view
611 // of the database list -- subject to modification by the settings ws command
612 void session_init_databases(struct session *se)
615 predef_grep_databases(se, se->service, session_init_databases_fun);
618 // Probably session_init_databases_fun should be refactored instead of
620 static struct session_database *load_session_database(struct session *se,
623 struct database *db = new_database(id, se->session_nmem);
625 resolve_database(se->service, db);
627 session_init_databases_fun((void*) se, db);
629 // New sdb is head of se->databases list
630 return se->databases;
633 // Find an existing session database. If not found, load it
634 static struct session_database *find_session_database(struct session *se,
637 struct session_database *sdb;
639 for (sdb = se->databases; sdb; sdb = sdb->next)
640 if (!strcmp(sdb->database->url, id))
642 return load_session_database(se, id);
645 // Apply a session override to a database
646 void session_apply_setting(struct session *se, char *dbname, char *setting,
649 struct session_database *sdb = find_session_database(se, dbname);
650 struct conf_service *service = se->service;
651 struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
652 int offset = settings_create_offset(service, setting);
654 expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
657 new->target = dbname;
660 new->next = sdb->settings[offset];
661 sdb->settings[offset] = new;
663 // Force later recompute of settings-driven data structures
664 // (happens when a search starts and client connections are prepared)
676 void destroy_session(struct session *se)
678 struct session_database *sdb;
680 yaz_log(YLOG_DEBUG, "%p Pazpar2 session destroy", se);
681 session_remove_clients(se);
683 for (sdb = se->databases; sdb; sdb = sdb->next)
684 session_database_destroy(sdb);
685 normalize_cache_destroy(se->normalize_cache);
686 relevance_destroy(&se->relevance);
687 reclist_destroy(se->reclist);
688 nmem_destroy(se->nmem);
689 service_destroy(se->service);
690 yaz_mutex_destroy(&se->session_mutex);
691 wrbuf_destroy(se->wrbuf);
694 struct session *new_session(NMEM nmem, struct conf_service *service,
698 struct session *session = nmem_malloc(nmem, sizeof(*session));
700 yaz_log(YLOG_DEBUG, "%p New Pazpar2 session", session);
702 session->service = service;
703 session->relevance = 0;
704 session->total_hits = 0;
705 session->total_records = 0;
706 session->number_of_warnings_unknown_elements = 0;
707 session->number_of_warnings_unknown_metadata = 0;
708 session->num_termlists = 0;
709 session->reclist = 0;
710 session->clients = 0;
711 session->session_nmem = nmem;
712 session->nmem = nmem_create();
713 session->wrbuf = wrbuf_alloc();
714 session->databases = 0;
715 for (i = 0; i <= SESSION_WATCH_MAX; i++)
717 session->watchlist[i].data = 0;
718 session->watchlist[i].fun = 0;
720 session->normalize_cache = normalize_cache_create();
721 session->session_mutex = 0;
722 pazpar2_mutex_create(&session->session_mutex, name);
727 struct hitsbytarget *hitsbytarget(struct session *se, int *count, NMEM nmem)
729 struct hitsbytarget *res = 0;
730 struct client_list *l;
734 for (l = se->clients; l; l = l->next)
737 res = nmem_malloc(nmem, sizeof(*res) * sz);
739 for (l = se->clients; l; l = l->next)
741 struct client *cl = l->client;
742 WRBUF w = wrbuf_alloc();
743 const char *name = session_setting_oneval(client_get_database(cl),
746 res[*count].id = client_get_database(cl)->database->url;
747 res[*count].name = *name ? name : "Unknown";
748 res[*count].hits = client_get_hits(cl);
749 res[*count].records = client_get_num_records(cl);
750 res[*count].diagnostic = client_get_diagnostic(cl);
751 res[*count].state = client_get_state_str(cl);
752 res[*count].connected = client_get_connection(cl) ? 1 : 0;
753 session_settings_dump(se, client_get_database(cl), w);
754 res[*count].settings_xml = w;
761 struct termlist_score **termlist(struct session *se, const char *name, int *num)
764 struct termlist_score **tl = 0;
767 for (i = 0; i < se->num_termlists; i++)
768 if (!strcmp((const char *) se->termlists[i].name, name))
770 tl = termlist_highscore(se->termlists[i].termlist, num);
777 #ifdef MISSING_HEADERS
778 void report_nmem_stats(void)
780 size_t in_use, is_free;
782 nmem_get_memory_in_use(&in_use);
783 nmem_get_memory_free(&is_free);
785 yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
786 (long) in_use, (long) is_free);
790 struct record_cluster *show_single_start(struct session *se, const char *id,
791 struct record_cluster **prev_r,
792 struct record_cluster **next_r)
794 struct record_cluster *r;
797 reclist_enter(se->reclist);
800 while ((r = reclist_read_record(se->reclist)))
802 if (!strcmp(r->recid, id))
804 *next_r = reclist_read_record(se->reclist);
809 reclist_leave(se->reclist);
815 void show_single_stop(struct session *se, struct record_cluster *rec)
820 struct record_cluster **show_range_start(struct session *se,
821 struct reclist_sortparms *sp,
822 int start, int *num, int *total, Odr_int *sumhits)
824 struct record_cluster **recs;
825 struct reclist_sortparms *spp;
828 yaz_timing_t t = yaz_timing_create();
831 recs = nmem_malloc(se->nmem, *num * sizeof(struct record_cluster *));
841 for (spp = sp; spp; spp = spp->next)
842 if (spp->type == Metadata_sortkey_relevance)
844 relevance_prepare_read(se->relevance, se->reclist);
847 reclist_sort(se->reclist, sp);
849 reclist_enter(se->reclist);
850 *total = reclist_get_num_records(se->reclist);
851 *sumhits = se->total_hits;
853 for (i = 0; i < start; i++)
854 if (!reclist_read_record(se->reclist))
861 for (i = 0; i < *num; i++)
863 struct record_cluster *r = reclist_read_record(se->reclist);
871 reclist_leave(se->reclist);
875 yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
876 yaz_timing_get_real(t), yaz_timing_get_user(t),
877 yaz_timing_get_sys(t));
878 yaz_timing_destroy(&t);
883 void show_range_stop(struct session *se, struct record_cluster **recs)
888 void statistics(struct session *se, struct statistics *stat)
890 struct client_list *l;
893 memset(stat, 0, sizeof(*stat));
894 for (l = se->clients; l; l = l->next)
896 struct client *cl = l->client;
897 if (!client_get_connection(cl))
898 stat->num_no_connection++;
899 switch (client_get_state(cl))
901 case Client_Connecting: stat->num_connecting++; break;
902 case Client_Working: stat->num_working++; break;
903 case Client_Idle: stat->num_idle++; break;
904 case Client_Failed: stat->num_failed++; break;
905 case Client_Error: stat->num_error++; break;
910 stat->num_hits = se->total_hits;
911 stat->num_records = se->total_records;
913 stat->num_clients = count;
916 static struct record_metadata *record_metadata_init(
917 NMEM nmem, const char *value, enum conf_metadata_type type,
918 struct _xmlAttr *attr)
920 struct record_metadata *rec_md = record_metadata_create(nmem);
921 struct record_metadata_attr **attrp = &rec_md->attributes;
923 for (; attr; attr = attr->next)
925 if (attr->children && attr->children->content)
927 if (strcmp((const char *) attr->name, "type"))
928 { /* skip the "type" attribute.. Its value is already part of
929 the element in output (md-%s) and so repeating it here
931 *attrp = nmem_malloc(nmem, sizeof(**attrp));
933 nmem_strdup(nmem, (const char *) attr->name);
935 nmem_strdup(nmem, (const char *) attr->children->content);
936 attrp = &(*attrp)->next;
942 if (type == Metadata_type_generic)
944 char *p = nmem_strdup(nmem, value);
946 p = normalize7bit_generic(p, " ,/.:([");
948 rec_md->data.text.disp = p;
949 rec_md->data.text.sort = 0;
951 else if (type == Metadata_type_year || type == Metadata_type_date)
956 if (type == Metadata_type_date)
958 if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
961 rec_md->data.number.min = first;
962 rec_md->data.number.max = last;
969 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
970 struct conf_service *service, WRBUF norm_wr)
974 for (n = root->children; n; n = n->next)
976 if (n->type != XML_ELEMENT_NODE)
978 if (!strcmp((const char *) n->name, "metadata"))
980 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
981 if (!strcmp(name, (const char *) type))
983 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
986 const char *norm_str;
987 pp2_relevance_token_t prt =
988 pp2_relevance_tokenize(service->mergekey_pct);
990 pp2_relevance_first(prt, (const char *) value, 0);
991 if (wrbuf_len(norm_wr) > 0)
992 wrbuf_puts(norm_wr, " ");
993 wrbuf_puts(norm_wr, name);
995 pp2_relevance_token_next(prt)))
999 wrbuf_puts(norm_wr, " ");
1000 wrbuf_puts(norm_wr, norm_str);
1004 pp2_relevance_token_destroy(prt);
1014 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
1015 struct conf_service *service, NMEM nmem)
1017 char *mergekey_norm = 0;
1018 xmlNode *root = xmlDocGetRootElement(doc);
1019 WRBUF norm_wr = wrbuf_alloc();
1021 /* consider mergekey from XSL first */
1022 xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
1025 const char *norm_str;
1026 pp2_relevance_token_t prt =
1027 pp2_relevance_tokenize(service->mergekey_pct);
1029 pp2_relevance_first(prt, (const char *) mergekey, 0);
1030 while ((norm_str = pp2_relevance_token_next(prt)))
1034 if (wrbuf_len(norm_wr))
1035 wrbuf_puts(norm_wr, " ");
1036 wrbuf_puts(norm_wr, norm_str);
1039 pp2_relevance_token_destroy(prt);
1044 /* no mergekey defined in XSL. Look for mergekey metadata instead */
1046 for (field_id = 0; field_id < service->num_metadata; field_id++)
1048 struct conf_metadata *ser_md = &service->metadata[field_id];
1049 if (ser_md->mergekey != Metadata_mergekey_no)
1051 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1053 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1055 /* no mergekey on this one and it is required..
1056 Generate unique key instead */
1057 wrbuf_rewind(norm_wr);
1064 /* generate unique key if none is not generated already or is empty */
1065 if (wrbuf_len(norm_wr) == 0)
1067 wrbuf_printf(norm_wr, "%s-%d",
1068 client_get_database(cl)->database->url, record_no);
1070 if (wrbuf_len(norm_wr) > 0)
1071 mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1072 wrbuf_destroy(norm_wr);
1073 return mergekey_norm;
1076 /** \brief see if metadata for pz:recordfilter exists
1077 \param root xml root element of normalized record
1078 \param sdb session database for client
1079 \retval 0 if there is no metadata for pz:recordfilter
1080 \retval 1 if there is metadata for pz:recordfilter
1082 If there is no pz:recordfilter defined, this function returns 1
1086 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1091 s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1096 for (n = root->children; n; n = n->next)
1098 if (n->type != XML_ELEMENT_NODE)
1100 if (!strcmp((const char *) n->name, "metadata"))
1102 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1106 const char *eq = strchr(s, '~');
1111 if (len == strlen((const char *)type) &&
1112 !memcmp((const char *) type, s, len))
1114 xmlChar *value = xmlNodeGetContent(n);
1115 if (value && *value)
1117 if (!eq || strstr((const char *) value, eq+1))
1130 static int ingest_to_cluster(struct client *cl,
1134 const char *mergekey_norm);
1136 /** \brief ingest XML record
1137 \param cl client holds the result set for record
1138 \param rec record buffer (0 terminated)
1139 \param record_no record position (1, 2, ..)
1143 int ingest_record(struct client *cl, const char *rec,
1144 int record_no, NMEM nmem)
1146 struct session *se = client_get_session(cl);
1148 struct session_database *sdb = client_get_database(cl);
1149 struct conf_service *service = se->service;
1150 xmlDoc *xdoc = normalize_record(sdb, service, rec, nmem);
1152 const char *mergekey_norm;
1157 root = xmlDocGetRootElement(xdoc);
1159 if (!check_record_filter(root, sdb))
1161 yaz_log(YLOG_WARN, "Filtered out record no %d from %s", record_no,
1162 sdb->database->url);
1167 mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem);
1170 yaz_log(YLOG_WARN, "Got no mergekey");
1175 if (client_get_session(cl) == se)
1176 ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1183 static int ingest_to_cluster(struct client *cl,
1187 const char *mergekey_norm)
1192 struct session_database *sdb = client_get_database(cl);
1193 struct session *se = client_get_session(cl);
1194 struct conf_service *service = se->service;
1195 struct record *record = record_create(se->nmem,
1196 service->num_metadata,
1197 service->num_sortkeys, cl,
1199 struct record_cluster *cluster = reclist_insert(se->reclist,
1206 if (global_parameters.dump_records)
1207 yaz_log(YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1208 sdb->database->url, record_no);
1209 relevance_newrec(se->relevance, cluster);
1211 // now parsing XML record and adding data to cluster or record metadata
1212 for (n = root->children; n; n = n->next)
1214 pp2_relevance_token_t prt;
1221 if (n->type != XML_ELEMENT_NODE)
1223 if (!strcmp((const char *) n->name, "metadata"))
1225 struct conf_metadata *ser_md = 0;
1226 struct conf_sortkey *ser_sk = 0;
1227 struct record_metadata **wheretoput = 0;
1228 struct record_metadata *rec_md = 0;
1229 int md_field_id = -1;
1230 int sk_field_id = -1;
1232 type = xmlGetProp(n, (xmlChar *) "type");
1233 value = xmlNodeListGetString(xdoc, n->children, 1);
1235 if (!type || !value || !*value)
1239 = conf_service_metadata_field_id(service, (const char *) type);
1240 if (md_field_id < 0)
1242 if (se->number_of_warnings_unknown_metadata == 0)
1245 "Ignoring unknown metadata element: %s", type);
1247 se->number_of_warnings_unknown_metadata++;
1251 ser_md = &service->metadata[md_field_id];
1253 if (ser_md->sortkey_offset >= 0){
1254 sk_field_id = ser_md->sortkey_offset;
1255 ser_sk = &service->sortkeys[sk_field_id];
1258 // non-merged metadata
1259 rec_md = record_metadata_init(se->nmem, (const char *) value,
1260 ser_md->type, n->properties);
1263 yaz_log(YLOG_WARN, "bad metadata data '%s' for element '%s'",
1267 wheretoput = &record->metadata[md_field_id];
1269 wheretoput = &(*wheretoput)->next;
1270 *wheretoput = rec_md;
1273 rec_md = record_metadata_init(se->nmem, (const char *) value,
1275 wheretoput = &cluster->metadata[md_field_id];
1277 // and polulate with data:
1278 // assign cluster or record based on merge action
1279 if (ser_md->merge == Metadata_merge_unique)
1281 struct record_metadata *mnode;
1282 for (mnode = *wheretoput; mnode; mnode = mnode->next)
1283 if (!strcmp((const char *) mnode->data.text.disp,
1284 rec_md->data.text.disp))
1288 rec_md->next = *wheretoput;
1289 *wheretoput = rec_md;
1292 else if (ser_md->merge == Metadata_merge_longest)
1295 || strlen(rec_md->data.text.disp)
1296 > strlen((*wheretoput)->data.text.disp))
1298 *wheretoput = rec_md;
1301 const char *sort_str = 0;
1303 ser_sk->type == Metadata_sortkey_skiparticle;
1305 if (!cluster->sortkeys[sk_field_id])
1306 cluster->sortkeys[sk_field_id] =
1307 nmem_malloc(se->nmem,
1308 sizeof(union data_types));
1310 prt = pp2_relevance_tokenize(service->sort_pct);
1312 pp2_relevance_first(prt, rec_md->data.text.disp,
1315 pp2_relevance_token_next(prt);
1317 sort_str = pp2_get_sort(prt);
1319 cluster->sortkeys[sk_field_id]->text.disp =
1320 rec_md->data.text.disp;
1323 sort_str = rec_md->data.text.disp;
1325 "Could not make sortkey. Bug #1858");
1327 cluster->sortkeys[sk_field_id]->text.sort =
1328 nmem_strdup(se->nmem, sort_str);
1330 yaz_log(YLOG_LOG, "text disp=%s",
1331 cluster->sortkeys[sk_field_id]->text.disp);
1332 yaz_log(YLOG_LOG, "text sort=%s",
1333 cluster->sortkeys[sk_field_id]->text.sort);
1335 pp2_relevance_token_destroy(prt);
1339 else if (ser_md->merge == Metadata_merge_all)
1341 rec_md->next = *wheretoput;
1342 *wheretoput = rec_md;
1344 else if (ser_md->merge == Metadata_merge_range)
1348 *wheretoput = rec_md;
1350 cluster->sortkeys[sk_field_id]
1355 int this_min = rec_md->data.number.min;
1356 int this_max = rec_md->data.number.max;
1357 if (this_min < (*wheretoput)->data.number.min)
1358 (*wheretoput)->data.number.min = this_min;
1359 if (this_max > (*wheretoput)->data.number.max)
1360 (*wheretoput)->data.number.max = this_max;
1365 // ranking of _all_ fields enabled ...
1367 relevance_countwords(se->relevance, cluster,
1368 (char *) value, ser_md->rank,
1371 // construct facets ...
1372 if (ser_md->termlist)
1374 if (ser_md->type == Metadata_type_year)
1377 sprintf(year, "%d", rec_md->data.number.max);
1378 add_facet(se, (char *) type, year);
1379 if (rec_md->data.number.max != rec_md->data.number.min)
1381 sprintf(year, "%d", rec_md->data.number.min);
1382 add_facet(se, (char *) type, year);
1386 add_facet(se, (char *) type, (char *) value);
1396 if (se->number_of_warnings_unknown_elements == 0)
1398 "Unexpected element in internal record: %s", n->name);
1399 se->number_of_warnings_unknown_elements++;
1407 relevance_donerecord(se->relevance, cluster);
1408 se->total_records++;
1416 * c-file-style: "Stroustrup"
1417 * indent-tabs-mode: nil
1419 * vim: shiftwidth=4 tabstop=8 expandtab