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))
207 struct named_termlist **tp = &s->termlists;
208 for (; (*tp); tp = &(*tp)->next)
209 if (!strcmp((*tp)->name, type))
213 *tp = nmem_malloc(s->nmem, sizeof(**tp));
214 (*tp)->name = nmem_strdup(s->nmem, type);
215 (*tp)->termlist = termlist_create(s->nmem);
218 termlist_insert((*tp)->termlist, wrbuf_cstr(display_wrbuf),
219 wrbuf_cstr(facet_wrbuf), count);
221 wrbuf_destroy(facet_wrbuf);
222 wrbuf_destroy(display_wrbuf);
225 static xmlDoc *record_to_xml(struct session *se,
226 struct session_database *sdb, const char *rec)
228 struct database *db = sdb->database;
231 rdoc = xmlParseMemory(rec, strlen(rec));
235 session_log(se, YLOG_WARN, "Non-wellformed XML");
239 if (global_parameters.dump_records)
241 session_log(se, YLOG_LOG, "Un-normalized record from %s", db->id);
248 #define MAX_XSLT_ARGS 16
250 // Add static values from session database settings if applicable
251 static void insert_settings_parameters(struct session_database *sdb,
252 struct conf_service *service,
260 for (i = 0; i < service->num_metadata; i++)
262 struct conf_metadata *md = &service->metadata[i];
265 if (md->setting == Metadata_setting_parameter &&
266 (setting = settings_lookup_offset(service, md->name)) >= 0)
268 const char *val = session_setting_oneval(sdb, setting);
269 if (val && nparms < MAX_XSLT_ARGS)
272 int len = strlen(val);
273 buf = nmem_malloc(nmem, len + 3);
275 strcpy(buf + 1, val);
278 parms[offset++] = md->name;
279 parms[offset++] = buf;
287 // Add static values from session database settings if applicable
288 static void insert_settings_values(struct session_database *sdb, xmlDoc *doc,
290 struct conf_service *service)
294 for (i = 0; i < service->num_metadata; i++)
296 struct conf_metadata *md = &service->metadata[i];
299 if (md->setting == Metadata_setting_postproc &&
300 (offset = settings_lookup_offset(service, md->name)) >= 0)
302 const char *val = session_setting_oneval(sdb, offset);
305 xmlNode *n = xmlNewTextChild(root, 0, (xmlChar *) "metadata",
307 xmlSetProp(n, (xmlChar *) "type", (xmlChar *) md->name);
313 static xmlDoc *normalize_record(struct session *se,
314 struct session_database *sdb,
315 struct conf_service *service,
316 const char *rec, NMEM nmem)
318 xmlDoc *rdoc = record_to_xml(se, sdb, rec);
322 char *parms[MAX_XSLT_ARGS*2+1];
324 insert_settings_parameters(sdb, service, parms, nmem);
326 if (normalize_record_transform(sdb->map, &rdoc, (const char **)parms))
328 session_log(se, YLOG_WARN, "Normalize failed");
334 void session_settings_dump(struct session *se,
335 struct session_database *db,
340 int i, num = db->num_settings;
341 for (i = 0; i < num; i++)
343 struct setting *s = db->settings[i];
344 for (;s ; s = s->next)
346 wrbuf_puts(w, "<set name=\"");
347 wrbuf_xmlputs(w, s->name);
348 wrbuf_puts(w, "\" value=\"");
349 wrbuf_xmlputs(w, s->value);
350 wrbuf_puts(w, "\"/>");
358 // Retrieve first defined value for 'name' for given database.
359 // Will be extended to take into account user associated with session
360 const char *session_setting_oneval(struct session_database *db, int offset)
362 if (offset >= db->num_settings || !db->settings[offset])
364 return db->settings[offset]->value;
367 // Prepare XSLT stylesheets for record normalization
368 // Structures are allocated on the session_wide nmem to avoid having
369 // to recompute this for every search. This would lead
370 // to leaking if a single session was to repeatedly change the PZ_XSLT
371 // setting. However, this is not a realistic use scenario.
372 static int prepare_map(struct session *se, struct session_database *sdb)
374 if (sdb->settings && !sdb->map)
378 if (sdb->settings[PZ_XSLT] &&
379 (s = session_setting_oneval(sdb, PZ_XSLT)))
381 char auto_stylesheet[256];
383 if (!strcmp(s, "auto"))
385 const char *request_syntax = session_setting_oneval(
386 sdb, PZ_REQUESTSYNTAX);
390 yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet),
391 "%s.xsl", request_syntax);
392 for (cp = auto_stylesheet; *cp; cp++)
394 /* deliberately only consider ASCII */
395 if (*cp > 32 && *cp < 127)
402 session_log(se, YLOG_WARN,
403 "No pz:requestsyntax for auto stylesheet");
406 sdb->map = normalize_cache_get(se->normalize_cache,
415 // called if watch should be removed because http_channel is to be destroyed
416 static void session_watch_cancel(void *data, struct http_channel *c,
419 struct session_watchentry *ent = data;
426 // set watch. Returns 0=OK, -1 if watch is already set
427 int session_set_watch(struct session *s, int what,
428 session_watchfun fun, void *data,
429 struct http_channel *chan)
432 session_enter(s, "session_set_watch");
433 if (s->watchlist[what].fun)
438 s->watchlist[what].fun = fun;
439 s->watchlist[what].data = data;
440 s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
441 session_watch_cancel);
444 session_leave(s, "session_set_watch");
448 void session_alert_watch(struct session *s, int what)
451 session_enter(s, "session_alert_watch");
452 if (s->watchlist[what].fun)
454 /* our watch is no longer associated with http_channel */
456 session_watchfun fun;
458 http_remove_observer(s->watchlist[what].obs);
459 fun = s->watchlist[what].fun;
460 data = s->watchlist[what].data;
462 /* reset watch before fun is invoked - in case fun wants to set
464 s->watchlist[what].fun = 0;
465 s->watchlist[what].data = 0;
466 s->watchlist[what].obs = 0;
468 session_leave(s, "session_alert_watch");
469 session_log(s, YLOG_DEBUG,
470 "Alert Watch: %d calling function: %p", what, fun);
474 session_leave(s,"session_alert_watch");
477 //callback for grep_databases
478 static void select_targets_callback(struct session *se,
479 struct session_database *db)
482 struct client_list *l;
484 for (l = se->clients_cached; l; l = l->next)
485 if (client_get_database(l->client) == db)
492 cl = client_create(db->database->id);
493 client_set_database(cl, db);
495 l = xmalloc(sizeof(*l));
497 l->next = se->clients_cached;
498 se->clients_cached = l;
500 /* set session always. If may be 0 if client is not active */
501 client_set_session(cl, se);
503 l = xmalloc(sizeof(*l));
505 l->next = se->clients_active;
506 se->clients_active = l;
509 static void session_reset_active_clients(struct session *se,
510 struct client_list *new_list)
512 struct client_list *l;
514 session_enter(se, "session_reset_active_clients");
515 l = se->clients_active;
516 se->clients_active = new_list;
517 session_leave(se, "session_reset_active_clients");
521 struct client_list *l_next = l->next;
523 client_lock(l->client);
524 client_set_session(l->client, 0); /* mark client inactive */
525 client_unlock(l->client);
532 static void session_remove_cached_clients(struct session *se)
534 struct client_list *l;
536 session_reset_active_clients(se, 0);
538 session_enter(se, "session_remove_cached_clients");
539 l = se->clients_cached;
540 se->clients_cached = 0;
541 session_leave(se, "session_remove_cached_clients");
545 struct client_list *l_next = l->next;
546 client_lock(l->client);
547 client_set_session(l->client, 0);
548 client_set_database(l->client, 0);
549 client_unlock(l->client);
550 client_destroy(l->client);
556 // Associates a set of clients with a session;
557 // Note: Session-databases represent databases with per-session
559 static int select_targets(struct session *se, const char *filter)
561 return session_grep_databases(se, filter, select_targets_callback);
564 int session_active_clients(struct session *s)
566 struct client_list *l;
569 for (l = s->clients_active; l; l = l->next)
570 if (client_is_active(l->client))
576 int session_is_preferred_clients_ready(struct session *s)
578 struct client_list *l;
581 for (l = s->clients_active; l; l = l->next)
582 if (client_is_active_preferred(l->client))
584 session_log(s, YLOG_DEBUG, "Has %d active preferred clients.", res);
588 static void session_clear_set(struct session *se, struct reclist_sortparms *sp)
590 reclist_destroy(se->reclist);
591 if (nmem_total(se->nmem))
592 session_log(se, YLOG_DEBUG, "NMEN operation usage %zd",
593 nmem_total(se->nmem));
594 nmem_reset(se->nmem);
595 se->total_records = se->total_merged = 0;
597 relevance_clear(se->relevance);
599 /* reset list of sorted results and clear to relevance search */
600 se->sorted_results = nmem_malloc(se->nmem, sizeof(*se->sorted_results));
601 se->sorted_results->name = nmem_strdup(se->nmem, sp->name);
602 se->sorted_results->increasing = sp->increasing;
603 se->sorted_results->type = sp->type;
604 se->sorted_results->next = 0;
606 session_log(se, YLOG_DEBUG, "clear_set session_sort: field=%s increasing=%d type=%d configured",
607 sp->name, sp->increasing, sp->type);
609 se->reclist = reclist_create(se->nmem);
612 void session_sort(struct session *se, struct reclist_sortparms *sp,
613 const char *mergekey, const char *rank)
615 struct client_list *l;
616 const char *field = sp->name;
617 int increasing = sp->increasing;
619 int clients_research = 0;
621 session_enter(se, "session_sort");
622 session_log(se, YLOG_DEBUG, "session_sort field=%s increasing=%d type=%d",
623 field, increasing, type);
625 if (rank && (!se->rank || strcmp(se->rank, rank)))
627 /* new rank must research/reingest anyway */
630 se->rank = *rank ? xstrdup(rank) : 0;
631 clients_research = 1;
632 session_log(se, YLOG_DEBUG, "session_sort: new rank = %s",
635 if (mergekey && (!se->mergekey || strcmp(se->mergekey, mergekey)))
637 /* new mergekey must research/reingest anyway */
640 se->mergekey = *mergekey ? xstrdup(mergekey) : 0;
641 clients_research = 1;
642 session_log(se, YLOG_DEBUG, "session_sort: new mergekey = %s",
645 if (clients_research == 0)
647 struct reclist_sortparms *sr;
648 for (sr = se->sorted_results; sr; sr = sr->next)
649 if (!reclist_sortparms_cmp(sr, sp))
653 session_log(se, YLOG_DEBUG, "session_sort: field=%s increasing=%d type=%d already fetched",
654 field, increasing, type);
655 session_leave(se, "session_sort");
659 session_log(se, YLOG_DEBUG, "session_sort: field=%s increasing=%d type=%d must fetch",
660 field, increasing, type);
662 // We need to reset reclist on every sort that changes the records, not just for position
663 // So if just one client requires new searching, we need to clear set.
664 // Ask each of the client if sorting requires re-search due to native sort
665 // If it does it will require us to
666 for (l = se->clients_active; l; l = l->next)
668 struct client *cl = l->client;
669 // Assume no re-search is required.
670 client_parse_init(cl, 1);
671 clients_research += client_parse_sort(cl, sp);
673 if (!clients_research || se->clients_starting)
675 // A new sorting based on same record set
676 struct reclist_sortparms *sr = nmem_malloc(se->nmem, sizeof(*sr));
677 sr->name = nmem_strdup(se->nmem, field);
678 sr->increasing = increasing;
680 sr->next = se->sorted_results;
681 se->sorted_results = sr;
682 session_log(se, YLOG_DEBUG, "session_sort: no research/ingesting done");
683 session_leave(se, "session_sort");
687 se->clients_starting = 1;
688 session_log(se, YLOG_DEBUG,
689 "session_sort: reset results due to %d clients researching",
691 session_clear_set(se, sp);
692 session_log(se, YLOG_DEBUG, "Re- search/ingesting for clients due to change in sort order");
694 session_leave(se, "session_sort");
695 for (l = se->clients_active; l; l = l->next)
697 struct client *cl = l->client;
698 if (client_get_state(cl) == Client_Connecting ||
699 client_get_state(cl) == Client_Idle ||
700 client_get_state(cl) == Client_Working) {
701 client_start_search(cl);
705 session_log(se, YLOG_DEBUG,
706 "session_sort: %s: No re-start/ingest in show. "
707 "Wrong client state: %d",
708 client_get_id(cl), client_get_state(cl));
711 session_enter(se, "session_sort");
712 se->clients_starting = 0;
713 session_leave(se, "session_sort");
717 void session_stop(struct session *se)
719 struct client_list *l;
720 session_enter(se, "session_stop1");
721 if (se->clients_starting)
723 session_leave(se, "session_stop1");
726 se->clients_starting = 1;
727 session_leave(se, "session_stop1");
729 session_alert_watch(se, SESSION_WATCH_SHOW);
730 session_alert_watch(se, SESSION_WATCH_BYTARGET);
731 session_alert_watch(se, SESSION_WATCH_TERMLIST);
732 session_alert_watch(se, SESSION_WATCH_SHOW_PREF);
734 for (l = se->clients_active; l; l = l->next)
736 struct client *cl = l->client;
739 session_enter(se, "session_stop2");
740 se->clients_starting = 0;
741 session_leave(se, "session_stop2");
744 enum pazpar2_error_code session_search(struct session *se,
746 const char *startrecs,
750 const char **addinfo,
751 const char **addinfo2,
752 struct reclist_sortparms *sp,
753 const char *mergekey,
756 int live_channels = 0;
758 int no_failed_query = 0;
759 int no_failed_limit = 0;
760 struct client_list *l;
762 session_log(se, YLOG_DEBUG, "Search");
766 session_enter(se, "session_search0");
767 if (se->clients_starting)
769 session_leave(se, "session_search0");
770 return PAZPAR2_NO_ERROR;
772 se->clients_starting = 1;
773 session_leave(se, "session_search0");
775 if (se->settings_modified) {
776 session_remove_cached_clients(se);
779 session_reset_active_clients(se, 0);
781 session_enter(se, "session_search");
782 se->settings_modified = 0;
787 se->mergekey = *mergekey ? xstrdup(mergekey) : 0;
792 se->rank = *rank ? xstrdup(rank) : 0;
795 session_clear_set(se, sp);
796 relevance_destroy(&se->relevance);
798 live_channels = select_targets(se, filter);
801 session_leave(se, "session_search");
802 se->clients_starting = 0;
803 return PAZPAR2_NO_TARGETS;
806 facet_limits_destroy(se->facet_limits);
807 se->facet_limits = facet_limits_create(limit);
808 if (!se->facet_limits)
811 session_leave(se, "session_search");
812 se->clients_starting = 0;
813 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
816 session_leave(se, "session_search");
818 session_alert_watch(se, SESSION_WATCH_SHOW);
819 session_alert_watch(se, SESSION_WATCH_BYTARGET);
820 session_alert_watch(se, SESSION_WATCH_TERMLIST);
821 session_alert_watch(se, SESSION_WATCH_SHOW_PREF);
823 for (l = se->clients_active; l; l = l->next)
826 struct client *cl = l->client;
827 client_parse_init(cl, 1);
828 if (prepare_map(se, client_get_database(cl)) < 0)
831 parse_ret = client_parse_query(cl, query, se->facet_limits, addinfo2);
834 else if (parse_ret == -2)
836 else if (parse_ret < 0)
837 no_working++; /* other error, such as bad CCL map */
840 client_parse_range(cl, startrecs, maxrecs);
841 client_parse_sort(cl, sp);
842 client_start_search(cl);
846 session_enter(se, "session_search2");
847 se->clients_starting = 0;
848 session_leave(se, "session_search2");
851 if (no_failed_query > 0)
854 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
856 else if (no_failed_limit > 0)
859 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
862 return PAZPAR2_NO_TARGETS;
864 return PAZPAR2_NO_ERROR;
867 // Creates a new session_database object for a database
868 static void session_init_databases_fun(void *context, struct database *db)
870 struct session *se = (struct session *) context;
871 struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
877 assert(db->settings);
878 new->settings = nmem_malloc(se->session_nmem,
879 sizeof(struct settings *) * db->num_settings);
880 new->num_settings = db->num_settings;
881 for (i = 0; i < db->num_settings; i++)
883 struct setting *setting = db->settings[i];
884 new->settings[i] = setting;
886 new->next = se->databases;
890 // Doesn't free memory associated with sdb -- nmem takes care of that
891 static void session_database_destroy(struct session_database *sdb)
896 // Initialize session_database list -- this represents this session's view
897 // of the database list -- subject to modification by the settings ws command
898 void session_init_databases(struct session *se)
901 predef_grep_databases(se, se->service, session_init_databases_fun);
904 // Probably session_init_databases_fun should be refactored instead of
906 static struct session_database *load_session_database(struct session *se,
909 struct database *db = new_database_inherit_settings(id, se->session_nmem, se->service->settings);
910 session_init_databases_fun((void*) se, db);
912 // New sdb is head of se->databases list
913 return se->databases;
916 // Find an existing session database. If not found, load it
917 static struct session_database *find_session_database(struct session *se,
920 struct session_database *sdb;
922 for (sdb = se->databases; sdb; sdb = sdb->next)
923 if (!strcmp(sdb->database->id, id))
925 return load_session_database(se, id);
928 // Apply a session override to a database
929 void session_apply_setting(struct session *se, const char *dbname,
930 const char *name, const char *value)
932 session_enter(se, "session_apply_setting");
934 struct session_database *sdb = find_session_database(se, dbname);
935 struct conf_service *service = se->service;
937 int offset = settings_create_offset(service, name);
939 expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
941 // Force later recompute of settings-driven data structures
942 // (happens when a search starts and client connections are prepared)
943 if (offset == PZ_XSLT)
945 se->settings_modified = 1;
946 for (s = sdb->settings[offset]; s; s = s->next)
947 if (!strcmp(s->name, name) &&
948 dbname && s->target && !strcmp(dbname, s->target))
952 s = nmem_malloc(se->session_nmem, sizeof(*s));
954 s->target = nmem_strdup(se->session_nmem, dbname);
955 s->name = nmem_strdup(se->session_nmem, name);
956 s->next = sdb->settings[offset];
957 sdb->settings[offset] = s;
959 s->value = nmem_strdup(se->session_nmem, value);
961 session_leave(se, "session_apply_setting");
964 void session_destroy(struct session *se)
966 struct session_database *sdb;
967 session_log(se, YLOG_LOG, "destroy");
969 session_remove_cached_clients(se);
971 for (sdb = se->databases; sdb; sdb = sdb->next)
972 session_database_destroy(sdb);
973 normalize_cache_destroy(se->normalize_cache);
974 relevance_destroy(&se->relevance);
975 reclist_destroy(se->reclist);
978 if (nmem_total(se->nmem))
979 session_log(se, YLOG_DEBUG, "NMEN operation usage %zd", nmem_total(se->nmem));
980 if (nmem_total(se->session_nmem))
981 session_log(se, YLOG_DEBUG, "NMEN session usage %zd", nmem_total(se->session_nmem));
982 facet_limits_destroy(se->facet_limits);
983 nmem_destroy(se->nmem);
984 service_destroy(se->service);
985 yaz_mutex_destroy(&se->session_mutex);
988 size_t session_get_memory_status(struct session *session) {
992 session_enter(session, "session_get_memory_status");
993 session_nmem = nmem_total(session->nmem);
994 session_leave(session, "session_get_memory_status");
999 struct session *new_session(NMEM nmem, struct conf_service *service,
1000 unsigned session_id)
1003 struct session *session = nmem_malloc(nmem, sizeof(*session));
1007 sprintf(tmp_str, "session#%u", session_id);
1009 session->session_id = session_id;
1010 session_log(session, YLOG_DEBUG, "New");
1011 session->service = service;
1012 session->relevance = 0;
1013 session->total_records = 0;
1014 session->number_of_warnings_unknown_elements = 0;
1015 session->number_of_warnings_unknown_metadata = 0;
1016 session->termlists = 0;
1017 session->reclist = reclist_create(nmem);
1018 session->clients_active = 0;
1019 session->clients_cached = 0;
1020 session->settings_modified = 0;
1021 session->session_nmem = nmem;
1022 session->nmem = nmem_create();
1023 session->databases = 0;
1024 session->sorted_results = 0;
1025 session->facet_limits = 0;
1026 session->mergekey = 0;
1028 session->clients_starting = 0;
1030 for (i = 0; i <= SESSION_WATCH_MAX; i++)
1032 session->watchlist[i].data = 0;
1033 session->watchlist[i].fun = 0;
1035 session->normalize_cache = normalize_cache_create();
1036 session->session_mutex = 0;
1037 pazpar2_mutex_create(&session->session_mutex, tmp_str);
1038 session_log(session, YLOG_LOG, "create");
1044 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf);
1046 static struct hitsbytarget *hitsbytarget_nb(struct session *se,
1047 int *count, NMEM nmem)
1049 struct hitsbytarget *res = 0;
1050 struct client_list *l;
1053 for (l = se->clients_active; l; l = l->next)
1056 res = nmem_malloc(nmem, sizeof(*res) * sz);
1058 for (l = se->clients_active; l; l = l->next)
1060 struct client *cl = l->client;
1061 WRBUF w = wrbuf_alloc();
1062 const char *name = session_setting_oneval(client_get_database(cl),
1064 res[*count].id = client_get_id(cl);
1065 res[*count].name = *name ? name : "Unknown";
1066 res[*count].hits = client_get_hits(cl);
1067 res[*count].approximation = client_get_approximation(cl);
1068 res[*count].records = client_get_num_records(cl,
1069 &res[*count].filtered,
1071 res[*count].diagnostic =
1072 client_get_diagnostic(cl, &res[*count].message,
1073 &res[*count].addinfo);
1074 res[*count].state = client_get_state_str(cl);
1075 res[*count].connected = client_get_connection(cl) ? 1 : 0;
1076 session_settings_dump(se, client_get_database(cl), w);
1077 res[*count].settings_xml = nmem_strdup(nmem, wrbuf_cstr(w));
1080 res[*count].suggestions_xml = nmem_strdup(nmem, client_get_suggestions_xml(cl, w));
1087 struct hitsbytarget *get_hitsbytarget(struct session *se, int *count, NMEM nmem)
1089 struct hitsbytarget *p;
1090 session_enter(se, "get_hitsbytarget");
1091 p = hitsbytarget_nb(se, count, nmem);
1092 session_leave(se, "get_hitsbytarget");
1096 // Compares two hitsbytarget nodes by hitcount
1097 static int cmp_ht(const void *p1, const void *p2)
1099 const struct hitsbytarget *h1 = p1;
1100 const struct hitsbytarget *h2 = p2;
1101 return h2->hits - h1->hits;
1104 // Compares two hitsbytarget nodes by hitcount
1105 static int cmp_ht_approx(const void *p1, const void *p2)
1107 const struct hitsbytarget *h1 = p1;
1108 const struct hitsbytarget *h2 = p2;
1109 return h2->approximation - h1->approximation;
1112 static int targets_termlist_nb(WRBUF wrbuf, struct session *se, int num,
1113 NMEM nmem, int version)
1115 struct hitsbytarget *ht;
1118 ht = hitsbytarget_nb(se, &count, nmem);
1120 qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht_approx);
1122 qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
1123 for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
1126 // do only print terms which have display names
1128 wrbuf_puts(wrbuf, "<term>\n");
1130 wrbuf_puts(wrbuf, "<id>");
1131 wrbuf_xmlputs(wrbuf, ht[i].id);
1132 wrbuf_puts(wrbuf, "</id>\n");
1134 wrbuf_puts(wrbuf, "<name>");
1135 if (!ht[i].name || !ht[i].name[0])
1136 wrbuf_xmlputs(wrbuf, "NO TARGET NAME");
1138 wrbuf_xmlputs(wrbuf, ht[i].name);
1139 wrbuf_puts(wrbuf, "</name>\n");
1141 wrbuf_printf(wrbuf, "<frequency>" ODR_INT_PRINTF "</frequency>\n",
1145 // Should not print if we know it isn't a approximation.
1146 wrbuf_printf(wrbuf, "<approximation>" ODR_INT_PRINTF "</approximation>\n", ht[i].approximation);
1147 wrbuf_printf(wrbuf, "<records>%d</records>\n", ht[i].records - ht[i].filtered);
1148 wrbuf_printf(wrbuf, "<filtered>%d</filtered>\n", ht[i].filtered);
1151 wrbuf_puts(wrbuf, "<state>");
1152 wrbuf_xmlputs(wrbuf, ht[i].state);
1153 wrbuf_puts(wrbuf, "</state>\n");
1155 wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n",
1157 wrbuf_puts(wrbuf, "</term>\n");
1162 void perform_termlist(struct http_channel *c, struct session *se,
1163 const char *name, int num, int version)
1166 NMEM nmem_tmp = nmem_create();
1173 nmem_strsplit(nmem_tmp, ",", name, &names, &num_names);
1175 session_enter(se, "perform_termlist");
1177 for (j = 0; j < num_names; j++)
1180 int must_generate_empty = 1; /* bug 5350 */
1182 struct named_termlist *t = se->termlists;
1183 for (; t; t = t->next)
1186 if (!strcmp(names[j], tname) || !strcmp(names[j], "*"))
1188 struct termlist_score **p = 0;
1191 wrbuf_puts(c->wrbuf, "<list name=\"");
1192 wrbuf_xmlputs(c->wrbuf, tname);
1193 wrbuf_puts(c->wrbuf, "\">\n");
1194 must_generate_empty = 0;
1196 p = termlist_highscore(t->termlist, &len, nmem_tmp);
1200 for (i = 0; i < len && i < num; i++)
1202 // prevent sending empty term elements
1203 if (!p[i]->display_term || !p[i]->display_term[0])
1206 wrbuf_puts(c->wrbuf, "<term>");
1207 wrbuf_puts(c->wrbuf, "<name>");
1208 wrbuf_xmlputs(c->wrbuf, p[i]->display_term);
1209 wrbuf_puts(c->wrbuf, "</name>");
1211 wrbuf_printf(c->wrbuf,
1212 "<frequency>%d</frequency>",
1214 wrbuf_puts(c->wrbuf, "</term>\n");
1217 wrbuf_puts(c->wrbuf, "</list>\n");
1221 if (!strcmp(names[j], tname) || !strcmp(names[j], "*"))
1223 wrbuf_puts(c->wrbuf, "<list name=\"");
1224 wrbuf_xmlputs(c->wrbuf, tname);
1225 wrbuf_puts(c->wrbuf, "\">\n");
1227 targets_termlist_nb(c->wrbuf, se, num, c->nmem, version);
1228 wrbuf_puts(c->wrbuf, "</list>\n");
1229 must_generate_empty = 0;
1231 if (must_generate_empty)
1233 wrbuf_puts(c->wrbuf, "<list name=\"");
1234 wrbuf_xmlputs(c->wrbuf, names[j]);
1235 wrbuf_puts(c->wrbuf, "\"/>\n");
1238 session_leave(se, "perform_termlist");
1239 nmem_destroy(nmem_tmp);
1242 #ifdef MISSING_HEADERS
1243 void report_nmem_stats(void)
1245 size_t in_use, is_free;
1247 nmem_get_memory_in_use(&in_use);
1248 nmem_get_memory_free(&is_free);
1250 yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
1251 (long) in_use, (long) is_free);
1255 struct record_cluster *show_single_start(struct session *se, const char *id,
1256 struct record_cluster **prev_r,
1257 struct record_cluster **next_r)
1259 struct record_cluster *r = 0;
1261 session_enter(se, "show_single_start");
1264 reclist_limit(se->reclist, se, 1);
1266 reclist_enter(se->reclist);
1267 while ((r = reclist_read_record(se->reclist)))
1269 if (!strcmp(r->recid, id))
1271 *next_r = reclist_read_record(se->reclist);
1276 reclist_leave(se->reclist);
1278 session_leave(se, "show_single_start");
1282 void show_single_stop(struct session *se, struct record_cluster *rec)
1284 session_leave(se, "show_single_stop");
1288 int session_fetch_more(struct session *se)
1290 struct client_list *l;
1293 for (l = se->clients_active; l; l = l->next)
1295 struct client *cl = l->client;
1296 if (client_get_state(cl) == Client_Idle)
1298 if (client_fetch_more(cl))
1300 session_log(se, YLOG_LOG, "%s: more to fetch",
1307 int ingest_failures;
1308 int record_failures;
1309 int num = client_get_num_records(
1310 cl, &filtered, &ingest_failures, &record_failures);
1312 session_log(se, YLOG_LOG, "%s: hits=" ODR_INT_PRINTF
1313 " fetched=%d filtered=%d",
1315 client_get_hits(cl),
1317 if (ingest_failures || record_failures)
1319 session_log(se, YLOG_WARN, "%s:"
1320 " ingest failures=%d record failures=%d",
1322 ingest_failures, record_failures);
1328 session_log(se, YLOG_LOG, "%s: no fetch due to state=%s",
1329 client_get_id(cl), client_get_state_str(cl));
1336 struct record_cluster **show_range_start(struct session *se,
1337 struct reclist_sortparms *sp,
1338 int start, int *num, int *total,
1339 Odr_int *sumhits, Odr_int *approx_hits,
1340 void (*show_records_ready)(void *data),
1341 struct http_channel *chan)
1343 struct record_cluster **recs = 0;
1344 struct reclist_sortparms *spp;
1345 struct client_list *l;
1348 yaz_timing_t t = yaz_timing_create();
1350 session_enter(se, "show_range_start");
1354 reclist_limit(se->reclist, se, 0);
1357 for (spp = sp; spp; spp = spp->next)
1358 if (spp->type == Metadata_type_relevance)
1360 relevance_prepare_read(se->relevance, se->reclist);
1363 for (l = se->clients_active; l; l = l->next) {
1364 *sumhits += client_get_hits(l->client);
1365 *approx_hits += client_get_approximation(l->client);
1368 reclist_sort(se->reclist, sp);
1370 reclist_enter(se->reclist);
1371 *total = reclist_get_num_records(se->reclist);
1373 for (l = se->clients_active; l; l = l->next)
1374 client_update_show_stat(l->client, 0);
1376 for (i = 0; i < start; i++)
1378 struct record_cluster *r = reclist_read_record(se->reclist);
1386 struct record *rec = r->records;
1387 for (;rec; rec = rec->next)
1388 client_update_show_stat(rec->client, 1);
1391 recs = nmem_malloc(se->nmem, (*num > 0 ? *num : 1) * sizeof(*recs));
1392 for (i = 0; i < *num; i++)
1394 struct record_cluster *r = reclist_read_record(se->reclist);
1402 struct record *rec = r->records;
1403 for (;rec; rec = rec->next)
1404 client_update_show_stat(rec->client, 1);
1408 reclist_leave(se->reclist);
1411 session_log(se, YLOG_LOG, "show %6.5f %3.2f %3.2f",
1412 yaz_timing_get_real(t), yaz_timing_get_user(t),
1413 yaz_timing_get_sys(t));
1414 yaz_timing_destroy(&t);
1417 if (!session_fetch_more(se))
1418 session_log(se, YLOG_LOG, "can not fetch more");
1421 show_range_stop(se, recs);
1422 session_log(se, YLOG_LOG, "fetching more in progress");
1423 if (session_set_watch(se, SESSION_WATCH_SHOW,
1424 show_records_ready, chan, chan))
1426 session_log(se, YLOG_WARN, "Ignoring show block");
1427 session_enter(se, "show_range_start");
1431 session_log(se, YLOG_LOG, "session watch OK");
1438 void show_range_stop(struct session *se, struct record_cluster **recs)
1440 session_leave(se, "show_range_stop");
1443 void statistics(struct session *se, struct statistics *stat)
1445 struct client_list *l;
1448 memset(stat, 0, sizeof(*stat));
1450 for (l = se->clients_active; l; l = l->next)
1452 struct client *cl = l->client;
1453 if (!client_get_connection(cl))
1454 stat->num_no_connection++;
1455 stat->num_hits += client_get_hits(cl);
1456 switch (client_get_state(cl))
1458 case Client_Connecting: stat->num_connecting++; break;
1459 case Client_Working: stat->num_working++; break;
1460 case Client_Idle: stat->num_idle++; break;
1461 case Client_Failed: stat->num_failed++; break;
1462 case Client_Error: stat->num_error++; break;
1467 stat->num_records = se->total_records;
1469 stat->num_clients = count;
1472 static struct record_metadata *record_metadata_init(
1473 NMEM nmem, const char *value, enum conf_metadata_type type,
1474 struct _xmlAttr *attr)
1476 struct record_metadata *rec_md = record_metadata_create(nmem);
1477 struct record_metadata_attr **attrp = &rec_md->attributes;
1479 for (; attr; attr = attr->next)
1481 if (attr->children && attr->children->content)
1483 if (strcmp((const char *) attr->name, "type")
1484 && strcmp((const char *) attr->name, "empty"))
1485 { /* skip the "type" + "empty" attribute..
1486 The "Type" is already part of the element in output
1487 (md-%s) and so repeating it here is redundant */
1488 *attrp = nmem_malloc(nmem, sizeof(**attrp));
1490 nmem_strdup(nmem, (const char *) attr->name);
1492 nmem_strdup(nmem, (const char *) attr->children->content);
1493 attrp = &(*attrp)->next;
1501 case Metadata_type_generic:
1502 case Metadata_type_skiparticle:
1503 if (strstr(value, "://")) /* looks like a URL */
1504 rec_md->data.text.disp = nmem_strdup(nmem, value);
1506 rec_md->data.text.disp =
1507 normalize7bit_generic(nmem_strdup(nmem, value), " ,/.:([");
1508 rec_md->data.text.sort = 0;
1509 rec_md->data.text.snippet = 0;
1511 case Metadata_type_year:
1512 case Metadata_type_date:
1517 if (type == Metadata_type_date)
1519 if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
1522 rec_md->data.number.min = first;
1523 rec_md->data.number.max = last;
1526 case Metadata_type_float:
1527 rec_md->data.fnumber = atof(value);
1529 case Metadata_type_relevance:
1530 case Metadata_type_position:
1536 static void mergekey_norm_wr(pp2_charset_fact_t charsets,
1537 WRBUF norm_wr, const char *value)
1539 const char *norm_str;
1540 pp2_charset_token_t prt =
1541 pp2_charset_token_create(charsets, "mergekey");
1543 pp2_charset_token_first(prt, value, 0);
1544 while ((norm_str = pp2_charset_token_next(prt)))
1548 if (wrbuf_len(norm_wr))
1549 wrbuf_puts(norm_wr, " ");
1550 wrbuf_puts(norm_wr, norm_str);
1553 pp2_charset_token_destroy(prt);
1556 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
1557 struct conf_service *service, WRBUF norm_wr)
1561 for (n = root->children; n; n = n->next)
1563 if (n->type != XML_ELEMENT_NODE)
1565 if (!strcmp((const char *) n->name, "metadata"))
1567 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1569 yaz_log(YLOG_FATAL, "Missing type attribute on metadata element. Skipping!");
1571 else if (!strcmp(name, (const char *) type))
1573 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
1574 if (value && *value)
1576 if (wrbuf_len(norm_wr) > 0)
1577 wrbuf_puts(norm_wr, " ");
1578 wrbuf_puts(norm_wr, name);
1579 mergekey_norm_wr(service->charsets, norm_wr,
1580 (const char *) value);
1592 static const char *get_mergekey(xmlDoc *doc, xmlNode *root,
1593 struct client *cl, int record_no,
1594 struct conf_service *service, NMEM nmem,
1595 const char *session_mergekey)
1597 char *mergekey_norm = 0;
1598 WRBUF norm_wr = wrbuf_alloc();
1601 if (session_mergekey)
1605 nmem_strsplit_escape2(nmem, ",", session_mergekey, &values,
1608 for (i = 0; i < num; i++)
1609 get_mergekey_from_doc(doc, root, values[i], service, norm_wr);
1611 else if ((mergekey = xmlGetProp(root, (xmlChar *) "mergekey")))
1613 mergekey_norm_wr(service->charsets, norm_wr, (const char *) mergekey);
1618 /* no mergekey defined in XSL. Look for mergekey metadata instead */
1620 for (field_id = 0; field_id < service->num_metadata; field_id++)
1622 struct conf_metadata *ser_md = &service->metadata[field_id];
1623 if (ser_md->mergekey != Metadata_mergekey_no)
1625 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1627 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1629 /* no mergekey on this one and it is required..
1630 Generate unique key instead */
1631 wrbuf_rewind(norm_wr);
1638 /* generate unique key if none is not generated already or is empty */
1639 if (wrbuf_len(norm_wr) == 0)
1641 wrbuf_printf(norm_wr, "position: %s-%d",
1642 client_get_id(cl), record_no);
1646 const char *lead = "content: ";
1647 wrbuf_insert(norm_wr, 0, lead, strlen(lead));
1649 if (wrbuf_len(norm_wr) > 0)
1650 mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1651 wrbuf_destroy(norm_wr);
1652 return mergekey_norm;
1655 /** \brief see if metadata for pz:recordfilter exists
1656 \param root xml root element of normalized record
1657 \param sdb session database for client
1658 \retval 0 if there is no metadata for pz:recordfilter
1659 \retval 1 if there is metadata for pz:recordfilter
1661 If there is no pz:recordfilter defined, this function returns 1
1665 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1670 s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1675 for (n = root->children; n; n = n->next)
1677 if (n->type != XML_ELEMENT_NODE)
1679 if (!strcmp((const char *) n->name, "metadata"))
1681 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1688 if ((eq = strchr(s, '=')))
1690 else if ((eq = strchr(s, '~')))
1696 if (len == strlen((const char *)type) &&
1697 !memcmp((const char *) type, s, len))
1699 xmlChar *value = xmlNodeGetContent(n);
1700 if (value && *value)
1703 (substring && strstr((const char *) value, eq+1)) ||
1704 (!substring && !strcmp((const char *) value, eq + 1)))
1716 static int ingest_to_cluster(struct client *cl,
1720 struct record_metadata_attr *mergekey);
1722 static int ingest_sub_record(struct client *cl, xmlDoc *xdoc, xmlNode *root,
1723 int record_no, NMEM nmem,
1724 struct session_database *sdb,
1725 struct record_metadata_attr *mergekeys)
1728 struct session *se = client_get_session(cl);
1730 if (!check_record_filter(root, sdb))
1732 session_log(se, YLOG_LOG,
1733 "Filtered out record no %d from %s",
1734 record_no, sdb->database->id);
1737 session_enter(se, "ingest_sub_record");
1738 if (client_get_session(cl) == se && se->relevance)
1739 ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekeys);
1740 session_leave(se, "ingest_sub_record");
1745 /** \brief ingest XML record
1746 \param cl client holds the result set for record
1747 \param rec record buffer (0 terminated)
1748 \param record_no record position (1, 2, ..)
1749 \param nmem working NMEM
1754 int ingest_record(struct client *cl, const char *rec,
1755 int record_no, NMEM nmem)
1757 struct session *se = client_get_session(cl);
1758 struct session_database *sdb = client_get_database(cl);
1759 struct conf_service *service = se->service;
1760 xmlDoc *xdoc = normalize_record(se, sdb, service, rec, nmem);
1761 int r = ingest_xml_record(cl, xdoc, record_no, nmem, 0);
1762 client_store_xdoc(cl, record_no, xdoc);
1766 int ingest_xml_record(struct client *cl, xmlDoc *xdoc,
1767 int record_no, NMEM nmem, int cached_copy)
1769 struct session *se = client_get_session(cl);
1770 struct session_database *sdb = client_get_database(cl);
1771 struct conf_service *service = se->service;
1777 if (global_parameters.dump_records)
1779 session_log(se, YLOG_LOG, "Normalized record from %s",
1784 root = xmlDocGetRootElement(xdoc);
1786 if (!strcmp((const char *) root->name, "cluster"))
1788 int no_merge_keys = 0;
1789 int no_merge_dups = 0;
1791 struct record_metadata_attr *mk = 0;
1793 for (sroot = root->children; sroot; sroot = sroot->next)
1794 if (sroot->type == XML_ELEMENT_NODE &&
1795 !strcmp((const char *) sroot->name, "record"))
1797 struct record_metadata_attr **mkp;
1798 const char *mergekey_norm =
1799 get_mergekey(xdoc, sroot, cl, record_no, service, nmem,
1806 for (mkp = &mk; *mkp; mkp = &(*mkp)->next)
1807 if (!strcmp((*mkp)->value, mergekey_norm))
1811 *mkp = (struct record_metadata_attr*)
1812 nmem_malloc(nmem, sizeof(**mkp));
1814 (*mkp)->value = nmem_strdup(nmem, mergekey_norm);
1821 if (no_merge_keys > 1 || no_merge_dups > 0)
1823 yaz_log(YLOG_LOG, "Got %d mergekeys, %d dups for position %d",
1824 no_merge_keys, no_merge_dups, record_no);
1826 for (sroot = root->children; !r && sroot; sroot = sroot->next)
1827 if (sroot->type == XML_ELEMENT_NODE &&
1828 !strcmp((const char *) sroot->name, "record"))
1831 insert_settings_values(sdb, xdoc, root, service);
1832 r = ingest_sub_record(cl, xdoc, sroot, record_no, nmem, sdb,
1836 else if (!strcmp((const char *) root->name, "record"))
1838 const char *mergekey_norm =
1839 get_mergekey(xdoc, root, cl, record_no, service, nmem,
1843 struct record_metadata_attr *mk = (struct record_metadata_attr*)
1844 nmem_malloc(nmem, sizeof(*mk));
1846 mk->value = nmem_strdup(nmem, mergekey_norm);
1850 insert_settings_values(sdb, xdoc, root, service);
1851 r = ingest_sub_record(cl, xdoc, root, record_no, nmem, sdb, mk);
1856 session_log(se, YLOG_WARN, "Bad pz root element: %s",
1857 (const char *) root->name);
1864 // struct conf_metadata *ser_md = &service->metadata[md_field_id];
1865 // struct record_metadata *rec_md = record->metadata[md_field_id];
1866 static int match_metadata_local(struct conf_service *service,
1867 struct conf_metadata *ser_md,
1868 struct record_metadata *rec_md0,
1869 char **values, int num_v)
1872 struct record_metadata *rec_md = rec_md0;
1874 WRBUF text_wr = wrbuf_alloc();
1875 for (i = 0; i < num_v; )
1879 if (ser_md->type == Metadata_type_year
1880 || ser_md->type == Metadata_type_date)
1882 int y = atoi(values[i]);
1883 if (y >= rec_md->data.number.min
1884 && y <= rec_md->data.number.max)
1891 val_wr = wrbuf_alloc();
1892 mergekey_norm_wr(service->charsets, val_wr, values[i]);
1894 wrbuf_rewind(text_wr);
1895 mergekey_norm_wr(service->charsets, text_wr,
1896 rec_md->data.text.disp);
1897 if (!strcmp(wrbuf_cstr(val_wr), wrbuf_cstr(text_wr)))
1900 rec_md = rec_md->next;
1905 wrbuf_destroy(val_wr);
1910 wrbuf_destroy(val_wr);
1911 wrbuf_destroy(text_wr);
1912 return i < num_v ? 1 : 0;
1915 int session_check_cluster_limit(struct session *se, struct record_cluster *rec)
1918 struct conf_service *service = se->service;
1922 NMEM nmem_tmp = nmem_create();
1924 for (i = 0; (name = facet_limits_get(se->facet_limits, i, &value)); i++)
1927 for (j = 0; j < service->num_metadata; j++)
1929 struct conf_metadata *md = service->metadata + j;
1930 if (!strcmp(md->name, name) && md->limitcluster)
1935 conf_service_metadata_field_id(service,
1938 if (md_field_id < 0)
1944 nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
1947 if (!match_metadata_local(service,
1948 &service->metadata[md_field_id],
1949 rec->metadata[md_field_id],
1958 nmem_destroy(nmem_tmp);
1962 // Skip record on non-zero
1963 static int check_limit_local(struct client *cl,
1964 struct record *record,
1967 int skip_record = 0;
1968 struct session *se = client_get_session(cl);
1969 struct conf_service *service = se->service;
1970 NMEM nmem_tmp = nmem_create();
1971 struct session_database *sdb = client_get_database(cl);
1973 while (!skip_record)
1979 client_get_facet_limit_local(cl, sdb, &l, nmem_tmp,
1984 if (!strcmp(name, "*"))
1986 for (md_field_id = 0; md_field_id < service->num_metadata;
1989 if (match_metadata_local(
1991 &service->metadata[md_field_id],
1992 record->metadata[md_field_id],
1996 if (md_field_id == service->num_metadata)
2001 md_field_id = conf_service_metadata_field_id(service, name);
2002 if (md_field_id < 0)
2007 if (!match_metadata_local(
2009 &service->metadata[md_field_id],
2010 record->metadata[md_field_id],
2017 nmem_destroy(nmem_tmp);
2021 static int ingest_to_cluster(struct client *cl,
2025 struct record_metadata_attr *merge_keys)
2030 struct session *se = client_get_session(cl);
2031 struct conf_service *service = se->service;
2032 int term_factor = 1;
2033 struct record_cluster *cluster;
2034 struct record_metadata **metadata0;
2035 struct session_database *sdb = client_get_database(cl);
2036 NMEM ingest_nmem = 0;
2037 char **rank_values = 0;
2039 struct record *record = record_create(se->nmem,
2040 service->num_metadata,
2041 service->num_sortkeys, cl,
2044 for (n = root->children; n; n = n->next)
2052 if (n->type != XML_ELEMENT_NODE)
2054 if (!strcmp((const char *) n->name, "metadata"))
2056 struct conf_metadata *ser_md = 0;
2057 struct record_metadata **wheretoput = 0;
2058 struct record_metadata *rec_md = 0;
2059 int md_field_id = -1;
2061 type = xmlGetProp(n, (xmlChar *) "type");
2062 value = xmlNodeListGetString(xdoc, n->children, 1);
2065 if (!value || !*value)
2067 xmlChar *empty = xmlGetProp(n, (xmlChar *) "empty");
2075 = conf_service_metadata_field_id(service, (const char *) type);
2076 if (md_field_id < 0)
2078 if (se->number_of_warnings_unknown_metadata == 0)
2080 session_log(se, YLOG_WARN,
2081 "Ignoring unknown metadata element: %s", type);
2083 se->number_of_warnings_unknown_metadata++;
2087 ser_md = &service->metadata[md_field_id];
2089 // non-merged metadata
2090 rec_md = record_metadata_init(se->nmem, (const char *) value,
2091 ser_md->type, n->properties);
2094 session_log(se, YLOG_WARN, "bad metadata data '%s' "
2095 "for element '%s'", value, type);
2099 if (ser_md->type == Metadata_type_generic)
2101 WRBUF w = wrbuf_alloc();
2102 if (relevance_snippet(se->relevance,
2103 (char*) value, ser_md->name, w))
2104 rec_md->data.text.snippet = nmem_strdup(se->nmem,
2110 wheretoput = &record->metadata[md_field_id];
2112 wheretoput = &(*wheretoput)->next;
2113 *wheretoput = rec_md;
2117 if (check_limit_local(cl, record, record_no))
2125 cluster = reclist_insert(se->reclist, se->relevance, service, record,
2126 merge_keys, &se->total_merged);
2133 return 0; // complete match with existing record
2137 const char *use_term_factor_str =
2138 session_setting_oneval(sdb, PZ_TERMLIST_TERM_FACTOR);
2139 if (use_term_factor_str && use_term_factor_str[0] == '1')
2141 int maxrecs = client_get_maxrecs(cl);
2142 int hits = (int) client_get_hits(cl);
2143 term_factor = MAX(hits, maxrecs) / MAX(1, maxrecs);
2144 assert(term_factor >= 1);
2145 session_log(se, YLOG_DEBUG, "Using term factor: %d (%d / %d)",
2146 term_factor, MAX(hits, maxrecs), MAX(1, maxrecs));
2150 if (global_parameters.dump_records)
2151 session_log(se, YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
2152 sdb->database->id, record_no);
2154 // original metadata, to check if first existence of a field
2155 metadata0 = xmalloc(sizeof(*metadata0) * service->num_metadata);
2156 memcpy(metadata0, cluster->metadata,
2157 sizeof(*metadata0) * service->num_metadata);
2159 ingest_nmem = nmem_create();
2162 yaz_log(YLOG_LOG, "local in sort : %s", se->rank);
2163 nmem_strsplit_escape2(ingest_nmem, ",", se->rank, &rank_values,
2164 &rank_num, 1, '\\', 1);
2167 // now parsing XML record and adding data to cluster or record metadata
2168 for (n = root->children; n; n = n->next)
2170 pp2_charset_token_t prt;
2177 if (n->type != XML_ELEMENT_NODE)
2179 if (!strcmp((const char *) n->name, "metadata"))
2181 struct conf_metadata *ser_md = 0;
2182 struct conf_sortkey *ser_sk = 0;
2183 struct record_metadata **wheretoput = 0;
2184 struct record_metadata *rec_md = 0;
2185 int md_field_id = -1;
2186 int sk_field_id = -1;
2187 const char *rank = 0;
2188 xmlChar *xml_rank = 0;
2190 type = xmlGetProp(n, (xmlChar *) "type");
2191 value = xmlNodeListGetString(xdoc, n->children, 1);
2193 if (!type || !value || !*value)
2197 = conf_service_metadata_field_id(service, (const char *) type);
2198 if (md_field_id < 0)
2201 ser_md = &service->metadata[md_field_id];
2203 if (ser_md->sortkey_offset >= 0)
2205 sk_field_id = ser_md->sortkey_offset;
2206 ser_sk = &service->sortkeys[sk_field_id];
2210 rec_md = record_metadata_init(se->nmem, (const char *) value,
2213 // see if the field was not in cluster already (from beginning)
2221 for (i = 0; i < rank_num; i++)
2223 const char *val = rank_values[i];
2224 const char *cp = strchr(val, '=');
2227 if ((cp - val) == strlen((const char *) type)
2228 && !memcmp(val, type, cp - val))
2237 xml_rank = xmlGetProp(n, (xmlChar *) "rank");
2238 rank = xml_rank ? (const char *) xml_rank : ser_md->rank;
2241 wheretoput = &cluster->metadata[md_field_id];
2243 if (ser_md->merge == Metadata_merge_first)
2245 if (!metadata0[md_field_id])
2248 wheretoput = &(*wheretoput)->next;
2249 *wheretoput = rec_md;
2252 else if (ser_md->merge == Metadata_merge_unique)
2256 if (!strcmp((const char *) (*wheretoput)->data.text.disp,
2257 rec_md->data.text.disp))
2259 wheretoput = &(*wheretoput)->next;
2262 *wheretoput = rec_md;
2264 else if (ser_md->merge == Metadata_merge_longest)
2267 || strlen(rec_md->data.text.disp)
2268 > strlen((*wheretoput)->data.text.disp))
2270 *wheretoput = rec_md;
2273 const char *sort_str = 0;
2275 ser_sk->type == Metadata_type_skiparticle;
2277 if (!cluster->sortkeys[sk_field_id])
2278 cluster->sortkeys[sk_field_id] =
2279 nmem_malloc(se->nmem,
2280 sizeof(union data_types));
2283 pp2_charset_token_create(service->charsets, "sort");
2285 pp2_charset_token_first(prt, rec_md->data.text.disp,
2288 pp2_charset_token_next(prt);
2290 sort_str = pp2_get_sort(prt);
2292 cluster->sortkeys[sk_field_id]->text.disp =
2293 rec_md->data.text.disp;
2296 sort_str = rec_md->data.text.disp;
2297 session_log(se, YLOG_WARN,
2298 "Could not make sortkey. Bug #1858");
2300 cluster->sortkeys[sk_field_id]->text.sort =
2301 nmem_strdup(se->nmem, sort_str);
2302 pp2_charset_token_destroy(prt);
2306 else if (ser_md->merge == Metadata_merge_all)
2309 wheretoput = &(*wheretoput)->next;
2310 *wheretoput = rec_md;
2312 else if (ser_md->merge == Metadata_merge_range)
2316 *wheretoput = rec_md;
2318 cluster->sortkeys[sk_field_id]
2323 int this_min = rec_md->data.number.min;
2324 int this_max = rec_md->data.number.max;
2325 if (this_min < (*wheretoput)->data.number.min)
2326 (*wheretoput)->data.number.min = this_min;
2327 if (this_max > (*wheretoput)->data.number.max)
2328 (*wheretoput)->data.number.max = this_max;
2332 // ranking of _all_ fields enabled ...
2335 relevance_countwords(se->relevance, cluster,
2336 (char *) value, rank, ser_md->name);
2338 // construct facets ... unless the client already has reported them
2339 if (ser_md->termlist && !client_has_facet(cl, (char *) type))
2341 if (ser_md->type == Metadata_type_year)
2344 sprintf(year, "%d", rec_md->data.number.max);
2346 add_facet(se, (char *) type, year, term_factor);
2347 if (rec_md->data.number.max != rec_md->data.number.min)
2349 sprintf(year, "%d", rec_md->data.number.min);
2350 add_facet(se, (char *) type, year, term_factor);
2354 add_facet(se, (char *) type, (char *) value, term_factor);
2366 if (se->number_of_warnings_unknown_elements == 0)
2367 session_log(se, YLOG_WARN,
2368 "Unexpected element in internal record: %s", n->name);
2369 se->number_of_warnings_unknown_elements++;
2377 nmem_destroy(ingest_nmem);
2379 relevance_donerecord(se->relevance, cluster);
2380 se->total_records++;
2385 void session_log(struct session *s, int level, const char *fmt, ...)
2391 yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
2392 yaz_log(level, "Session %u: %s", s ? s->session_id : 0, buf);
2400 * c-file-style: "Stroustrup"
2401 * indent-tabs-mode: nil
2403 * vim: shiftwidth=4 tabstop=8 expandtab