1 /* This file is part of Pazpar2.
2 Copyright (C) 2006-2011 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>
59 #include <yaz/gettimeofday.h>
63 #include <yaz/timing.h>
67 #include "parameters.h"
71 #include "termlists.h"
73 #include "relevance.h"
77 #include "normalize7bit.h"
79 #define TERMLIST_HIGH_SCORE 25
83 #define MAX(a,b) ((a)>(b)?(a):(b))
85 // Note: Some things in this structure will eventually move to configuration
86 struct parameters global_parameters =
90 0, // predictable sessions
94 struct client *client;
95 struct client_list *next;
98 /* session counting (1) , disable client counting (0) */
99 static YAZ_MUTEX g_session_mutex = 0;
100 static int no_sessions = 0;
101 static int no_session_total = 0;
103 static int session_use(int delta)
106 if (!g_session_mutex)
107 yaz_mutex_create(&g_session_mutex);
108 yaz_mutex_enter(g_session_mutex);
109 no_sessions += delta;
111 no_session_total += delta;
112 sessions = no_sessions;
113 yaz_mutex_leave(g_session_mutex);
114 yaz_log(YLOG_DEBUG, "%s sessions=%d", delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), no_sessions);
118 int sessions_count(void)
120 return session_use(0);
123 int session_count_total(void)
126 if (!g_session_mutex)
128 yaz_mutex_enter(g_session_mutex);
129 total = no_session_total;
130 yaz_mutex_leave(g_session_mutex);
134 static void log_xml_doc(xmlDoc *doc)
136 FILE *lf = yaz_log_file();
139 #if LIBXML_VERSION >= 20600
140 xmlDocDumpFormatMemory(doc, &result, &len, 1);
142 xmlDocDumpMemory(doc, &result, &len);
146 (void) fwrite(result, 1, len, lf);
152 static void session_enter(struct session *s)
154 yaz_mutex_enter(s->session_mutex);
157 static void session_leave(struct session *s)
159 yaz_mutex_leave(s->session_mutex);
162 void add_facet(struct session *s, const char *type, const char *value, int count)
164 struct conf_service *service = s->service;
165 pp2_charset_token_t prt;
166 const char *facet_component;
167 WRBUF facet_wrbuf = wrbuf_alloc();
168 WRBUF display_wrbuf = wrbuf_alloc();
170 const char *icu_chain_id = 0;
172 for (i = 0; i < service->num_metadata; i++)
173 if (!strcmp((service->metadata + i)->name, type))
174 icu_chain_id = (service->metadata + i)->facetrule;
176 icu_chain_id = "facet";
177 prt = pp2_charset_token_create(service->charsets, icu_chain_id);
180 yaz_log(YLOG_FATAL, "Unknown ICU chain '%s' for facet of type '%s'",
182 wrbuf_destroy(facet_wrbuf);
183 wrbuf_destroy(display_wrbuf);
186 pp2_charset_token_first(prt, value, 0);
187 while ((facet_component = pp2_charset_token_next(prt)))
189 const char *display_component;
190 if (*facet_component)
192 if (wrbuf_len(facet_wrbuf))
193 wrbuf_puts(facet_wrbuf, " ");
194 wrbuf_puts(facet_wrbuf, facet_component);
196 display_component = pp2_get_display(prt);
197 if (display_component)
199 if (wrbuf_len(display_wrbuf))
200 wrbuf_puts(display_wrbuf, " ");
201 wrbuf_puts(display_wrbuf, display_component);
204 pp2_charset_token_destroy(prt);
206 if (wrbuf_len(facet_wrbuf))
209 for (i = 0; i < s->num_termlists; i++)
210 if (!strcmp(s->termlists[i].name, type))
212 if (i == s->num_termlists)
214 if (i == SESSION_MAX_TERMLISTS)
216 session_log(s, YLOG_FATAL, "Too many termlists");
217 wrbuf_destroy(facet_wrbuf);
218 wrbuf_destroy(display_wrbuf);
222 s->termlists[i].name = nmem_strdup(s->nmem, type);
223 s->termlists[i].termlist
224 = termlist_create(s->nmem, TERMLIST_HIGH_SCORE);
225 s->num_termlists = i + 1;
229 session_log(s, YLOG_DEBUG, "Facets for %s: %s norm:%s (%d)", type, value, wrbuf_cstr(facet_wrbuf), count);
231 termlist_insert(s->termlists[i].termlist, wrbuf_cstr(display_wrbuf),
232 wrbuf_cstr(facet_wrbuf), count);
234 wrbuf_destroy(facet_wrbuf);
235 wrbuf_destroy(display_wrbuf);
238 static xmlDoc *record_to_xml(struct session *se,
239 struct session_database *sdb, const char *rec)
241 struct database *db = sdb->database;
244 rdoc = xmlParseMemory(rec, strlen(rec));
248 session_log(se, YLOG_FATAL, "Non-wellformed XML received from %s",
253 if (global_parameters.dump_records)
255 session_log(se, YLOG_LOG, "Un-normalized record from %s", db->url);
262 #define MAX_XSLT_ARGS 16
264 // Add static values from session database settings if applicable
265 static void insert_settings_parameters(struct session_database *sdb,
266 struct conf_service *service,
274 for (i = 0; i < service->num_metadata; i++)
276 struct conf_metadata *md = &service->metadata[i];
279 if (md->setting == Metadata_setting_parameter &&
280 (setting = settings_lookup_offset(service, md->name)) >= 0)
282 const char *val = session_setting_oneval(sdb, setting);
283 if (val && nparms < MAX_XSLT_ARGS)
286 int len = strlen(val);
287 buf = nmem_malloc(nmem, len + 3);
289 strcpy(buf + 1, val);
292 parms[offset++] = md->name;
293 parms[offset++] = buf;
301 // Add static values from session database settings if applicable
302 static void insert_settings_values(struct session_database *sdb, xmlDoc *doc,
303 struct conf_service *service)
307 for (i = 0; i < service->num_metadata; i++)
309 struct conf_metadata *md = &service->metadata[i];
312 if (md->setting == Metadata_setting_postproc &&
313 (offset = settings_lookup_offset(service, md->name)) >= 0)
315 const char *val = session_setting_oneval(sdb, offset);
318 xmlNode *r = xmlDocGetRootElement(doc);
319 xmlNode *n = xmlNewTextChild(r, 0, (xmlChar *) "metadata",
321 xmlSetProp(n, (xmlChar *) "type", (xmlChar *) md->name);
327 static xmlDoc *normalize_record(struct session *se,
328 struct session_database *sdb,
329 struct conf_service *service,
330 const char *rec, NMEM nmem)
332 xmlDoc *rdoc = record_to_xml(se, sdb, rec);
336 char *parms[MAX_XSLT_ARGS*2+1];
338 insert_settings_parameters(sdb, service, parms, nmem);
340 if (normalize_record_transform(sdb->map, &rdoc, (const char **)parms))
342 session_log(se, YLOG_WARN, "Normalize failed from %s",
347 insert_settings_values(sdb, rdoc, service);
349 if (global_parameters.dump_records)
351 session_log(se, YLOG_LOG, "Normalized record from %s",
360 void session_settings_dump(struct session *se,
361 struct session_database *db,
366 int i, num = db->num_settings;
367 for (i = 0; i < num; i++)
369 struct setting *s = db->settings[i];
370 for (;s ; s = s->next)
372 wrbuf_puts(w, "<set name=\"");
373 wrbuf_xmlputs(w, s->name);
374 wrbuf_puts(w, "\" value=\"");
375 wrbuf_xmlputs(w, s->value);
376 wrbuf_puts(w, "\"/>");
384 // Retrieve first defined value for 'name' for given database.
385 // Will be extended to take into account user associated with session
386 const char *session_setting_oneval(struct session_database *db, int offset)
388 if (offset >= db->num_settings || !db->settings[offset])
390 return db->settings[offset]->value;
393 // Prepare XSLT stylesheets for record normalization
394 // Structures are allocated on the session_wide nmem to avoid having
395 // to recompute this for every search. This would lead
396 // to leaking if a single session was to repeatedly change the PZ_XSLT
397 // setting. However, this is not a realistic use scenario.
398 static int prepare_map(struct session *se, struct session_database *sdb)
404 session_log(se, YLOG_WARN, "No settings on %s", sdb->database->url);
407 if ((s = session_setting_oneval(sdb, PZ_XSLT)))
409 char auto_stylesheet[256];
411 if (!strcmp(s, "auto"))
413 const char *request_syntax = session_setting_oneval(
414 sdb, PZ_REQUESTSYNTAX);
418 yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet),
419 "%s.xsl", request_syntax);
420 for (cp = auto_stylesheet; *cp; cp++)
422 /* deliberately only consider ASCII */
423 if (*cp > 32 && *cp < 127)
430 session_log(se, YLOG_WARN,
431 "No pz:requestsyntax for auto stylesheet");
434 sdb->map = normalize_cache_get(se->normalize_cache,
435 se->service->server->config, s);
442 // This analyzes settings and recomputes any supporting data structures
444 static int prepare_session_database(struct session *se,
445 struct session_database *sdb)
449 session_log(se, YLOG_WARN,
450 "No settings associated with %s", sdb->database->url);
453 if (sdb->settings[PZ_XSLT] && !sdb->map)
455 if (prepare_map(se, sdb) < 0)
461 // called if watch should be removed because http_channel is to be destroyed
462 static void session_watch_cancel(void *data, struct http_channel *c,
465 struct session_watchentry *ent = data;
472 // set watch. Returns 0=OK, -1 if watch is already set
473 int session_set_watch(struct session *s, int what,
474 session_watchfun fun, void *data,
475 struct http_channel *chan)
479 if (s->watchlist[what].fun)
484 s->watchlist[what].fun = fun;
485 s->watchlist[what].data = data;
486 s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
487 session_watch_cancel);
494 void session_alert_watch(struct session *s, int what)
498 if (s->watchlist[what].fun)
500 /* our watch is no longer associated with http_channel */
502 session_watchfun fun;
504 http_remove_observer(s->watchlist[what].obs);
505 fun = s->watchlist[what].fun;
506 data = s->watchlist[what].data;
508 /* reset watch before fun is invoked - in case fun wants to set
510 s->watchlist[what].fun = 0;
511 s->watchlist[what].data = 0;
512 s->watchlist[what].obs = 0;
515 session_log(s, YLOG_DEBUG,
516 "Alert Watch: %d calling function: %p", what, fun);
523 //callback for grep_databases
524 static void select_targets_callback(struct session *se,
525 struct session_database *db)
527 struct client *cl = client_create();
528 struct client_list *l;
529 const char *url = session_setting_oneval(db, PZ_URL);
532 url = db->database->url;
534 resolve_database(se->service, db->database, url);
536 client_set_database(cl, db);
538 client_set_session(cl, se);
540 l = xmalloc(sizeof(*l));
542 l->next = se->clients;
546 static void session_remove_clients(struct session *se)
548 struct client_list *l;
557 struct client_list *l_next = l->next;
558 client_lock(l->client);
559 client_set_session(l->client, 0);
560 client_set_database(l->client, 0);
561 client_unlock(l->client);
562 client_destroy(l->client);
568 // Associates a set of clients with a session;
569 // Note: Session-databases represent databases with per-session
571 static int select_targets(struct session *se, const char *filter)
573 return session_grep_databases(se, filter, select_targets_callback);
576 int session_active_clients(struct session *s)
578 struct client_list *l;
581 for (l = s->clients; l; l = l->next)
582 if (client_is_active(l->client))
588 int session_is_preferred_clients_ready(struct session *s)
590 struct client_list *l;
593 for (l = s->clients; l; l = l->next)
594 if (client_is_active_preferred(l->client))
596 session_log(s, YLOG_DEBUG, "Has %d active preferred clients.", res);
600 enum pazpar2_error_code search(struct session *se,
602 const char *startrecs, const char *maxrecs,
605 const char **addinfo)
607 int live_channels = 0;
610 struct client_list *l;
612 facet_limits_t facet_limits;
614 session_log(se, YLOG_DEBUG, "Search");
618 session_remove_clients(se);
621 reclist_destroy(se->reclist);
623 relevance_destroy(&se->relevance);
624 nmem_reset(se->nmem);
625 se->total_records = se->total_hits = se->total_merged = 0;
626 se->num_termlists = 0;
627 live_channels = select_targets(se, filter);
631 return PAZPAR2_NO_TARGETS;
633 se->reclist = reclist_create(se->nmem);
635 yaz_gettimeofday(&tval);
639 facet_limits = facet_limits_create(limit);
644 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
646 for (l = se->clients; l; l = l->next)
648 struct client *cl = l->client;
651 client_set_maxrecs(cl, atoi(maxrecs));
653 client_set_startrecs(cl, atoi(startrecs));
654 if (prepare_session_database(se, client_get_database(cl)) < 0)
656 else if (client_parse_query(cl, query, facet_limits) < 0)
661 if (client_prep_connection(cl, se->service->z3950_operation_timeout,
662 se->service->z3950_session_timeout,
663 se->service->server->iochan_man,
665 client_start_search(cl);
668 facet_limits_destroy(facet_limits);
675 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
678 return PAZPAR2_NO_TARGETS;
680 return PAZPAR2_NO_ERROR;
683 // Creates a new session_database object for a database
684 static void session_init_databases_fun(void *context, struct database *db)
686 struct session *se = (struct session *) context;
687 struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
693 assert(db->settings);
694 new->settings = nmem_malloc(se->session_nmem,
695 sizeof(struct settings *) * db->num_settings);
696 new->num_settings = db->num_settings;
697 for (i = 0; i < db->num_settings; i++)
699 struct setting *setting = db->settings[i];
700 new->settings[i] = setting;
702 new->next = se->databases;
706 // Doesn't free memory associated with sdb -- nmem takes care of that
707 static void session_database_destroy(struct session_database *sdb)
712 // Initialize session_database list -- this represents this session's view
713 // of the database list -- subject to modification by the settings ws command
714 void session_init_databases(struct session *se)
717 predef_grep_databases(se, se->service, session_init_databases_fun);
720 // Probably session_init_databases_fun should be refactored instead of
722 static struct session_database *load_session_database(struct session *se,
725 struct database *db = new_database(id, se->session_nmem);
727 session_init_databases_fun((void*) se, db);
729 // New sdb is head of se->databases list
730 return se->databases;
733 // Find an existing session database. If not found, load it
734 static struct session_database *find_session_database(struct session *se,
737 struct session_database *sdb;
739 for (sdb = se->databases; sdb; sdb = sdb->next)
740 if (!strcmp(sdb->database->url, id))
742 return load_session_database(se, id);
745 // Apply a session override to a database
746 void session_apply_setting(struct session *se, char *dbname, char *setting,
749 struct session_database *sdb = find_session_database(se, dbname);
750 struct conf_service *service = se->service;
751 struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
752 int offset = settings_create_offset(service, setting);
754 expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
757 new->target = dbname;
760 new->next = sdb->settings[offset];
761 sdb->settings[offset] = new;
763 // Force later recompute of settings-driven data structures
764 // (happens when a search starts and client connections are prepared)
776 void session_destroy(struct session *se) {
777 struct session_database *sdb;
778 session_log(se, YLOG_DEBUG, "Destroying");
780 session_remove_clients(se);
782 for (sdb = se->databases; sdb; sdb = sdb->next)
783 session_database_destroy(sdb);
784 normalize_cache_destroy(se->normalize_cache);
785 relevance_destroy(&se->relevance);
786 reclist_destroy(se->reclist);
787 nmem_destroy(se->nmem);
788 service_destroy(se->service);
789 yaz_mutex_destroy(&se->session_mutex);
792 /* Depreciated: use session_destroy */
793 void destroy_session(struct session *se)
798 size_t session_get_memory_status(struct session *session) {
802 session_enter(session);
803 session_nmem = nmem_total(session->nmem);
804 session_leave(session);
809 struct session *new_session(NMEM nmem, struct conf_service *service,
813 struct session *session = nmem_malloc(nmem, sizeof(*session));
817 sprintf(tmp_str, "session#%u", session_id);
819 session->session_id = session_id;
820 session_log(session, YLOG_DEBUG, "New");
821 session->service = service;
822 session->relevance = 0;
823 session->total_hits = 0;
824 session->total_records = 0;
825 session->number_of_warnings_unknown_elements = 0;
826 session->number_of_warnings_unknown_metadata = 0;
827 session->num_termlists = 0;
828 session->reclist = 0;
829 session->clients = 0;
830 session->session_nmem = nmem;
831 session->nmem = nmem_create();
832 session->databases = 0;
833 for (i = 0; i <= SESSION_WATCH_MAX; i++)
835 session->watchlist[i].data = 0;
836 session->watchlist[i].fun = 0;
838 session->normalize_cache = normalize_cache_create();
839 session->session_mutex = 0;
840 pazpar2_mutex_create(&session->session_mutex, tmp_str);
845 static struct hitsbytarget *hitsbytarget_nb(struct session *se,
846 int *count, NMEM nmem)
848 struct hitsbytarget *res = 0;
849 struct client_list *l;
852 for (l = se->clients; l; l = l->next)
855 res = nmem_malloc(nmem, sizeof(*res) * sz);
857 for (l = se->clients; l; l = l->next)
859 struct client *cl = l->client;
860 WRBUF w = wrbuf_alloc();
861 const char *name = session_setting_oneval(client_get_database(cl),
864 res[*count].id = client_get_database(cl)->database->url;
865 res[*count].name = *name ? name : "Unknown";
866 res[*count].hits = client_get_hits(cl);
867 res[*count].records = client_get_num_records(cl);
868 res[*count].diagnostic = client_get_diagnostic(cl);
869 res[*count].state = client_get_state_str(cl);
870 res[*count].connected = client_get_connection(cl) ? 1 : 0;
871 session_settings_dump(se, client_get_database(cl), w);
872 res[*count].settings_xml = nmem_strdup(nmem, wrbuf_cstr(w));
879 struct hitsbytarget *get_hitsbytarget(struct session *se, int *count, NMEM nmem)
881 struct hitsbytarget *p;
883 p = hitsbytarget_nb(se, count, nmem);
888 struct termlist_score **get_termlist_score(struct session *se,
889 const char *name, int *num)
892 struct termlist_score **tl = 0;
895 for (i = 0; i < se->num_termlists; i++)
896 if (!strcmp((const char *) se->termlists[i].name, name))
898 tl = termlist_highscore(se->termlists[i].termlist, num);
905 // Compares two hitsbytarget nodes by hitcount
906 static int cmp_ht(const void *p1, const void *p2)
908 const struct hitsbytarget *h1 = p1;
909 const struct hitsbytarget *h2 = p2;
910 return h2->hits - h1->hits;
913 static int targets_termlist_nb(WRBUF wrbuf, struct session *se, int num,
916 struct hitsbytarget *ht;
919 ht = hitsbytarget_nb(se, &count, nmem);
920 qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
921 for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
924 // do only print terms which have display names
926 wrbuf_puts(wrbuf, "<term>\n");
928 wrbuf_puts(wrbuf, "<id>");
929 wrbuf_xmlputs(wrbuf, ht[i].id);
930 wrbuf_puts(wrbuf, "</id>\n");
932 wrbuf_puts(wrbuf, "<name>");
933 if (!ht[i].name || !ht[i].name[0])
934 wrbuf_xmlputs(wrbuf, "NO TARGET NAME");
936 wrbuf_xmlputs(wrbuf, ht[i].name);
937 wrbuf_puts(wrbuf, "</name>\n");
939 wrbuf_printf(wrbuf, "<frequency>" ODR_INT_PRINTF "</frequency>\n",
942 wrbuf_puts(wrbuf, "<state>");
943 wrbuf_xmlputs(wrbuf, ht[i].state);
944 wrbuf_puts(wrbuf, "</state>\n");
946 wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n",
948 wrbuf_puts(wrbuf, "</term>\n");
953 void perform_termlist(struct http_channel *c, struct session *se,
954 const char *name, int num)
957 NMEM nmem_tmp = nmem_create();
962 nmem_strsplit(nmem_tmp, ",", name, &names, &num_names);
966 for (j = 0; j < num_names; j++)
969 for (i = 0; i < se->num_termlists; i++)
971 tname = se->termlists[i].name;
972 if (num_names > 0 && !strcmp(names[j], tname))
974 struct termlist_score **p = 0;
976 p = termlist_highscore(se->termlists[i].termlist, &len);
980 wrbuf_puts(c->wrbuf, "<list name=\"");
981 wrbuf_xmlputs(c->wrbuf, tname);
982 wrbuf_puts(c->wrbuf, "\">\n");
983 for (i = 0; i < len && i < num; i++)
985 // prevent sending empty term elements
986 if (!p[i]->display_term || !p[i]->display_term[0])
989 wrbuf_puts(c->wrbuf, "<term>");
990 wrbuf_puts(c->wrbuf, "<name>");
991 wrbuf_xmlputs(c->wrbuf, p[i]->display_term);
992 wrbuf_puts(c->wrbuf, "</name>");
994 wrbuf_printf(c->wrbuf,
995 "<frequency>%d</frequency>",
997 wrbuf_puts(c->wrbuf, "</term>\n");
999 wrbuf_puts(c->wrbuf, "</list>\n");
1004 if (num_names > 0 && !strcmp(names[j], tname))
1006 wrbuf_puts(c->wrbuf, "<list name=\"");
1007 wrbuf_xmlputs(c->wrbuf, tname);
1008 wrbuf_puts(c->wrbuf, "\">\n");
1009 targets_termlist_nb(c->wrbuf, se, num, c->nmem);
1010 wrbuf_puts(c->wrbuf, "</list>\n");
1014 nmem_destroy(nmem_tmp);
1017 #ifdef MISSING_HEADERS
1018 void report_nmem_stats(void)
1020 size_t in_use, is_free;
1022 nmem_get_memory_in_use(&in_use);
1023 nmem_get_memory_free(&is_free);
1025 yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
1026 (long) in_use, (long) is_free);
1030 struct record_cluster *show_single_start(struct session *se, const char *id,
1031 struct record_cluster **prev_r,
1032 struct record_cluster **next_r)
1034 struct record_cluster *r = 0;
1041 reclist_enter(se->reclist);
1042 while ((r = reclist_read_record(se->reclist)))
1044 if (!strcmp(r->recid, id))
1046 *next_r = reclist_read_record(se->reclist);
1051 reclist_leave(se->reclist);
1058 void show_single_stop(struct session *se, struct record_cluster *rec)
1063 struct record_cluster **show_range_start(struct session *se,
1064 struct reclist_sortparms *sp,
1065 int start, int *num, int *total, Odr_int *sumhits)
1067 struct record_cluster **recs;
1068 struct reclist_sortparms *spp;
1071 yaz_timing_t t = yaz_timing_create();
1074 recs = nmem_malloc(se->nmem, *num * sizeof(struct record_cluster *));
1084 for (spp = sp; spp; spp = spp->next)
1085 if (spp->type == Metadata_sortkey_relevance)
1087 relevance_prepare_read(se->relevance, se->reclist);
1090 reclist_sort(se->reclist, sp);
1092 reclist_enter(se->reclist);
1093 *total = reclist_get_num_records(se->reclist);
1094 *sumhits = se->total_hits;
1096 for (i = 0; i < start; i++)
1097 if (!reclist_read_record(se->reclist))
1104 for (i = 0; i < *num; i++)
1106 struct record_cluster *r = reclist_read_record(se->reclist);
1114 reclist_leave(se->reclist);
1118 yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
1119 yaz_timing_get_real(t), yaz_timing_get_user(t),
1120 yaz_timing_get_sys(t));
1121 yaz_timing_destroy(&t);
1126 void show_range_stop(struct session *se, struct record_cluster **recs)
1131 void statistics(struct session *se, struct statistics *stat)
1133 struct client_list *l;
1136 memset(stat, 0, sizeof(*stat));
1137 for (l = se->clients; l; l = l->next)
1139 struct client *cl = l->client;
1140 if (!client_get_connection(cl))
1141 stat->num_no_connection++;
1142 switch (client_get_state(cl))
1144 case Client_Connecting: stat->num_connecting++; break;
1145 case Client_Working: stat->num_working++; break;
1146 case Client_Idle: stat->num_idle++; break;
1147 case Client_Failed: stat->num_failed++; break;
1148 case Client_Error: stat->num_error++; break;
1153 stat->num_hits = se->total_hits;
1154 stat->num_records = se->total_records;
1156 stat->num_clients = count;
1159 static struct record_metadata *record_metadata_init(
1160 NMEM nmem, const char *value, enum conf_metadata_type type,
1161 struct _xmlAttr *attr)
1163 struct record_metadata *rec_md = record_metadata_create(nmem);
1164 struct record_metadata_attr **attrp = &rec_md->attributes;
1166 for (; attr; attr = attr->next)
1168 if (attr->children && attr->children->content)
1170 if (strcmp((const char *) attr->name, "type"))
1171 { /* skip the "type" attribute.. Its value is already part of
1172 the element in output (md-%s) and so repeating it here
1174 *attrp = nmem_malloc(nmem, sizeof(**attrp));
1176 nmem_strdup(nmem, (const char *) attr->name);
1178 nmem_strdup(nmem, (const char *) attr->children->content);
1179 attrp = &(*attrp)->next;
1185 if (type == Metadata_type_generic)
1187 char *p = nmem_strdup(nmem, value);
1189 p = normalize7bit_generic(p, " ,/.:([");
1191 rec_md->data.text.disp = p;
1192 rec_md->data.text.sort = 0;
1194 else if (type == Metadata_type_year || type == Metadata_type_date)
1199 if (type == Metadata_type_date)
1201 if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
1204 rec_md->data.number.min = first;
1205 rec_md->data.number.max = last;
1212 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
1213 struct conf_service *service, WRBUF norm_wr)
1217 for (n = root->children; n; n = n->next)
1219 if (n->type != XML_ELEMENT_NODE)
1221 if (!strcmp((const char *) n->name, "metadata"))
1223 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1225 yaz_log(YLOG_FATAL, "Missing type attribute on metadata element. Skipping!");
1227 else if (!strcmp(name, (const char *) type))
1229 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
1232 const char *norm_str;
1233 pp2_charset_token_t prt =
1234 pp2_charset_token_create(service->charsets, "mergekey");
1236 pp2_charset_token_first(prt, (const char *) value, 0);
1237 if (wrbuf_len(norm_wr) > 0)
1238 wrbuf_puts(norm_wr, " ");
1239 wrbuf_puts(norm_wr, name);
1241 pp2_charset_token_next(prt)))
1245 wrbuf_puts(norm_wr, " ");
1246 wrbuf_puts(norm_wr, norm_str);
1250 pp2_charset_token_destroy(prt);
1260 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
1261 struct conf_service *service, NMEM nmem)
1263 char *mergekey_norm = 0;
1264 xmlNode *root = xmlDocGetRootElement(doc);
1265 WRBUF norm_wr = wrbuf_alloc();
1267 /* consider mergekey from XSL first */
1268 xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
1271 const char *norm_str;
1272 pp2_charset_token_t prt =
1273 pp2_charset_token_create(service->charsets, "mergekey");
1275 pp2_charset_token_first(prt, (const char *) mergekey, 0);
1276 while ((norm_str = pp2_charset_token_next(prt)))
1280 if (wrbuf_len(norm_wr))
1281 wrbuf_puts(norm_wr, " ");
1282 wrbuf_puts(norm_wr, norm_str);
1285 pp2_charset_token_destroy(prt);
1290 /* no mergekey defined in XSL. Look for mergekey metadata instead */
1292 for (field_id = 0; field_id < service->num_metadata; field_id++)
1294 struct conf_metadata *ser_md = &service->metadata[field_id];
1295 if (ser_md->mergekey != Metadata_mergekey_no)
1297 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1299 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1301 /* no mergekey on this one and it is required..
1302 Generate unique key instead */
1303 wrbuf_rewind(norm_wr);
1310 /* generate unique key if none is not generated already or is empty */
1311 if (wrbuf_len(norm_wr) == 0)
1313 wrbuf_printf(norm_wr, "%s-%d",
1314 client_get_database(cl)->database->url, record_no);
1316 if (wrbuf_len(norm_wr) > 0)
1317 mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1318 wrbuf_destroy(norm_wr);
1319 return mergekey_norm;
1322 /** \brief see if metadata for pz:recordfilter exists
1323 \param root xml root element of normalized record
1324 \param sdb session database for client
1325 \retval 0 if there is no metadata for pz:recordfilter
1326 \retval 1 if there is metadata for pz:recordfilter
1328 If there is no pz:recordfilter defined, this function returns 1
1332 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1337 s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1342 for (n = root->children; n; n = n->next)
1344 if (n->type != XML_ELEMENT_NODE)
1346 if (!strcmp((const char *) n->name, "metadata"))
1348 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1355 if ((eq = strchr(s, '=')))
1357 else if ((eq = strchr(s, '~')))
1363 if (len == strlen((const char *)type) &&
1364 !memcmp((const char *) type, s, len))
1366 xmlChar *value = xmlNodeGetContent(n);
1367 if (value && *value)
1370 (substring && strstr((const char *) value, eq+1)) ||
1371 (!substring && !strcmp((const char *) value, eq + 1)))
1384 static int ingest_to_cluster(struct client *cl,
1388 const char *mergekey_norm);
1390 /** \brief ingest XML record
1391 \param cl client holds the result set for record
1392 \param rec record buffer (0 terminated)
1393 \param record_no record position (1, 2, ..)
1394 \param nmem working NMEM
1399 int ingest_record(struct client *cl, const char *rec,
1400 int record_no, NMEM nmem)
1402 struct session *se = client_get_session(cl);
1404 struct session_database *sdb = client_get_database(cl);
1405 struct conf_service *service = se->service;
1406 xmlDoc *xdoc = normalize_record(se, sdb, service, rec, nmem);
1408 const char *mergekey_norm;
1413 root = xmlDocGetRootElement(xdoc);
1415 if (!check_record_filter(root, sdb))
1417 session_log(se, YLOG_LOG, "Filtered out record no %d from %s",
1418 record_no, sdb->database->url);
1423 mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem);
1426 session_log(se, YLOG_WARN, "Got no mergekey");
1431 if (client_get_session(cl) == se)
1432 ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1439 static int ingest_to_cluster(struct client *cl,
1443 const char *mergekey_norm)
1448 struct session_database *sdb = client_get_database(cl);
1449 struct session *se = client_get_session(cl);
1450 struct conf_service *service = se->service;
1451 struct record *record = record_create(se->nmem,
1452 service->num_metadata,
1453 service->num_sortkeys, cl,
1455 struct record_cluster *cluster = reclist_insert(se->reclist,
1461 const char *use_term_factor_str = session_setting_oneval(sdb, PZ_TERMLIST_TERM_FACTOR);
1462 int use_term_factor = 0;
1463 int term_factor = 1;
1464 if (use_term_factor_str && use_term_factor_str[0] != 0)
1465 use_term_factor = atoi(use_term_factor_str);
1466 if (use_term_factor) {
1467 int maxrecs = client_get_maxrecs(cl);
1468 int hits = (int) client_get_hits(cl);
1469 term_factor = MAX(hits, maxrecs) / MAX(1, maxrecs);
1470 assert(term_factor >= 1);
1471 yaz_log(YLOG_DEBUG, "Using term factor: %d (%d / %d)", term_factor, MAX(hits, maxrecs), MAX(1, maxrecs));
1476 if (global_parameters.dump_records)
1477 session_log(se, YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1478 sdb->database->url, record_no);
1479 relevance_newrec(se->relevance, cluster);
1481 // now parsing XML record and adding data to cluster or record metadata
1482 for (n = root->children; n; n = n->next)
1484 pp2_charset_token_t prt;
1491 if (n->type != XML_ELEMENT_NODE)
1493 if (!strcmp((const char *) n->name, "metadata"))
1495 struct conf_metadata *ser_md = 0;
1496 struct conf_sortkey *ser_sk = 0;
1497 struct record_metadata **wheretoput = 0;
1498 struct record_metadata *rec_md = 0;
1499 int md_field_id = -1;
1500 int sk_field_id = -1;
1502 type = xmlGetProp(n, (xmlChar *) "type");
1503 value = xmlNodeListGetString(xdoc, n->children, 1);
1505 if (!type || !value || !*value)
1509 = conf_service_metadata_field_id(service, (const char *) type);
1510 if (md_field_id < 0)
1512 if (se->number_of_warnings_unknown_metadata == 0)
1514 session_log(se, YLOG_WARN,
1515 "Ignoring unknown metadata element: %s", type);
1517 se->number_of_warnings_unknown_metadata++;
1521 ser_md = &service->metadata[md_field_id];
1523 if (ser_md->sortkey_offset >= 0){
1524 sk_field_id = ser_md->sortkey_offset;
1525 ser_sk = &service->sortkeys[sk_field_id];
1528 // non-merged metadata
1529 rec_md = record_metadata_init(se->nmem, (const char *) value,
1530 ser_md->type, n->properties);
1533 session_log(se, YLOG_WARN, "bad metadata data '%s' "
1534 "for element '%s'", value, type);
1537 wheretoput = &record->metadata[md_field_id];
1539 wheretoput = &(*wheretoput)->next;
1540 *wheretoput = rec_md;
1543 rec_md = record_metadata_init(se->nmem, (const char *) value,
1545 wheretoput = &cluster->metadata[md_field_id];
1547 // and polulate with data:
1548 // assign cluster or record based on merge action
1549 if (ser_md->merge == Metadata_merge_unique)
1553 if (!strcmp((const char *) (*wheretoput)->data.text.disp,
1554 rec_md->data.text.disp))
1556 wheretoput = &(*wheretoput)->next;
1559 *wheretoput = rec_md;
1561 else if (ser_md->merge == Metadata_merge_longest)
1564 || strlen(rec_md->data.text.disp)
1565 > strlen((*wheretoput)->data.text.disp))
1567 *wheretoput = rec_md;
1570 const char *sort_str = 0;
1572 ser_sk->type == Metadata_sortkey_skiparticle;
1574 if (!cluster->sortkeys[sk_field_id])
1575 cluster->sortkeys[sk_field_id] =
1576 nmem_malloc(se->nmem,
1577 sizeof(union data_types));
1580 pp2_charset_token_create(service->charsets, "sort");
1582 pp2_charset_token_first(prt, rec_md->data.text.disp,
1585 pp2_charset_token_next(prt);
1587 sort_str = pp2_get_sort(prt);
1589 cluster->sortkeys[sk_field_id]->text.disp =
1590 rec_md->data.text.disp;
1593 sort_str = rec_md->data.text.disp;
1594 session_log(se, YLOG_WARN,
1595 "Could not make sortkey. Bug #1858");
1597 cluster->sortkeys[sk_field_id]->text.sort =
1598 nmem_strdup(se->nmem, sort_str);
1599 pp2_charset_token_destroy(prt);
1603 else if (ser_md->merge == Metadata_merge_all)
1606 wheretoput = &(*wheretoput)->next;
1607 *wheretoput = rec_md;
1609 else if (ser_md->merge == Metadata_merge_range)
1613 *wheretoput = rec_md;
1615 cluster->sortkeys[sk_field_id]
1620 int this_min = rec_md->data.number.min;
1621 int this_max = rec_md->data.number.max;
1622 if (this_min < (*wheretoput)->data.number.min)
1623 (*wheretoput)->data.number.min = this_min;
1624 if (this_max > (*wheretoput)->data.number.max)
1625 (*wheretoput)->data.number.max = this_max;
1630 // ranking of _all_ fields enabled ...
1632 relevance_countwords(se->relevance, cluster,
1633 (char *) value, ser_md->rank,
1636 // construct facets ... unless the client already has reported them
1637 if (ser_md->termlist && !client_has_facet(cl, (char *) type))
1639 if (ser_md->type == Metadata_type_year)
1642 sprintf(year, "%d", rec_md->data.number.max);
1644 add_facet(se, (char *) type, year, term_factor);
1645 if (rec_md->data.number.max != rec_md->data.number.min)
1647 sprintf(year, "%d", rec_md->data.number.min);
1648 add_facet(se, (char *) type, year, term_factor);
1652 add_facet(se, (char *) type, (char *) value, term_factor);
1662 if (se->number_of_warnings_unknown_elements == 0)
1663 session_log(se, YLOG_WARN,
1664 "Unexpected element in internal record: %s", n->name);
1665 se->number_of_warnings_unknown_elements++;
1673 relevance_donerecord(se->relevance, cluster);
1674 se->total_records++;
1679 void session_log(struct session *s, int level, const char *fmt, ...)
1685 yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
1686 yaz_log(level, "Session (%u): %s", s->session_id, buf);
1694 * c-file-style: "Stroustrup"
1695 * indent-tabs-mode: nil
1697 * vim: shiftwidth=4 tabstop=8 expandtab