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>
60 #include "parameters.h"
64 #include "termlists.h"
66 #include "relevance.h"
70 #include "normalize7bit.h"
72 #define TERMLIST_HIGH_SCORE 25
76 // Note: Some things in this structure will eventually move to configuration
77 struct parameters global_parameters =
83 static void log_xml_doc(xmlDoc *doc)
85 FILE *lf = yaz_log_file();
88 #if LIBXML_VERSION >= 20600
89 xmlDocDumpFormatMemory(doc, &result, &len, 1);
91 xmlDocDumpMemory(doc, &result, &len);
95 (void) fwrite(result, 1, len, lf);
101 static void session_enter(struct session *s)
103 yaz_mutex_enter(s->mutex);
106 static void session_leave(struct session *s)
108 yaz_mutex_leave(s->mutex);
111 // Recursively traverse query structure to extract terms.
112 void pull_terms(NMEM nmem, struct ccl_rpn_node *n, char **termlist, int *num)
124 pull_terms(nmem, n->u.p[0], termlist, num);
125 pull_terms(nmem, n->u.p[1], termlist, num);
128 nmem_strsplit(nmem, " ", n->u.t.term, &words, &numwords);
129 for (i = 0; i < numwords; i++)
130 termlist[(*num)++] = words[i];
138 static void add_facet(struct session *s, const char *type, const char *value)
144 for (i = 0; i < s->num_termlists; i++)
145 if (!strcmp(s->termlists[i].name, type))
147 if (i == s->num_termlists)
149 if (i == SESSION_MAX_TERMLISTS)
151 yaz_log(YLOG_FATAL, "Too many termlists");
155 s->termlists[i].name = nmem_strdup(s->nmem, type);
156 s->termlists[i].termlist
157 = termlist_create(s->nmem, TERMLIST_HIGH_SCORE);
158 s->num_termlists = i + 1;
160 termlist_insert(s->termlists[i].termlist, value);
163 static xmlDoc *record_to_xml(struct session_database *sdb, const char *rec)
165 struct database *db = sdb->database;
168 rdoc = xmlParseMemory(rec, strlen(rec));
172 yaz_log(YLOG_FATAL, "Non-wellformed XML received from %s",
177 if (global_parameters.dump_records)
179 yaz_log(YLOG_LOG, "Un-normalized record from %s", db->url);
186 #define MAX_XSLT_ARGS 16
188 // Add static values from session database settings if applicable
189 static void insert_settings_parameters(struct session_database *sdb,
190 struct conf_service *service,
198 for (i = 0; i < service->num_metadata; i++)
200 struct conf_metadata *md = &service->metadata[i];
203 if (md->setting == Metadata_setting_parameter &&
204 (setting = settings_lookup_offset(service, md->name)) >= 0)
206 const char *val = session_setting_oneval(sdb, setting);
207 if (val && nparms < MAX_XSLT_ARGS)
210 int len = strlen(val);
211 buf = nmem_malloc(nmem, len + 3);
213 strcpy(buf + 1, val);
216 parms[offset++] = md->name;
217 parms[offset++] = buf;
225 // Add static values from session database settings if applicable
226 static void insert_settings_values(struct session_database *sdb, xmlDoc *doc,
227 struct conf_service *service)
231 for (i = 0; i < service->num_metadata; i++)
233 struct conf_metadata *md = &service->metadata[i];
236 if (md->setting == Metadata_setting_postproc &&
237 (offset = settings_lookup_offset(service, md->name)) >= 0)
239 const char *val = session_setting_oneval(sdb, offset);
242 xmlNode *r = xmlDocGetRootElement(doc);
243 xmlNode *n = xmlNewTextChild(r, 0, (xmlChar *) "metadata",
245 xmlSetProp(n, (xmlChar *) "type", (xmlChar *) md->name);
251 static xmlDoc *normalize_record(struct session_database *sdb,
252 struct conf_service *service,
253 const char *rec, NMEM nmem)
255 xmlDoc *rdoc = record_to_xml(sdb, rec);
259 char *parms[MAX_XSLT_ARGS*2+1];
261 insert_settings_parameters(sdb, service, parms, nmem);
263 if (normalize_record_transform(sdb->map, &rdoc, (const char **)parms))
265 yaz_log(YLOG_WARN, "Normalize failed from %s", sdb->database->url);
269 insert_settings_values(sdb, rdoc, service);
271 if (global_parameters.dump_records)
273 yaz_log(YLOG_LOG, "Normalized record from %s",
282 void session_settings_dump(struct session *se,
283 struct session_database *db,
288 int i, num = db->num_settings;
289 for (i = 0; i < num; i++)
291 struct setting *s = db->settings[i];
292 for (;s ; s = s->next)
294 wrbuf_puts(w, "<set name=\"");
295 wrbuf_xmlputs(w, s->name);
296 wrbuf_puts(w, "\" value=\"");
297 wrbuf_xmlputs(w, s->value);
298 wrbuf_puts(w, "\"/>");
306 // Retrieve first defined value for 'name' for given database.
307 // Will be extended to take into account user associated with session
308 const char *session_setting_oneval(struct session_database *db, int offset)
310 if (offset >= db->num_settings || !db->settings[offset])
312 return db->settings[offset]->value;
315 // Prepare XSLT stylesheets for record normalization
316 // Structures are allocated on the session_wide nmem to avoid having
317 // to recompute this for every search. This would lead
318 // to leaking if a single session was to repeatedly change the PZ_XSLT
319 // setting. However, this is not a realistic use scenario.
320 static int prepare_map(struct session *se, struct session_database *sdb)
326 yaz_log(YLOG_WARN, "No settings on %s", sdb->database->url);
329 if ((s = session_setting_oneval(sdb, PZ_XSLT)))
331 char auto_stylesheet[256];
333 if (!strcmp(s, "auto"))
335 const char *request_syntax = session_setting_oneval(
336 sdb, PZ_REQUESTSYNTAX);
340 yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet),
341 "%s.xsl", request_syntax);
342 for (cp = auto_stylesheet; *cp; cp++)
344 /* deliberately only consider ASCII */
345 if (*cp > 32 && *cp < 127)
352 yaz_log(YLOG_WARN, "No pz:requestsyntax for auto stylesheet");
355 sdb->map = normalize_cache_get(se->normalize_cache,
363 // This analyzes settings and recomputes any supporting data structures
365 static int prepare_session_database(struct session *se,
366 struct session_database *sdb)
371 "No settings associated with %s", sdb->database->url);
374 if (sdb->settings[PZ_XSLT] && !sdb->map)
376 if (prepare_map(se, sdb) < 0)
382 // called if watch should be removed because http_channel is to be destroyed
383 static void session_watch_cancel(void *data, struct http_channel *c,
386 struct session_watchentry *ent = data;
393 // set watch. Returns 0=OK, -1 if watch is already set
394 int session_set_watch(struct session *s, int what,
395 session_watchfun fun, void *data,
396 struct http_channel *chan)
400 if (s->watchlist[what].fun)
405 s->watchlist[what].fun = fun;
406 s->watchlist[what].data = data;
407 s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
408 session_watch_cancel);
415 void session_alert_watch(struct session *s, int what)
419 if (s->watchlist[what].fun)
421 /* our watch is no longer associated with http_channel */
423 session_watchfun fun;
425 http_remove_observer(s->watchlist[what].obs);
426 fun = s->watchlist[what].fun;
427 data = s->watchlist[what].data;
429 /* reset watch before fun is invoked - in case fun wants to set
431 s->watchlist[what].fun = 0;
432 s->watchlist[what].data = 0;
433 s->watchlist[what].obs = 0;
442 //callback for grep_databases
443 static void select_targets_callback(void *context, struct session_database *db)
445 struct session *se = (struct session*) context;
446 struct client *cl = client_create();
447 client_set_database(cl, db);
448 client_set_session(cl, se);
451 static void session_remove_clients(struct session *se)
453 struct client *cl = se->clients;
456 struct client *cl_next = client_next_in_session(cl);
457 client_remove_from_session(cl);
464 // Associates a set of clients with a session;
465 // Note: Session-databases represent databases with per-session
467 static int select_targets(struct session *se, const char *filter)
469 session_remove_clients(se);
470 return session_grep_databases(se, filter, select_targets_callback);
473 int session_active_clients(struct session *s)
478 for (c = s->clients; c; c = client_next_in_session(c))
479 if (client_is_active(c))
486 enum pazpar2_error_code search(struct session *se,
488 const char *startrecs, const char *maxrecs,
490 const char **addinfo)
492 int live_channels = 0;
497 yaz_log(YLOG_DEBUG, "Search");
502 reclist_destroy(se->reclist);
504 nmem_reset(se->nmem);
506 se->total_records = se->total_hits = se->total_merged = 0;
507 se->num_termlists = 0;
508 live_channels = select_targets(se, filter);
512 return PAZPAR2_NO_TARGETS;
514 se->reclist = reclist_create(se->nmem);
516 for (cl = se->clients; cl; cl = client_next_in_session(cl))
519 client_set_maxrecs(cl, atoi(maxrecs));
521 client_set_startrecs(cl, atoi(startrecs));
522 if (prepare_session_database(se, client_get_database(cl)) < 0)
524 // Parse query for target
525 if (client_parse_query(cl, query) < 0)
530 if (client_prep_connection(cl, se->service->z3950_operation_timeout,
531 se->service->z3950_session_timeout,
532 se->service->server->iochan_man))
533 client_start_search(cl);
542 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
545 return PAZPAR2_NO_TARGETS;
547 return PAZPAR2_NO_ERROR;
550 // Creates a new session_database object for a database
551 static void session_init_databases_fun(void *context, struct database *db)
553 struct session *se = (struct session *) context;
554 struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
560 assert(db->settings);
561 new->settings = nmem_malloc(se->session_nmem,
562 sizeof(struct settings *) * db->num_settings);
563 new->num_settings = db->num_settings;
564 for (i = 0; i < db->num_settings; i++)
566 struct setting *setting = db->settings[i];
567 new->settings[i] = setting;
569 new->next = se->databases;
573 // Doesn't free memory associated with sdb -- nmem takes care of that
574 static void session_database_destroy(struct session_database *sdb)
579 // Initialize session_database list -- this represents this session's view
580 // of the database list -- subject to modification by the settings ws command
581 void session_init_databases(struct session *se)
584 predef_grep_databases(se, se->service, session_init_databases_fun);
587 // Probably session_init_databases_fun should be refactored instead of
589 static struct session_database *load_session_database(struct session *se,
592 struct database *db = new_database(id, se->session_nmem);
594 resolve_database(se->service, db);
596 session_init_databases_fun((void*) se, db);
598 // New sdb is head of se->databases list
599 return se->databases;
602 // Find an existing session database. If not found, load it
603 static struct session_database *find_session_database(struct session *se,
606 struct session_database *sdb;
608 for (sdb = se->databases; sdb; sdb = sdb->next)
609 if (!strcmp(sdb->database->url, id))
611 return load_session_database(se, id);
614 // Apply a session override to a database
615 void session_apply_setting(struct session *se, char *dbname, char *setting,
618 struct session_database *sdb = find_session_database(se, dbname);
619 struct conf_service *service = se->service;
620 struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
621 int offset = settings_create_offset(service, setting);
623 expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
626 new->target = dbname;
629 new->next = sdb->settings[offset];
630 sdb->settings[offset] = new;
632 // Force later recompute of settings-driven data structures
633 // (happens when a search starts and client connections are prepared)
645 void destroy_session(struct session *s)
647 struct session_database *sdb;
649 session_remove_clients(s);
651 for (sdb = s->databases; sdb; sdb = sdb->next)
652 session_database_destroy(sdb);
653 normalize_cache_destroy(s->normalize_cache);
654 reclist_destroy(s->reclist);
655 nmem_destroy(s->nmem);
656 service_destroy(s->service);
657 yaz_mutex_destroy(&s->mutex);
658 wrbuf_destroy(s->wrbuf);
661 struct session *new_session(NMEM nmem, struct conf_service *service)
664 struct session *session = nmem_malloc(nmem, sizeof(*session));
666 yaz_log(YLOG_DEBUG, "New Pazpar2 session");
668 session->service = service;
669 session->relevance = 0;
670 session->total_hits = 0;
671 session->total_records = 0;
672 session->number_of_warnings_unknown_elements = 0;
673 session->number_of_warnings_unknown_metadata = 0;
674 session->num_termlists = 0;
675 session->reclist = 0;
676 session->clients = 0;
677 session->session_nmem = nmem;
678 session->nmem = nmem_create();
679 session->wrbuf = wrbuf_alloc();
680 session->databases = 0;
681 for (i = 0; i <= SESSION_WATCH_MAX; i++)
683 session->watchlist[i].data = 0;
684 session->watchlist[i].fun = 0;
686 session->normalize_cache = normalize_cache_create();
688 yaz_mutex_create(&session->mutex);
689 yaz_mutex_set_name(session->mutex, "session");
694 struct hitsbytarget *hitsbytarget(struct session *se, int *count, NMEM nmem)
696 struct hitsbytarget *res = 0;
701 for (cl = se->clients; cl; cl = client_next_in_session(cl))
704 res = nmem_malloc(nmem, sizeof(*res) * sz);
706 for (cl = se->clients; cl; cl = client_next_in_session(cl))
708 WRBUF w = wrbuf_alloc();
709 const char *name = session_setting_oneval(client_get_database(cl),
712 res[*count].id = client_get_database(cl)->database->url;
713 res[*count].name = *name ? name : "Unknown";
714 res[*count].hits = client_get_hits(cl);
715 res[*count].records = client_get_num_records(cl);
716 res[*count].diagnostic = client_get_diagnostic(cl);
717 res[*count].state = client_get_state_str(cl);
718 res[*count].connected = client_get_connection(cl) ? 1 : 0;
719 session_settings_dump(se, client_get_database(cl), w);
720 res[*count].settings_xml = w;
727 struct termlist_score **termlist(struct session *s, const char *name, int *num)
730 struct termlist_score **tl = 0;
733 for (i = 0; i < s->num_termlists; i++)
734 if (!strcmp((const char *) s->termlists[i].name, name))
736 tl = termlist_highscore(s->termlists[i].termlist, num);
743 #ifdef MISSING_HEADERS
744 void report_nmem_stats(void)
746 size_t in_use, is_free;
748 nmem_get_memory_in_use(&in_use);
749 nmem_get_memory_free(&is_free);
751 yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
752 (long) in_use, (long) is_free);
756 struct record_cluster *show_single_start(struct session *s, const char *id,
757 struct record_cluster **prev_r,
758 struct record_cluster **next_r)
760 struct record_cluster *r;
763 reclist_enter(s->reclist);
766 while ((r = reclist_read_record(s->reclist)))
768 if (!strcmp(r->recid, id))
770 *next_r = reclist_read_record(s->reclist);
775 reclist_leave(s->reclist);
781 void show_single_stop(struct session *s, struct record_cluster *rec)
786 struct record_cluster **show_range_start(struct session *s,
787 struct reclist_sortparms *sp,
788 int start, int *num, int *total, Odr_int *sumhits)
790 struct record_cluster **recs = nmem_malloc(s->nmem, *num
791 * sizeof(struct record_cluster *));
792 struct reclist_sortparms *spp;
795 yaz_timing_t t = yaz_timing_create();
808 for (spp = sp; spp; spp = spp->next)
809 if (spp->type == Metadata_sortkey_relevance)
811 relevance_prepare_read(s->relevance, s->reclist);
814 reclist_sort(s->reclist, sp);
816 reclist_enter(s->reclist);
817 *total = reclist_get_num_records(s->reclist);
818 *sumhits = s->total_hits;
820 for (i = 0; i < start; i++)
821 if (!reclist_read_record(s->reclist))
828 for (i = 0; i < *num; i++)
830 struct record_cluster *r = reclist_read_record(s->reclist);
838 reclist_leave(s->reclist);
842 yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
843 yaz_timing_get_real(t), yaz_timing_get_user(t),
844 yaz_timing_get_sys(t));
845 yaz_timing_destroy(&t);
850 void show_range_stop(struct session *s, struct record_cluster **recs)
855 void statistics(struct session *se, struct statistics *stat)
860 memset(stat, 0, sizeof(*stat));
861 for (cl = se->clients; cl; cl = client_next_in_session(cl))
863 if (!client_get_connection(cl))
864 stat->num_no_connection++;
865 switch (client_get_state(cl))
867 case Client_Connecting: stat->num_connecting++; break;
868 case Client_Working: stat->num_working++; break;
869 case Client_Idle: stat->num_idle++; break;
870 case Client_Failed: stat->num_failed++; break;
871 case Client_Error: stat->num_error++; break;
876 stat->num_hits = se->total_hits;
877 stat->num_records = se->total_records;
879 stat->num_clients = count;
882 static struct record_metadata *record_metadata_init(
883 NMEM nmem, const char *value, enum conf_metadata_type type,
884 struct _xmlAttr *attr)
886 struct record_metadata *rec_md = record_metadata_create(nmem);
887 struct record_metadata_attr **attrp = &rec_md->attributes;
889 for (; attr; attr = attr->next)
891 if (attr->children && attr->children->content)
893 if (strcmp((const char *) attr->name, "type"))
894 { /* skip the "type" attribute.. Its value is already part of
895 the element in output (md-%s) and so repeating it here
897 *attrp = nmem_malloc(nmem, sizeof(**attrp));
899 nmem_strdup(nmem, (const char *) attr->name);
901 nmem_strdup(nmem, (const char *) attr->children->content);
902 attrp = &(*attrp)->next;
908 if (type == Metadata_type_generic)
910 char *p = nmem_strdup(nmem, value);
912 p = normalize7bit_generic(p, " ,/.:([");
914 rec_md->data.text.disp = p;
915 rec_md->data.text.sort = 0;
917 else if (type == Metadata_type_year || type == Metadata_type_date)
922 if (type == Metadata_type_date)
924 if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
927 rec_md->data.number.min = first;
928 rec_md->data.number.max = last;
935 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
936 struct conf_service *service, WRBUF norm_wr)
940 for (n = root->children; n; n = n->next)
942 if (n->type != XML_ELEMENT_NODE)
944 if (!strcmp((const char *) n->name, "metadata"))
946 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
947 if (!strcmp(name, (const char *) type))
949 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
952 const char *norm_str;
953 pp2_relevance_token_t prt =
954 pp2_relevance_tokenize(
955 service->mergekey_pct,
956 (const char *) value, 0);
958 if (wrbuf_len(norm_wr) > 0)
959 wrbuf_puts(norm_wr, " ");
960 wrbuf_puts(norm_wr, name);
962 pp2_relevance_token_next(prt)))
966 wrbuf_puts(norm_wr, " ");
967 wrbuf_puts(norm_wr, norm_str);
971 pp2_relevance_token_destroy(prt);
981 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
982 struct conf_service *service, NMEM nmem)
984 char *mergekey_norm = 0;
985 xmlNode *root = xmlDocGetRootElement(doc);
986 WRBUF norm_wr = wrbuf_alloc();
988 /* consider mergekey from XSL first */
989 xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
992 const char *norm_str;
993 pp2_relevance_token_t prt =
994 pp2_relevance_tokenize(
995 service->mergekey_pct,
996 (const char *) mergekey, 0);
998 while ((norm_str = pp2_relevance_token_next(prt)))
1002 if (wrbuf_len(norm_wr))
1003 wrbuf_puts(norm_wr, " ");
1004 wrbuf_puts(norm_wr, norm_str);
1007 pp2_relevance_token_destroy(prt);
1012 /* no mergekey defined in XSL. Look for mergekey metadata instead */
1014 for (field_id = 0; field_id < service->num_metadata; field_id++)
1016 struct conf_metadata *ser_md = &service->metadata[field_id];
1017 if (ser_md->mergekey != Metadata_mergekey_no)
1019 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1021 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1023 /* no mergekey on this one and it is required..
1024 Generate unique key instead */
1025 wrbuf_rewind(norm_wr);
1032 /* generate unique key if none is not generated already or is empty */
1033 if (wrbuf_len(norm_wr) == 0)
1035 wrbuf_printf(norm_wr, "%s-%d",
1036 client_get_database(cl)->database->url, record_no);
1038 if (wrbuf_len(norm_wr) > 0)
1039 mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1040 wrbuf_destroy(norm_wr);
1041 return mergekey_norm;
1044 /** \brief see if metadata for pz:recordfilter exists
1045 \param root xml root element of normalized record
1046 \param sdb session database for client
1047 \retval 0 if there is no metadata for pz:recordfilter
1048 \retval 1 if there is metadata for pz:recordfilter
1050 If there is no pz:recordfilter defined, this function returns 1
1054 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1059 s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1064 for (n = root->children; n; n = n->next)
1066 if (n->type != XML_ELEMENT_NODE)
1068 if (!strcmp((const char *) n->name, "metadata"))
1070 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1074 const char *eq = strchr(s, '~');
1079 if (len == strlen((const char *)type) &&
1080 !memcmp((const char *) type, s, len))
1082 xmlChar *value = xmlNodeGetContent(n);
1083 if (value && *value)
1085 if (!eq || strstr((const char *) value, eq+1))
1098 static int ingest_to_cluster(struct client *cl,
1102 const char *mergekey_norm);
1104 /** \brief ingest XML record
1105 \param cl client holds the result set for record
1106 \param rec record buffer (0 terminated)
1107 \param record_no record position (1, 2, ..)
1111 int ingest_record(struct client *cl, const char *rec,
1112 int record_no, NMEM nmem)
1114 struct session *se = client_get_session(cl);
1116 struct session_database *sdb = client_get_database(cl);
1117 struct conf_service *service = se->service;
1118 xmlDoc *xdoc = normalize_record(sdb, service, rec, nmem);
1120 const char *mergekey_norm;
1125 root = xmlDocGetRootElement(xdoc);
1127 if (!check_record_filter(root, sdb))
1129 yaz_log(YLOG_WARN, "Filtered out record no %d from %s", record_no,
1130 sdb->database->url);
1135 mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem);
1138 yaz_log(YLOG_WARN, "Got no mergekey");
1143 ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1150 static int ingest_to_cluster(struct client *cl,
1154 const char *mergekey_norm)
1159 struct session_database *sdb = client_get_database(cl);
1160 struct session *se = client_get_session(cl);
1161 struct conf_service *service = se->service;
1162 struct record *record = record_create(se->nmem,
1163 service->num_metadata,
1164 service->num_sortkeys, cl,
1166 struct record_cluster *cluster = reclist_insert(se->reclist,
1173 if (global_parameters.dump_records)
1174 yaz_log(YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1175 sdb->database->url, record_no);
1176 relevance_newrec(se->relevance, cluster);
1178 // now parsing XML record and adding data to cluster or record metadata
1179 for (n = root->children; n; n = n->next)
1181 pp2_relevance_token_t prt;
1188 if (n->type != XML_ELEMENT_NODE)
1190 if (!strcmp((const char *) n->name, "metadata"))
1192 struct conf_metadata *ser_md = 0;
1193 struct conf_sortkey *ser_sk = 0;
1194 struct record_metadata **wheretoput = 0;
1195 struct record_metadata *rec_md = 0;
1196 int md_field_id = -1;
1197 int sk_field_id = -1;
1199 type = xmlGetProp(n, (xmlChar *) "type");
1200 value = xmlNodeListGetString(xdoc, n->children, 1);
1202 if (!type || !value || !*value)
1206 = conf_service_metadata_field_id(service, (const char *) type);
1207 if (md_field_id < 0)
1209 if (se->number_of_warnings_unknown_metadata == 0)
1212 "Ignoring unknown metadata element: %s", type);
1214 se->number_of_warnings_unknown_metadata++;
1218 ser_md = &service->metadata[md_field_id];
1220 if (ser_md->sortkey_offset >= 0){
1221 sk_field_id = ser_md->sortkey_offset;
1222 ser_sk = &service->sortkeys[sk_field_id];
1225 // non-merged metadata
1226 rec_md = record_metadata_init(se->nmem, (const char *) value,
1227 ser_md->type, n->properties);
1230 yaz_log(YLOG_WARN, "bad metadata data '%s' for element '%s'",
1234 wheretoput = &record->metadata[md_field_id];
1236 wheretoput = &(*wheretoput)->next;
1237 *wheretoput = rec_md;
1240 rec_md = record_metadata_init(se->nmem, (const char *) value,
1242 wheretoput = &cluster->metadata[md_field_id];
1244 // and polulate with data:
1245 // assign cluster or record based on merge action
1246 if (ser_md->merge == Metadata_merge_unique)
1248 struct record_metadata *mnode;
1249 for (mnode = *wheretoput; mnode; mnode = mnode->next)
1250 if (!strcmp((const char *) mnode->data.text.disp,
1251 rec_md->data.text.disp))
1255 rec_md->next = *wheretoput;
1256 *wheretoput = rec_md;
1259 else if (ser_md->merge == Metadata_merge_longest)
1262 || strlen(rec_md->data.text.disp)
1263 > strlen((*wheretoput)->data.text.disp))
1265 *wheretoput = rec_md;
1268 const char *sort_str = 0;
1270 ser_sk->type == Metadata_sortkey_skiparticle;
1272 if (!cluster->sortkeys[sk_field_id])
1273 cluster->sortkeys[sk_field_id] =
1274 nmem_malloc(se->nmem,
1275 sizeof(union data_types));
1277 prt = pp2_relevance_tokenize(
1279 rec_md->data.text.disp, skip_article);
1281 pp2_relevance_token_next(prt);
1283 sort_str = pp2_get_sort(prt);
1285 cluster->sortkeys[sk_field_id]->text.disp =
1286 rec_md->data.text.disp;
1289 sort_str = rec_md->data.text.disp;
1291 "Could not make sortkey. Bug #1858");
1293 cluster->sortkeys[sk_field_id]->text.sort =
1294 nmem_strdup(se->nmem, sort_str);
1296 yaz_log(YLOG_LOG, "text disp=%s",
1297 cluster->sortkeys[sk_field_id]->text.disp);
1298 yaz_log(YLOG_LOG, "text sort=%s",
1299 cluster->sortkeys[sk_field_id]->text.sort);
1301 pp2_relevance_token_destroy(prt);
1305 else if (ser_md->merge == Metadata_merge_all)
1307 rec_md->next = *wheretoput;
1308 *wheretoput = rec_md;
1310 else if (ser_md->merge == Metadata_merge_range)
1314 *wheretoput = rec_md;
1316 cluster->sortkeys[sk_field_id]
1321 int this_min = rec_md->data.number.min;
1322 int this_max = rec_md->data.number.max;
1323 if (this_min < (*wheretoput)->data.number.min)
1324 (*wheretoput)->data.number.min = this_min;
1325 if (this_max > (*wheretoput)->data.number.max)
1326 (*wheretoput)->data.number.max = this_max;
1331 // ranking of _all_ fields enabled ...
1333 relevance_countwords(se->relevance, cluster,
1334 (char *) value, ser_md->rank,
1337 // construct facets ...
1338 if (ser_md->termlist)
1340 if (ser_md->type == Metadata_type_year)
1343 sprintf(year, "%d", rec_md->data.number.max);
1344 add_facet(se, (char *) type, year);
1345 if (rec_md->data.number.max != rec_md->data.number.min)
1347 sprintf(year, "%d", rec_md->data.number.min);
1348 add_facet(se, (char *) type, year);
1352 add_facet(se, (char *) type, (char *) value);
1362 if (se->number_of_warnings_unknown_elements == 0)
1364 "Unexpected element in internal record: %s", n->name);
1365 se->number_of_warnings_unknown_elements++;
1373 relevance_donerecord(se->relevance, cluster);
1374 se->total_records++;
1382 * c-file-style: "Stroustrup"
1383 * indent-tabs-mode: nil
1385 * vim: shiftwidth=4 tabstop=8 expandtab