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;
530 resolve_database(se->service, db->database);
532 client_set_database(cl, db);
534 client_set_session(cl, se);
536 l = xmalloc(sizeof(*l));
538 l->next = se->clients;
542 static void session_remove_clients(struct session *se)
544 struct client_list *l;
553 struct client_list *l_next = l->next;
554 client_lock(l->client);
555 client_set_session(l->client, 0);
556 client_set_database(l->client, 0);
557 client_unlock(l->client);
558 client_destroy(l->client);
564 // Associates a set of clients with a session;
565 // Note: Session-databases represent databases with per-session
567 static int select_targets(struct session *se, const char *filter)
569 return session_grep_databases(se, filter, select_targets_callback);
572 int session_active_clients(struct session *s)
574 struct client_list *l;
577 for (l = s->clients; l; l = l->next)
578 if (client_is_active(l->client))
584 int session_is_preferred_clients_ready(struct session *s)
586 struct client_list *l;
589 for (l = s->clients; l; l = l->next)
590 if (client_is_active_preferred(l->client))
592 session_log(s, YLOG_DEBUG, "Has %d active preferred clients.", res);
596 enum pazpar2_error_code search(struct session *se,
598 const char *startrecs, const char *maxrecs,
601 const char **addinfo)
603 int live_channels = 0;
606 struct client_list *l;
608 facet_limits_t facet_limits;
610 session_log(se, YLOG_DEBUG, "Search");
614 session_remove_clients(se);
617 reclist_destroy(se->reclist);
619 relevance_destroy(&se->relevance);
620 nmem_reset(se->nmem);
621 se->total_records = se->total_hits = se->total_merged = 0;
622 se->num_termlists = 0;
623 live_channels = select_targets(se, filter);
627 return PAZPAR2_NO_TARGETS;
629 se->reclist = reclist_create(se->nmem);
631 yaz_gettimeofday(&tval);
635 facet_limits = facet_limits_create(limit);
640 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
642 for (l = se->clients; l; l = l->next)
644 struct client *cl = l->client;
647 client_set_maxrecs(cl, atoi(maxrecs));
649 client_set_startrecs(cl, atoi(startrecs));
650 if (prepare_session_database(se, client_get_database(cl)) < 0)
652 else if (client_parse_query(cl, query, facet_limits) < 0)
657 if (client_prep_connection(cl, se->service->z3950_operation_timeout,
658 se->service->z3950_session_timeout,
659 se->service->server->iochan_man,
661 client_start_search(cl);
664 facet_limits_destroy(facet_limits);
671 return PAZPAR2_MALFORMED_PARAMETER_VALUE;
674 return PAZPAR2_NO_TARGETS;
676 return PAZPAR2_NO_ERROR;
679 // Creates a new session_database object for a database
680 static void session_init_databases_fun(void *context, struct database *db)
682 struct session *se = (struct session *) context;
683 struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
689 assert(db->settings);
690 new->settings = nmem_malloc(se->session_nmem,
691 sizeof(struct settings *) * db->num_settings);
692 new->num_settings = db->num_settings;
693 for (i = 0; i < db->num_settings; i++)
695 struct setting *setting = db->settings[i];
696 new->settings[i] = setting;
698 new->next = se->databases;
702 // Doesn't free memory associated with sdb -- nmem takes care of that
703 static void session_database_destroy(struct session_database *sdb)
708 // Initialize session_database list -- this represents this session's view
709 // of the database list -- subject to modification by the settings ws command
710 void session_init_databases(struct session *se)
713 predef_grep_databases(se, se->service, session_init_databases_fun);
716 // Probably session_init_databases_fun should be refactored instead of
718 static struct session_database *load_session_database(struct session *se,
721 struct database *db = new_database(id, se->session_nmem);
723 session_init_databases_fun((void*) se, db);
725 // New sdb is head of se->databases list
726 return se->databases;
729 // Find an existing session database. If not found, load it
730 static struct session_database *find_session_database(struct session *se,
733 struct session_database *sdb;
735 for (sdb = se->databases; sdb; sdb = sdb->next)
736 if (!strcmp(sdb->database->url, id))
738 return load_session_database(se, id);
741 // Apply a session override to a database
742 void session_apply_setting(struct session *se, char *dbname, char *setting,
745 struct session_database *sdb = find_session_database(se, dbname);
746 struct conf_service *service = se->service;
747 struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
748 int offset = settings_create_offset(service, setting);
750 expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
753 new->target = dbname;
756 new->next = sdb->settings[offset];
757 sdb->settings[offset] = new;
759 // Force later recompute of settings-driven data structures
760 // (happens when a search starts and client connections are prepared)
772 void session_destroy(struct session *se) {
773 struct session_database *sdb;
774 session_log(se, YLOG_DEBUG, "Destroying");
776 session_remove_clients(se);
778 for (sdb = se->databases; sdb; sdb = sdb->next)
779 session_database_destroy(sdb);
780 normalize_cache_destroy(se->normalize_cache);
781 relevance_destroy(&se->relevance);
782 reclist_destroy(se->reclist);
783 nmem_destroy(se->nmem);
784 service_destroy(se->service);
785 yaz_mutex_destroy(&se->session_mutex);
788 /* Depreciated: use session_destroy */
789 void destroy_session(struct session *se)
794 size_t session_get_memory_status(struct session *session) {
798 session_enter(session);
799 session_nmem = nmem_total(session->nmem);
800 session_leave(session);
805 struct session *new_session(NMEM nmem, struct conf_service *service,
809 struct session *session = nmem_malloc(nmem, sizeof(*session));
813 sprintf(tmp_str, "session#%u", session_id);
815 session->session_id = session_id;
816 session_log(session, YLOG_DEBUG, "New");
817 session->service = service;
818 session->relevance = 0;
819 session->total_hits = 0;
820 session->total_records = 0;
821 session->number_of_warnings_unknown_elements = 0;
822 session->number_of_warnings_unknown_metadata = 0;
823 session->num_termlists = 0;
824 session->reclist = 0;
825 session->clients = 0;
826 session->session_nmem = nmem;
827 session->nmem = nmem_create();
828 session->databases = 0;
829 for (i = 0; i <= SESSION_WATCH_MAX; i++)
831 session->watchlist[i].data = 0;
832 session->watchlist[i].fun = 0;
834 session->normalize_cache = normalize_cache_create();
835 session->session_mutex = 0;
836 pazpar2_mutex_create(&session->session_mutex, tmp_str);
841 static struct hitsbytarget *hitsbytarget_nb(struct session *se,
842 int *count, NMEM nmem)
844 struct hitsbytarget *res = 0;
845 struct client_list *l;
848 for (l = se->clients; l; l = l->next)
851 res = nmem_malloc(nmem, sizeof(*res) * sz);
853 for (l = se->clients; l; l = l->next)
855 struct client *cl = l->client;
856 WRBUF w = wrbuf_alloc();
857 const char *name = session_setting_oneval(client_get_database(cl),
860 res[*count].id = client_get_database(cl)->database->url;
861 res[*count].name = *name ? name : "Unknown";
862 res[*count].hits = client_get_hits(cl);
863 res[*count].records = client_get_num_records(cl);
864 res[*count].diagnostic = client_get_diagnostic(cl);
865 res[*count].state = client_get_state_str(cl);
866 res[*count].connected = client_get_connection(cl) ? 1 : 0;
867 session_settings_dump(se, client_get_database(cl), w);
868 res[*count].settings_xml = nmem_strdup(nmem, wrbuf_cstr(w));
875 struct hitsbytarget *get_hitsbytarget(struct session *se, int *count, NMEM nmem)
877 struct hitsbytarget *p;
879 p = hitsbytarget_nb(se, count, nmem);
884 struct termlist_score **get_termlist_score(struct session *se,
885 const char *name, int *num)
888 struct termlist_score **tl = 0;
891 for (i = 0; i < se->num_termlists; i++)
892 if (!strcmp((const char *) se->termlists[i].name, name))
894 tl = termlist_highscore(se->termlists[i].termlist, num);
901 // Compares two hitsbytarget nodes by hitcount
902 static int cmp_ht(const void *p1, const void *p2)
904 const struct hitsbytarget *h1 = p1;
905 const struct hitsbytarget *h2 = p2;
906 return h2->hits - h1->hits;
909 static int targets_termlist_nb(WRBUF wrbuf, struct session *se, int num,
912 struct hitsbytarget *ht;
915 ht = hitsbytarget_nb(se, &count, nmem);
916 qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
917 for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
920 // do only print terms which have display names
922 wrbuf_puts(wrbuf, "<term>\n");
924 wrbuf_puts(wrbuf, "<id>");
925 wrbuf_xmlputs(wrbuf, ht[i].id);
926 wrbuf_puts(wrbuf, "</id>\n");
928 wrbuf_puts(wrbuf, "<name>");
929 if (!ht[i].name || !ht[i].name[0])
930 wrbuf_xmlputs(wrbuf, "NO TARGET NAME");
932 wrbuf_xmlputs(wrbuf, ht[i].name);
933 wrbuf_puts(wrbuf, "</name>\n");
935 wrbuf_printf(wrbuf, "<frequency>" ODR_INT_PRINTF "</frequency>\n",
938 wrbuf_puts(wrbuf, "<state>");
939 wrbuf_xmlputs(wrbuf, ht[i].state);
940 wrbuf_puts(wrbuf, "</state>\n");
942 wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n",
944 wrbuf_puts(wrbuf, "</term>\n");
949 void perform_termlist(struct http_channel *c, struct session *se,
950 const char *name, int num)
953 NMEM nmem_tmp = nmem_create();
958 nmem_strsplit(nmem_tmp, ",", name, &names, &num_names);
962 for (j = 0; j < num_names; j++)
965 for (i = 0; i < se->num_termlists; i++)
967 tname = se->termlists[i].name;
968 if (num_names > 0 && !strcmp(names[j], tname))
970 struct termlist_score **p = 0;
972 p = termlist_highscore(se->termlists[i].termlist, &len);
976 wrbuf_puts(c->wrbuf, "<list name=\"");
977 wrbuf_xmlputs(c->wrbuf, tname);
978 wrbuf_puts(c->wrbuf, "\">\n");
979 for (i = 0; i < len && i < num; i++)
981 // prevent sending empty term elements
982 if (!p[i]->display_term || !p[i]->display_term[0])
985 wrbuf_puts(c->wrbuf, "<term>");
986 wrbuf_puts(c->wrbuf, "<name>");
987 wrbuf_xmlputs(c->wrbuf, p[i]->display_term);
988 wrbuf_puts(c->wrbuf, "</name>");
990 wrbuf_printf(c->wrbuf,
991 "<frequency>%d</frequency>",
993 wrbuf_puts(c->wrbuf, "</term>\n");
995 wrbuf_puts(c->wrbuf, "</list>\n");
1000 if (num_names > 0 && !strcmp(names[j], tname))
1002 wrbuf_puts(c->wrbuf, "<list name=\"");
1003 wrbuf_xmlputs(c->wrbuf, tname);
1004 wrbuf_puts(c->wrbuf, "\">\n");
1005 targets_termlist_nb(c->wrbuf, se, num, c->nmem);
1006 wrbuf_puts(c->wrbuf, "</list>\n");
1010 nmem_destroy(nmem_tmp);
1013 #ifdef MISSING_HEADERS
1014 void report_nmem_stats(void)
1016 size_t in_use, is_free;
1018 nmem_get_memory_in_use(&in_use);
1019 nmem_get_memory_free(&is_free);
1021 yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
1022 (long) in_use, (long) is_free);
1026 struct record_cluster *show_single_start(struct session *se, const char *id,
1027 struct record_cluster **prev_r,
1028 struct record_cluster **next_r)
1030 struct record_cluster *r = 0;
1037 reclist_enter(se->reclist);
1038 while ((r = reclist_read_record(se->reclist)))
1040 if (!strcmp(r->recid, id))
1042 *next_r = reclist_read_record(se->reclist);
1047 reclist_leave(se->reclist);
1054 void show_single_stop(struct session *se, struct record_cluster *rec)
1059 struct record_cluster **show_range_start(struct session *se,
1060 struct reclist_sortparms *sp,
1061 int start, int *num, int *total, Odr_int *sumhits)
1063 struct record_cluster **recs;
1064 struct reclist_sortparms *spp;
1067 yaz_timing_t t = yaz_timing_create();
1070 recs = nmem_malloc(se->nmem, *num * sizeof(struct record_cluster *));
1080 for (spp = sp; spp; spp = spp->next)
1081 if (spp->type == Metadata_sortkey_relevance)
1083 relevance_prepare_read(se->relevance, se->reclist);
1086 reclist_sort(se->reclist, sp);
1088 reclist_enter(se->reclist);
1089 *total = reclist_get_num_records(se->reclist);
1090 *sumhits = se->total_hits;
1092 for (i = 0; i < start; i++)
1093 if (!reclist_read_record(se->reclist))
1100 for (i = 0; i < *num; i++)
1102 struct record_cluster *r = reclist_read_record(se->reclist);
1110 reclist_leave(se->reclist);
1114 yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
1115 yaz_timing_get_real(t), yaz_timing_get_user(t),
1116 yaz_timing_get_sys(t));
1117 yaz_timing_destroy(&t);
1122 void show_range_stop(struct session *se, struct record_cluster **recs)
1127 void statistics(struct session *se, struct statistics *stat)
1129 struct client_list *l;
1132 memset(stat, 0, sizeof(*stat));
1133 for (l = se->clients; l; l = l->next)
1135 struct client *cl = l->client;
1136 if (!client_get_connection(cl))
1137 stat->num_no_connection++;
1138 switch (client_get_state(cl))
1140 case Client_Connecting: stat->num_connecting++; break;
1141 case Client_Working: stat->num_working++; break;
1142 case Client_Idle: stat->num_idle++; break;
1143 case Client_Failed: stat->num_failed++; break;
1144 case Client_Error: stat->num_error++; break;
1149 stat->num_hits = se->total_hits;
1150 stat->num_records = se->total_records;
1152 stat->num_clients = count;
1155 static struct record_metadata *record_metadata_init(
1156 NMEM nmem, const char *value, enum conf_metadata_type type,
1157 struct _xmlAttr *attr)
1159 struct record_metadata *rec_md = record_metadata_create(nmem);
1160 struct record_metadata_attr **attrp = &rec_md->attributes;
1162 for (; attr; attr = attr->next)
1164 if (attr->children && attr->children->content)
1166 if (strcmp((const char *) attr->name, "type"))
1167 { /* skip the "type" attribute.. Its value is already part of
1168 the element in output (md-%s) and so repeating it here
1170 *attrp = nmem_malloc(nmem, sizeof(**attrp));
1172 nmem_strdup(nmem, (const char *) attr->name);
1174 nmem_strdup(nmem, (const char *) attr->children->content);
1175 attrp = &(*attrp)->next;
1181 if (type == Metadata_type_generic)
1183 char *p = nmem_strdup(nmem, value);
1185 p = normalize7bit_generic(p, " ,/.:([");
1187 rec_md->data.text.disp = p;
1188 rec_md->data.text.sort = 0;
1190 else if (type == Metadata_type_year || type == Metadata_type_date)
1195 if (type == Metadata_type_date)
1197 if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
1200 rec_md->data.number.min = first;
1201 rec_md->data.number.max = last;
1208 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
1209 struct conf_service *service, WRBUF norm_wr)
1213 for (n = root->children; n; n = n->next)
1215 if (n->type != XML_ELEMENT_NODE)
1217 if (!strcmp((const char *) n->name, "metadata"))
1219 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1221 yaz_log(YLOG_FATAL, "Missing type attribute on metadata element. Skipping!");
1223 else if (!strcmp(name, (const char *) type))
1225 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
1228 const char *norm_str;
1229 pp2_charset_token_t prt =
1230 pp2_charset_token_create(service->charsets, "mergekey");
1232 pp2_charset_token_first(prt, (const char *) value, 0);
1233 if (wrbuf_len(norm_wr) > 0)
1234 wrbuf_puts(norm_wr, " ");
1235 wrbuf_puts(norm_wr, name);
1237 pp2_charset_token_next(prt)))
1241 wrbuf_puts(norm_wr, " ");
1242 wrbuf_puts(norm_wr, norm_str);
1246 pp2_charset_token_destroy(prt);
1256 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
1257 struct conf_service *service, NMEM nmem)
1259 char *mergekey_norm = 0;
1260 xmlNode *root = xmlDocGetRootElement(doc);
1261 WRBUF norm_wr = wrbuf_alloc();
1263 /* consider mergekey from XSL first */
1264 xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
1267 const char *norm_str;
1268 pp2_charset_token_t prt =
1269 pp2_charset_token_create(service->charsets, "mergekey");
1271 pp2_charset_token_first(prt, (const char *) mergekey, 0);
1272 while ((norm_str = pp2_charset_token_next(prt)))
1276 if (wrbuf_len(norm_wr))
1277 wrbuf_puts(norm_wr, " ");
1278 wrbuf_puts(norm_wr, norm_str);
1281 pp2_charset_token_destroy(prt);
1286 /* no mergekey defined in XSL. Look for mergekey metadata instead */
1288 for (field_id = 0; field_id < service->num_metadata; field_id++)
1290 struct conf_metadata *ser_md = &service->metadata[field_id];
1291 if (ser_md->mergekey != Metadata_mergekey_no)
1293 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1295 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1297 /* no mergekey on this one and it is required..
1298 Generate unique key instead */
1299 wrbuf_rewind(norm_wr);
1306 /* generate unique key if none is not generated already or is empty */
1307 if (wrbuf_len(norm_wr) == 0)
1309 wrbuf_printf(norm_wr, "%s-%d",
1310 client_get_database(cl)->database->url, record_no);
1312 if (wrbuf_len(norm_wr) > 0)
1313 mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1314 wrbuf_destroy(norm_wr);
1315 return mergekey_norm;
1318 /** \brief see if metadata for pz:recordfilter exists
1319 \param root xml root element of normalized record
1320 \param sdb session database for client
1321 \retval 0 if there is no metadata for pz:recordfilter
1322 \retval 1 if there is metadata for pz:recordfilter
1324 If there is no pz:recordfilter defined, this function returns 1
1328 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1333 s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1338 for (n = root->children; n; n = n->next)
1340 if (n->type != XML_ELEMENT_NODE)
1342 if (!strcmp((const char *) n->name, "metadata"))
1344 xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1351 if ((eq = strchr(s, '=')))
1353 else if ((eq = strchr(s, '~')))
1359 if (len == strlen((const char *)type) &&
1360 !memcmp((const char *) type, s, len))
1362 xmlChar *value = xmlNodeGetContent(n);
1363 if (value && *value)
1366 (substring && strstr((const char *) value, eq+1)) ||
1367 (!substring && !strcmp((const char *) value, eq + 1)))
1380 static int ingest_to_cluster(struct client *cl,
1384 const char *mergekey_norm);
1386 /** \brief ingest XML record
1387 \param cl client holds the result set for record
1388 \param rec record buffer (0 terminated)
1389 \param record_no record position (1, 2, ..)
1390 \param nmem working NMEM
1395 int ingest_record(struct client *cl, const char *rec,
1396 int record_no, NMEM nmem)
1398 struct session *se = client_get_session(cl);
1400 struct session_database *sdb = client_get_database(cl);
1401 struct conf_service *service = se->service;
1402 xmlDoc *xdoc = normalize_record(se, sdb, service, rec, nmem);
1404 const char *mergekey_norm;
1409 root = xmlDocGetRootElement(xdoc);
1411 if (!check_record_filter(root, sdb))
1413 session_log(se, YLOG_LOG, "Filtered out record no %d from %s",
1414 record_no, sdb->database->url);
1419 mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem);
1422 session_log(se, YLOG_WARN, "Got no mergekey");
1427 if (client_get_session(cl) == se)
1428 ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1435 static int ingest_to_cluster(struct client *cl,
1439 const char *mergekey_norm)
1444 struct session_database *sdb = client_get_database(cl);
1445 struct session *se = client_get_session(cl);
1446 struct conf_service *service = se->service;
1447 struct record *record = record_create(se->nmem,
1448 service->num_metadata,
1449 service->num_sortkeys, cl,
1451 struct record_cluster *cluster = reclist_insert(se->reclist,
1457 const char *use_term_factor_str = session_setting_oneval(sdb, PZ_TERMLIST_TERM_FACTOR);
1458 int use_term_factor = 0;
1459 int term_factor = 1;
1460 if (use_term_factor_str && use_term_factor_str[0] != 0)
1461 use_term_factor = atoi(use_term_factor_str);
1462 if (use_term_factor) {
1463 int maxrecs = client_get_maxrecs(cl);
1464 int hits = (int) client_get_hits(cl);
1465 term_factor = MAX(hits, maxrecs) / MAX(1, maxrecs);
1466 assert(term_factor >= 1);
1467 yaz_log(YLOG_DEBUG, "Using term factor: %d (%d / %d)", term_factor, MAX(hits, maxrecs), MAX(1, maxrecs));
1472 if (global_parameters.dump_records)
1473 session_log(se, YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1474 sdb->database->url, record_no);
1475 relevance_newrec(se->relevance, cluster);
1477 // now parsing XML record and adding data to cluster or record metadata
1478 for (n = root->children; n; n = n->next)
1480 pp2_charset_token_t prt;
1487 if (n->type != XML_ELEMENT_NODE)
1489 if (!strcmp((const char *) n->name, "metadata"))
1491 struct conf_metadata *ser_md = 0;
1492 struct conf_sortkey *ser_sk = 0;
1493 struct record_metadata **wheretoput = 0;
1494 struct record_metadata *rec_md = 0;
1495 int md_field_id = -1;
1496 int sk_field_id = -1;
1498 type = xmlGetProp(n, (xmlChar *) "type");
1499 value = xmlNodeListGetString(xdoc, n->children, 1);
1501 if (!type || !value || !*value)
1505 = conf_service_metadata_field_id(service, (const char *) type);
1506 if (md_field_id < 0)
1508 if (se->number_of_warnings_unknown_metadata == 0)
1510 session_log(se, YLOG_WARN,
1511 "Ignoring unknown metadata element: %s", type);
1513 se->number_of_warnings_unknown_metadata++;
1517 ser_md = &service->metadata[md_field_id];
1519 if (ser_md->sortkey_offset >= 0){
1520 sk_field_id = ser_md->sortkey_offset;
1521 ser_sk = &service->sortkeys[sk_field_id];
1524 // non-merged metadata
1525 rec_md = record_metadata_init(se->nmem, (const char *) value,
1526 ser_md->type, n->properties);
1529 session_log(se, YLOG_WARN, "bad metadata data '%s' "
1530 "for element '%s'", value, type);
1533 wheretoput = &record->metadata[md_field_id];
1535 wheretoput = &(*wheretoput)->next;
1536 *wheretoput = rec_md;
1539 rec_md = record_metadata_init(se->nmem, (const char *) value,
1541 wheretoput = &cluster->metadata[md_field_id];
1543 // and polulate with data:
1544 // assign cluster or record based on merge action
1545 if (ser_md->merge == Metadata_merge_unique)
1549 if (!strcmp((const char *) (*wheretoput)->data.text.disp,
1550 rec_md->data.text.disp))
1552 wheretoput = &(*wheretoput)->next;
1555 *wheretoput = rec_md;
1557 else if (ser_md->merge == Metadata_merge_longest)
1560 || strlen(rec_md->data.text.disp)
1561 > strlen((*wheretoput)->data.text.disp))
1563 *wheretoput = rec_md;
1566 const char *sort_str = 0;
1568 ser_sk->type == Metadata_sortkey_skiparticle;
1570 if (!cluster->sortkeys[sk_field_id])
1571 cluster->sortkeys[sk_field_id] =
1572 nmem_malloc(se->nmem,
1573 sizeof(union data_types));
1576 pp2_charset_token_create(service->charsets, "sort");
1578 pp2_charset_token_first(prt, rec_md->data.text.disp,
1581 pp2_charset_token_next(prt);
1583 sort_str = pp2_get_sort(prt);
1585 cluster->sortkeys[sk_field_id]->text.disp =
1586 rec_md->data.text.disp;
1589 sort_str = rec_md->data.text.disp;
1590 session_log(se, YLOG_WARN,
1591 "Could not make sortkey. Bug #1858");
1593 cluster->sortkeys[sk_field_id]->text.sort =
1594 nmem_strdup(se->nmem, sort_str);
1595 pp2_charset_token_destroy(prt);
1599 else if (ser_md->merge == Metadata_merge_all)
1602 wheretoput = &(*wheretoput)->next;
1603 *wheretoput = rec_md;
1605 else if (ser_md->merge == Metadata_merge_range)
1609 *wheretoput = rec_md;
1611 cluster->sortkeys[sk_field_id]
1616 int this_min = rec_md->data.number.min;
1617 int this_max = rec_md->data.number.max;
1618 if (this_min < (*wheretoput)->data.number.min)
1619 (*wheretoput)->data.number.min = this_min;
1620 if (this_max > (*wheretoput)->data.number.max)
1621 (*wheretoput)->data.number.max = this_max;
1626 // ranking of _all_ fields enabled ...
1628 relevance_countwords(se->relevance, cluster,
1629 (char *) value, ser_md->rank,
1632 // construct facets ... unless the client already has reported them
1633 if (ser_md->termlist && !client_has_facet(cl, (char *) type))
1635 if (ser_md->type == Metadata_type_year)
1638 sprintf(year, "%d", rec_md->data.number.max);
1640 add_facet(se, (char *) type, year, term_factor);
1641 if (rec_md->data.number.max != rec_md->data.number.min)
1643 sprintf(year, "%d", rec_md->data.number.min);
1644 add_facet(se, (char *) type, year, term_factor);
1648 add_facet(se, (char *) type, (char *) value, term_factor);
1658 if (se->number_of_warnings_unknown_elements == 0)
1659 session_log(se, YLOG_WARN,
1660 "Unexpected element in internal record: %s", n->name);
1661 se->number_of_warnings_unknown_elements++;
1669 relevance_donerecord(se->relevance, cluster);
1670 se->total_records++;
1675 void session_log(struct session *s, int level, const char *fmt, ...)
1681 yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
1682 yaz_log(level, "Session (%u): %s", s->session_id, buf);
1690 * c-file-style: "Stroustrup"
1691 * indent-tabs-mode: nil
1693 * vim: shiftwidth=4 tabstop=8 expandtab