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
41 #include <yaz/marcdisp.h>
42 #include <yaz/comstack.h>
43 #include <yaz/tcpip.h>
44 #include <yaz/proto.h>
45 #include <yaz/readconf.h>
46 #include <yaz/pquery.h>
47 #include <yaz/otherinfo.h>
48 #include <yaz/yaz-util.h>
50 #include <yaz/query-charset.h>
51 #include <yaz/querytowrbuf.h>
52 #include <yaz/oid_db.h>
53 #include <yaz/snprintf.h>
57 #include <yaz/timing.h>
61 #include "parameters.h"
65 #include "termlists.h"
67 #include "relevance.h"
71 #include "normalize7bit.h"
73 #define TERMLIST_HIGH_SCORE 25
77 // Note: Some things in this structure will eventually move to configuration
78 struct parameters global_parameters =
84 static void log_xml_doc(xmlDoc *doc)
86 FILE *lf = yaz_log_file();
89 #if LIBXML_VERSION >= 20600
90 xmlDocDumpFormatMemory(doc, &result, &len, 1);
92 xmlDocDumpMemory(doc, &result, &len);
96 (void) fwrite(result, 1, len, lf);
102 static void session_enter(struct session *s)
104 yaz_mutex_enter(s->mutex);
107 static void session_leave(struct session *s)
109 yaz_mutex_leave(s->mutex);
112 // Recursively traverse query structure to extract terms.
113 void pull_terms(NMEM nmem, struct ccl_rpn_node *n, char **termlist, int *num)
125 pull_terms(nmem, n->u.p[0], termlist, num);
126 pull_terms(nmem, n->u.p[1], termlist, num);
129 nmem_strsplit(nmem, " ", n->u.t.term, &words, &numwords);
130 for (i = 0; i < numwords; i++)
131 termlist[(*num)++] = words[i];
139 static void add_facet(struct session *s, const char *type, const char *value)
145 for (i = 0; i < s->num_termlists; i++)
146 if (!strcmp(s->termlists[i].name, type))
148 if (i == s->num_termlists)
150 if (i == SESSION_MAX_TERMLISTS)
152 yaz_log(YLOG_FATAL, "Too many termlists");
156 s->termlists[i].name = nmem_strdup(s->nmem, type);
157 s->termlists[i].termlist
158 = termlist_create(s->nmem, TERMLIST_HIGH_SCORE);
159 s->num_termlists = i + 1;
161 termlist_insert(s->termlists[i].termlist, value);
164 static xmlDoc *record_to_xml(struct session_database *sdb, const char *rec)
166 struct database *db = sdb->database;
169 rdoc = xmlParseMemory(rec, strlen(rec));
173 yaz_log(YLOG_FATAL, "Non-wellformed XML received from %s",
178 if (global_parameters.dump_records)
180 yaz_log(YLOG_LOG, "Un-normalized record from %s", db->url);
187 #define MAX_XSLT_ARGS 16
189 // Add static values from session database settings if applicable
190 static void insert_settings_parameters(struct session_database *sdb,
191 struct conf_service *service,
199 for (i = 0; i < service->num_metadata; i++)
201 struct conf_metadata *md = &service->metadata[i];
204 if (md->setting == Metadata_setting_parameter &&
205 (setting = settings_lookup_offset(service, md->name)) >= 0)
207 const char *val = session_setting_oneval(sdb, setting);
208 if (val && nparms < MAX_XSLT_ARGS)
211 int len = strlen(val);
212 buf = nmem_malloc(nmem, len + 3);
214 strcpy(buf + 1, val);
217 parms[offset++] = md->name;
218 parms[offset++] = buf;
226 // Add static values from session database settings if applicable
227 static void insert_settings_values(struct session_database *sdb, xmlDoc *doc,
228 struct conf_service *service)
232 for (i = 0; i < service->num_metadata; i++)
234 struct conf_metadata *md = &service->metadata[i];
237 if (md->setting == Metadata_setting_postproc &&
238 (offset = settings_lookup_offset(service, md->name)) >= 0)
240 const char *val = session_setting_oneval(sdb, offset);
243 xmlNode *r = xmlDocGetRootElement(doc);
244 xmlNode *n = xmlNewTextChild(r, 0, (xmlChar *) "metadata",
246 xmlSetProp(n, (xmlChar *) "type", (xmlChar *) md->name);
252 static xmlDoc *normalize_record(struct session_database *sdb,
253 struct conf_service *service,
254 const char *rec, NMEM nmem)
256 xmlDoc *rdoc = record_to_xml(sdb, rec);
260 char *parms[MAX_XSLT_ARGS*2+1];
262 insert_settings_parameters(sdb, service, parms, nmem);
264 if (normalize_record_transform(sdb->map, &rdoc, (const char **)parms))
266 yaz_log(YLOG_WARN, "Normalize failed from %s", sdb->database->url);
270 insert_settings_values(sdb, rdoc, service);
272 if (global_parameters.dump_records)
274 yaz_log(YLOG_LOG, "Normalized record from %s",
283 void session_settings_dump(struct session *se,
284 struct session_database *db,
289 int i, num = db->num_settings;
290 for (i = 0; i < num; i++)
292 struct setting *s = db->settings[i];
293 for (;s ; s = s->next)
295 wrbuf_puts(w, "<set name=\"");
296 wrbuf_xmlputs(w, s->name);
297 wrbuf_puts(w, "\" value=\"");
298 wrbuf_xmlputs(w, s->value);
299 wrbuf_puts(w, "\"/>");
307 // Retrieve first defined value for 'name' for given database.
308 // Will be extended to take into account user associated with session
309 const char *session_setting_oneval(struct session_database *db, int offset)
311 if (offset >= db->num_settings || !db->settings[offset])
313 return db->settings[offset]->value;
316 // Prepare XSLT stylesheets for record normalization
317 // Structures are allocated on the session_wide nmem to avoid having
318 // to recompute this for every search. This would lead
319 // to leaking if a single session was to repeatedly change the PZ_XSLT
320 // setting. However, this is not a realistic use scenario.
321 static int prepare_map(struct session *se, struct session_database *sdb)
327 yaz_log(YLOG_WARN, "No settings on %s", sdb->database->url);
330 if ((s = session_setting_oneval(sdb, PZ_XSLT)))
332 char auto_stylesheet[256];
334 if (!strcmp(s, "auto"))
336 const char *request_syntax = session_setting_oneval(
337 sdb, PZ_REQUESTSYNTAX);
341 yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet),
342 "%s.xsl", request_syntax);
343 for (cp = auto_stylesheet; *cp; cp++)
345 /* deliberately only consider ASCII */
346 if (*cp > 32 && *cp < 127)
353 yaz_log(YLOG_WARN, "No pz:requestsyntax for auto stylesheet");
356 sdb->map = normalize_cache_get(se->normalize_cache,
364 // This analyzes settings and recomputes any supporting data structures
366 static int prepare_session_database(struct session *se,
367 struct session_database *sdb)
372 "No settings associated with %s", sdb->database->url);
375 if (sdb->settings[PZ_XSLT] && !sdb->map)
377 if (prepare_map(se, sdb) < 0)
383 // called if watch should be removed because http_channel is to be destroyed
384 static void session_watch_cancel(void *data, struct http_channel *c,
387 struct session_watchentry *ent = data;
394 // set watch. Returns 0=OK, -1 if watch is already set
395 int session_set_watch(struct session *s, int what,
396 session_watchfun fun, void *data,
397 struct http_channel *chan)
401 if (s->watchlist[what].fun)
406 s->watchlist[what].fun = fun;
407 s->watchlist[what].data = data;
408 s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
409 session_watch_cancel);
416 void session_alert_watch(struct session *s, int what)
420 if (s->watchlist[what].fun)
422 /* our watch is no longer associated with http_channel */
424 session_watchfun fun;
426 http_remove_observer(s->watchlist[what].obs);
427 fun = s->watchlist[what].fun;
428 data = s->watchlist[what].data;
430 /* reset watch before fun is invoked - in case fun wants to set
432 s->watchlist[what].fun = 0;
433 s->watchlist[what].data = 0;
434 s->watchlist[what].obs = 0;
443 //callback for grep_databases
444 static void select_targets_callback(void *context, struct session_database *db)
446 struct session *se = (struct session*) context;
447 struct client *cl = client_create();
448 client_set_database(cl, db);
449 client_set_session(cl, se);
452 static void session_remove_clients(struct session *se)
455 client_remove_from_session(se->clients);
458 // Associates a set of clients with a session;
459 // Note: Session-databases represent databases with per-session
461 static int select_targets(struct session *se, const char *filter)
463 session_remove_clients(se);
464 return session_grep_databases(se, filter, select_targets_callback);
467 int session_active_clients(struct session *s)
472 for (c = s->clients; c; c = client_next_in_session(c))
473 if (client_is_active(c))
480 enum pazpar2_error_code search(struct session *se,
482 const char *startrecs, const char *maxrecs,
484 const char **addinfo)
486 int live_channels = 0;
491 yaz_log(YLOG_DEBUG, "Search");
496 reclist_destroy(se->reclist);
498 nmem_reset(se->nmem);
499 relevance_destroy(&se->relevance);
500 se->total_records = se->total_hits = se->total_merged = 0;
501 se->num_termlists = 0;
502 live_channels = select_targets(se, filter);
506 return PAZPAR2_NO_TARGETS;
508 se->reclist = reclist_create(se->nmem);
510 for (cl = se->clients; cl; cl = client_next_in_session(cl))
513 client_set_maxrecs(cl, atoi(maxrecs));
515 client_set_startrecs(cl, atoi(startrecs));
516 if (prepare_session_database(se, client_get_database(cl)) < 0)
518 // Parse query for target
519 if (client_parse_query(cl, query) < 0)
524 if (client_prep_connection(cl, se->service->z3950_operation_timeout,
525 se->service->z3950_session_timeout,
526 se->service->server->iochan_man))
527 client_start_search(cl);
536 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
539 return PAZPAR2_NO_TARGETS;
541 return PAZPAR2_NO_ERROR;
544 // Creates a new session_database object for a database
545 static void session_init_databases_fun(void *context, struct database *db)
547 struct session *se = (struct session *) context;
548 struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
554 assert(db->settings);
555 new->settings = nmem_malloc(se->session_nmem,
556 sizeof(struct settings *) * db->num_settings);
557 new->num_settings = db->num_settings;
558 for (i = 0; i < db->num_settings; i++)
560 struct setting *setting = db->settings[i];
561 new->settings[i] = setting;
563 new->next = se->databases;
567 // Doesn't free memory associated with sdb -- nmem takes care of that
568 static void session_database_destroy(struct session_database *sdb)
573 // Initialize session_database list -- this represents this session's view
574 // of the database list -- subject to modification by the settings ws command
575 void session_init_databases(struct session *se)
578 predef_grep_databases(se, se->service, session_init_databases_fun);
581 // Probably session_init_databases_fun should be refactored instead of
583 static struct session_database *load_session_database(struct session *se,
586 struct database *db = new_database(id, se->session_nmem);
588 resolve_database(se->service, db);
590 session_init_databases_fun((void*) se, db);
592 // New sdb is head of se->databases list
593 return se->databases;
596 // Find an existing session database. If not found, load it
597 static struct session_database *find_session_database(struct session *se,
600 struct session_database *sdb;
602 for (sdb = se->databases; sdb; sdb = sdb->next)
603 if (!strcmp(sdb->database->url, id))
605 return load_session_database(se, id);
608 // Apply a session override to a database
609 void session_apply_setting(struct session *se, char *dbname, char *setting,
612 struct session_database *sdb = find_session_database(se, dbname);
613 struct conf_service *service = se->service;
614 struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
615 int offset = settings_create_offset(service, setting);
617 expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
620 new->target = dbname;
623 new->next = sdb->settings[offset];
624 sdb->settings[offset] = new;
626 // Force later recompute of settings-driven data structures
627 // (happens when a search starts and client connections are prepared)
639 void destroy_session(struct session *s)
641 struct session_database *sdb;
643 session_remove_clients(s);
645 for (sdb = s->databases; sdb; sdb = sdb->next)
646 session_database_destroy(sdb);
647 normalize_cache_destroy(s->normalize_cache);
648 relevance_destroy(&s->relevance);
649 reclist_destroy(s->reclist);
650 nmem_destroy(s->nmem);
651 service_destroy(s->service);
652 yaz_mutex_destroy(&s->mutex);
653 wrbuf_destroy(s->wrbuf);
656 struct session *new_session(NMEM nmem, struct conf_service *service,
660 struct session *session = nmem_malloc(nmem, sizeof(*session));
662 yaz_log(YLOG_DEBUG, "New Pazpar2 session");
664 session->service = service;
665 session->relevance = 0;
666 session->total_hits = 0;
667 session->total_records = 0;
668 session->number_of_warnings_unknown_elements = 0;
669 session->number_of_warnings_unknown_metadata = 0;
670 session->num_termlists = 0;
671 session->reclist = 0;
672 session->clients = 0;
673 session->session_nmem = nmem;
674 session->nmem = nmem_create();
675 session->wrbuf = wrbuf_alloc();
676 session->databases = 0;
677 for (i = 0; i <= SESSION_WATCH_MAX; i++)
679 session->watchlist[i].data = 0;
680 session->watchlist[i].fun = 0;
682 session->normalize_cache = normalize_cache_create();
685 pazpar2_mutex_create(&session->mutex, name);
690 struct hitsbytarget *hitsbytarget(struct session *se, int *count, NMEM nmem)
692 struct hitsbytarget *res = 0;
697 for (cl = se->clients; cl; cl = client_next_in_session(cl))
700 res = nmem_malloc(nmem, sizeof(*res) * sz);
702 for (cl = se->clients; cl; cl = client_next_in_session(cl))
704 WRBUF w = wrbuf_alloc();
705 const char *name = session_setting_oneval(client_get_database(cl),
708 res[*count].id = client_get_database(cl)->database->url;
709 res[*count].name = *name ? name : "Unknown";
710 res[*count].hits = client_get_hits(cl);
711 res[*count].records = client_get_num_records(cl);
712 res[*count].diagnostic = client_get_diagnostic(cl);
713 res[*count].state = client_get_state_str(cl);
714 res[*count].connected = client_get_connection(cl) ? 1 : 0;
715 session_settings_dump(se, client_get_database(cl), w);
716 res[*count].settings_xml = w;
723 struct termlist_score **termlist(struct session *s, const char *name, int *num)
726 struct termlist_score **tl = 0;
729 for (i = 0; i < s->num_termlists; i++)
730 if (!strcmp((const char *) s->termlists[i].name, name))
732 tl = termlist_highscore(s->termlists[i].termlist, num);
739 #ifdef MISSING_HEADERS
740 void report_nmem_stats(void)
742 size_t in_use, is_free;
744 nmem_get_memory_in_use(&in_use);
745 nmem_get_memory_free(&is_free);
747 yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
748 (long) in_use, (long) is_free);
752 struct record_cluster *show_single_start(struct session *s, const char *id,
753 struct record_cluster **prev_r,
754 struct record_cluster **next_r)
756 struct record_cluster *r;
759 reclist_enter(s->reclist);
762 while ((r = reclist_read_record(s->reclist)))
764 if (!strcmp(r->recid, id))
766 *next_r = reclist_read_record(s->reclist);
771 reclist_leave(s->reclist);
777 void show_single_stop(struct session *s, struct record_cluster *rec)
782 struct record_cluster **show_range_start(struct session *s,
783 struct reclist_sortparms *sp,
784 int start, int *num, int *total, Odr_int *sumhits)
786 struct record_cluster **recs = nmem_malloc(s->nmem, *num
787 * sizeof(struct record_cluster *));
788 struct reclist_sortparms *spp;
791 yaz_timing_t t = yaz_timing_create();
804 for (spp = sp; spp; spp = spp->next)
805 if (spp->type == Metadata_sortkey_relevance)
807 relevance_prepare_read(s->relevance, s->reclist);
810 reclist_sort(s->reclist, sp);
812 reclist_enter(s->reclist);
813 *total = reclist_get_num_records(s->reclist);
814 *sumhits = s->total_hits;
816 for (i = 0; i < start; i++)
817 if (!reclist_read_record(s->reclist))
824 for (i = 0; i < *num; i++)
826 struct record_cluster *r = reclist_read_record(s->reclist);
834 reclist_leave(s->reclist);
838 yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
839 yaz_timing_get_real(t), yaz_timing_get_user(t),
840 yaz_timing_get_sys(t));
841 yaz_timing_destroy(&t);
846 void show_range_stop(struct session *s, struct record_cluster **recs)
851 void statistics(struct session *se, struct statistics *stat)
856 memset(stat, 0, sizeof(*stat));
857 for (cl = se->clients; cl; cl = client_next_in_session(cl))
859 if (!client_get_connection(cl))
860 stat->num_no_connection++;
861 switch (client_get_state(cl))
863 case Client_Connecting: stat->num_connecting++; break;
864 case Client_Working: stat->num_working++; break;
865 case Client_Idle: stat->num_idle++; break;
866 case Client_Failed: stat->num_failed++; break;
867 case Client_Error: stat->num_error++; break;
872 stat->num_hits = se->total_hits;
873 stat->num_records = se->total_records;
875 stat->num_clients = count;
878 static struct record_metadata *record_metadata_init(
879 NMEM nmem, const char *value, enum conf_metadata_type type,
880 struct _xmlAttr *attr)
882 struct record_metadata *rec_md = record_metadata_create(nmem);
883 struct record_metadata_attr **attrp = &rec_md->attributes;
885 for (; attr; attr = attr->next)
887 if (attr->children && attr->children->content)
889 if (strcmp((const char *) attr->name, "type"))
890 { /* skip the "type" attribute.. Its value is already part of
891 the element in output (md-%s) and so repeating it here
893 *attrp = nmem_malloc(nmem, sizeof(**attrp));
895 nmem_strdup(nmem, (const char *) attr->name);
897 nmem_strdup(nmem, (const char *) attr->children->content);
898 attrp = &(*attrp)->next;
904 if (type == Metadata_type_generic)
906 char *p = nmem_strdup(nmem, value);
908 p = normalize7bit_generic(p, " ,/.:([");
910 rec_md->data.text.disp = p;
911 rec_md->data.text.sort = 0;
913 else if (type == Metadata_type_year || type == Metadata_type_date)
918 if (type == Metadata_type_date)
920 if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
923 rec_md->data.number.min = first;
924 rec_md->data.number.max = last;
931 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
932 struct conf_service *service, WRBUF norm_wr)
936 for (n = root->children; n; n = n->next)
938 if (n->type != XML_ELEMENT_NODE)
940 if (!strcmp((const char *) n->name, "metadata"))
942 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
943 if (!strcmp(name, (const char *) type))
945 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
948 const char *norm_str;
949 pp2_relevance_token_t prt =
950 pp2_relevance_tokenize(service->mergekey_pct);
952 pp2_relevance_first(prt, (const char *) value, 0);
953 if (wrbuf_len(norm_wr) > 0)
954 wrbuf_puts(norm_wr, " ");
955 wrbuf_puts(norm_wr, name);
957 pp2_relevance_token_next(prt)))
961 wrbuf_puts(norm_wr, " ");
962 wrbuf_puts(norm_wr, norm_str);
966 pp2_relevance_token_destroy(prt);
976 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
977 struct conf_service *service, NMEM nmem)
979 char *mergekey_norm = 0;
980 xmlNode *root = xmlDocGetRootElement(doc);
981 WRBUF norm_wr = wrbuf_alloc();
983 /* consider mergekey from XSL first */
984 xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
987 const char *norm_str;
988 pp2_relevance_token_t prt =
989 pp2_relevance_tokenize(service->mergekey_pct);
991 pp2_relevance_first(prt, (const char *) mergekey, 0);
992 while ((norm_str = pp2_relevance_token_next(prt)))
996 if (wrbuf_len(norm_wr))
997 wrbuf_puts(norm_wr, " ");
998 wrbuf_puts(norm_wr, norm_str);
1001 pp2_relevance_token_destroy(prt);
1006 /* no mergekey defined in XSL. Look for mergekey metadata instead */
1008 for (field_id = 0; field_id < service->num_metadata; field_id++)
1010 struct conf_metadata *ser_md = &service->metadata[field_id];
1011 if (ser_md->mergekey != Metadata_mergekey_no)
1013 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1015 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1017 /* no mergekey on this one and it is required..
1018 Generate unique key instead */
1019 wrbuf_rewind(norm_wr);
1026 /* generate unique key if none is not generated already or is empty */
1027 if (wrbuf_len(norm_wr) == 0)
1029 wrbuf_printf(norm_wr, "%s-%d",
1030 client_get_database(cl)->database->url, record_no);
1032 if (wrbuf_len(norm_wr) > 0)
1033 mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1034 wrbuf_destroy(norm_wr);
1035 return mergekey_norm;
1038 /** \brief see if metadata for pz:recordfilter exists
1039 \param root xml root element of normalized record
1040 \param sdb session database for client
1041 \retval 0 if there is no metadata for pz:recordfilter
1042 \retval 1 if there is metadata for pz:recordfilter
1044 If there is no pz:recordfilter defined, this function returns 1
1048 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1053 s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1058 for (n = root->children; n; n = n->next)
1060 if (n->type != XML_ELEMENT_NODE)
1062 if (!strcmp((const char *) n->name, "metadata"))
1064 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1068 const char *eq = strchr(s, '~');
1073 if (len == strlen((const char *)type) &&
1074 !memcmp((const char *) type, s, len))
1076 xmlChar *value = xmlNodeGetContent(n);
1077 if (value && *value)
1079 if (!eq || strstr((const char *) value, eq+1))
1092 static int ingest_to_cluster(struct client *cl,
1096 const char *mergekey_norm);
1098 /** \brief ingest XML record
1099 \param cl client holds the result set for record
1100 \param rec record buffer (0 terminated)
1101 \param record_no record position (1, 2, ..)
1105 int ingest_record(struct client *cl, const char *rec,
1106 int record_no, NMEM nmem)
1108 struct session *se = client_get_session(cl);
1110 struct session_database *sdb = client_get_database(cl);
1111 struct conf_service *service = se->service;
1112 xmlDoc *xdoc = normalize_record(sdb, service, rec, nmem);
1114 const char *mergekey_norm;
1119 root = xmlDocGetRootElement(xdoc);
1121 if (!check_record_filter(root, sdb))
1123 yaz_log(YLOG_WARN, "Filtered out record no %d from %s", record_no,
1124 sdb->database->url);
1129 mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem);
1132 yaz_log(YLOG_WARN, "Got no mergekey");
1137 ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1144 static int ingest_to_cluster(struct client *cl,
1148 const char *mergekey_norm)
1153 struct session_database *sdb = client_get_database(cl);
1154 struct session *se = client_get_session(cl);
1155 struct conf_service *service = se->service;
1156 struct record *record = record_create(se->nmem,
1157 service->num_metadata,
1158 service->num_sortkeys, cl,
1160 struct record_cluster *cluster = reclist_insert(se->reclist,
1167 if (global_parameters.dump_records)
1168 yaz_log(YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1169 sdb->database->url, record_no);
1170 relevance_newrec(se->relevance, cluster);
1172 // now parsing XML record and adding data to cluster or record metadata
1173 for (n = root->children; n; n = n->next)
1175 pp2_relevance_token_t prt;
1182 if (n->type != XML_ELEMENT_NODE)
1184 if (!strcmp((const char *) n->name, "metadata"))
1186 struct conf_metadata *ser_md = 0;
1187 struct conf_sortkey *ser_sk = 0;
1188 struct record_metadata **wheretoput = 0;
1189 struct record_metadata *rec_md = 0;
1190 int md_field_id = -1;
1191 int sk_field_id = -1;
1193 type = xmlGetProp(n, (xmlChar *) "type");
1194 value = xmlNodeListGetString(xdoc, n->children, 1);
1196 if (!type || !value || !*value)
1200 = conf_service_metadata_field_id(service, (const char *) type);
1201 if (md_field_id < 0)
1203 if (se->number_of_warnings_unknown_metadata == 0)
1206 "Ignoring unknown metadata element: %s", type);
1208 se->number_of_warnings_unknown_metadata++;
1212 ser_md = &service->metadata[md_field_id];
1214 if (ser_md->sortkey_offset >= 0){
1215 sk_field_id = ser_md->sortkey_offset;
1216 ser_sk = &service->sortkeys[sk_field_id];
1219 // non-merged metadata
1220 rec_md = record_metadata_init(se->nmem, (const char *) value,
1221 ser_md->type, n->properties);
1224 yaz_log(YLOG_WARN, "bad metadata data '%s' for element '%s'",
1228 wheretoput = &record->metadata[md_field_id];
1230 wheretoput = &(*wheretoput)->next;
1231 *wheretoput = rec_md;
1234 rec_md = record_metadata_init(se->nmem, (const char *) value,
1236 wheretoput = &cluster->metadata[md_field_id];
1238 // and polulate with data:
1239 // assign cluster or record based on merge action
1240 if (ser_md->merge == Metadata_merge_unique)
1242 struct record_metadata *mnode;
1243 for (mnode = *wheretoput; mnode; mnode = mnode->next)
1244 if (!strcmp((const char *) mnode->data.text.disp,
1245 rec_md->data.text.disp))
1249 rec_md->next = *wheretoput;
1250 *wheretoput = rec_md;
1253 else if (ser_md->merge == Metadata_merge_longest)
1256 || strlen(rec_md->data.text.disp)
1257 > strlen((*wheretoput)->data.text.disp))
1259 *wheretoput = rec_md;
1262 const char *sort_str = 0;
1264 ser_sk->type == Metadata_sortkey_skiparticle;
1266 if (!cluster->sortkeys[sk_field_id])
1267 cluster->sortkeys[sk_field_id] =
1268 nmem_malloc(se->nmem,
1269 sizeof(union data_types));
1271 prt = pp2_relevance_tokenize(service->sort_pct);
1273 pp2_relevance_first(prt, rec_md->data.text.disp,
1276 pp2_relevance_token_next(prt);
1278 sort_str = pp2_get_sort(prt);
1280 cluster->sortkeys[sk_field_id]->text.disp =
1281 rec_md->data.text.disp;
1284 sort_str = rec_md->data.text.disp;
1286 "Could not make sortkey. Bug #1858");
1288 cluster->sortkeys[sk_field_id]->text.sort =
1289 nmem_strdup(se->nmem, sort_str);
1291 yaz_log(YLOG_LOG, "text disp=%s",
1292 cluster->sortkeys[sk_field_id]->text.disp);
1293 yaz_log(YLOG_LOG, "text sort=%s",
1294 cluster->sortkeys[sk_field_id]->text.sort);
1296 pp2_relevance_token_destroy(prt);
1300 else if (ser_md->merge == Metadata_merge_all)
1302 rec_md->next = *wheretoput;
1303 *wheretoput = rec_md;
1305 else if (ser_md->merge == Metadata_merge_range)
1309 *wheretoput = rec_md;
1311 cluster->sortkeys[sk_field_id]
1316 int this_min = rec_md->data.number.min;
1317 int this_max = rec_md->data.number.max;
1318 if (this_min < (*wheretoput)->data.number.min)
1319 (*wheretoput)->data.number.min = this_min;
1320 if (this_max > (*wheretoput)->data.number.max)
1321 (*wheretoput)->data.number.max = this_max;
1326 // ranking of _all_ fields enabled ...
1328 relevance_countwords(se->relevance, cluster,
1329 (char *) value, ser_md->rank,
1332 // construct facets ...
1333 if (ser_md->termlist)
1335 if (ser_md->type == Metadata_type_year)
1338 sprintf(year, "%d", rec_md->data.number.max);
1339 add_facet(se, (char *) type, year);
1340 if (rec_md->data.number.max != rec_md->data.number.min)
1342 sprintf(year, "%d", rec_md->data.number.min);
1343 add_facet(se, (char *) type, year);
1347 add_facet(se, (char *) type, (char *) value);
1357 if (se->number_of_warnings_unknown_elements == 0)
1359 "Unexpected element in internal record: %s", n->name);
1360 se->number_of_warnings_unknown_elements++;
1368 relevance_donerecord(se->relevance, cluster);
1369 se->total_records++;
1377 * c-file-style: "Stroustrup"
1378 * indent-tabs-mode: nil
1380 * vim: shiftwidth=4 tabstop=8 expandtab