1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2013 Index Data
4 Pazpar2 is free software; you can redistribute it and/or modify it under
5 the terms of the GNU General Public License as published by the Free
6 Software Foundation; either version 2, or (at your option) any later
9 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
14 You should have received a copy of the GNU General Public License
15 along with this program; if not, write to the Free Software
16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA
21 \brief high-level logic; mostly user sessions and settings
46 #include <yaz/marcdisp.h>
47 #include <yaz/comstack.h>
48 #include <yaz/tcpip.h>
49 #include <yaz/proto.h>
50 #include <yaz/readconf.h>
51 #include <yaz/pquery.h>
52 #include <yaz/otherinfo.h>
53 #include <yaz/yaz-util.h>
55 #include <yaz/query-charset.h>
56 #include <yaz/querytowrbuf.h>
57 #include <yaz/oid_db.h>
58 #include <yaz/snprintf.h>
62 #include <yaz/timing.h>
66 #include "parameters.h"
70 #include "termlists.h"
72 #include "relevance.h"
76 #include "normalize7bit.h"
78 #include <libxml/tree.h>
82 #define MAX(a,b) ((a)>(b)?(a):(b))
84 // Note: Some things in this structure will eventually move to configuration
85 struct parameters global_parameters =
89 0, // predictable sessions
93 struct client *client;
94 struct client_list *next;
97 /* session counting (1) , disable client counting (0) */
98 static YAZ_MUTEX g_session_mutex = 0;
99 static int no_sessions = 0;
100 static int no_session_total = 0;
102 static int session_use(int delta)
105 if (!g_session_mutex)
106 yaz_mutex_create(&g_session_mutex);
107 yaz_mutex_enter(g_session_mutex);
108 no_sessions += delta;
110 no_session_total += delta;
111 sessions = no_sessions;
112 yaz_mutex_leave(g_session_mutex);
113 yaz_log(YLOG_DEBUG, "%s sessions=%d", delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), no_sessions);
117 int sessions_count(void)
119 return session_use(0);
122 int session_count_total(void)
125 if (!g_session_mutex)
127 yaz_mutex_enter(g_session_mutex);
128 total = no_session_total;
129 yaz_mutex_leave(g_session_mutex);
133 static void log_xml_doc(xmlDoc *doc)
135 FILE *lf = yaz_log_file();
138 #if LIBXML_VERSION >= 20600
139 xmlDocDumpFormatMemory(doc, &result, &len, 1);
141 xmlDocDumpMemory(doc, &result, &len);
145 (void) fwrite(result, 1, len, lf);
151 static void session_enter(struct session *s, const char *caller)
154 session_log(s, YLOG_DEBUG, "Session lock by %s", caller);
155 yaz_mutex_enter(s->session_mutex);
158 static void session_leave(struct session *s, const char *caller)
160 yaz_mutex_leave(s->session_mutex);
162 session_log(s, YLOG_DEBUG, "Session unlock by %s", caller);
165 static void session_normalize_facet(struct session *s, const char *type,
170 struct conf_service *service = s->service;
171 pp2_charset_token_t prt;
172 const char *facet_component;
174 const char *icu_chain_id = 0;
176 for (i = 0; i < service->num_metadata; i++)
177 if (!strcmp((service->metadata + i)->name, type))
178 icu_chain_id = (service->metadata + i)->facetrule;
180 icu_chain_id = "facet";
181 prt = pp2_charset_token_create(service->charsets, icu_chain_id);
184 session_log(s, YLOG_FATAL,
185 "Unknown ICU chain '%s' for facet of type '%s'",
187 wrbuf_destroy(facet_wrbuf);
188 wrbuf_destroy(display_wrbuf);
191 pp2_charset_token_first(prt, value, 0);
192 while ((facet_component = pp2_charset_token_next(prt)))
194 const char *display_component;
195 if (*facet_component)
197 if (wrbuf_len(facet_wrbuf))
198 wrbuf_puts(facet_wrbuf, " ");
199 wrbuf_puts(facet_wrbuf, facet_component);
201 display_component = pp2_get_display(prt);
202 if (display_component)
204 if (wrbuf_len(display_wrbuf))
205 wrbuf_puts(display_wrbuf, " ");
206 wrbuf_puts(display_wrbuf, display_component);
209 pp2_charset_token_destroy(prt);
212 void add_facet(struct session *s, const char *type, const char *value, int count)
214 WRBUF facet_wrbuf = wrbuf_alloc();
215 WRBUF display_wrbuf = wrbuf_alloc();
217 session_normalize_facet(s, type, value, display_wrbuf, facet_wrbuf);
219 if (wrbuf_len(facet_wrbuf))
222 for (i = 0; i < s->num_termlists; i++)
223 if (!strcmp(s->termlists[i].name, type))
225 if (i == s->num_termlists)
227 if (i == SESSION_MAX_TERMLISTS)
229 session_log(s, YLOG_FATAL, "Too many termlists");
230 wrbuf_destroy(facet_wrbuf);
231 wrbuf_destroy(display_wrbuf);
235 s->termlists[i].name = nmem_strdup(s->nmem, type);
236 s->termlists[i].termlist = termlist_create(s->nmem);
237 s->num_termlists = i + 1;
241 session_log(s, YLOG_LOG, "Facets for %s: %s norm:%s (%d)", type, value, wrbuf_cstr(facet_wrbuf), count);
243 termlist_insert(s->termlists[i].termlist, wrbuf_cstr(display_wrbuf),
244 wrbuf_cstr(facet_wrbuf), count);
246 wrbuf_destroy(facet_wrbuf);
247 wrbuf_destroy(display_wrbuf);
250 static xmlDoc *record_to_xml(struct session *se,
251 struct session_database *sdb, const char *rec)
253 struct database *db = sdb->database;
256 rdoc = xmlParseMemory(rec, strlen(rec));
260 session_log(se, YLOG_WARN, "Non-wellformed XML");
264 if (global_parameters.dump_records)
266 session_log(se, YLOG_LOG, "Un-normalized record from %s", db->id);
273 #define MAX_XSLT_ARGS 16
275 // Add static values from session database settings if applicable
276 static void insert_settings_parameters(struct session_database *sdb,
277 struct conf_service *service,
285 for (i = 0; i < service->num_metadata; i++)
287 struct conf_metadata *md = &service->metadata[i];
290 if (md->setting == Metadata_setting_parameter &&
291 (setting = settings_lookup_offset(service, md->name)) >= 0)
293 const char *val = session_setting_oneval(sdb, setting);
294 if (val && nparms < MAX_XSLT_ARGS)
297 int len = strlen(val);
298 buf = nmem_malloc(nmem, len + 3);
300 strcpy(buf + 1, val);
303 parms[offset++] = md->name;
304 parms[offset++] = buf;
312 // Add static values from session database settings if applicable
313 static void insert_settings_values(struct session_database *sdb, xmlDoc *doc,
314 struct conf_service *service)
318 for (i = 0; i < service->num_metadata; i++)
320 struct conf_metadata *md = &service->metadata[i];
323 if (md->setting == Metadata_setting_postproc &&
324 (offset = settings_lookup_offset(service, md->name)) >= 0)
326 const char *val = session_setting_oneval(sdb, offset);
329 xmlNode *r = xmlDocGetRootElement(doc);
330 xmlNode *n = xmlNewTextChild(r, 0, (xmlChar *) "metadata",
332 xmlSetProp(n, (xmlChar *) "type", (xmlChar *) md->name);
338 static xmlDoc *normalize_record(struct session *se,
339 struct session_database *sdb,
340 struct conf_service *service,
341 const char *rec, NMEM nmem)
343 xmlDoc *rdoc = record_to_xml(se, sdb, rec);
347 char *parms[MAX_XSLT_ARGS*2+1];
349 insert_settings_parameters(sdb, service, parms, nmem);
351 if (normalize_record_transform(sdb->map, &rdoc, (const char **)parms))
353 session_log(se, YLOG_WARN, "Normalize failed");
357 insert_settings_values(sdb, rdoc, service);
359 if (global_parameters.dump_records)
361 session_log(se, YLOG_LOG, "Normalized record from %s",
370 void session_settings_dump(struct session *se,
371 struct session_database *db,
376 int i, num = db->num_settings;
377 for (i = 0; i < num; i++)
379 struct setting *s = db->settings[i];
380 for (;s ; s = s->next)
382 wrbuf_puts(w, "<set name=\"");
383 wrbuf_xmlputs(w, s->name);
384 wrbuf_puts(w, "\" value=\"");
385 wrbuf_xmlputs(w, s->value);
386 wrbuf_puts(w, "\"/>");
394 // Retrieve first defined value for 'name' for given database.
395 // Will be extended to take into account user associated with session
396 const char *session_setting_oneval(struct session_database *db, int offset)
398 if (offset >= db->num_settings || !db->settings[offset])
400 return db->settings[offset]->value;
403 // Prepare XSLT stylesheets for record normalization
404 // Structures are allocated on the session_wide nmem to avoid having
405 // to recompute this for every search. This would lead
406 // to leaking if a single session was to repeatedly change the PZ_XSLT
407 // setting. However, this is not a realistic use scenario.
408 static int prepare_map(struct session *se, struct session_database *sdb)
410 if (sdb->settings && !sdb->map)
414 if (sdb->settings[PZ_XSLT] &&
415 (s = session_setting_oneval(sdb, PZ_XSLT)))
417 char auto_stylesheet[256];
419 if (!strcmp(s, "auto"))
421 const char *request_syntax = session_setting_oneval(
422 sdb, PZ_REQUESTSYNTAX);
426 yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet),
427 "%s.xsl", request_syntax);
428 for (cp = auto_stylesheet; *cp; cp++)
430 /* deliberately only consider ASCII */
431 if (*cp > 32 && *cp < 127)
438 session_log(se, YLOG_WARN,
439 "No pz:requestsyntax for auto stylesheet");
442 sdb->map = normalize_cache_get(se->normalize_cache,
451 // called if watch should be removed because http_channel is to be destroyed
452 static void session_watch_cancel(void *data, struct http_channel *c,
455 struct session_watchentry *ent = data;
462 // set watch. Returns 0=OK, -1 if watch is already set
463 int session_set_watch(struct session *s, int what,
464 session_watchfun fun, void *data,
465 struct http_channel *chan)
468 session_enter(s, "session_set_watch");
469 if (s->watchlist[what].fun)
474 s->watchlist[what].fun = fun;
475 s->watchlist[what].data = data;
476 s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
477 session_watch_cancel);
480 session_leave(s, "session_set_watch");
484 void session_alert_watch(struct session *s, int what)
487 session_enter(s, "session_alert_watch");
488 if (s->watchlist[what].fun)
490 /* our watch is no longer associated with http_channel */
492 session_watchfun fun;
494 http_remove_observer(s->watchlist[what].obs);
495 fun = s->watchlist[what].fun;
496 data = s->watchlist[what].data;
498 /* reset watch before fun is invoked - in case fun wants to set
500 s->watchlist[what].fun = 0;
501 s->watchlist[what].data = 0;
502 s->watchlist[what].obs = 0;
504 session_leave(s, "session_alert_watch");
505 session_log(s, YLOG_DEBUG,
506 "Alert Watch: %d calling function: %p", what, fun);
510 session_leave(s,"session_alert_watch");
513 //callback for grep_databases
514 static void select_targets_callback(struct session *se,
515 struct session_database *db)
518 struct client_list *l;
520 for (l = se->clients_cached; l; l = l->next)
521 if (client_get_database(l->client) == db)
528 cl = client_create(db->database->id);
529 client_set_database(cl, db);
531 l = xmalloc(sizeof(*l));
533 l->next = se->clients_cached;
534 se->clients_cached = l;
536 /* set session always. If may be 0 if client is not active */
537 client_set_session(cl, se);
539 l = xmalloc(sizeof(*l));
541 l->next = se->clients_active;
542 se->clients_active = l;
545 static void session_reset_active_clients(struct session *se,
546 struct client_list *new_list)
548 struct client_list *l;
550 session_enter(se, "session_reset_active_clients");
551 l = se->clients_active;
552 se->clients_active = new_list;
553 session_leave(se, "session_reset_active_clients");
557 struct client_list *l_next = l->next;
559 client_lock(l->client);
560 client_set_session(l->client, 0); /* mark client inactive */
561 client_unlock(l->client);
568 static void session_remove_cached_clients(struct session *se)
570 struct client_list *l;
572 session_reset_active_clients(se, 0);
574 session_enter(se, "session_remove_cached_clients");
575 l = se->clients_cached;
576 se->clients_cached = 0;
577 session_leave(se, "session_remove_cached_clients");
581 struct client_list *l_next = l->next;
582 client_lock(l->client);
583 client_set_session(l->client, 0);
584 client_set_database(l->client, 0);
585 client_unlock(l->client);
586 client_destroy(l->client);
592 // Associates a set of clients with a session;
593 // Note: Session-databases represent databases with per-session
595 static int select_targets(struct session *se, const char *filter)
597 return session_grep_databases(se, filter, select_targets_callback);
600 int session_active_clients(struct session *s)
602 struct client_list *l;
605 for (l = s->clients_active; l; l = l->next)
606 if (client_is_active(l->client))
612 int session_is_preferred_clients_ready(struct session *s)
614 struct client_list *l;
617 for (l = s->clients_active; l; l = l->next)
618 if (client_is_active_preferred(l->client))
620 session_log(s, YLOG_DEBUG, "Has %d active preferred clients.", res);
624 static void session_clear_set(struct session *se, struct reclist_sortparms *sp)
626 reclist_destroy(se->reclist);
627 if (nmem_total(se->nmem))
628 session_log(se, YLOG_DEBUG, "NMEN operation usage %zd",
629 nmem_total(se->nmem));
630 nmem_reset(se->nmem);
631 se->total_records = se->total_merged = 0;
632 se->num_termlists = 0;
634 /* reset list of sorted results and clear to relevance search */
635 se->sorted_results = nmem_malloc(se->nmem, sizeof(*se->sorted_results));
636 se->sorted_results->name = nmem_strdup(se->nmem, sp->name);
637 se->sorted_results->increasing = sp->increasing;
638 se->sorted_results->type = sp->type;
639 se->sorted_results->next = 0;
641 session_log(se, YLOG_DEBUG, "clear_set session_sort: field=%s increasing=%d type=%d configured",
642 sp->name, sp->increasing, sp->type);
644 se->reclist = reclist_create(se->nmem);
647 static void session_sort_unlocked(struct session *se,
648 struct reclist_sortparms *sp,
649 const char *mergekey)
651 struct reclist_sortparms *sr;
652 struct client_list *l;
653 const char *field = sp->name;
654 int increasing = sp->increasing;
656 int clients_research = 0;
658 session_log(se, YLOG_DEBUG, "session_sort field=%s increasing=%d type=%d",
659 field, increasing, type);
662 (se->mergekey && !strcmp(se->mergekey, mergekey)))
664 /* mergekey unchanged.. */
665 /* see if we already have sorted for this criteria */
666 for (sr = se->sorted_results; sr; sr = sr->next)
668 if (!reclist_sortparms_cmp(sr, sp))
673 session_log(se, YLOG_DEBUG, "search_sort: field=%s increasing=%d type=%d already fetched",
674 field, increasing, type);
677 session_log(se, YLOG_DEBUG, "search_sort: field=%s increasing=%d type=%d must fetch",
678 field, increasing, type);
682 /* new mergekey must research/reingest anyway */
685 se->mergekey = *mergekey ? xstrdup(mergekey) : 0;
686 clients_research = 1;
688 session_log(se, YLOG_DEBUG, "search_sort: new mergekey = %s",
692 // We need to reset reclist on every sort that changes the records, not just for position
693 // So if just one client requires new searching, we need to clear set.
694 // Ask each of the client if sorting requires re-search due to native sort
695 // If it does it will require us to
696 for (l = se->clients_active; l; l = l->next)
698 struct client *cl = l->client;
699 // Assume no re-search is required.
700 client_parse_init(cl, 1);
701 clients_research += client_parse_sort(cl, sp);
703 if (clients_research) {
704 session_log(se, YLOG_DEBUG,
705 "Reset results due to %d clients researching",
707 session_clear_set(se, sp);
710 // A new sorting based on same record set
711 sr = nmem_malloc(se->nmem, sizeof(*sr));
712 sr->name = nmem_strdup(se->nmem, field);
713 sr->increasing = increasing;
715 sr->next = se->sorted_results;
716 se->sorted_results = sr;
717 session_log(se, YLOG_DEBUG, "No research/ingesting done");
720 session_log(se, YLOG_DEBUG, "Re- search/ingesting for clients due to change in sort order");
722 for (l = se->clients_active; l; l = l->next)
724 struct client *cl = l->client;
725 if (client_get_state(cl) == Client_Connecting ||
726 client_get_state(cl) == Client_Idle ||
727 client_get_state(cl) == Client_Working) {
728 client_start_search(cl);
731 session_log(se, YLOG_DEBUG,
732 "Client %s: No re-start/ingest in show. Wrong client state: %d",
733 client_get_id(cl), client_get_state(cl));
739 void session_sort(struct session *se, struct reclist_sortparms *sp,
740 const char *mergekey)
742 //session_enter(se, "session_sort");
743 session_sort_unlocked(se, sp, mergekey);
744 //session_leave(se, "session_sort");
748 enum pazpar2_error_code session_search(struct session *se,
750 const char *startrecs,
754 const char **addinfo,
755 struct reclist_sortparms *sp)
757 int live_channels = 0;
759 int no_failed_query = 0;
760 int no_failed_limit = 0;
761 struct client_list *l, *l0;
763 session_log(se, YLOG_DEBUG, "Search");
767 if (se->settings_modified) {
768 session_remove_cached_clients(se);
771 session_reset_active_clients(se, 0);
773 session_enter(se, "session_search");
774 se->settings_modified = 0;
776 session_clear_set(se, sp);
777 relevance_destroy(&se->relevance);
779 live_channels = select_targets(se, filter);
782 session_leave(se, "session_search");
783 return PAZPAR2_NO_TARGETS;
786 facet_limits_destroy(se->facet_limits);
787 se->facet_limits = facet_limits_create(limit);
788 if (!se->facet_limits)
791 session_leave(se, "session_search");
792 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
795 l0 = se->clients_active;
796 se->clients_active = 0;
797 session_leave(se, "session_search");
799 for (l = l0; l; l = l->next)
802 struct client *cl = l->client;
803 client_parse_init(cl, 1);
804 if (prepare_map(se, client_get_database(cl)) < 0)
807 parse_ret = client_parse_query(cl, query, se->facet_limits);
810 else if (parse_ret == -2)
812 else if (parse_ret < 0)
813 no_working++; /* other error, such as bad CCL map */
816 client_parse_range(cl, startrecs, maxrecs);
817 client_parse_sort(cl, sp);
818 client_start_search(cl);
822 session_reset_active_clients(se, l0);
826 if (no_failed_query > 0)
829 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
831 else if (no_failed_limit > 0)
834 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
837 return PAZPAR2_NO_TARGETS;
839 session_log(se, YLOG_LOG, "session_start_search done");
840 return PAZPAR2_NO_ERROR;
843 // Creates a new session_database object for a database
844 static void session_init_databases_fun(void *context, struct database *db)
846 struct session *se = (struct session *) context;
847 struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
853 assert(db->settings);
854 new->settings = nmem_malloc(se->session_nmem,
855 sizeof(struct settings *) * db->num_settings);
856 new->num_settings = db->num_settings;
857 for (i = 0; i < db->num_settings; i++)
859 struct setting *setting = db->settings[i];
860 new->settings[i] = setting;
862 new->next = se->databases;
866 // Doesn't free memory associated with sdb -- nmem takes care of that
867 static void session_database_destroy(struct session_database *sdb)
872 // Initialize session_database list -- this represents this session's view
873 // of the database list -- subject to modification by the settings ws command
874 void session_init_databases(struct session *se)
877 predef_grep_databases(se, se->service, session_init_databases_fun);
880 // Probably session_init_databases_fun should be refactored instead of
882 static struct session_database *load_session_database(struct session *se,
885 struct database *db = new_database_inherit_settings(id, se->session_nmem, se->service->settings);
886 session_init_databases_fun((void*) se, db);
888 // New sdb is head of se->databases list
889 return se->databases;
892 // Find an existing session database. If not found, load it
893 static struct session_database *find_session_database(struct session *se,
896 struct session_database *sdb;
898 for (sdb = se->databases; sdb; sdb = sdb->next)
899 if (!strcmp(sdb->database->id, id))
901 return load_session_database(se, id);
904 // Apply a session override to a database
905 void session_apply_setting(struct session *se, char *dbname, char *setting,
908 struct session_database *sdb = find_session_database(se, dbname);
909 struct conf_service *service = se->service;
910 struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
911 int offset = settings_create_offset(service, setting);
913 expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
916 new->target = dbname;
919 new->next = sdb->settings[offset];
920 sdb->settings[offset] = new;
922 se->settings_modified = 1;
924 // Force later recompute of settings-driven data structures
925 // (happens when a search starts and client connections are prepared)
937 void session_destroy(struct session *se)
939 struct session_database *sdb;
940 session_log(se, YLOG_DEBUG, "Destroying");
942 session_remove_cached_clients(se);
944 for (sdb = se->databases; sdb; sdb = sdb->next)
945 session_database_destroy(sdb);
946 normalize_cache_destroy(se->normalize_cache);
947 relevance_destroy(&se->relevance);
948 reclist_destroy(se->reclist);
950 if (nmem_total(se->nmem))
951 session_log(se, YLOG_DEBUG, "NMEN operation usage %zd", nmem_total(se->nmem));
952 if (nmem_total(se->session_nmem))
953 session_log(se, YLOG_DEBUG, "NMEN session usage %zd", nmem_total(se->session_nmem));
954 facet_limits_destroy(se->facet_limits);
955 nmem_destroy(se->nmem);
956 service_destroy(se->service);
957 yaz_mutex_destroy(&se->session_mutex);
960 size_t session_get_memory_status(struct session *session) {
964 session_enter(session, "session_get_memory_status");
965 session_nmem = nmem_total(session->nmem);
966 session_leave(session, "session_get_memory_status");
971 struct session *new_session(NMEM nmem, struct conf_service *service,
975 struct session *session = nmem_malloc(nmem, sizeof(*session));
979 sprintf(tmp_str, "session#%u", session_id);
981 session->session_id = session_id;
982 session_log(session, YLOG_DEBUG, "New");
983 session->service = service;
984 session->relevance = 0;
985 session->total_records = 0;
986 session->number_of_warnings_unknown_elements = 0;
987 session->number_of_warnings_unknown_metadata = 0;
988 session->num_termlists = 0;
989 session->reclist = reclist_create(nmem);
990 session->clients_active = 0;
991 session->clients_cached = 0;
992 session->settings_modified = 0;
993 session->session_nmem = nmem;
994 session->nmem = nmem_create();
995 session->databases = 0;
996 session->sorted_results = 0;
997 session->facet_limits = 0;
998 session->mergekey = 0;
1000 for (i = 0; i <= SESSION_WATCH_MAX; i++)
1002 session->watchlist[i].data = 0;
1003 session->watchlist[i].fun = 0;
1005 session->normalize_cache = normalize_cache_create();
1006 session->session_mutex = 0;
1007 pazpar2_mutex_create(&session->session_mutex, tmp_str);
1012 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf);
1014 static struct hitsbytarget *hitsbytarget_nb(struct session *se,
1015 int *count, NMEM nmem)
1017 struct hitsbytarget *res = 0;
1018 struct client_list *l;
1021 for (l = se->clients_active; l; l = l->next)
1024 res = nmem_malloc(nmem, sizeof(*res) * sz);
1026 for (l = se->clients_active; l; l = l->next)
1028 struct client *cl = l->client;
1029 WRBUF w = wrbuf_alloc();
1030 const char *name = session_setting_oneval(client_get_database(cl),
1033 res[*count].id = client_get_id(cl);
1034 res[*count].name = *name ? name : "Unknown";
1035 res[*count].hits = client_get_hits(cl);
1036 res[*count].approximation = client_get_approximation(cl);
1037 res[*count].records = client_get_num_records(cl);
1038 res[*count].filtered = client_get_num_records_filtered(cl);
1039 res[*count].diagnostic =
1040 client_get_diagnostic(cl, &res[*count].message,
1041 &res[*count].addinfo);
1042 res[*count].state = client_get_state_str(cl);
1043 res[*count].connected = client_get_connection(cl) ? 1 : 0;
1044 session_settings_dump(se, client_get_database(cl), w);
1045 res[*count].settings_xml = nmem_strdup(nmem, wrbuf_cstr(w));
1048 res[*count].suggestions_xml = nmem_strdup(nmem, client_get_suggestions_xml(cl, w));
1055 struct hitsbytarget *get_hitsbytarget(struct session *se, int *count, NMEM nmem)
1057 struct hitsbytarget *p;
1058 session_enter(se, "get_hitsbytarget");
1059 p = hitsbytarget_nb(se, count, nmem);
1060 session_leave(se, "get_hitsbytarget");
1064 // Compares two hitsbytarget nodes by hitcount
1065 static int cmp_ht(const void *p1, const void *p2)
1067 const struct hitsbytarget *h1 = p1;
1068 const struct hitsbytarget *h2 = p2;
1069 return h2->hits - h1->hits;
1072 // Compares two hitsbytarget nodes by hitcount
1073 static int cmp_ht_approx(const void *p1, const void *p2)
1075 const struct hitsbytarget *h1 = p1;
1076 const struct hitsbytarget *h2 = p2;
1077 return h2->approximation - h1->approximation;
1080 static int targets_termlist_nb(WRBUF wrbuf, struct session *se, int num,
1081 NMEM nmem, int version)
1083 struct hitsbytarget *ht;
1086 ht = hitsbytarget_nb(se, &count, nmem);
1088 qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht_approx);
1090 qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
1091 for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
1094 // do only print terms which have display names
1096 wrbuf_puts(wrbuf, "<term>\n");
1098 wrbuf_puts(wrbuf, "<id>");
1099 wrbuf_xmlputs(wrbuf, ht[i].id);
1100 wrbuf_puts(wrbuf, "</id>\n");
1102 wrbuf_puts(wrbuf, "<name>");
1103 if (!ht[i].name || !ht[i].name[0])
1104 wrbuf_xmlputs(wrbuf, "NO TARGET NAME");
1106 wrbuf_xmlputs(wrbuf, ht[i].name);
1107 wrbuf_puts(wrbuf, "</name>\n");
1109 wrbuf_printf(wrbuf, "<frequency>" ODR_INT_PRINTF "</frequency>\n",
1113 // Should not print if we know it isn't a approximation.
1114 wrbuf_printf(wrbuf, "<approximation>" ODR_INT_PRINTF "</approximation>\n", ht[i].approximation);
1115 wrbuf_printf(wrbuf, "<records>%d</records>\n", ht[i].records - ht[i].filtered);
1116 wrbuf_printf(wrbuf, "<filtered>%d</filtered>\n", ht[i].filtered);
1119 wrbuf_puts(wrbuf, "<state>");
1120 wrbuf_xmlputs(wrbuf, ht[i].state);
1121 wrbuf_puts(wrbuf, "</state>\n");
1123 wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n",
1125 wrbuf_puts(wrbuf, "</term>\n");
1130 void perform_termlist(struct http_channel *c, struct session *se,
1131 const char *name, int num, int version)
1134 NMEM nmem_tmp = nmem_create();
1141 nmem_strsplit(nmem_tmp, ",", name, &names, &num_names);
1143 session_enter(se, "perform_termlist");
1145 for (j = 0; j < num_names; j++)
1148 int must_generate_empty = 1; /* bug 5350 */
1150 for (i = 0; i < se->num_termlists; i++)
1152 tname = se->termlists[i].name;
1153 if (!strcmp(names[j], tname) || !strcmp(names[j], "*"))
1155 struct termlist_score **p = 0;
1158 wrbuf_puts(c->wrbuf, "<list name=\"");
1159 wrbuf_xmlputs(c->wrbuf, tname);
1160 wrbuf_puts(c->wrbuf, "\">\n");
1161 must_generate_empty = 0;
1163 p = termlist_highscore(se->termlists[i].termlist, &len,
1168 for (i = 0; i < len && i < num; i++)
1170 // prevent sending empty term elements
1171 if (!p[i]->display_term || !p[i]->display_term[0])
1174 wrbuf_puts(c->wrbuf, "<term>");
1175 wrbuf_puts(c->wrbuf, "<name>");
1176 wrbuf_xmlputs(c->wrbuf, p[i]->display_term);
1177 wrbuf_puts(c->wrbuf, "</name>");
1179 wrbuf_printf(c->wrbuf,
1180 "<frequency>%d</frequency>",
1182 wrbuf_puts(c->wrbuf, "</term>\n");
1185 wrbuf_puts(c->wrbuf, "</list>\n");
1189 if (!strcmp(names[j], tname) || !strcmp(names[j], "*"))
1191 wrbuf_puts(c->wrbuf, "<list name=\"");
1192 wrbuf_xmlputs(c->wrbuf, tname);
1193 wrbuf_puts(c->wrbuf, "\">\n");
1195 targets_termlist_nb(c->wrbuf, se, num, c->nmem, version);
1196 wrbuf_puts(c->wrbuf, "</list>\n");
1197 must_generate_empty = 0;
1199 if (must_generate_empty)
1201 wrbuf_puts(c->wrbuf, "<list name=\"");
1202 wrbuf_xmlputs(c->wrbuf, names[j]);
1203 wrbuf_puts(c->wrbuf, "\"/>\n");
1206 session_leave(se, "perform_termlist");
1207 nmem_destroy(nmem_tmp);
1210 #ifdef MISSING_HEADERS
1211 void report_nmem_stats(void)
1213 size_t in_use, is_free;
1215 nmem_get_memory_in_use(&in_use);
1216 nmem_get_memory_free(&is_free);
1218 yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
1219 (long) in_use, (long) is_free);
1223 struct record_cluster *show_single_start(struct session *se, const char *id,
1224 struct record_cluster **prev_r,
1225 struct record_cluster **next_r)
1227 struct record_cluster *r = 0;
1229 session_enter(se, "show_single_start");
1232 reclist_limit(se->reclist, se);
1234 reclist_enter(se->reclist);
1235 while ((r = reclist_read_record(se->reclist)))
1237 if (!strcmp(r->recid, id))
1239 *next_r = reclist_read_record(se->reclist);
1244 reclist_leave(se->reclist);
1246 session_leave(se, "show_single_start");
1250 void show_single_stop(struct session *se, struct record_cluster *rec)
1252 session_leave(se, "show_single_stop");
1256 int session_fetch_more(struct session *se)
1258 struct client_list *l;
1261 for (l = se->clients_active; l; l = l->next)
1263 struct client *cl = l->client;
1264 if (client_get_state(cl) == Client_Idle)
1266 if (client_fetch_more(cl))
1268 session_log(se, YLOG_LOG, "%s: more to fetch",
1274 session_log(se, YLOG_LOG, "%s: no more to fetch",
1280 session_log(se, YLOG_LOG, "%s: no fetch due to state=%s",
1281 client_get_id(cl), client_get_state_str(cl));
1288 struct record_cluster **show_range_start(struct session *se,
1289 struct reclist_sortparms *sp,
1290 int start, int *num, int *total,
1291 Odr_int *sumhits, Odr_int *approx_hits,
1292 void (*show_records_ready)(void *data),
1293 struct http_channel *chan)
1295 struct record_cluster **recs = 0;
1296 struct reclist_sortparms *spp;
1297 struct client_list *l;
1300 yaz_timing_t t = yaz_timing_create();
1302 session_enter(se, "show_range_start");
1306 reclist_limit(se->reclist, se);
1309 for (spp = sp; spp; spp = spp->next)
1310 if (spp->type == Metadata_sortkey_relevance)
1312 relevance_prepare_read(se->relevance, se->reclist);
1315 for (l = se->clients_active; l; l = l->next) {
1316 *sumhits += client_get_hits(l->client);
1317 *approx_hits += client_get_approximation(l->client);
1320 reclist_sort(se->reclist, sp);
1322 reclist_enter(se->reclist);
1323 *total = reclist_get_num_records(se->reclist);
1325 for (l = se->clients_active; l; l = l->next)
1326 client_update_show_stat(l->client, 0);
1328 for (i = 0; i < start; i++)
1330 struct record_cluster *r = reclist_read_record(se->reclist);
1338 struct record *rec = r->records;
1339 for (;rec; rec = rec->next)
1340 client_update_show_stat(rec->client, 1);
1343 recs = nmem_malloc(se->nmem, (*num > 0 ? *num : 1) * sizeof(*recs));
1344 for (i = 0; i < *num; i++)
1346 struct record_cluster *r = reclist_read_record(se->reclist);
1354 struct record *rec = r->records;
1355 for (;rec; rec = rec->next)
1356 client_update_show_stat(rec->client, 1);
1360 reclist_leave(se->reclist);
1363 session_log(se, YLOG_LOG, "show %6.5f %3.2f %3.2f",
1364 yaz_timing_get_real(t), yaz_timing_get_user(t),
1365 yaz_timing_get_sys(t));
1366 yaz_timing_destroy(&t);
1369 if (!session_fetch_more(se))
1370 session_log(se, YLOG_LOG, "can not fetch more");
1373 show_range_stop(se, recs);
1374 session_log(se, YLOG_LOG, "fetching more in progress");
1375 if (session_set_watch(se, SESSION_WATCH_SHOW,
1376 show_records_ready, chan, chan))
1378 session_log(se, YLOG_WARN, "Ignoring show block");
1379 session_enter(se, "show_range_start");
1383 session_log(se, YLOG_LOG, "session watch OK");
1390 void show_range_stop(struct session *se, struct record_cluster **recs)
1392 session_leave(se, "show_range_stop");
1395 void statistics(struct session *se, struct statistics *stat)
1397 struct client_list *l;
1400 memset(stat, 0, sizeof(*stat));
1402 for (l = se->clients_active; l; l = l->next)
1404 struct client *cl = l->client;
1405 if (!client_get_connection(cl))
1406 stat->num_no_connection++;
1407 stat->num_hits += client_get_hits(cl);
1408 switch (client_get_state(cl))
1410 case Client_Connecting: stat->num_connecting++; break;
1411 case Client_Working: stat->num_working++; break;
1412 case Client_Idle: stat->num_idle++; break;
1413 case Client_Failed: stat->num_failed++; break;
1414 case Client_Error: stat->num_error++; break;
1419 stat->num_records = se->total_records;
1421 stat->num_clients = count;
1424 static struct record_metadata *record_metadata_init(
1425 NMEM nmem, const char *value, enum conf_metadata_type type,
1426 struct _xmlAttr *attr)
1428 struct record_metadata *rec_md = record_metadata_create(nmem);
1429 struct record_metadata_attr **attrp = &rec_md->attributes;
1431 for (; attr; attr = attr->next)
1433 if (attr->children && attr->children->content)
1435 if (strcmp((const char *) attr->name, "type")
1436 && strcmp((const char *) attr->name, "empty"))
1437 { /* skip the "type" + "empty" attribute..
1438 The "Type" is already part of the element in output
1439 (md-%s) and so repeating it here is redundant */
1440 *attrp = nmem_malloc(nmem, sizeof(**attrp));
1442 nmem_strdup(nmem, (const char *) attr->name);
1444 nmem_strdup(nmem, (const char *) attr->children->content);
1445 attrp = &(*attrp)->next;
1451 if (type == Metadata_type_generic)
1453 char *p = nmem_strdup(nmem, value);
1455 p = normalize7bit_generic(p, " ,/.:([");
1457 rec_md->data.text.disp = p;
1458 rec_md->data.text.sort = 0;
1460 else if (type == Metadata_type_year || type == Metadata_type_date)
1465 if (type == Metadata_type_date)
1467 if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
1470 rec_md->data.number.min = first;
1471 rec_md->data.number.max = last;
1478 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
1479 struct conf_service *service, WRBUF norm_wr)
1483 for (n = root->children; n; n = n->next)
1485 if (n->type != XML_ELEMENT_NODE)
1487 if (!strcmp((const char *) n->name, "metadata"))
1489 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1491 yaz_log(YLOG_FATAL, "Missing type attribute on metadata element. Skipping!");
1493 else if (!strcmp(name, (const char *) type))
1495 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
1498 const char *norm_str;
1499 pp2_charset_token_t prt =
1500 pp2_charset_token_create(service->charsets, "mergekey");
1502 pp2_charset_token_first(prt, (const char *) value, 0);
1503 if (wrbuf_len(norm_wr) > 0)
1504 wrbuf_puts(norm_wr, " ");
1505 wrbuf_puts(norm_wr, name);
1507 pp2_charset_token_next(prt)))
1511 wrbuf_puts(norm_wr, " ");
1512 wrbuf_puts(norm_wr, norm_str);
1516 pp2_charset_token_destroy(prt);
1526 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
1527 struct conf_service *service, NMEM nmem,
1528 const char *session_mergekey)
1530 char *mergekey_norm = 0;
1531 xmlNode *root = xmlDocGetRootElement(doc);
1532 WRBUF norm_wr = wrbuf_alloc();
1535 if (session_mergekey)
1539 nmem_strsplit_escape2(nmem, ",", session_mergekey, &values,
1542 for (i = 0; i < num; i++)
1543 get_mergekey_from_doc(doc, root, values[i], service, norm_wr);
1545 else if ((mergekey = xmlGetProp(root, (xmlChar *) "mergekey")))
1547 const char *norm_str;
1548 pp2_charset_token_t prt =
1549 pp2_charset_token_create(service->charsets, "mergekey");
1551 pp2_charset_token_first(prt, (const char *) mergekey, 0);
1552 while ((norm_str = pp2_charset_token_next(prt)))
1556 if (wrbuf_len(norm_wr))
1557 wrbuf_puts(norm_wr, " ");
1558 wrbuf_puts(norm_wr, norm_str);
1561 pp2_charset_token_destroy(prt);
1566 /* no mergekey defined in XSL. Look for mergekey metadata instead */
1568 for (field_id = 0; field_id < service->num_metadata; field_id++)
1570 struct conf_metadata *ser_md = &service->metadata[field_id];
1571 if (ser_md->mergekey != Metadata_mergekey_no)
1573 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1575 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1577 /* no mergekey on this one and it is required..
1578 Generate unique key instead */
1579 wrbuf_rewind(norm_wr);
1586 /* generate unique key if none is not generated already or is empty */
1587 if (wrbuf_len(norm_wr) == 0)
1589 wrbuf_printf(norm_wr, "position: %s-%d",
1590 client_get_id(cl), record_no);
1594 const char *lead = "content: ";
1595 wrbuf_insert(norm_wr, 0, lead, strlen(lead));
1597 if (wrbuf_len(norm_wr) > 0)
1598 mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1599 wrbuf_destroy(norm_wr);
1600 return mergekey_norm;
1603 /** \brief see if metadata for pz:recordfilter exists
1604 \param root xml root element of normalized record
1605 \param sdb session database for client
1606 \retval 0 if there is no metadata for pz:recordfilter
1607 \retval 1 if there is metadata for pz:recordfilter
1609 If there is no pz:recordfilter defined, this function returns 1
1613 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1618 s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1623 for (n = root->children; n; n = n->next)
1625 if (n->type != XML_ELEMENT_NODE)
1627 if (!strcmp((const char *) n->name, "metadata"))
1629 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1636 if ((eq = strchr(s, '=')))
1638 else if ((eq = strchr(s, '~')))
1644 if (len == strlen((const char *)type) &&
1645 !memcmp((const char *) type, s, len))
1647 xmlChar *value = xmlNodeGetContent(n);
1648 if (value && *value)
1651 (substring && strstr((const char *) value, eq+1)) ||
1652 (!substring && !strcmp((const char *) value, eq + 1)))
1665 static int ingest_to_cluster(struct client *cl,
1669 const char *mergekey_norm);
1671 /** \brief ingest XML record
1672 \param cl client holds the result set for record
1673 \param rec record buffer (0 terminated)
1674 \param record_no record position (1, 2, ..)
1675 \param nmem working NMEM
1680 int ingest_record(struct client *cl, const char *rec,
1681 int record_no, NMEM nmem)
1683 struct session *se = client_get_session(cl);
1685 struct session_database *sdb = client_get_database(cl);
1686 struct conf_service *service = se->service;
1687 xmlDoc *xdoc = normalize_record(se, sdb, service, rec, nmem);
1689 const char *mergekey_norm;
1694 root = xmlDocGetRootElement(xdoc);
1696 if (!check_record_filter(root, sdb))
1698 session_log(se, YLOG_LOG, "Filtered out record no %d from %s", record_no, sdb->database->id);
1703 mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem,
1707 session_log(se, YLOG_WARN, "Got no mergekey");
1711 session_enter(se, "ingest_record");
1712 if (client_get_session(cl) == se && se->relevance)
1713 ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1714 session_leave(se, "ingest_record");
1720 // struct conf_metadata *ser_md = &service->metadata[md_field_id];
1721 // struct record_metadata *rec_md = record->metadata[md_field_id];
1722 static int match_metadata_local(struct conf_metadata *ser_md,
1723 struct record_metadata *rec_md0,
1724 char **values, int num_v)
1727 struct record_metadata *rec_md = rec_md0;
1728 for (i = 0; i < num_v; )
1732 if (ser_md->type == Metadata_type_year
1733 || ser_md->type == Metadata_type_date)
1735 int y = atoi(values[i]);
1736 if (y >= rec_md->data.number.min
1737 && y <= rec_md->data.number.max)
1742 yaz_log(YLOG_DEBUG, "cmp: '%s' '%s'", rec_md->data.text.disp, values[i]);
1743 if (!strcmp(rec_md->data.text.disp, values[i]))
1745 // Value equals, should not be filtered.
1749 rec_md = rec_md->next;
1757 return i < num_v ? 1 : 0;
1760 int session_check_cluster_limit(struct session *se, struct record_cluster *rec)
1763 struct conf_service *service = se->service;
1767 NMEM nmem_tmp = nmem_create();
1769 for (i = 0; (name = facet_limits_get(se->facet_limits, i, &value)); i++)
1772 for (j = 0; j < service->num_metadata; j++)
1774 struct conf_metadata *md = service->metadata + j;
1775 if (!strcmp(md->name, name) && md->limitcluster)
1780 conf_service_metadata_field_id(service,
1783 if (md_field_id < 0)
1789 nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
1792 if (!match_metadata_local(&service->metadata[md_field_id],
1793 rec->metadata[md_field_id],
1802 nmem_destroy(nmem_tmp);
1806 // Skip record on non-zero
1807 static int check_limit_local(struct client *cl,
1808 struct record *record,
1811 int skip_record = 0;
1812 struct session *se = client_get_session(cl);
1813 struct conf_service *service = se->service;
1814 NMEM nmem_tmp = nmem_create();
1815 struct session_database *sdb = client_get_database(cl);
1817 while (!skip_record)
1823 client_get_facet_limit_local(cl, sdb, &l, nmem_tmp,
1828 if (!strcmp(name, "*"))
1830 for (md_field_id = 0; md_field_id < service->num_metadata;
1833 if (match_metadata_local(
1834 &service->metadata[md_field_id],
1835 record->metadata[md_field_id],
1839 if (md_field_id == service->num_metadata)
1844 md_field_id = conf_service_metadata_field_id(service, name);
1845 if (md_field_id < 0)
1850 if (!match_metadata_local(
1851 &service->metadata[md_field_id],
1852 record->metadata[md_field_id],
1859 nmem_destroy(nmem_tmp);
1863 static int ingest_to_cluster(struct client *cl,
1867 const char *mergekey_norm)
1872 struct session *se = client_get_session(cl);
1873 struct conf_service *service = se->service;
1874 int term_factor = 1;
1875 struct record_cluster *cluster;
1876 struct record_metadata **metadata0;
1877 struct session_database *sdb = client_get_database(cl);
1878 struct record *record = record_create(se->nmem,
1879 service->num_metadata,
1880 service->num_sortkeys, cl,
1883 for (n = root->children; n; n = n->next)
1891 if (n->type != XML_ELEMENT_NODE)
1893 if (!strcmp((const char *) n->name, "metadata"))
1895 struct conf_metadata *ser_md = 0;
1896 struct record_metadata **wheretoput = 0;
1897 struct record_metadata *rec_md = 0;
1898 int md_field_id = -1;
1900 type = xmlGetProp(n, (xmlChar *) "type");
1901 value = xmlNodeListGetString(xdoc, n->children, 1);
1904 if (!value || !*value)
1906 xmlChar *empty = xmlGetProp(n, (xmlChar *) "empty");
1914 = conf_service_metadata_field_id(service, (const char *) type);
1915 if (md_field_id < 0)
1917 if (se->number_of_warnings_unknown_metadata == 0)
1919 session_log(se, YLOG_WARN,
1920 "Ignoring unknown metadata element: %s", type);
1922 se->number_of_warnings_unknown_metadata++;
1926 ser_md = &service->metadata[md_field_id];
1928 // non-merged metadata
1929 rec_md = record_metadata_init(se->nmem, (const char *) value,
1930 ser_md->type, n->properties);
1933 session_log(se, YLOG_WARN, "bad metadata data '%s' "
1934 "for element '%s'", value, type);
1937 wheretoput = &record->metadata[md_field_id];
1939 wheretoput = &(*wheretoput)->next;
1940 *wheretoput = rec_md;
1944 if (check_limit_local(cl, record, record_no))
1946 session_log(se, YLOG_LOG, "Facet filtered out record no %d from %s",
1947 record_no, sdb->database->id);
1954 cluster = reclist_insert(se->reclist, service, record,
1955 mergekey_norm, &se->total_merged);
1957 return 0; // complete match with existing record
1960 const char *use_term_factor_str =
1961 session_setting_oneval(sdb, PZ_TERMLIST_TERM_FACTOR);
1962 if (use_term_factor_str && use_term_factor_str[0] == '1')
1964 int maxrecs = client_get_maxrecs(cl);
1965 int hits = (int) client_get_hits(cl);
1966 term_factor = MAX(hits, maxrecs) / MAX(1, maxrecs);
1967 assert(term_factor >= 1);
1968 session_log(se, YLOG_DEBUG, "Using term factor: %d (%d / %d)",
1969 term_factor, MAX(hits, maxrecs), MAX(1, maxrecs));
1973 if (global_parameters.dump_records)
1974 session_log(se, YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1975 sdb->database->id, record_no);
1978 relevance_newrec(se->relevance, cluster);
1980 // original metadata, to check if first existence of a field
1981 metadata0 = xmalloc(sizeof(*metadata0) * service->num_metadata);
1982 memcpy(metadata0, cluster->metadata,
1983 sizeof(*metadata0) * service->num_metadata);
1985 // now parsing XML record and adding data to cluster or record metadata
1986 for (n = root->children; n; n = n->next)
1988 pp2_charset_token_t prt;
1995 if (n->type != XML_ELEMENT_NODE)
1997 if (!strcmp((const char *) n->name, "metadata"))
1999 struct conf_metadata *ser_md = 0;
2000 struct conf_sortkey *ser_sk = 0;
2001 struct record_metadata **wheretoput = 0;
2002 struct record_metadata *rec_md = 0;
2003 int md_field_id = -1;
2004 int sk_field_id = -1;
2008 type = xmlGetProp(n, (xmlChar *) "type");
2009 value = xmlNodeListGetString(xdoc, n->children, 1);
2011 if (!type || !value || !*value)
2015 = conf_service_metadata_field_id(service, (const char *) type);
2016 if (md_field_id < 0)
2019 ser_md = &service->metadata[md_field_id];
2021 if (ser_md->sortkey_offset >= 0)
2023 sk_field_id = ser_md->sortkey_offset;
2024 ser_sk = &service->sortkeys[sk_field_id];
2028 rec_md = record_metadata_init(se->nmem, (const char *) value,
2031 // see if the field was not in cluster already (from beginning)
2036 xml_rank = xmlGetProp(n, (xmlChar *) "rank");
2037 rank = xml_rank ? (const char *) xml_rank : ser_md->rank;
2039 wheretoput = &cluster->metadata[md_field_id];
2041 if (ser_md->merge == Metadata_merge_first)
2043 if (!metadata0[md_field_id])
2046 wheretoput = &(*wheretoput)->next;
2047 *wheretoput = rec_md;
2050 else if (ser_md->merge == Metadata_merge_unique)
2054 if (!strcmp((const char *) (*wheretoput)->data.text.disp,
2055 rec_md->data.text.disp))
2057 wheretoput = &(*wheretoput)->next;
2060 *wheretoput = rec_md;
2062 else if (ser_md->merge == Metadata_merge_longest)
2065 || strlen(rec_md->data.text.disp)
2066 > strlen((*wheretoput)->data.text.disp))
2068 *wheretoput = rec_md;
2071 const char *sort_str = 0;
2073 ser_sk->type == Metadata_sortkey_skiparticle;
2075 if (!cluster->sortkeys[sk_field_id])
2076 cluster->sortkeys[sk_field_id] =
2077 nmem_malloc(se->nmem,
2078 sizeof(union data_types));
2081 pp2_charset_token_create(service->charsets, "sort");
2083 pp2_charset_token_first(prt, rec_md->data.text.disp,
2086 pp2_charset_token_next(prt);
2088 sort_str = pp2_get_sort(prt);
2090 cluster->sortkeys[sk_field_id]->text.disp =
2091 rec_md->data.text.disp;
2094 sort_str = rec_md->data.text.disp;
2095 session_log(se, YLOG_WARN,
2096 "Could not make sortkey. Bug #1858");
2098 cluster->sortkeys[sk_field_id]->text.sort =
2099 nmem_strdup(se->nmem, sort_str);
2100 pp2_charset_token_destroy(prt);
2104 else if (ser_md->merge == Metadata_merge_all)
2107 wheretoput = &(*wheretoput)->next;
2108 *wheretoput = rec_md;
2110 else if (ser_md->merge == Metadata_merge_range)
2114 *wheretoput = rec_md;
2116 cluster->sortkeys[sk_field_id]
2121 int this_min = rec_md->data.number.min;
2122 int this_max = rec_md->data.number.max;
2123 if (this_min < (*wheretoput)->data.number.min)
2124 (*wheretoput)->data.number.min = this_min;
2125 if (this_max > (*wheretoput)->data.number.max)
2126 (*wheretoput)->data.number.max = this_max;
2130 // ranking of _all_ fields enabled ...
2133 relevance_countwords(se->relevance, cluster,
2134 (char *) value, rank, ser_md->name);
2137 // construct facets ... unless the client already has reported them
2138 if (ser_md->termlist && !client_has_facet(cl, (char *) type))
2140 if (ser_md->type == Metadata_type_year)
2143 sprintf(year, "%d", rec_md->data.number.max);
2145 add_facet(se, (char *) type, year, term_factor);
2146 if (rec_md->data.number.max != rec_md->data.number.min)
2148 sprintf(year, "%d", rec_md->data.number.min);
2149 add_facet(se, (char *) type, year, term_factor);
2153 add_facet(se, (char *) type, (char *) value, term_factor);
2165 if (se->number_of_warnings_unknown_elements == 0)
2166 session_log(se, YLOG_WARN,
2167 "Unexpected element in internal record: %s", n->name);
2168 se->number_of_warnings_unknown_elements++;
2177 relevance_donerecord(se->relevance, cluster);
2178 se->total_records++;
2183 void session_log(struct session *s, int level, const char *fmt, ...)
2189 yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
2190 yaz_log(level, "Session %u: %s", s ? s->session_id : 0, buf);
2198 * c-file-style: "Stroustrup"
2199 * indent-tabs-mode: nil
2201 * vim: shiftwidth=4 tabstop=8 expandtab