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;
101 static int session_use(int delta)
104 if (!g_session_mutex)
105 yaz_mutex_create(&g_session_mutex);
106 yaz_mutex_enter(g_session_mutex);
107 no_sessions += delta;
108 sessions = no_sessions;
109 yaz_mutex_leave(g_session_mutex);
110 yaz_log(YLOG_DEBUG, "%s sessions=%d", delta == 0 ? "" :
111 (delta > 0 ? "INC" : "DEC"), no_sessions);
115 int sessions_count(void)
117 return session_use(0);
120 static void log_xml_doc(xmlDoc *doc)
122 FILE *lf = yaz_log_file();
125 #if LIBXML_VERSION >= 20600
126 xmlDocDumpFormatMemory(doc, &result, &len, 1);
128 xmlDocDumpMemory(doc, &result, &len);
132 (void) fwrite(result, 1, len, lf);
138 static void session_enter(struct session *s, const char *caller)
141 session_log(s, YLOG_DEBUG, "Session lock by %s", caller);
142 yaz_mutex_enter(s->session_mutex);
145 static void session_leave(struct session *s, const char *caller)
147 yaz_mutex_leave(s->session_mutex);
149 session_log(s, YLOG_DEBUG, "Session unlock by %s", caller);
152 static void session_normalize_facet(struct session *s,
153 const char *type, const char *value,
154 WRBUF display_wrbuf, WRBUF facet_wrbuf)
156 struct conf_service *service = s->service;
157 pp2_charset_token_t prt;
158 const char *facet_component;
160 const char *icu_chain_id = 0;
162 for (i = 0; i < service->num_metadata; i++)
163 if (!strcmp((service->metadata + i)->name, type))
164 icu_chain_id = (service->metadata + i)->facetrule;
166 icu_chain_id = "facet";
167 prt = pp2_charset_token_create(service->charsets, icu_chain_id);
170 session_log(s, YLOG_FATAL,
171 "Unknown ICU chain '%s' for facet of type '%s'",
173 wrbuf_destroy(facet_wrbuf);
174 wrbuf_destroy(display_wrbuf);
177 pp2_charset_token_first(prt, value, 0);
178 while ((facet_component = pp2_charset_token_next(prt)))
180 const char *display_component;
181 if (*facet_component)
183 if (wrbuf_len(facet_wrbuf))
184 wrbuf_puts(facet_wrbuf, " ");
185 wrbuf_puts(facet_wrbuf, facet_component);
187 display_component = pp2_get_display(prt);
188 if (display_component)
190 if (wrbuf_len(display_wrbuf))
191 wrbuf_puts(display_wrbuf, " ");
192 wrbuf_puts(display_wrbuf, display_component);
195 pp2_charset_token_destroy(prt);
198 void add_facet(struct session *s, const char *type, const char *value, int count)
200 WRBUF facet_wrbuf = wrbuf_alloc();
201 WRBUF display_wrbuf = wrbuf_alloc();
203 session_normalize_facet(s, type, value, display_wrbuf, facet_wrbuf);
205 if (wrbuf_len(facet_wrbuf))
208 for (i = 0; i < s->num_termlists; i++)
209 if (!strcmp(s->termlists[i].name, type))
211 if (i == s->num_termlists)
213 if (i == SESSION_MAX_TERMLISTS)
215 session_log(s, YLOG_FATAL, "Too many termlists");
216 wrbuf_destroy(facet_wrbuf);
217 wrbuf_destroy(display_wrbuf);
221 s->termlists[i].name = nmem_strdup(s->nmem, type);
222 s->termlists[i].termlist = termlist_create(s->nmem);
223 s->num_termlists = i + 1;
227 session_log(s, YLOG_LOG, "Facets for %s: %s norm:%s (%d)", type, value, wrbuf_cstr(facet_wrbuf), count);
229 termlist_insert(s->termlists[i].termlist, wrbuf_cstr(display_wrbuf),
230 wrbuf_cstr(facet_wrbuf), count);
232 wrbuf_destroy(facet_wrbuf);
233 wrbuf_destroy(display_wrbuf);
236 static xmlDoc *record_to_xml(struct session *se,
237 struct session_database *sdb, const char *rec)
239 struct database *db = sdb->database;
242 rdoc = xmlParseMemory(rec, strlen(rec));
246 session_log(se, YLOG_WARN, "Non-wellformed XML");
250 if (global_parameters.dump_records)
252 session_log(se, YLOG_LOG, "Un-normalized record from %s", db->id);
259 #define MAX_XSLT_ARGS 16
261 // Add static values from session database settings if applicable
262 static void insert_settings_parameters(struct session_database *sdb,
263 struct conf_service *service,
271 for (i = 0; i < service->num_metadata; i++)
273 struct conf_metadata *md = &service->metadata[i];
276 if (md->setting == Metadata_setting_parameter &&
277 (setting = settings_lookup_offset(service, md->name)) >= 0)
279 const char *val = session_setting_oneval(sdb, setting);
280 if (val && nparms < MAX_XSLT_ARGS)
283 int len = strlen(val);
284 buf = nmem_malloc(nmem, len + 3);
286 strcpy(buf + 1, val);
289 parms[offset++] = md->name;
290 parms[offset++] = buf;
298 // Add static values from session database settings if applicable
299 static void insert_settings_values(struct session_database *sdb, xmlDoc *doc,
301 struct conf_service *service)
305 for (i = 0; i < service->num_metadata; i++)
307 struct conf_metadata *md = &service->metadata[i];
310 if (md->setting == Metadata_setting_postproc &&
311 (offset = settings_lookup_offset(service, md->name)) >= 0)
313 const char *val = session_setting_oneval(sdb, offset);
316 xmlNode *n = xmlNewTextChild(root, 0, (xmlChar *) "metadata",
318 xmlSetProp(n, (xmlChar *) "type", (xmlChar *) md->name);
324 static xmlDoc *normalize_record(struct session *se,
325 struct session_database *sdb,
326 struct conf_service *service,
327 const char *rec, NMEM nmem)
329 xmlDoc *rdoc = record_to_xml(se, sdb, rec);
333 char *parms[MAX_XSLT_ARGS*2+1];
335 insert_settings_parameters(sdb, service, parms, nmem);
337 if (normalize_record_transform(sdb->map, &rdoc, (const char **)parms))
339 session_log(se, YLOG_WARN, "Normalize failed");
345 void session_settings_dump(struct session *se,
346 struct session_database *db,
351 int i, num = db->num_settings;
352 for (i = 0; i < num; i++)
354 struct setting *s = db->settings[i];
355 for (;s ; s = s->next)
357 wrbuf_puts(w, "<set name=\"");
358 wrbuf_xmlputs(w, s->name);
359 wrbuf_puts(w, "\" value=\"");
360 wrbuf_xmlputs(w, s->value);
361 wrbuf_puts(w, "\"/>");
369 // Retrieve first defined value for 'name' for given database.
370 // Will be extended to take into account user associated with session
371 const char *session_setting_oneval(struct session_database *db, int offset)
373 if (offset >= db->num_settings || !db->settings[offset])
375 return db->settings[offset]->value;
378 // Prepare XSLT stylesheets for record normalization
379 // Structures are allocated on the session_wide nmem to avoid having
380 // to recompute this for every search. This would lead
381 // to leaking if a single session was to repeatedly change the PZ_XSLT
382 // setting. However, this is not a realistic use scenario.
383 static int prepare_map(struct session *se, struct session_database *sdb)
385 if (sdb->settings && !sdb->map)
389 if (sdb->settings[PZ_XSLT] &&
390 (s = session_setting_oneval(sdb, PZ_XSLT)))
392 char auto_stylesheet[256];
394 if (!strcmp(s, "auto"))
396 const char *request_syntax = session_setting_oneval(
397 sdb, PZ_REQUESTSYNTAX);
401 yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet),
402 "%s.xsl", request_syntax);
403 for (cp = auto_stylesheet; *cp; cp++)
405 /* deliberately only consider ASCII */
406 if (*cp > 32 && *cp < 127)
413 session_log(se, YLOG_WARN,
414 "No pz:requestsyntax for auto stylesheet");
417 sdb->map = normalize_cache_get(se->normalize_cache,
426 // called if watch should be removed because http_channel is to be destroyed
427 static void session_watch_cancel(void *data, struct http_channel *c,
430 struct session_watchentry *ent = data;
437 // set watch. Returns 0=OK, -1 if watch is already set
438 int session_set_watch(struct session *s, int what,
439 session_watchfun fun, void *data,
440 struct http_channel *chan)
443 session_enter(s, "session_set_watch");
444 if (s->watchlist[what].fun)
449 s->watchlist[what].fun = fun;
450 s->watchlist[what].data = data;
451 s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
452 session_watch_cancel);
455 session_leave(s, "session_set_watch");
459 void session_alert_watch(struct session *s, int what)
462 session_enter(s, "session_alert_watch");
463 if (s->watchlist[what].fun)
465 /* our watch is no longer associated with http_channel */
467 session_watchfun fun;
469 http_remove_observer(s->watchlist[what].obs);
470 fun = s->watchlist[what].fun;
471 data = s->watchlist[what].data;
473 /* reset watch before fun is invoked - in case fun wants to set
475 s->watchlist[what].fun = 0;
476 s->watchlist[what].data = 0;
477 s->watchlist[what].obs = 0;
479 session_leave(s, "session_alert_watch");
480 session_log(s, YLOG_DEBUG,
481 "Alert Watch: %d calling function: %p", what, fun);
485 session_leave(s,"session_alert_watch");
488 //callback for grep_databases
489 static void select_targets_callback(struct session *se,
490 struct session_database *db)
493 struct client_list *l;
495 for (l = se->clients_cached; l; l = l->next)
496 if (client_get_database(l->client) == db)
503 cl = client_create(db->database->id);
504 client_set_database(cl, db);
506 l = xmalloc(sizeof(*l));
508 l->next = se->clients_cached;
509 se->clients_cached = l;
511 /* set session always. If may be 0 if client is not active */
512 client_set_session(cl, se);
514 l = xmalloc(sizeof(*l));
516 l->next = se->clients_active;
517 se->clients_active = l;
520 static void session_reset_active_clients(struct session *se,
521 struct client_list *new_list)
523 struct client_list *l;
525 session_enter(se, "session_reset_active_clients");
526 l = se->clients_active;
527 se->clients_active = new_list;
528 session_leave(se, "session_reset_active_clients");
532 struct client_list *l_next = l->next;
534 client_lock(l->client);
535 client_set_session(l->client, 0); /* mark client inactive */
536 client_unlock(l->client);
543 static void session_remove_cached_clients(struct session *se)
545 struct client_list *l;
547 session_reset_active_clients(se, 0);
549 session_enter(se, "session_remove_cached_clients");
550 l = se->clients_cached;
551 se->clients_cached = 0;
552 session_leave(se, "session_remove_cached_clients");
556 struct client_list *l_next = l->next;
557 client_lock(l->client);
558 client_set_session(l->client, 0);
559 client_set_database(l->client, 0);
560 client_unlock(l->client);
561 client_destroy(l->client);
567 // Associates a set of clients with a session;
568 // Note: Session-databases represent databases with per-session
570 static int select_targets(struct session *se, const char *filter)
572 return session_grep_databases(se, filter, select_targets_callback);
575 int session_active_clients(struct session *s)
577 struct client_list *l;
580 for (l = s->clients_active; l; l = l->next)
581 if (client_is_active(l->client))
587 int session_is_preferred_clients_ready(struct session *s)
589 struct client_list *l;
592 for (l = s->clients_active; l; l = l->next)
593 if (client_is_active_preferred(l->client))
595 session_log(s, YLOG_DEBUG, "Has %d active preferred clients.", res);
599 static void session_clear_set(struct session *se, struct reclist_sortparms *sp)
601 reclist_destroy(se->reclist);
602 if (nmem_total(se->nmem))
603 session_log(se, YLOG_DEBUG, "NMEN operation usage %zd",
604 nmem_total(se->nmem));
605 nmem_reset(se->nmem);
606 se->total_records = se->total_merged = 0;
607 se->num_termlists = 0;
609 relevance_clear(se->relevance);
611 /* reset list of sorted results and clear to relevance search */
612 se->sorted_results = nmem_malloc(se->nmem, sizeof(*se->sorted_results));
613 se->sorted_results->name = nmem_strdup(se->nmem, sp->name);
614 se->sorted_results->increasing = sp->increasing;
615 se->sorted_results->type = sp->type;
616 se->sorted_results->next = 0;
618 session_log(se, YLOG_DEBUG, "clear_set session_sort: field=%s increasing=%d type=%d configured",
619 sp->name, sp->increasing, sp->type);
621 se->reclist = reclist_create(se->nmem);
624 static void session_sort_unlocked(struct session *se,
625 struct reclist_sortparms *sp,
626 const char *mergekey,
629 struct client_list *l;
630 const char *field = sp->name;
631 int increasing = sp->increasing;
633 int clients_research = 0;
635 session_log(se, YLOG_DEBUG, "session_sort field=%s increasing=%d type=%d",
636 field, increasing, type);
638 if (rank && (!se->rank || strcmp(se->rank, rank)))
640 /* new rank must research/reingest anyway */
643 se->rank = *rank ? xstrdup(rank) : 0;
644 clients_research = 1;
645 session_log(se, YLOG_DEBUG, "session_sort: new rank = %s",
648 if (mergekey && (!se->mergekey || strcmp(se->mergekey, mergekey)))
650 /* new mergekey must research/reingest anyway */
653 se->mergekey = *mergekey ? xstrdup(mergekey) : 0;
654 clients_research = 1;
655 session_log(se, YLOG_DEBUG, "session_sort: new mergekey = %s",
658 if (clients_research == 0)
660 struct reclist_sortparms *sr;
661 for (sr = se->sorted_results; sr; sr = sr->next)
662 if (!reclist_sortparms_cmp(sr, sp))
666 session_log(se, YLOG_DEBUG, "session_sort: field=%s increasing=%d type=%d already fetched",
667 field, increasing, type);
671 session_log(se, YLOG_DEBUG, "session_sort: field=%s increasing=%d type=%d must fetch",
672 field, increasing, type);
674 // We need to reset reclist on every sort that changes the records, not just for position
675 // So if just one client requires new searching, we need to clear set.
676 // Ask each of the client if sorting requires re-search due to native sort
677 // If it does it will require us to
678 for (l = se->clients_active; l; l = l->next)
680 struct client *cl = l->client;
681 // Assume no re-search is required.
682 client_parse_init(cl, 1);
683 clients_research += client_parse_sort(cl, sp);
685 if (clients_research)
687 session_log(se, YLOG_DEBUG,
688 "session_sort: reset results due to %d clients researching",
690 session_clear_set(se, sp);
694 // A new sorting based on same record set
695 struct reclist_sortparms *sr = nmem_malloc(se->nmem, sizeof(*sr));
696 sr->name = nmem_strdup(se->nmem, field);
697 sr->increasing = increasing;
699 sr->next = se->sorted_results;
700 se->sorted_results = sr;
701 session_log(se, YLOG_DEBUG, "session_sort: no research/ingesting done");
704 session_log(se, YLOG_DEBUG, "Re- search/ingesting for clients due to change in sort order");
706 for (l = se->clients_active; l; l = l->next)
708 struct client *cl = l->client;
709 if (client_get_state(cl) == Client_Connecting ||
710 client_get_state(cl) == Client_Idle ||
711 client_get_state(cl) == Client_Working) {
712 client_start_search(cl);
716 session_log(se, YLOG_DEBUG,
717 "session_sort: %s: No re-start/ingest in show. "
718 "Wrong client state: %d",
719 client_get_id(cl), client_get_state(cl));
724 void session_sort(struct session *se, struct reclist_sortparms *sp,
725 const char *mergekey, const char *rank)
727 //session_enter(se, "session_sort");
728 session_sort_unlocked(se, sp, mergekey, rank);
729 //session_leave(se, "session_sort");
733 enum pazpar2_error_code session_search(struct session *se,
735 const char *startrecs,
739 const char **addinfo,
740 const char **addinfo2,
741 struct reclist_sortparms *sp,
742 const char *mergekey,
745 int live_channels = 0;
747 int no_failed_query = 0;
748 int no_failed_limit = 0;
749 struct client_list *l, *l0;
751 session_alert_watch(se, SESSION_WATCH_SHOW);
752 session_alert_watch(se, SESSION_WATCH_BYTARGET);
753 session_alert_watch(se, SESSION_WATCH_TERMLIST);
754 session_alert_watch(se, SESSION_WATCH_SHOW_PREF);
756 session_log(se, YLOG_DEBUG, "Search");
760 if (se->settings_modified) {
761 session_remove_cached_clients(se);
764 session_reset_active_clients(se, 0);
766 session_enter(se, "session_search");
767 se->settings_modified = 0;
772 se->mergekey = *mergekey ? xstrdup(mergekey) : 0;
777 se->rank = *rank ? xstrdup(rank) : 0;
780 session_clear_set(se, sp);
781 relevance_destroy(&se->relevance);
783 live_channels = select_targets(se, filter);
786 session_leave(se, "session_search");
787 return PAZPAR2_NO_TARGETS;
790 facet_limits_destroy(se->facet_limits);
791 se->facet_limits = facet_limits_create(limit);
792 if (!se->facet_limits)
795 session_leave(se, "session_search");
796 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
799 l0 = se->clients_active;
800 se->clients_active = 0;
801 session_leave(se, "session_search");
803 for (l = l0; l; l = l->next)
806 struct client *cl = l->client;
807 client_parse_init(cl, 1);
808 if (prepare_map(se, client_get_database(cl)) < 0)
811 parse_ret = client_parse_query(cl, query, se->facet_limits, addinfo2);
814 else if (parse_ret == -2)
816 else if (parse_ret < 0)
817 no_working++; /* other error, such as bad CCL map */
820 client_parse_range(cl, startrecs, maxrecs);
821 client_parse_sort(cl, sp);
822 client_start_search(cl);
826 session_reset_active_clients(se, l0);
830 if (no_failed_query > 0)
833 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
835 else if (no_failed_limit > 0)
838 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
841 return PAZPAR2_NO_TARGETS;
843 return PAZPAR2_NO_ERROR;
846 // Creates a new session_database object for a database
847 static void session_init_databases_fun(void *context, struct database *db)
849 struct session *se = (struct session *) context;
850 struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
856 assert(db->settings);
857 new->settings = nmem_malloc(se->session_nmem,
858 sizeof(struct settings *) * db->num_settings);
859 new->num_settings = db->num_settings;
860 for (i = 0; i < db->num_settings; i++)
862 struct setting *setting = db->settings[i];
863 new->settings[i] = setting;
865 new->next = se->databases;
869 // Doesn't free memory associated with sdb -- nmem takes care of that
870 static void session_database_destroy(struct session_database *sdb)
875 // Initialize session_database list -- this represents this session's view
876 // of the database list -- subject to modification by the settings ws command
877 void session_init_databases(struct session *se)
880 predef_grep_databases(se, se->service, session_init_databases_fun);
883 // Probably session_init_databases_fun should be refactored instead of
885 static struct session_database *load_session_database(struct session *se,
888 struct database *db = new_database_inherit_settings(id, se->session_nmem, se->service->settings);
889 session_init_databases_fun((void*) se, db);
891 // New sdb is head of se->databases list
892 return se->databases;
895 // Find an existing session database. If not found, load it
896 static struct session_database *find_session_database(struct session *se,
899 struct session_database *sdb;
901 for (sdb = se->databases; sdb; sdb = sdb->next)
902 if (!strcmp(sdb->database->id, id))
904 return load_session_database(se, id);
907 // Apply a session override to a database
908 void session_apply_setting(struct session *se, char *dbname, char *setting,
911 struct session_database *sdb = find_session_database(se, dbname);
912 struct conf_service *service = se->service;
913 struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
914 int offset = settings_create_offset(service, setting);
916 expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
919 new->target = dbname;
922 new->next = sdb->settings[offset];
923 sdb->settings[offset] = new;
925 se->settings_modified = 1;
927 // Force later recompute of settings-driven data structures
928 // (happens when a search starts and client connections are prepared)
940 void session_destroy(struct session *se)
942 struct session_database *sdb;
943 session_log(se, YLOG_DEBUG, "Destroying");
945 session_remove_cached_clients(se);
947 for (sdb = se->databases; sdb; sdb = sdb->next)
948 session_database_destroy(sdb);
949 normalize_cache_destroy(se->normalize_cache);
950 relevance_destroy(&se->relevance);
951 reclist_destroy(se->reclist);
954 if (nmem_total(se->nmem))
955 session_log(se, YLOG_DEBUG, "NMEN operation usage %zd", nmem_total(se->nmem));
956 if (nmem_total(se->session_nmem))
957 session_log(se, YLOG_DEBUG, "NMEN session usage %zd", nmem_total(se->session_nmem));
958 facet_limits_destroy(se->facet_limits);
959 nmem_destroy(se->nmem);
960 service_destroy(se->service);
961 yaz_mutex_destroy(&se->session_mutex);
964 size_t session_get_memory_status(struct session *session) {
968 session_enter(session, "session_get_memory_status");
969 session_nmem = nmem_total(session->nmem);
970 session_leave(session, "session_get_memory_status");
975 struct session *new_session(NMEM nmem, struct conf_service *service,
979 struct session *session = nmem_malloc(nmem, sizeof(*session));
983 sprintf(tmp_str, "session#%u", session_id);
985 session->session_id = session_id;
986 session_log(session, YLOG_DEBUG, "New");
987 session->service = service;
988 session->relevance = 0;
989 session->total_records = 0;
990 session->number_of_warnings_unknown_elements = 0;
991 session->number_of_warnings_unknown_metadata = 0;
992 session->num_termlists = 0;
993 session->reclist = reclist_create(nmem);
994 session->clients_active = 0;
995 session->clients_cached = 0;
996 session->settings_modified = 0;
997 session->session_nmem = nmem;
998 session->nmem = nmem_create();
999 session->databases = 0;
1000 session->sorted_results = 0;
1001 session->facet_limits = 0;
1002 session->mergekey = 0;
1005 for (i = 0; i <= SESSION_WATCH_MAX; i++)
1007 session->watchlist[i].data = 0;
1008 session->watchlist[i].fun = 0;
1010 session->normalize_cache = normalize_cache_create();
1011 session->session_mutex = 0;
1012 pazpar2_mutex_create(&session->session_mutex, tmp_str);
1017 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf);
1019 static struct hitsbytarget *hitsbytarget_nb(struct session *se,
1020 int *count, NMEM nmem)
1022 struct hitsbytarget *res = 0;
1023 struct client_list *l;
1026 for (l = se->clients_active; l; l = l->next)
1029 res = nmem_malloc(nmem, sizeof(*res) * sz);
1031 for (l = se->clients_active; l; l = l->next)
1033 struct client *cl = l->client;
1034 WRBUF w = wrbuf_alloc();
1035 const char *name = session_setting_oneval(client_get_database(cl),
1038 res[*count].id = client_get_id(cl);
1039 res[*count].name = *name ? name : "Unknown";
1040 res[*count].hits = client_get_hits(cl);
1041 res[*count].approximation = client_get_approximation(cl);
1042 res[*count].records = client_get_num_records(cl);
1043 res[*count].filtered = client_get_num_records_filtered(cl);
1044 res[*count].diagnostic =
1045 client_get_diagnostic(cl, &res[*count].message,
1046 &res[*count].addinfo);
1047 res[*count].state = client_get_state_str(cl);
1048 res[*count].connected = client_get_connection(cl) ? 1 : 0;
1049 session_settings_dump(se, client_get_database(cl), w);
1050 res[*count].settings_xml = nmem_strdup(nmem, wrbuf_cstr(w));
1053 res[*count].suggestions_xml = nmem_strdup(nmem, client_get_suggestions_xml(cl, w));
1060 struct hitsbytarget *get_hitsbytarget(struct session *se, int *count, NMEM nmem)
1062 struct hitsbytarget *p;
1063 session_enter(se, "get_hitsbytarget");
1064 p = hitsbytarget_nb(se, count, nmem);
1065 session_leave(se, "get_hitsbytarget");
1069 // Compares two hitsbytarget nodes by hitcount
1070 static int cmp_ht(const void *p1, const void *p2)
1072 const struct hitsbytarget *h1 = p1;
1073 const struct hitsbytarget *h2 = p2;
1074 return h2->hits - h1->hits;
1077 // Compares two hitsbytarget nodes by hitcount
1078 static int cmp_ht_approx(const void *p1, const void *p2)
1080 const struct hitsbytarget *h1 = p1;
1081 const struct hitsbytarget *h2 = p2;
1082 return h2->approximation - h1->approximation;
1085 static int targets_termlist_nb(WRBUF wrbuf, struct session *se, int num,
1086 NMEM nmem, int version)
1088 struct hitsbytarget *ht;
1091 ht = hitsbytarget_nb(se, &count, nmem);
1093 qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht_approx);
1095 qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
1096 for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
1099 // do only print terms which have display names
1101 wrbuf_puts(wrbuf, "<term>\n");
1103 wrbuf_puts(wrbuf, "<id>");
1104 wrbuf_xmlputs(wrbuf, ht[i].id);
1105 wrbuf_puts(wrbuf, "</id>\n");
1107 wrbuf_puts(wrbuf, "<name>");
1108 if (!ht[i].name || !ht[i].name[0])
1109 wrbuf_xmlputs(wrbuf, "NO TARGET NAME");
1111 wrbuf_xmlputs(wrbuf, ht[i].name);
1112 wrbuf_puts(wrbuf, "</name>\n");
1114 wrbuf_printf(wrbuf, "<frequency>" ODR_INT_PRINTF "</frequency>\n",
1118 // Should not print if we know it isn't a approximation.
1119 wrbuf_printf(wrbuf, "<approximation>" ODR_INT_PRINTF "</approximation>\n", ht[i].approximation);
1120 wrbuf_printf(wrbuf, "<records>%d</records>\n", ht[i].records - ht[i].filtered);
1121 wrbuf_printf(wrbuf, "<filtered>%d</filtered>\n", ht[i].filtered);
1124 wrbuf_puts(wrbuf, "<state>");
1125 wrbuf_xmlputs(wrbuf, ht[i].state);
1126 wrbuf_puts(wrbuf, "</state>\n");
1128 wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n",
1130 wrbuf_puts(wrbuf, "</term>\n");
1135 void perform_termlist(struct http_channel *c, struct session *se,
1136 const char *name, int num, int version)
1139 NMEM nmem_tmp = nmem_create();
1146 nmem_strsplit(nmem_tmp, ",", name, &names, &num_names);
1148 session_enter(se, "perform_termlist");
1150 for (j = 0; j < num_names; j++)
1153 int must_generate_empty = 1; /* bug 5350 */
1155 for (i = 0; i < se->num_termlists; i++)
1157 tname = se->termlists[i].name;
1158 if (!strcmp(names[j], tname) || !strcmp(names[j], "*"))
1160 struct termlist_score **p = 0;
1163 wrbuf_puts(c->wrbuf, "<list name=\"");
1164 wrbuf_xmlputs(c->wrbuf, tname);
1165 wrbuf_puts(c->wrbuf, "\">\n");
1166 must_generate_empty = 0;
1168 p = termlist_highscore(se->termlists[i].termlist, &len,
1173 for (i = 0; i < len && i < num; i++)
1175 // prevent sending empty term elements
1176 if (!p[i]->display_term || !p[i]->display_term[0])
1179 wrbuf_puts(c->wrbuf, "<term>");
1180 wrbuf_puts(c->wrbuf, "<name>");
1181 wrbuf_xmlputs(c->wrbuf, p[i]->display_term);
1182 wrbuf_puts(c->wrbuf, "</name>");
1184 wrbuf_printf(c->wrbuf,
1185 "<frequency>%d</frequency>",
1187 wrbuf_puts(c->wrbuf, "</term>\n");
1190 wrbuf_puts(c->wrbuf, "</list>\n");
1194 if (!strcmp(names[j], tname) || !strcmp(names[j], "*"))
1196 wrbuf_puts(c->wrbuf, "<list name=\"");
1197 wrbuf_xmlputs(c->wrbuf, tname);
1198 wrbuf_puts(c->wrbuf, "\">\n");
1200 targets_termlist_nb(c->wrbuf, se, num, c->nmem, version);
1201 wrbuf_puts(c->wrbuf, "</list>\n");
1202 must_generate_empty = 0;
1204 if (must_generate_empty)
1206 wrbuf_puts(c->wrbuf, "<list name=\"");
1207 wrbuf_xmlputs(c->wrbuf, names[j]);
1208 wrbuf_puts(c->wrbuf, "\"/>\n");
1211 session_leave(se, "perform_termlist");
1212 nmem_destroy(nmem_tmp);
1215 #ifdef MISSING_HEADERS
1216 void report_nmem_stats(void)
1218 size_t in_use, is_free;
1220 nmem_get_memory_in_use(&in_use);
1221 nmem_get_memory_free(&is_free);
1223 yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
1224 (long) in_use, (long) is_free);
1228 struct record_cluster *show_single_start(struct session *se, const char *id,
1229 struct record_cluster **prev_r,
1230 struct record_cluster **next_r)
1232 struct record_cluster *r = 0;
1234 session_enter(se, "show_single_start");
1237 reclist_limit(se->reclist, se, 1);
1239 reclist_enter(se->reclist);
1240 while ((r = reclist_read_record(se->reclist)))
1242 if (!strcmp(r->recid, id))
1244 *next_r = reclist_read_record(se->reclist);
1249 reclist_leave(se->reclist);
1251 session_leave(se, "show_single_start");
1255 void show_single_stop(struct session *se, struct record_cluster *rec)
1257 session_leave(se, "show_single_stop");
1261 int session_fetch_more(struct session *se)
1263 struct client_list *l;
1266 for (l = se->clients_active; l; l = l->next)
1268 struct client *cl = l->client;
1269 if (client_get_state(cl) == Client_Idle)
1271 if (client_fetch_more(cl))
1273 session_log(se, YLOG_LOG, "%s: more to fetch",
1279 session_log(se, YLOG_LOG, "%s: no more to fetch",
1285 session_log(se, YLOG_LOG, "%s: no fetch due to state=%s",
1286 client_get_id(cl), client_get_state_str(cl));
1293 struct record_cluster **show_range_start(struct session *se,
1294 struct reclist_sortparms *sp,
1295 int start, int *num, int *total,
1296 Odr_int *sumhits, Odr_int *approx_hits,
1297 void (*show_records_ready)(void *data),
1298 struct http_channel *chan)
1300 struct record_cluster **recs = 0;
1301 struct reclist_sortparms *spp;
1302 struct client_list *l;
1305 yaz_timing_t t = yaz_timing_create();
1307 session_enter(se, "show_range_start");
1311 reclist_limit(se->reclist, se, 0);
1314 for (spp = sp; spp; spp = spp->next)
1315 if (spp->type == Metadata_sortkey_relevance)
1317 relevance_prepare_read(se->relevance, se->reclist);
1320 for (l = se->clients_active; l; l = l->next) {
1321 *sumhits += client_get_hits(l->client);
1322 *approx_hits += client_get_approximation(l->client);
1325 reclist_sort(se->reclist, sp);
1327 reclist_enter(se->reclist);
1328 *total = reclist_get_num_records(se->reclist);
1330 for (l = se->clients_active; l; l = l->next)
1331 client_update_show_stat(l->client, 0);
1333 for (i = 0; i < start; i++)
1335 struct record_cluster *r = reclist_read_record(se->reclist);
1343 struct record *rec = r->records;
1344 for (;rec; rec = rec->next)
1345 client_update_show_stat(rec->client, 1);
1348 recs = nmem_malloc(se->nmem, (*num > 0 ? *num : 1) * sizeof(*recs));
1349 for (i = 0; i < *num; i++)
1351 struct record_cluster *r = reclist_read_record(se->reclist);
1359 struct record *rec = r->records;
1360 for (;rec; rec = rec->next)
1361 client_update_show_stat(rec->client, 1);
1365 reclist_leave(se->reclist);
1368 session_log(se, YLOG_LOG, "show %6.5f %3.2f %3.2f",
1369 yaz_timing_get_real(t), yaz_timing_get_user(t),
1370 yaz_timing_get_sys(t));
1371 yaz_timing_destroy(&t);
1374 if (!session_fetch_more(se))
1375 session_log(se, YLOG_LOG, "can not fetch more");
1378 show_range_stop(se, recs);
1379 session_log(se, YLOG_LOG, "fetching more in progress");
1380 if (session_set_watch(se, SESSION_WATCH_SHOW,
1381 show_records_ready, chan, chan))
1383 session_log(se, YLOG_WARN, "Ignoring show block");
1384 session_enter(se, "show_range_start");
1388 session_log(se, YLOG_LOG, "session watch OK");
1395 void show_range_stop(struct session *se, struct record_cluster **recs)
1397 session_leave(se, "show_range_stop");
1400 void statistics(struct session *se, struct statistics *stat)
1402 struct client_list *l;
1405 memset(stat, 0, sizeof(*stat));
1407 for (l = se->clients_active; l; l = l->next)
1409 struct client *cl = l->client;
1410 if (!client_get_connection(cl))
1411 stat->num_no_connection++;
1412 stat->num_hits += client_get_hits(cl);
1413 switch (client_get_state(cl))
1415 case Client_Connecting: stat->num_connecting++; break;
1416 case Client_Working: stat->num_working++; break;
1417 case Client_Idle: stat->num_idle++; break;
1418 case Client_Failed: stat->num_failed++; break;
1419 case Client_Error: stat->num_error++; break;
1424 stat->num_records = se->total_records;
1426 stat->num_clients = count;
1429 static struct record_metadata *record_metadata_init(
1430 NMEM nmem, const char *value, enum conf_metadata_type type,
1431 struct _xmlAttr *attr)
1433 struct record_metadata *rec_md = record_metadata_create(nmem);
1434 struct record_metadata_attr **attrp = &rec_md->attributes;
1436 for (; attr; attr = attr->next)
1438 if (attr->children && attr->children->content)
1440 if (strcmp((const char *) attr->name, "type")
1441 && strcmp((const char *) attr->name, "empty"))
1442 { /* skip the "type" + "empty" attribute..
1443 The "Type" is already part of the element in output
1444 (md-%s) and so repeating it here is redundant */
1445 *attrp = nmem_malloc(nmem, sizeof(**attrp));
1447 nmem_strdup(nmem, (const char *) attr->name);
1449 nmem_strdup(nmem, (const char *) attr->children->content);
1450 attrp = &(*attrp)->next;
1456 if (type == Metadata_type_generic)
1458 char *p = nmem_strdup(nmem, value);
1460 p = normalize7bit_generic(p, " ,/.:([");
1462 rec_md->data.text.disp = p;
1463 rec_md->data.text.sort = 0;
1464 rec_md->data.text.snippet = 0;
1466 else if (type == Metadata_type_year || type == Metadata_type_date)
1471 if (type == Metadata_type_date)
1473 if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
1476 rec_md->data.number.min = first;
1477 rec_md->data.number.max = last;
1484 static void mergekey_norm_wr(pp2_charset_fact_t charsets,
1485 WRBUF norm_wr, const char *value)
1487 const char *norm_str;
1488 pp2_charset_token_t prt =
1489 pp2_charset_token_create(charsets, "mergekey");
1491 pp2_charset_token_first(prt, value, 0);
1492 while ((norm_str = pp2_charset_token_next(prt)))
1496 if (wrbuf_len(norm_wr))
1497 wrbuf_puts(norm_wr, " ");
1498 wrbuf_puts(norm_wr, norm_str);
1501 pp2_charset_token_destroy(prt);
1504 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
1505 struct conf_service *service, WRBUF norm_wr)
1509 for (n = root->children; n; n = n->next)
1511 if (n->type != XML_ELEMENT_NODE)
1513 if (!strcmp((const char *) n->name, "metadata"))
1515 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1517 yaz_log(YLOG_FATAL, "Missing type attribute on metadata element. Skipping!");
1519 else if (!strcmp(name, (const char *) type))
1521 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
1522 if (value && *value)
1524 if (wrbuf_len(norm_wr) > 0)
1525 wrbuf_puts(norm_wr, " ");
1526 wrbuf_puts(norm_wr, name);
1527 mergekey_norm_wr(service->charsets, norm_wr,
1528 (const char *) value);
1540 static const char *get_mergekey(xmlDoc *doc, xmlNode *root,
1541 struct client *cl, int record_no,
1542 struct conf_service *service, NMEM nmem,
1543 const char *session_mergekey)
1545 char *mergekey_norm = 0;
1546 WRBUF norm_wr = wrbuf_alloc();
1549 if (session_mergekey)
1553 nmem_strsplit_escape2(nmem, ",", session_mergekey, &values,
1556 for (i = 0; i < num; i++)
1557 get_mergekey_from_doc(doc, root, values[i], service, norm_wr);
1559 else if ((mergekey = xmlGetProp(root, (xmlChar *) "mergekey")))
1561 mergekey_norm_wr(service->charsets, norm_wr, (const char *) mergekey);
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)))
1664 static int ingest_to_cluster(struct client *cl,
1668 const char *mergekey_norm);
1670 static int ingest_sub_record(struct client *cl, xmlDoc *xdoc, xmlNode *root,
1671 int record_no, NMEM nmem,
1672 struct session_database *sdb,
1673 const char **mergekey_norm)
1676 struct session *se = client_get_session(cl);
1677 struct conf_service *service = se->service;
1679 insert_settings_values(sdb, xdoc, root, service);
1681 if (!check_record_filter(root, sdb))
1683 session_log(se, YLOG_LOG,
1684 "Filtered out record no %d from %s",
1685 record_no, sdb->database->id);
1688 if (!*mergekey_norm)
1690 *mergekey_norm = get_mergekey(xdoc, root, cl, record_no, service, nmem,
1693 if (!*mergekey_norm)
1695 session_log(se, YLOG_WARN, "Got no mergekey for record no %d from %s",
1696 record_no, sdb->database->id);
1699 session_enter(se, "ingest_sub_record");
1700 if (client_get_session(cl) == se && se->relevance)
1701 ret = ingest_to_cluster(cl, xdoc, root, record_no, *mergekey_norm);
1702 session_leave(se, "ingest_sub_record");
1707 /** \brief ingest XML record
1708 \param cl client holds the result set for record
1709 \param rec record buffer (0 terminated)
1710 \param record_no record position (1, 2, ..)
1711 \param nmem working NMEM
1716 int ingest_record(struct client *cl, const char *rec,
1717 int record_no, NMEM nmem)
1719 struct session *se = client_get_session(cl);
1720 struct session_database *sdb = client_get_database(cl);
1721 struct conf_service *service = se->service;
1722 xmlDoc *xdoc = normalize_record(se, sdb, service, rec, nmem);
1725 const char *mergekey_norm = 0;
1730 if (global_parameters.dump_records)
1732 session_log(se, YLOG_LOG, "Normalized record from %s",
1737 root = xmlDocGetRootElement(xdoc);
1739 if (!strcmp((const char *) root->name, "cluster"))
1741 for (root = root->children; root; root = root->next)
1742 if (root->type == XML_ELEMENT_NODE)
1744 r = ingest_sub_record(cl, xdoc, root, record_no, nmem, sdb,
1750 else if (!strcmp((const char *) root->name, "record"))
1752 r = ingest_sub_record(cl, xdoc, root, record_no, nmem, sdb,
1757 session_log(se, YLOG_WARN, "Bad pz root element: %s",
1758 (const char *) root->name);
1766 // struct conf_metadata *ser_md = &service->metadata[md_field_id];
1767 // struct record_metadata *rec_md = record->metadata[md_field_id];
1768 static int match_metadata_local(struct conf_service *service,
1769 struct conf_metadata *ser_md,
1770 struct record_metadata *rec_md0,
1771 char **values, int num_v)
1774 struct record_metadata *rec_md = rec_md0;
1776 WRBUF text_wr = wrbuf_alloc();
1777 for (i = 0; i < num_v; )
1781 if (ser_md->type == Metadata_type_year
1782 || ser_md->type == Metadata_type_date)
1784 int y = atoi(values[i]);
1785 if (y >= rec_md->data.number.min
1786 && y <= rec_md->data.number.max)
1793 val_wr = wrbuf_alloc();
1794 mergekey_norm_wr(service->charsets, val_wr, values[i]);
1796 wrbuf_rewind(text_wr);
1797 mergekey_norm_wr(service->charsets, text_wr,
1798 rec_md->data.text.disp);
1799 if (!strcmp(wrbuf_cstr(val_wr), wrbuf_cstr(text_wr)))
1802 rec_md = rec_md->next;
1807 wrbuf_destroy(val_wr);
1812 wrbuf_destroy(val_wr);
1813 wrbuf_destroy(text_wr);
1814 return i < num_v ? 1 : 0;
1817 int session_check_cluster_limit(struct session *se, struct record_cluster *rec)
1820 struct conf_service *service = se->service;
1824 NMEM nmem_tmp = nmem_create();
1826 for (i = 0; (name = facet_limits_get(se->facet_limits, i, &value)); i++)
1829 for (j = 0; j < service->num_metadata; j++)
1831 struct conf_metadata *md = service->metadata + j;
1832 if (!strcmp(md->name, name) && md->limitcluster)
1837 conf_service_metadata_field_id(service,
1840 if (md_field_id < 0)
1846 nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
1849 if (!match_metadata_local(service,
1850 &service->metadata[md_field_id],
1851 rec->metadata[md_field_id],
1860 nmem_destroy(nmem_tmp);
1864 // Skip record on non-zero
1865 static int check_limit_local(struct client *cl,
1866 struct record *record,
1869 int skip_record = 0;
1870 struct session *se = client_get_session(cl);
1871 struct conf_service *service = se->service;
1872 NMEM nmem_tmp = nmem_create();
1873 struct session_database *sdb = client_get_database(cl);
1875 while (!skip_record)
1881 client_get_facet_limit_local(cl, sdb, &l, nmem_tmp,
1886 if (!strcmp(name, "*"))
1888 for (md_field_id = 0; md_field_id < service->num_metadata;
1891 if (match_metadata_local(
1893 &service->metadata[md_field_id],
1894 record->metadata[md_field_id],
1898 if (md_field_id == service->num_metadata)
1903 md_field_id = conf_service_metadata_field_id(service, name);
1904 if (md_field_id < 0)
1909 if (!match_metadata_local(
1911 &service->metadata[md_field_id],
1912 record->metadata[md_field_id],
1919 nmem_destroy(nmem_tmp);
1923 static int ingest_to_cluster(struct client *cl,
1927 const char *mergekey_norm)
1932 struct session *se = client_get_session(cl);
1933 struct conf_service *service = se->service;
1934 int term_factor = 1;
1935 struct record_cluster *cluster;
1936 struct record_metadata **metadata0;
1937 struct session_database *sdb = client_get_database(cl);
1938 NMEM ingest_nmem = 0;
1939 char **rank_values = 0;
1941 struct record *record = record_create(se->nmem,
1942 service->num_metadata,
1943 service->num_sortkeys, cl,
1946 for (n = root->children; n; n = n->next)
1954 if (n->type != XML_ELEMENT_NODE)
1956 if (!strcmp((const char *) n->name, "metadata"))
1958 struct conf_metadata *ser_md = 0;
1959 struct record_metadata **wheretoput = 0;
1960 struct record_metadata *rec_md = 0;
1961 int md_field_id = -1;
1963 type = xmlGetProp(n, (xmlChar *) "type");
1964 value = xmlNodeListGetString(xdoc, n->children, 1);
1967 if (!value || !*value)
1969 xmlChar *empty = xmlGetProp(n, (xmlChar *) "empty");
1977 = conf_service_metadata_field_id(service, (const char *) type);
1978 if (md_field_id < 0)
1980 if (se->number_of_warnings_unknown_metadata == 0)
1982 session_log(se, YLOG_WARN,
1983 "Ignoring unknown metadata element: %s", type);
1985 se->number_of_warnings_unknown_metadata++;
1989 ser_md = &service->metadata[md_field_id];
1991 // non-merged metadata
1992 rec_md = record_metadata_init(se->nmem, (const char *) value,
1993 ser_md->type, n->properties);
1996 session_log(se, YLOG_WARN, "bad metadata data '%s' "
1997 "for element '%s'", value, type);
2001 if (ser_md->type == Metadata_type_generic)
2003 WRBUF w = wrbuf_alloc();
2004 if (relevance_snippet(se->relevance,
2005 (char*) value, ser_md->name, w))
2006 rec_md->data.text.snippet = nmem_strdup(se->nmem,
2012 wheretoput = &record->metadata[md_field_id];
2014 wheretoput = &(*wheretoput)->next;
2015 *wheretoput = rec_md;
2019 if (check_limit_local(cl, record, record_no))
2021 session_log(se, YLOG_LOG, "Facet filtered out record no %d from %s",
2022 record_no, sdb->database->id);
2029 cluster = reclist_insert(se->reclist, service, record,
2030 mergekey_norm, &se->total_merged);
2032 return 0; // complete match with existing record
2035 const char *use_term_factor_str =
2036 session_setting_oneval(sdb, PZ_TERMLIST_TERM_FACTOR);
2037 if (use_term_factor_str && use_term_factor_str[0] == '1')
2039 int maxrecs = client_get_maxrecs(cl);
2040 int hits = (int) client_get_hits(cl);
2041 term_factor = MAX(hits, maxrecs) / MAX(1, maxrecs);
2042 assert(term_factor >= 1);
2043 session_log(se, YLOG_DEBUG, "Using term factor: %d (%d / %d)",
2044 term_factor, MAX(hits, maxrecs), MAX(1, maxrecs));
2048 if (global_parameters.dump_records)
2049 session_log(se, YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
2050 sdb->database->id, record_no);
2053 relevance_newrec(se->relevance, cluster);
2055 // original metadata, to check if first existence of a field
2056 metadata0 = xmalloc(sizeof(*metadata0) * service->num_metadata);
2057 memcpy(metadata0, cluster->metadata,
2058 sizeof(*metadata0) * service->num_metadata);
2060 ingest_nmem = nmem_create();
2063 yaz_log(YLOG_LOG, "local in sort : %s", se->rank);
2064 nmem_strsplit_escape2(ingest_nmem, ",", se->rank, &rank_values,
2065 &rank_num, 1, '\\', 1);
2068 // now parsing XML record and adding data to cluster or record metadata
2069 for (n = root->children; n; n = n->next)
2071 pp2_charset_token_t prt;
2078 if (n->type != XML_ELEMENT_NODE)
2080 if (!strcmp((const char *) n->name, "metadata"))
2082 struct conf_metadata *ser_md = 0;
2083 struct conf_sortkey *ser_sk = 0;
2084 struct record_metadata **wheretoput = 0;
2085 struct record_metadata *rec_md = 0;
2086 int md_field_id = -1;
2087 int sk_field_id = -1;
2088 const char *rank = 0;
2089 xmlChar *xml_rank = 0;
2091 type = xmlGetProp(n, (xmlChar *) "type");
2092 value = xmlNodeListGetString(xdoc, n->children, 1);
2094 if (!type || !value || !*value)
2098 = conf_service_metadata_field_id(service, (const char *) type);
2099 if (md_field_id < 0)
2102 ser_md = &service->metadata[md_field_id];
2104 if (ser_md->sortkey_offset >= 0)
2106 sk_field_id = ser_md->sortkey_offset;
2107 ser_sk = &service->sortkeys[sk_field_id];
2111 rec_md = record_metadata_init(se->nmem, (const char *) value,
2114 // see if the field was not in cluster already (from beginning)
2122 for (i = 0; i < rank_num; i++)
2124 const char *val = rank_values[i];
2125 const char *cp = strchr(val, '=');
2128 if ((cp - val) == strlen((const char *) type)
2129 && !memcmp(val, type, cp - val))
2138 xml_rank = xmlGetProp(n, (xmlChar *) "rank");
2139 rank = xml_rank ? (const char *) xml_rank : ser_md->rank;
2142 wheretoput = &cluster->metadata[md_field_id];
2144 if (ser_md->merge == Metadata_merge_first)
2146 if (!metadata0[md_field_id])
2149 wheretoput = &(*wheretoput)->next;
2150 *wheretoput = rec_md;
2153 else if (ser_md->merge == Metadata_merge_unique)
2157 if (!strcmp((const char *) (*wheretoput)->data.text.disp,
2158 rec_md->data.text.disp))
2160 wheretoput = &(*wheretoput)->next;
2163 *wheretoput = rec_md;
2165 else if (ser_md->merge == Metadata_merge_longest)
2168 || strlen(rec_md->data.text.disp)
2169 > strlen((*wheretoput)->data.text.disp))
2171 *wheretoput = rec_md;
2174 const char *sort_str = 0;
2176 ser_sk->type == Metadata_sortkey_skiparticle;
2178 if (!cluster->sortkeys[sk_field_id])
2179 cluster->sortkeys[sk_field_id] =
2180 nmem_malloc(se->nmem,
2181 sizeof(union data_types));
2184 pp2_charset_token_create(service->charsets, "sort");
2186 pp2_charset_token_first(prt, rec_md->data.text.disp,
2189 pp2_charset_token_next(prt);
2191 sort_str = pp2_get_sort(prt);
2193 cluster->sortkeys[sk_field_id]->text.disp =
2194 rec_md->data.text.disp;
2197 sort_str = rec_md->data.text.disp;
2198 session_log(se, YLOG_WARN,
2199 "Could not make sortkey. Bug #1858");
2201 cluster->sortkeys[sk_field_id]->text.sort =
2202 nmem_strdup(se->nmem, sort_str);
2203 pp2_charset_token_destroy(prt);
2207 else if (ser_md->merge == Metadata_merge_all)
2210 wheretoput = &(*wheretoput)->next;
2211 *wheretoput = rec_md;
2213 else if (ser_md->merge == Metadata_merge_range)
2217 *wheretoput = rec_md;
2219 cluster->sortkeys[sk_field_id]
2224 int this_min = rec_md->data.number.min;
2225 int this_max = rec_md->data.number.max;
2226 if (this_min < (*wheretoput)->data.number.min)
2227 (*wheretoput)->data.number.min = this_min;
2228 if (this_max > (*wheretoput)->data.number.max)
2229 (*wheretoput)->data.number.max = this_max;
2233 // ranking of _all_ fields enabled ...
2236 relevance_countwords(se->relevance, cluster,
2237 (char *) value, rank, ser_md->name);
2239 // construct facets ... unless the client already has reported them
2240 if (ser_md->termlist && !client_has_facet(cl, (char *) type))
2242 if (ser_md->type == Metadata_type_year)
2245 sprintf(year, "%d", rec_md->data.number.max);
2247 add_facet(se, (char *) type, year, term_factor);
2248 if (rec_md->data.number.max != rec_md->data.number.min)
2250 sprintf(year, "%d", rec_md->data.number.min);
2251 add_facet(se, (char *) type, year, term_factor);
2255 add_facet(se, (char *) type, (char *) value, term_factor);
2267 if (se->number_of_warnings_unknown_elements == 0)
2268 session_log(se, YLOG_WARN,
2269 "Unexpected element in internal record: %s", n->name);
2270 se->number_of_warnings_unknown_elements++;
2278 nmem_destroy(ingest_nmem);
2280 relevance_donerecord(se->relevance, cluster);
2281 se->total_records++;
2286 void session_log(struct session *s, int level, const char *fmt, ...)
2292 yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
2293 yaz_log(level, "Session %u: %s", s ? s->session_id : 0, buf);
2301 * c-file-style: "Stroustrup"
2302 * indent-tabs-mode: nil
2304 * vim: shiftwidth=4 tabstop=8 expandtab