1 /* This file is part of Pazpar2.
2 Copyright (C) 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;
751 session_log(se, YLOG_DEBUG, "Search");
755 session_enter(se, "session_search0");
756 if (se->clients_starting)
758 session_leave(se, "session_search0");
759 return PAZPAR2_NO_ERROR;
761 se->clients_starting = 1;
762 session_leave(se, "session_search0");
764 if (se->settings_modified) {
765 session_remove_cached_clients(se);
768 session_reset_active_clients(se, 0);
770 session_enter(se, "session_search");
771 se->settings_modified = 0;
776 se->mergekey = *mergekey ? xstrdup(mergekey) : 0;
781 se->rank = *rank ? xstrdup(rank) : 0;
784 session_clear_set(se, sp);
785 relevance_destroy(&se->relevance);
787 live_channels = select_targets(se, filter);
790 session_leave(se, "session_search");
791 se->clients_starting = 0;
792 return PAZPAR2_NO_TARGETS;
795 facet_limits_destroy(se->facet_limits);
796 se->facet_limits = facet_limits_create(limit);
797 if (!se->facet_limits)
800 session_leave(se, "session_search");
801 se->clients_starting = 0;
802 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
805 session_leave(se, "session_search");
807 session_alert_watch(se, SESSION_WATCH_SHOW);
808 session_alert_watch(se, SESSION_WATCH_BYTARGET);
809 session_alert_watch(se, SESSION_WATCH_TERMLIST);
810 session_alert_watch(se, SESSION_WATCH_SHOW_PREF);
812 for (l = se->clients_active; l; l = l->next)
815 struct client *cl = l->client;
816 client_parse_init(cl, 1);
817 if (prepare_map(se, client_get_database(cl)) < 0)
820 parse_ret = client_parse_query(cl, query, se->facet_limits, addinfo2);
823 else if (parse_ret == -2)
825 else if (parse_ret < 0)
826 no_working++; /* other error, such as bad CCL map */
829 client_parse_range(cl, startrecs, maxrecs);
830 client_parse_sort(cl, sp);
831 client_start_search(cl);
835 session_enter(se, "session_search2");
836 se->clients_starting = 0;
837 session_leave(se, "session_search2");
840 if (no_failed_query > 0)
843 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
845 else if (no_failed_limit > 0)
848 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
851 return PAZPAR2_NO_TARGETS;
853 return PAZPAR2_NO_ERROR;
856 // Creates a new session_database object for a database
857 static void session_init_databases_fun(void *context, struct database *db)
859 struct session *se = (struct session *) context;
860 struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
866 assert(db->settings);
867 new->settings = nmem_malloc(se->session_nmem,
868 sizeof(struct settings *) * db->num_settings);
869 new->num_settings = db->num_settings;
870 for (i = 0; i < db->num_settings; i++)
872 struct setting *setting = db->settings[i];
873 new->settings[i] = setting;
875 new->next = se->databases;
879 // Doesn't free memory associated with sdb -- nmem takes care of that
880 static void session_database_destroy(struct session_database *sdb)
885 // Initialize session_database list -- this represents this session's view
886 // of the database list -- subject to modification by the settings ws command
887 void session_init_databases(struct session *se)
890 predef_grep_databases(se, se->service, session_init_databases_fun);
893 // Probably session_init_databases_fun should be refactored instead of
895 static struct session_database *load_session_database(struct session *se,
898 struct database *db = new_database_inherit_settings(id, se->session_nmem, se->service->settings);
899 session_init_databases_fun((void*) se, db);
901 // New sdb is head of se->databases list
902 return se->databases;
905 // Find an existing session database. If not found, load it
906 static struct session_database *find_session_database(struct session *se,
909 struct session_database *sdb;
911 for (sdb = se->databases; sdb; sdb = sdb->next)
912 if (!strcmp(sdb->database->id, id))
914 return load_session_database(se, id);
917 // Apply a session override to a database
918 void session_apply_setting(struct session *se, const char *dbname,
919 const char *name, const char *value)
921 session_enter(se, "session_apply_setting");
923 struct session_database *sdb = find_session_database(se, dbname);
924 struct conf_service *service = se->service;
926 int offset = settings_create_offset(service, name);
928 expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
930 // Force later recompute of settings-driven data structures
931 // (happens when a search starts and client connections are prepared)
932 if (offset == PZ_XSLT)
934 se->settings_modified = 1;
935 for (s = sdb->settings[offset]; s; s = s->next)
936 if (!strcmp(s->name, name) &&
937 dbname && s->target && !strcmp(dbname, s->target))
941 s = nmem_malloc(se->session_nmem, sizeof(*s));
943 s->target = nmem_strdup(se->session_nmem, dbname);
944 s->name = nmem_strdup(se->session_nmem, name);
945 s->next = sdb->settings[offset];
946 sdb->settings[offset] = s;
948 s->value = nmem_strdup(se->session_nmem, value);
950 session_leave(se, "session_apply_setting");
953 void session_destroy(struct session *se)
955 struct session_database *sdb;
956 session_log(se, YLOG_LOG, "destroy");
958 session_remove_cached_clients(se);
960 for (sdb = se->databases; sdb; sdb = sdb->next)
961 session_database_destroy(sdb);
962 normalize_cache_destroy(se->normalize_cache);
963 relevance_destroy(&se->relevance);
964 reclist_destroy(se->reclist);
967 if (nmem_total(se->nmem))
968 session_log(se, YLOG_DEBUG, "NMEN operation usage %zd", nmem_total(se->nmem));
969 if (nmem_total(se->session_nmem))
970 session_log(se, YLOG_DEBUG, "NMEN session usage %zd", nmem_total(se->session_nmem));
971 facet_limits_destroy(se->facet_limits);
972 nmem_destroy(se->nmem);
973 service_destroy(se->service);
974 yaz_mutex_destroy(&se->session_mutex);
977 size_t session_get_memory_status(struct session *session) {
981 session_enter(session, "session_get_memory_status");
982 session_nmem = nmem_total(session->nmem);
983 session_leave(session, "session_get_memory_status");
988 struct session *new_session(NMEM nmem, struct conf_service *service,
992 struct session *session = nmem_malloc(nmem, sizeof(*session));
996 sprintf(tmp_str, "session#%u", session_id);
998 session->session_id = session_id;
999 session_log(session, YLOG_DEBUG, "New");
1000 session->service = service;
1001 session->relevance = 0;
1002 session->total_records = 0;
1003 session->number_of_warnings_unknown_elements = 0;
1004 session->number_of_warnings_unknown_metadata = 0;
1005 session->num_termlists = 0;
1006 session->reclist = reclist_create(nmem);
1007 session->clients_active = 0;
1008 session->clients_cached = 0;
1009 session->settings_modified = 0;
1010 session->session_nmem = nmem;
1011 session->nmem = nmem_create();
1012 session->databases = 0;
1013 session->sorted_results = 0;
1014 session->facet_limits = 0;
1015 session->mergekey = 0;
1017 session->clients_starting = 0;
1019 for (i = 0; i <= SESSION_WATCH_MAX; i++)
1021 session->watchlist[i].data = 0;
1022 session->watchlist[i].fun = 0;
1024 session->normalize_cache = normalize_cache_create();
1025 session->session_mutex = 0;
1026 pazpar2_mutex_create(&session->session_mutex, tmp_str);
1027 session_log(session, YLOG_LOG, "create");
1033 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf);
1035 static struct hitsbytarget *hitsbytarget_nb(struct session *se,
1036 int *count, NMEM nmem)
1038 struct hitsbytarget *res = 0;
1039 struct client_list *l;
1042 for (l = se->clients_active; l; l = l->next)
1045 res = nmem_malloc(nmem, sizeof(*res) * sz);
1047 for (l = se->clients_active; l; l = l->next)
1049 struct client *cl = l->client;
1050 WRBUF w = wrbuf_alloc();
1051 const char *name = session_setting_oneval(client_get_database(cl),
1053 res[*count].id = client_get_id(cl);
1054 res[*count].name = *name ? name : "Unknown";
1055 res[*count].hits = client_get_hits(cl);
1056 res[*count].approximation = client_get_approximation(cl);
1057 res[*count].records = client_get_num_records(cl,
1058 &res[*count].filtered,
1060 res[*count].diagnostic =
1061 client_get_diagnostic(cl, &res[*count].message,
1062 &res[*count].addinfo);
1063 res[*count].state = client_get_state_str(cl);
1064 res[*count].connected = client_get_connection(cl) ? 1 : 0;
1065 session_settings_dump(se, client_get_database(cl), w);
1066 res[*count].settings_xml = nmem_strdup(nmem, wrbuf_cstr(w));
1069 res[*count].suggestions_xml = nmem_strdup(nmem, client_get_suggestions_xml(cl, w));
1076 struct hitsbytarget *get_hitsbytarget(struct session *se, int *count, NMEM nmem)
1078 struct hitsbytarget *p;
1079 session_enter(se, "get_hitsbytarget");
1080 p = hitsbytarget_nb(se, count, nmem);
1081 session_leave(se, "get_hitsbytarget");
1085 // Compares two hitsbytarget nodes by hitcount
1086 static int cmp_ht(const void *p1, const void *p2)
1088 const struct hitsbytarget *h1 = p1;
1089 const struct hitsbytarget *h2 = p2;
1090 return h2->hits - h1->hits;
1093 // Compares two hitsbytarget nodes by hitcount
1094 static int cmp_ht_approx(const void *p1, const void *p2)
1096 const struct hitsbytarget *h1 = p1;
1097 const struct hitsbytarget *h2 = p2;
1098 return h2->approximation - h1->approximation;
1101 static int targets_termlist_nb(WRBUF wrbuf, struct session *se, int num,
1102 NMEM nmem, int version)
1104 struct hitsbytarget *ht;
1107 ht = hitsbytarget_nb(se, &count, nmem);
1109 qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht_approx);
1111 qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
1112 for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
1115 // do only print terms which have display names
1117 wrbuf_puts(wrbuf, "<term>\n");
1119 wrbuf_puts(wrbuf, "<id>");
1120 wrbuf_xmlputs(wrbuf, ht[i].id);
1121 wrbuf_puts(wrbuf, "</id>\n");
1123 wrbuf_puts(wrbuf, "<name>");
1124 if (!ht[i].name || !ht[i].name[0])
1125 wrbuf_xmlputs(wrbuf, "NO TARGET NAME");
1127 wrbuf_xmlputs(wrbuf, ht[i].name);
1128 wrbuf_puts(wrbuf, "</name>\n");
1130 wrbuf_printf(wrbuf, "<frequency>" ODR_INT_PRINTF "</frequency>\n",
1134 // Should not print if we know it isn't a approximation.
1135 wrbuf_printf(wrbuf, "<approximation>" ODR_INT_PRINTF "</approximation>\n", ht[i].approximation);
1136 wrbuf_printf(wrbuf, "<records>%d</records>\n", ht[i].records - ht[i].filtered);
1137 wrbuf_printf(wrbuf, "<filtered>%d</filtered>\n", ht[i].filtered);
1140 wrbuf_puts(wrbuf, "<state>");
1141 wrbuf_xmlputs(wrbuf, ht[i].state);
1142 wrbuf_puts(wrbuf, "</state>\n");
1144 wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n",
1146 wrbuf_puts(wrbuf, "</term>\n");
1151 void perform_termlist(struct http_channel *c, struct session *se,
1152 const char *name, int num, int version)
1155 NMEM nmem_tmp = nmem_create();
1162 nmem_strsplit(nmem_tmp, ",", name, &names, &num_names);
1164 session_enter(se, "perform_termlist");
1166 for (j = 0; j < num_names; j++)
1169 int must_generate_empty = 1; /* bug 5350 */
1171 for (i = 0; i < se->num_termlists; i++)
1173 tname = se->termlists[i].name;
1174 if (!strcmp(names[j], tname) || !strcmp(names[j], "*"))
1176 struct termlist_score **p = 0;
1179 wrbuf_puts(c->wrbuf, "<list name=\"");
1180 wrbuf_xmlputs(c->wrbuf, tname);
1181 wrbuf_puts(c->wrbuf, "\">\n");
1182 must_generate_empty = 0;
1184 p = termlist_highscore(se->termlists[i].termlist, &len,
1189 for (i = 0; i < len && i < num; i++)
1191 // prevent sending empty term elements
1192 if (!p[i]->display_term || !p[i]->display_term[0])
1195 wrbuf_puts(c->wrbuf, "<term>");
1196 wrbuf_puts(c->wrbuf, "<name>");
1197 wrbuf_xmlputs(c->wrbuf, p[i]->display_term);
1198 wrbuf_puts(c->wrbuf, "</name>");
1200 wrbuf_printf(c->wrbuf,
1201 "<frequency>%d</frequency>",
1203 wrbuf_puts(c->wrbuf, "</term>\n");
1206 wrbuf_puts(c->wrbuf, "</list>\n");
1210 if (!strcmp(names[j], tname) || !strcmp(names[j], "*"))
1212 wrbuf_puts(c->wrbuf, "<list name=\"");
1213 wrbuf_xmlputs(c->wrbuf, tname);
1214 wrbuf_puts(c->wrbuf, "\">\n");
1216 targets_termlist_nb(c->wrbuf, se, num, c->nmem, version);
1217 wrbuf_puts(c->wrbuf, "</list>\n");
1218 must_generate_empty = 0;
1220 if (must_generate_empty)
1222 wrbuf_puts(c->wrbuf, "<list name=\"");
1223 wrbuf_xmlputs(c->wrbuf, names[j]);
1224 wrbuf_puts(c->wrbuf, "\"/>\n");
1227 session_leave(se, "perform_termlist");
1228 nmem_destroy(nmem_tmp);
1231 #ifdef MISSING_HEADERS
1232 void report_nmem_stats(void)
1234 size_t in_use, is_free;
1236 nmem_get_memory_in_use(&in_use);
1237 nmem_get_memory_free(&is_free);
1239 yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
1240 (long) in_use, (long) is_free);
1244 struct record_cluster *show_single_start(struct session *se, const char *id,
1245 struct record_cluster **prev_r,
1246 struct record_cluster **next_r)
1248 struct record_cluster *r = 0;
1250 session_enter(se, "show_single_start");
1253 reclist_limit(se->reclist, se, 1);
1255 reclist_enter(se->reclist);
1256 while ((r = reclist_read_record(se->reclist)))
1258 if (!strcmp(r->recid, id))
1260 *next_r = reclist_read_record(se->reclist);
1265 reclist_leave(se->reclist);
1267 session_leave(se, "show_single_start");
1271 void show_single_stop(struct session *se, struct record_cluster *rec)
1273 session_leave(se, "show_single_stop");
1277 int session_fetch_more(struct session *se)
1279 struct client_list *l;
1282 for (l = se->clients_active; l; l = l->next)
1284 struct client *cl = l->client;
1285 if (client_get_state(cl) == Client_Idle)
1287 if (client_fetch_more(cl))
1289 session_log(se, YLOG_LOG, "%s: more to fetch",
1296 int ingest_failures;
1297 int record_failures;
1298 int num = client_get_num_records(
1299 cl, &filtered, &ingest_failures, &record_failures);
1301 session_log(se, YLOG_LOG, "%s: hits=" ODR_INT_PRINTF
1302 " fetched=%d filtered=%d",
1304 client_get_hits(cl),
1306 if (ingest_failures || record_failures)
1308 session_log(se, YLOG_WARN, "%s:"
1309 " ingest failures=%d record failures=%d",
1311 ingest_failures, record_failures);
1317 session_log(se, YLOG_LOG, "%s: no fetch due to state=%s",
1318 client_get_id(cl), client_get_state_str(cl));
1325 struct record_cluster **show_range_start(struct session *se,
1326 struct reclist_sortparms *sp,
1327 int start, int *num, int *total,
1328 Odr_int *sumhits, Odr_int *approx_hits,
1329 void (*show_records_ready)(void *data),
1330 struct http_channel *chan)
1332 struct record_cluster **recs = 0;
1333 struct reclist_sortparms *spp;
1334 struct client_list *l;
1337 yaz_timing_t t = yaz_timing_create();
1339 session_enter(se, "show_range_start");
1343 reclist_limit(se->reclist, se, 0);
1346 for (spp = sp; spp; spp = spp->next)
1347 if (spp->type == Metadata_type_relevance)
1349 relevance_prepare_read(se->relevance, se->reclist);
1352 for (l = se->clients_active; l; l = l->next) {
1353 *sumhits += client_get_hits(l->client);
1354 *approx_hits += client_get_approximation(l->client);
1357 reclist_sort(se->reclist, sp);
1359 reclist_enter(se->reclist);
1360 *total = reclist_get_num_records(se->reclist);
1362 for (l = se->clients_active; l; l = l->next)
1363 client_update_show_stat(l->client, 0);
1365 for (i = 0; i < start; i++)
1367 struct record_cluster *r = reclist_read_record(se->reclist);
1375 struct record *rec = r->records;
1376 for (;rec; rec = rec->next)
1377 client_update_show_stat(rec->client, 1);
1380 recs = nmem_malloc(se->nmem, (*num > 0 ? *num : 1) * sizeof(*recs));
1381 for (i = 0; i < *num; i++)
1383 struct record_cluster *r = reclist_read_record(se->reclist);
1391 struct record *rec = r->records;
1392 for (;rec; rec = rec->next)
1393 client_update_show_stat(rec->client, 1);
1397 reclist_leave(se->reclist);
1400 session_log(se, YLOG_LOG, "show %6.5f %3.2f %3.2f",
1401 yaz_timing_get_real(t), yaz_timing_get_user(t),
1402 yaz_timing_get_sys(t));
1403 yaz_timing_destroy(&t);
1406 if (!session_fetch_more(se))
1407 session_log(se, YLOG_LOG, "can not fetch more");
1410 show_range_stop(se, recs);
1411 session_log(se, YLOG_LOG, "fetching more in progress");
1412 if (session_set_watch(se, SESSION_WATCH_SHOW,
1413 show_records_ready, chan, chan))
1415 session_log(se, YLOG_WARN, "Ignoring show block");
1416 session_enter(se, "show_range_start");
1420 session_log(se, YLOG_LOG, "session watch OK");
1427 void show_range_stop(struct session *se, struct record_cluster **recs)
1429 session_leave(se, "show_range_stop");
1432 void statistics(struct session *se, struct statistics *stat)
1434 struct client_list *l;
1437 memset(stat, 0, sizeof(*stat));
1439 for (l = se->clients_active; l; l = l->next)
1441 struct client *cl = l->client;
1442 if (!client_get_connection(cl))
1443 stat->num_no_connection++;
1444 stat->num_hits += client_get_hits(cl);
1445 switch (client_get_state(cl))
1447 case Client_Connecting: stat->num_connecting++; break;
1448 case Client_Working: stat->num_working++; break;
1449 case Client_Idle: stat->num_idle++; break;
1450 case Client_Failed: stat->num_failed++; break;
1451 case Client_Error: stat->num_error++; break;
1456 stat->num_records = se->total_records;
1458 stat->num_clients = count;
1461 static struct record_metadata *record_metadata_init(
1462 NMEM nmem, const char *value, enum conf_metadata_type type,
1463 struct _xmlAttr *attr)
1465 struct record_metadata *rec_md = record_metadata_create(nmem);
1466 struct record_metadata_attr **attrp = &rec_md->attributes;
1468 for (; attr; attr = attr->next)
1470 if (attr->children && attr->children->content)
1472 if (strcmp((const char *) attr->name, "type")
1473 && strcmp((const char *) attr->name, "empty"))
1474 { /* skip the "type" + "empty" attribute..
1475 The "Type" is already part of the element in output
1476 (md-%s) and so repeating it here is redundant */
1477 *attrp = nmem_malloc(nmem, sizeof(**attrp));
1479 nmem_strdup(nmem, (const char *) attr->name);
1481 nmem_strdup(nmem, (const char *) attr->children->content);
1482 attrp = &(*attrp)->next;
1490 case Metadata_type_generic:
1491 case Metadata_type_skiparticle:
1492 if (strstr(value, "://")) /* looks like a URL */
1493 rec_md->data.text.disp = nmem_strdup(nmem, value);
1495 rec_md->data.text.disp =
1496 normalize7bit_generic(nmem_strdup(nmem, value), " ,/.:([");
1497 rec_md->data.text.sort = 0;
1498 rec_md->data.text.snippet = 0;
1500 case Metadata_type_year:
1501 case Metadata_type_date:
1506 if (type == Metadata_type_date)
1508 if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
1511 rec_md->data.number.min = first;
1512 rec_md->data.number.max = last;
1515 case Metadata_type_float:
1516 rec_md->data.fnumber = atof(value);
1518 case Metadata_type_relevance:
1519 case Metadata_type_position:
1525 static void mergekey_norm_wr(pp2_charset_fact_t charsets,
1526 WRBUF norm_wr, const char *value)
1528 const char *norm_str;
1529 pp2_charset_token_t prt =
1530 pp2_charset_token_create(charsets, "mergekey");
1532 pp2_charset_token_first(prt, value, 0);
1533 while ((norm_str = pp2_charset_token_next(prt)))
1537 if (wrbuf_len(norm_wr))
1538 wrbuf_puts(norm_wr, " ");
1539 wrbuf_puts(norm_wr, norm_str);
1542 pp2_charset_token_destroy(prt);
1545 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
1546 struct conf_service *service, WRBUF norm_wr)
1550 for (n = root->children; n; n = n->next)
1552 if (n->type != XML_ELEMENT_NODE)
1554 if (!strcmp((const char *) n->name, "metadata"))
1556 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1558 yaz_log(YLOG_FATAL, "Missing type attribute on metadata element. Skipping!");
1560 else if (!strcmp(name, (const char *) type))
1562 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
1563 if (value && *value)
1565 if (wrbuf_len(norm_wr) > 0)
1566 wrbuf_puts(norm_wr, " ");
1567 wrbuf_puts(norm_wr, name);
1568 mergekey_norm_wr(service->charsets, norm_wr,
1569 (const char *) value);
1581 static const char *get_mergekey(xmlDoc *doc, xmlNode *root,
1582 struct client *cl, int record_no,
1583 struct conf_service *service, NMEM nmem,
1584 const char *session_mergekey)
1586 char *mergekey_norm = 0;
1587 WRBUF norm_wr = wrbuf_alloc();
1590 if (session_mergekey)
1594 nmem_strsplit_escape2(nmem, ",", session_mergekey, &values,
1597 for (i = 0; i < num; i++)
1598 get_mergekey_from_doc(doc, root, values[i], service, norm_wr);
1600 else if ((mergekey = xmlGetProp(root, (xmlChar *) "mergekey")))
1602 mergekey_norm_wr(service->charsets, norm_wr, (const char *) mergekey);
1607 /* no mergekey defined in XSL. Look for mergekey metadata instead */
1609 for (field_id = 0; field_id < service->num_metadata; field_id++)
1611 struct conf_metadata *ser_md = &service->metadata[field_id];
1612 if (ser_md->mergekey != Metadata_mergekey_no)
1614 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1616 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1618 /* no mergekey on this one and it is required..
1619 Generate unique key instead */
1620 wrbuf_rewind(norm_wr);
1627 /* generate unique key if none is not generated already or is empty */
1628 if (wrbuf_len(norm_wr) == 0)
1630 wrbuf_printf(norm_wr, "position: %s-%d",
1631 client_get_id(cl), record_no);
1635 const char *lead = "content: ";
1636 wrbuf_insert(norm_wr, 0, lead, strlen(lead));
1638 if (wrbuf_len(norm_wr) > 0)
1639 mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1640 wrbuf_destroy(norm_wr);
1641 return mergekey_norm;
1644 /** \brief see if metadata for pz:recordfilter exists
1645 \param root xml root element of normalized record
1646 \param sdb session database for client
1647 \retval 0 if there is no metadata for pz:recordfilter
1648 \retval 1 if there is metadata for pz:recordfilter
1650 If there is no pz:recordfilter defined, this function returns 1
1654 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1659 s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1664 for (n = root->children; n; n = n->next)
1666 if (n->type != XML_ELEMENT_NODE)
1668 if (!strcmp((const char *) n->name, "metadata"))
1670 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1677 if ((eq = strchr(s, '=')))
1679 else if ((eq = strchr(s, '~')))
1685 if (len == strlen((const char *)type) &&
1686 !memcmp((const char *) type, s, len))
1688 xmlChar *value = xmlNodeGetContent(n);
1689 if (value && *value)
1692 (substring && strstr((const char *) value, eq+1)) ||
1693 (!substring && !strcmp((const char *) value, eq + 1)))
1705 static int ingest_to_cluster(struct client *cl,
1709 struct record_metadata_attr *mergekey);
1711 static int ingest_sub_record(struct client *cl, xmlDoc *xdoc, xmlNode *root,
1712 int record_no, NMEM nmem,
1713 struct session_database *sdb,
1714 struct record_metadata_attr *mergekeys)
1717 struct session *se = client_get_session(cl);
1719 if (!check_record_filter(root, sdb))
1721 session_log(se, YLOG_LOG,
1722 "Filtered out record no %d from %s",
1723 record_no, sdb->database->id);
1726 session_enter(se, "ingest_sub_record");
1727 if (client_get_session(cl) == se && se->relevance)
1728 ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekeys);
1729 session_leave(se, "ingest_sub_record");
1734 /** \brief ingest XML record
1735 \param cl client holds the result set for record
1736 \param rec record buffer (0 terminated)
1737 \param record_no record position (1, 2, ..)
1738 \param nmem working NMEM
1743 int ingest_record(struct client *cl, const char *rec,
1744 int record_no, NMEM nmem)
1746 struct session *se = client_get_session(cl);
1747 struct session_database *sdb = client_get_database(cl);
1748 struct conf_service *service = se->service;
1749 xmlDoc *xdoc = normalize_record(se, sdb, service, rec, nmem);
1750 int r = ingest_xml_record(cl, xdoc, record_no, nmem, 0);
1751 client_store_xdoc(cl, record_no, xdoc);
1755 int ingest_xml_record(struct client *cl, xmlDoc *xdoc,
1756 int record_no, NMEM nmem, int cached_copy)
1758 struct session *se = client_get_session(cl);
1759 struct session_database *sdb = client_get_database(cl);
1760 struct conf_service *service = se->service;
1766 if (global_parameters.dump_records)
1768 session_log(se, YLOG_LOG, "Normalized record from %s",
1773 root = xmlDocGetRootElement(xdoc);
1775 if (!strcmp((const char *) root->name, "cluster"))
1777 int no_merge_keys = 0;
1778 int no_merge_dups = 0;
1780 struct record_metadata_attr *mk = 0;
1782 for (sroot = root->children; sroot; sroot = sroot->next)
1783 if (sroot->type == XML_ELEMENT_NODE &&
1784 !strcmp((const char *) sroot->name, "record"))
1786 struct record_metadata_attr **mkp;
1787 const char *mergekey_norm =
1788 get_mergekey(xdoc, sroot, cl, record_no, service, nmem,
1795 for (mkp = &mk; *mkp; mkp = &(*mkp)->next)
1796 if (!strcmp((*mkp)->value, mergekey_norm))
1800 *mkp = (struct record_metadata_attr*)
1801 nmem_malloc(nmem, sizeof(**mkp));
1803 (*mkp)->value = nmem_strdup(nmem, mergekey_norm);
1810 if (no_merge_keys > 1 || no_merge_dups > 0)
1812 yaz_log(YLOG_LOG, "Got %d mergekeys, %d dups for position %d",
1813 no_merge_keys, no_merge_dups, record_no);
1815 for (sroot = root->children; !r && sroot; sroot = sroot->next)
1816 if (sroot->type == XML_ELEMENT_NODE &&
1817 !strcmp((const char *) sroot->name, "record"))
1820 insert_settings_values(sdb, xdoc, root, service);
1821 r = ingest_sub_record(cl, xdoc, sroot, record_no, nmem, sdb,
1825 else if (!strcmp((const char *) root->name, "record"))
1827 const char *mergekey_norm =
1828 get_mergekey(xdoc, root, cl, record_no, service, nmem,
1832 struct record_metadata_attr *mk = (struct record_metadata_attr*)
1833 nmem_malloc(nmem, sizeof(*mk));
1835 mk->value = nmem_strdup(nmem, mergekey_norm);
1839 insert_settings_values(sdb, xdoc, root, service);
1840 r = ingest_sub_record(cl, xdoc, root, record_no, nmem, sdb, mk);
1845 session_log(se, YLOG_WARN, "Bad pz root element: %s",
1846 (const char *) root->name);
1853 // struct conf_metadata *ser_md = &service->metadata[md_field_id];
1854 // struct record_metadata *rec_md = record->metadata[md_field_id];
1855 static int match_metadata_local(struct conf_service *service,
1856 struct conf_metadata *ser_md,
1857 struct record_metadata *rec_md0,
1858 char **values, int num_v)
1861 struct record_metadata *rec_md = rec_md0;
1863 WRBUF text_wr = wrbuf_alloc();
1864 for (i = 0; i < num_v; )
1868 if (ser_md->type == Metadata_type_year
1869 || ser_md->type == Metadata_type_date)
1871 int y = atoi(values[i]);
1872 if (y >= rec_md->data.number.min
1873 && y <= rec_md->data.number.max)
1880 val_wr = wrbuf_alloc();
1881 mergekey_norm_wr(service->charsets, val_wr, values[i]);
1883 wrbuf_rewind(text_wr);
1884 mergekey_norm_wr(service->charsets, text_wr,
1885 rec_md->data.text.disp);
1886 if (!strcmp(wrbuf_cstr(val_wr), wrbuf_cstr(text_wr)))
1889 rec_md = rec_md->next;
1894 wrbuf_destroy(val_wr);
1899 wrbuf_destroy(val_wr);
1900 wrbuf_destroy(text_wr);
1901 return i < num_v ? 1 : 0;
1904 int session_check_cluster_limit(struct session *se, struct record_cluster *rec)
1907 struct conf_service *service = se->service;
1911 NMEM nmem_tmp = nmem_create();
1913 for (i = 0; (name = facet_limits_get(se->facet_limits, i, &value)); i++)
1916 for (j = 0; j < service->num_metadata; j++)
1918 struct conf_metadata *md = service->metadata + j;
1919 if (!strcmp(md->name, name) && md->limitcluster)
1924 conf_service_metadata_field_id(service,
1927 if (md_field_id < 0)
1933 nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
1936 if (!match_metadata_local(service,
1937 &service->metadata[md_field_id],
1938 rec->metadata[md_field_id],
1947 nmem_destroy(nmem_tmp);
1951 // Skip record on non-zero
1952 static int check_limit_local(struct client *cl,
1953 struct record *record,
1956 int skip_record = 0;
1957 struct session *se = client_get_session(cl);
1958 struct conf_service *service = se->service;
1959 NMEM nmem_tmp = nmem_create();
1960 struct session_database *sdb = client_get_database(cl);
1962 while (!skip_record)
1968 client_get_facet_limit_local(cl, sdb, &l, nmem_tmp,
1973 if (!strcmp(name, "*"))
1975 for (md_field_id = 0; md_field_id < service->num_metadata;
1978 if (match_metadata_local(
1980 &service->metadata[md_field_id],
1981 record->metadata[md_field_id],
1985 if (md_field_id == service->num_metadata)
1990 md_field_id = conf_service_metadata_field_id(service, name);
1991 if (md_field_id < 0)
1996 if (!match_metadata_local(
1998 &service->metadata[md_field_id],
1999 record->metadata[md_field_id],
2006 nmem_destroy(nmem_tmp);
2010 static int ingest_to_cluster(struct client *cl,
2014 struct record_metadata_attr *merge_keys)
2019 struct session *se = client_get_session(cl);
2020 struct conf_service *service = se->service;
2021 int term_factor = 1;
2022 struct record_cluster *cluster;
2023 struct record_metadata **metadata0;
2024 struct session_database *sdb = client_get_database(cl);
2025 NMEM ingest_nmem = 0;
2026 char **rank_values = 0;
2028 struct record *record = record_create(se->nmem,
2029 service->num_metadata,
2030 service->num_sortkeys, cl,
2033 for (n = root->children; n; n = n->next)
2041 if (n->type != XML_ELEMENT_NODE)
2043 if (!strcmp((const char *) n->name, "metadata"))
2045 struct conf_metadata *ser_md = 0;
2046 struct record_metadata **wheretoput = 0;
2047 struct record_metadata *rec_md = 0;
2048 int md_field_id = -1;
2050 type = xmlGetProp(n, (xmlChar *) "type");
2051 value = xmlNodeListGetString(xdoc, n->children, 1);
2054 if (!value || !*value)
2056 xmlChar *empty = xmlGetProp(n, (xmlChar *) "empty");
2064 = conf_service_metadata_field_id(service, (const char *) type);
2065 if (md_field_id < 0)
2067 if (se->number_of_warnings_unknown_metadata == 0)
2069 session_log(se, YLOG_WARN,
2070 "Ignoring unknown metadata element: %s", type);
2072 se->number_of_warnings_unknown_metadata++;
2076 ser_md = &service->metadata[md_field_id];
2078 // non-merged metadata
2079 rec_md = record_metadata_init(se->nmem, (const char *) value,
2080 ser_md->type, n->properties);
2083 session_log(se, YLOG_WARN, "bad metadata data '%s' "
2084 "for element '%s'", value, type);
2088 if (ser_md->type == Metadata_type_generic)
2090 WRBUF w = wrbuf_alloc();
2091 if (relevance_snippet(se->relevance,
2092 (char*) value, ser_md->name, w))
2093 rec_md->data.text.snippet = nmem_strdup(se->nmem,
2099 wheretoput = &record->metadata[md_field_id];
2101 wheretoput = &(*wheretoput)->next;
2102 *wheretoput = rec_md;
2106 if (check_limit_local(cl, record, record_no))
2114 cluster = reclist_insert(se->reclist, se->relevance, service, record,
2115 merge_keys, &se->total_merged);
2122 return 0; // complete match with existing record
2126 const char *use_term_factor_str =
2127 session_setting_oneval(sdb, PZ_TERMLIST_TERM_FACTOR);
2128 if (use_term_factor_str && use_term_factor_str[0] == '1')
2130 int maxrecs = client_get_maxrecs(cl);
2131 int hits = (int) client_get_hits(cl);
2132 term_factor = MAX(hits, maxrecs) / MAX(1, maxrecs);
2133 assert(term_factor >= 1);
2134 session_log(se, YLOG_DEBUG, "Using term factor: %d (%d / %d)",
2135 term_factor, MAX(hits, maxrecs), MAX(1, maxrecs));
2139 if (global_parameters.dump_records)
2140 session_log(se, YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
2141 sdb->database->id, record_no);
2143 // original metadata, to check if first existence of a field
2144 metadata0 = xmalloc(sizeof(*metadata0) * service->num_metadata);
2145 memcpy(metadata0, cluster->metadata,
2146 sizeof(*metadata0) * service->num_metadata);
2148 ingest_nmem = nmem_create();
2151 yaz_log(YLOG_LOG, "local in sort : %s", se->rank);
2152 nmem_strsplit_escape2(ingest_nmem, ",", se->rank, &rank_values,
2153 &rank_num, 1, '\\', 1);
2156 // now parsing XML record and adding data to cluster or record metadata
2157 for (n = root->children; n; n = n->next)
2159 pp2_charset_token_t prt;
2166 if (n->type != XML_ELEMENT_NODE)
2168 if (!strcmp((const char *) n->name, "metadata"))
2170 struct conf_metadata *ser_md = 0;
2171 struct conf_sortkey *ser_sk = 0;
2172 struct record_metadata **wheretoput = 0;
2173 struct record_metadata *rec_md = 0;
2174 int md_field_id = -1;
2175 int sk_field_id = -1;
2176 const char *rank = 0;
2177 xmlChar *xml_rank = 0;
2179 type = xmlGetProp(n, (xmlChar *) "type");
2180 value = xmlNodeListGetString(xdoc, n->children, 1);
2182 if (!type || !value || !*value)
2186 = conf_service_metadata_field_id(service, (const char *) type);
2187 if (md_field_id < 0)
2190 ser_md = &service->metadata[md_field_id];
2192 if (ser_md->sortkey_offset >= 0)
2194 sk_field_id = ser_md->sortkey_offset;
2195 ser_sk = &service->sortkeys[sk_field_id];
2199 rec_md = record_metadata_init(se->nmem, (const char *) value,
2202 // see if the field was not in cluster already (from beginning)
2210 for (i = 0; i < rank_num; i++)
2212 const char *val = rank_values[i];
2213 const char *cp = strchr(val, '=');
2216 if ((cp - val) == strlen((const char *) type)
2217 && !memcmp(val, type, cp - val))
2226 xml_rank = xmlGetProp(n, (xmlChar *) "rank");
2227 rank = xml_rank ? (const char *) xml_rank : ser_md->rank;
2230 wheretoput = &cluster->metadata[md_field_id];
2232 if (ser_md->merge == Metadata_merge_first)
2234 if (!metadata0[md_field_id])
2237 wheretoput = &(*wheretoput)->next;
2238 *wheretoput = rec_md;
2241 else if (ser_md->merge == Metadata_merge_unique)
2245 if (!strcmp((const char *) (*wheretoput)->data.text.disp,
2246 rec_md->data.text.disp))
2248 wheretoput = &(*wheretoput)->next;
2251 *wheretoput = rec_md;
2253 else if (ser_md->merge == Metadata_merge_longest)
2256 || strlen(rec_md->data.text.disp)
2257 > strlen((*wheretoput)->data.text.disp))
2259 *wheretoput = rec_md;
2262 const char *sort_str = 0;
2264 ser_sk->type == Metadata_type_skiparticle;
2266 if (!cluster->sortkeys[sk_field_id])
2267 cluster->sortkeys[sk_field_id] =
2268 nmem_malloc(se->nmem,
2269 sizeof(union data_types));
2272 pp2_charset_token_create(service->charsets, "sort");
2274 pp2_charset_token_first(prt, rec_md->data.text.disp,
2277 pp2_charset_token_next(prt);
2279 sort_str = pp2_get_sort(prt);
2281 cluster->sortkeys[sk_field_id]->text.disp =
2282 rec_md->data.text.disp;
2285 sort_str = rec_md->data.text.disp;
2286 session_log(se, YLOG_WARN,
2287 "Could not make sortkey. Bug #1858");
2289 cluster->sortkeys[sk_field_id]->text.sort =
2290 nmem_strdup(se->nmem, sort_str);
2291 pp2_charset_token_destroy(prt);
2295 else if (ser_md->merge == Metadata_merge_all)
2298 wheretoput = &(*wheretoput)->next;
2299 *wheretoput = rec_md;
2301 else if (ser_md->merge == Metadata_merge_range)
2305 *wheretoput = rec_md;
2307 cluster->sortkeys[sk_field_id]
2312 int this_min = rec_md->data.number.min;
2313 int this_max = rec_md->data.number.max;
2314 if (this_min < (*wheretoput)->data.number.min)
2315 (*wheretoput)->data.number.min = this_min;
2316 if (this_max > (*wheretoput)->data.number.max)
2317 (*wheretoput)->data.number.max = this_max;
2321 // ranking of _all_ fields enabled ...
2324 relevance_countwords(se->relevance, cluster,
2325 (char *) value, rank, ser_md->name);
2327 // construct facets ... unless the client already has reported them
2328 if (ser_md->termlist && !client_has_facet(cl, (char *) type))
2330 if (ser_md->type == Metadata_type_year)
2333 sprintf(year, "%d", rec_md->data.number.max);
2335 add_facet(se, (char *) type, year, term_factor);
2336 if (rec_md->data.number.max != rec_md->data.number.min)
2338 sprintf(year, "%d", rec_md->data.number.min);
2339 add_facet(se, (char *) type, year, term_factor);
2343 add_facet(se, (char *) type, (char *) value, term_factor);
2355 if (se->number_of_warnings_unknown_elements == 0)
2356 session_log(se, YLOG_WARN,
2357 "Unexpected element in internal record: %s", n->name);
2358 se->number_of_warnings_unknown_elements++;
2366 nmem_destroy(ingest_nmem);
2368 relevance_donerecord(se->relevance, cluster);
2369 se->total_records++;
2374 void session_log(struct session *s, int level, const char *fmt, ...)
2380 yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
2381 yaz_log(level, "Session %u: %s", s ? s->session_id : 0, buf);
2389 * c-file-style: "Stroustrup"
2390 * indent-tabs-mode: nil
2392 * vim: shiftwidth=4 tabstop=8 expandtab