Both option -X and -R enables predictable sessions
[pazpar2-moved-to-github.git] / src / session.c
1 /* This file is part of Pazpar2.
2    Copyright (C) 2006-2011 Index Data
3
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
7 version.
8
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
12 for more details.
13
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
17
18 */
19
20 /** \file session.c
21     \brief high-level logic; mostly user sessions and settings
22 */
23
24 #if HAVE_CONFIG_H
25 #include <config.h>
26 #endif
27
28 #include <time.h>
29 #include <stdlib.h>
30 #include <stdio.h>
31 #include <string.h>
32 #if HAVE_SYS_TIME_H
33 #include <sys/time.h>
34 #endif
35 #if HAVE_UNISTD_H
36 #include <unistd.h>
37 #endif
38 #ifdef WIN32
39 #include <windows.h>
40 #endif
41 #include <signal.h>
42 #include <ctype.h>
43 #include <assert.h>
44 #include <math.h>
45
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>
54 #include <yaz/nmem.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>
60
61 #define USE_TIMING 0
62 #if USE_TIMING
63 #include <yaz/timing.h>
64 #endif
65
66 #include "ppmutex.h"
67 #include "parameters.h"
68 #include "session.h"
69 #include "eventl.h"
70 #include "http.h"
71 #include "termlists.h"
72 #include "reclists.h"
73 #include "relevance.h"
74 #include "database.h"
75 #include "client.h"
76 #include "settings.h"
77 #include "normalize7bit.h"
78
79 #define TERMLIST_HIGH_SCORE 25
80
81 #define MAX_CHUNK 15
82
83 #define MAX(a,b) ((a)>(b)?(a):(b))
84
85 // Note: Some things in this structure will eventually move to configuration
86 struct parameters global_parameters = 
87 {
88     0,   // dump_records
89     0,   // debug_mode
90     0,   // predictable sessions
91 };
92
93 struct client_list {
94     struct client *client;
95     struct client_list *next;
96 };
97
98 /* session counting (1) , disable client counting (0) */
99 static YAZ_MUTEX g_session_mutex = 0;
100 static int no_sessions = 0;
101
102 static int session_use(int delta)
103 {
104     int sessions;
105     if (!g_session_mutex)
106         yaz_mutex_create(&g_session_mutex);
107     yaz_mutex_enter(g_session_mutex);
108     no_sessions += delta;
109     sessions = no_sessions;
110     yaz_mutex_leave(g_session_mutex);
111     yaz_log(YLOG_DEBUG, "%s sesions=%d", delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), no_sessions);
112     return sessions;
113 }
114
115 int sessions_count(void) {
116     return session_use(0);
117 }
118
119 static void log_xml_doc(xmlDoc *doc)
120 {
121     FILE *lf = yaz_log_file();
122     xmlChar *result = 0;
123     int len = 0;
124 #if LIBXML_VERSION >= 20600
125     xmlDocDumpFormatMemory(doc, &result, &len, 1);
126 #else
127     xmlDocDumpMemory(doc, &result, &len);
128 #endif
129     if (lf && len)
130     {
131         (void) fwrite(result, 1, len, lf);
132         fprintf(lf, "\n");
133     }
134     xmlFree(result);
135 }
136
137 static void session_enter(struct session *s)
138 {
139     yaz_mutex_enter(s->session_mutex);
140 }
141
142 static void session_leave(struct session *s)
143 {
144     yaz_mutex_leave(s->session_mutex);
145 }
146
147 // Recursively traverse query structure to extract terms.
148 void pull_terms(NMEM nmem, struct ccl_rpn_node *n, char **termlist, int *num)
149 {
150     char **words;
151     int numwords;
152     int i;
153
154     switch (n->kind)
155     {
156     case CCL_RPN_AND:
157     case CCL_RPN_OR:
158     case CCL_RPN_NOT:
159     case CCL_RPN_PROX:
160         pull_terms(nmem, n->u.p[0], termlist, num);
161         pull_terms(nmem, n->u.p[1], termlist, num);
162         break;
163     case CCL_RPN_TERM:
164         nmem_strsplit(nmem, " ", n->u.t.term, &words, &numwords);
165         for (i = 0; i < numwords; i++)
166             termlist[(*num)++] = words[i];
167         break;
168     default: // NOOP
169         break;
170     }
171 }
172
173
174 void add_facet(struct session *s, const char *type, const char *value, int count)
175 {
176     struct conf_service *service = s->service;
177     pp2_relevance_token_t prt;
178     const char *facet_component;
179     WRBUF facet_wrbuf = wrbuf_alloc();
180     prt = pp2_relevance_tokenize(service->facet_pct);
181     
182     pp2_relevance_first(prt, value, 0);
183     while ((facet_component = pp2_relevance_token_next(prt)))
184     {
185         if (*facet_component)
186         {
187             if (wrbuf_len(facet_wrbuf))
188                 wrbuf_puts(facet_wrbuf, " ");
189             wrbuf_puts(facet_wrbuf, facet_component);
190         }
191     }
192     pp2_relevance_token_destroy(prt);
193     
194     if (wrbuf_len(facet_wrbuf))
195     {
196         int i;
197         for (i = 0; i < s->num_termlists; i++)
198             if (!strcmp(s->termlists[i].name, type))
199                 break;
200         if (i == s->num_termlists)
201         {
202             if (i == SESSION_MAX_TERMLISTS)
203             {
204                 session_log(s, YLOG_FATAL, "Too many termlists");
205                 wrbuf_destroy(facet_wrbuf);
206                 return;
207             }
208             
209             s->termlists[i].name = nmem_strdup(s->nmem, type);
210             s->termlists[i].termlist 
211                 = termlist_create(s->nmem, TERMLIST_HIGH_SCORE);
212             s->num_termlists = i + 1;
213         }
214         
215 #if 0
216         session_log(s, YLOG_DEBUG, "Facets for %s: %s norm:%s (%d)", type, value, wrbuf_cstr(facet_wrbuf), count);
217 #endif
218         termlist_insert(s->termlists[i].termlist, wrbuf_cstr(facet_wrbuf),
219                         count);
220     }
221     wrbuf_destroy(facet_wrbuf);
222 }
223
224 static xmlDoc *record_to_xml(struct session *se,
225                              struct session_database *sdb, const char *rec)
226 {
227     struct database *db = sdb->database;
228     xmlDoc *rdoc = 0;
229
230     rdoc = xmlParseMemory(rec, strlen(rec));
231
232     if (!rdoc)
233     {
234         session_log(se, YLOG_FATAL, "Non-wellformed XML received from %s",
235                     db->url);
236         return 0;
237     }
238
239     if (global_parameters.dump_records)
240     {
241         session_log(se, YLOG_LOG, "Un-normalized record from %s", db->url);
242         log_xml_doc(rdoc);
243     }
244
245     return rdoc;
246 }
247
248 #define MAX_XSLT_ARGS 16
249
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,
253                                        char **parms,
254                                        NMEM nmem)
255 {
256     int i;
257     int nparms = 0;
258     int offset = 0;
259
260     for (i = 0; i < service->num_metadata; i++)
261     {
262         struct conf_metadata *md = &service->metadata[i];
263         int setting;
264
265         if (md->setting == Metadata_setting_parameter &&
266             (setting = settings_lookup_offset(service, md->name)) >= 0)
267         {
268             const char *val = session_setting_oneval(sdb, setting);
269             if (val && nparms < MAX_XSLT_ARGS)
270             {
271                 char *buf;
272                 int len = strlen(val);
273                 buf = nmem_malloc(nmem, len + 3);
274                 buf[0] = '\'';
275                 strcpy(buf + 1, val);
276                 buf[len+1] = '\'';
277                 buf[len+2] = '\0';
278                 parms[offset++] = md->name;
279                 parms[offset++] = buf;
280                 nparms++;
281             }
282         }
283     }
284     parms[offset] = 0;
285 }
286
287 // Add static values from session database settings if applicable
288 static void insert_settings_values(struct session_database *sdb, xmlDoc *doc,
289     struct conf_service *service)
290 {
291     int i;
292
293     for (i = 0; i < service->num_metadata; i++)
294     {
295         struct conf_metadata *md = &service->metadata[i];
296         int offset;
297
298         if (md->setting == Metadata_setting_postproc &&
299             (offset = settings_lookup_offset(service, md->name)) >= 0)
300         {
301             const char *val = session_setting_oneval(sdb, offset);
302             if (val)
303             {
304                 xmlNode *r = xmlDocGetRootElement(doc);
305                 xmlNode *n = xmlNewTextChild(r, 0, (xmlChar *) "metadata",
306                                              (xmlChar *) val);
307                 xmlSetProp(n, (xmlChar *) "type", (xmlChar *) md->name);
308             }
309         }
310     }
311 }
312
313 static xmlDoc *normalize_record(struct session *se,
314                                 struct session_database *sdb,
315                                 struct conf_service *service,
316                                 const char *rec, NMEM nmem)
317 {
318     xmlDoc *rdoc = record_to_xml(se, sdb, rec);
319
320     if (rdoc)
321     {
322         char *parms[MAX_XSLT_ARGS*2+1];
323         
324         insert_settings_parameters(sdb, service, parms, nmem);
325         
326         if (normalize_record_transform(sdb->map, &rdoc, (const char **)parms))
327         {
328             session_log(se, YLOG_WARN, "Normalize failed from %s",
329                         sdb->database->url);
330         }
331         else
332         {
333             insert_settings_values(sdb, rdoc, service);
334             
335             if (global_parameters.dump_records)
336             {
337                 session_log(se, YLOG_LOG, "Normalized record from %s", 
338                             sdb->database->url);
339                 log_xml_doc(rdoc);
340             }
341         }
342     }
343     return rdoc;
344 }
345
346 void session_settings_dump(struct session *se,
347                            struct session_database *db,
348                            WRBUF w)
349 {
350     if (db->settings)
351     {
352         int i, num = db->num_settings;
353         for (i = 0; i < num; i++)
354         {
355             struct setting *s = db->settings[i];
356             for (;s ; s = s->next)
357             {
358                 wrbuf_puts(w, "<set name=\"");
359                 wrbuf_xmlputs(w, s->name);
360                 wrbuf_puts(w, "\" value=\"");
361                 wrbuf_xmlputs(w, s->value);
362                 wrbuf_puts(w, "\"/>");
363             }
364             if (db->settings[i])
365                 wrbuf_puts(w, "\n");
366         }
367     }
368 }
369
370 // Retrieve first defined value for 'name' for given database.
371 // Will be extended to take into account user associated with session
372 const char *session_setting_oneval(struct session_database *db, int offset)
373 {
374     if (offset >= db->num_settings || !db->settings[offset])
375         return "";
376     return db->settings[offset]->value;
377 }
378
379 // Prepare XSLT stylesheets for record normalization
380 // Structures are allocated on the session_wide nmem to avoid having
381 // to recompute this for every search. This would lead
382 // to leaking if a single session was to repeatedly change the PZ_XSLT
383 // setting. However, this is not a realistic use scenario.
384 static int prepare_map(struct session *se, struct session_database *sdb)
385 {
386     const char *s;
387
388     if (!sdb->settings)
389     {
390         session_log(se, YLOG_WARN, "No settings on %s", sdb->database->url);
391         return -1;
392     }
393     if ((s = session_setting_oneval(sdb, PZ_XSLT)))
394     {
395         char auto_stylesheet[256];
396
397         if (!strcmp(s, "auto"))
398         {
399             const char *request_syntax = session_setting_oneval(
400                 sdb, PZ_REQUESTSYNTAX);
401             if (request_syntax)
402             {
403                 char *cp;
404                 yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet),
405                              "%s.xsl", request_syntax);
406                 for (cp = auto_stylesheet; *cp; cp++)
407                 {
408                     /* deliberately only consider ASCII */
409                     if (*cp > 32 && *cp < 127)
410                         *cp = tolower(*cp);
411                 }
412                 s = auto_stylesheet;
413             }
414             else
415             {
416                 session_log(se, YLOG_WARN,
417                             "No pz:requestsyntax for auto stylesheet");
418             }
419         }
420         sdb->map = normalize_cache_get(se->normalize_cache,
421                                        se->service->server->config, s);
422         if (!sdb->map)
423             return -1;
424     }
425     return 0;
426 }
427
428 // This analyzes settings and recomputes any supporting data structures
429 // if necessary.
430 static int prepare_session_database(struct session *se, 
431                                     struct session_database *sdb)
432 {
433     if (!sdb->settings)
434     {
435         session_log(se, YLOG_WARN, 
436                 "No settings associated with %s", sdb->database->url);
437         return -1;
438     }
439     if (sdb->settings[PZ_XSLT] && !sdb->map)
440     {
441         if (prepare_map(se, sdb) < 0)
442             return -1;
443     }
444     return 0;
445 }
446
447 // called if watch should be removed because http_channel is to be destroyed
448 static void session_watch_cancel(void *data, struct http_channel *c,
449                                  void *data2)
450 {
451     struct session_watchentry *ent = data;
452
453     ent->fun = 0;
454     ent->data = 0;
455     ent->obs = 0;
456 }
457
458 // set watch. Returns 0=OK, -1 if watch is already set
459 int session_set_watch(struct session *s, int what, 
460                       session_watchfun fun, void *data,
461                       struct http_channel *chan)
462 {
463     int ret;
464     session_enter(s);
465     if (s->watchlist[what].fun)
466         ret = -1;
467     else
468     {
469         
470         s->watchlist[what].fun = fun;
471         s->watchlist[what].data = data;
472         s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
473                                                    session_watch_cancel);
474         ret = 0;
475     }
476     session_leave(s);
477     return 0;
478 }
479
480 void session_alert_watch(struct session *s, int what)
481 {
482     assert(s);
483     session_enter(s);
484     if (s->watchlist[what].fun)
485     {
486         /* our watch is no longer associated with http_channel */
487         void *data;
488         session_watchfun fun;
489
490         http_remove_observer(s->watchlist[what].obs);
491         fun  = s->watchlist[what].fun;
492         data = s->watchlist[what].data;
493
494         /* reset watch before fun is invoked - in case fun wants to set
495            it again */
496         s->watchlist[what].fun = 0;
497         s->watchlist[what].data = 0;
498         s->watchlist[what].obs = 0;
499
500         session_leave(s);
501         session_log(s, YLOG_DEBUG,
502                     "Alert Watch: %d calling function: %p", what, fun);
503         fun(data);
504     }
505     else
506         session_leave(s);
507 }
508
509 //callback for grep_databases
510 static void select_targets_callback(void *context, struct session_database *db)
511 {
512     struct session *se = (struct session*) context;
513     struct client *cl = client_create();
514     struct client_list *l;
515     client_set_database(cl, db);
516
517     client_set_session(cl, se);
518
519     l = xmalloc(sizeof(*l));
520     l->client = cl;
521     l->next = se->clients;
522     se->clients = l;
523 }
524
525 static void session_remove_clients(struct session *se)
526 {
527     struct client_list *l;
528
529     session_enter(se);
530     l = se->clients;
531     se->clients = 0;
532     session_leave(se);
533
534     while (l)
535     {
536         struct client_list *l_next = l->next;
537         client_lock(l->client);
538         client_set_session(l->client, 0);
539         client_set_database(l->client, 0);
540         client_unlock(l->client);
541         client_destroy(l->client);
542         xfree(l);
543         l = l_next;
544     }
545 }
546
547 // Associates a set of clients with a session;
548 // Note: Session-databases represent databases with per-session 
549 // setting overrides
550 static int select_targets(struct session *se, const char *filter)
551 {
552     return session_grep_databases(se, filter, select_targets_callback);
553 }
554
555 int session_active_clients(struct session *s)
556 {
557     struct client_list *l;
558     int res = 0;
559
560     for (l = s->clients; l; l = l->next)
561         if (client_is_active(l->client))
562             res++;
563
564     return res;
565 }
566
567 int session_is_preferred_clients_ready(struct session *s)
568 {
569     struct client_list *l;
570     int res = 0;
571
572     for (l = s->clients; l; l = l->next)
573         if (client_is_active_preferred(l->client))
574             res++;
575     session_log(s, YLOG_DEBUG, "Has %d active preferred clients.", res);
576     return res == 0;
577 }
578
579
580
581 enum pazpar2_error_code search(struct session *se,
582                                const char *query,
583                                const char *startrecs, const char *maxrecs,
584                                const char *filter,
585                                const char **addinfo)
586 {
587     int live_channels = 0;
588     int no_working = 0;
589     int no_failed = 0;
590     struct client_list *l;
591     struct timeval tval;
592
593     session_log(se, YLOG_DEBUG, "Search");
594
595     *addinfo = 0;
596
597     session_remove_clients(se);
598     
599     session_enter(se);
600     reclist_destroy(se->reclist);
601     se->reclist = 0;
602     relevance_destroy(&se->relevance);
603     nmem_reset(se->nmem);
604     se->total_records = se->total_hits = se->total_merged = 0;
605     se->num_termlists = 0;
606     live_channels = select_targets(se, filter);
607     if (!live_channels)
608     {
609         session_leave(se);
610         return PAZPAR2_NO_TARGETS;
611     }
612     se->reclist = reclist_create(se->nmem);
613
614     yaz_gettimeofday(&tval);
615     
616     tval.tv_sec += 5;
617
618     for (l = se->clients; l; l = l->next)
619     {
620         struct client *cl = l->client;
621
622         if (maxrecs)
623             client_set_maxrecs(cl, atoi(maxrecs));
624         if (startrecs)
625             client_set_startrecs(cl, atoi(startrecs));
626         if (prepare_session_database(se, client_get_database(cl)) < 0)
627             ;
628         else if (client_parse_query(cl, query) < 0)
629             no_failed++;
630         else
631         {
632             no_working++;
633             if (client_prep_connection(cl, se->service->z3950_operation_timeout,
634                                        se->service->z3950_session_timeout,
635                                        se->service->server->iochan_man,
636                                        &tval))
637                 client_start_search(cl);
638         }
639     }
640     session_leave(se);
641     if (no_working == 0)
642     {
643         if (no_failed > 0)
644         {
645             *addinfo = "query";
646             return PAZPAR2_MALFORMED_PARAMETER_VALUE;
647         }
648         else
649             return PAZPAR2_NO_TARGETS;
650     }
651     return PAZPAR2_NO_ERROR;
652 }
653
654 // Creates a new session_database object for a database
655 static void session_init_databases_fun(void *context, struct database *db)
656 {
657     struct session *se = (struct session *) context;
658     struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
659     int i;
660
661     new->database = db;
662     
663     new->map = 0;
664     assert(db->settings);
665     new->settings = nmem_malloc(se->session_nmem,
666                                 sizeof(struct settings *) * db->num_settings);
667     new->num_settings = db->num_settings;
668     for (i = 0; i < db->num_settings; i++)
669     {
670         struct setting *setting = db->settings[i];
671         new->settings[i] = setting;
672     }
673     new->next = se->databases;
674     se->databases = new;
675 }
676
677 // Doesn't free memory associated with sdb -- nmem takes care of that
678 static void session_database_destroy(struct session_database *sdb)
679 {
680     sdb->map = 0;
681 }
682
683 // Initialize session_database list -- this represents this session's view
684 // of the database list -- subject to modification by the settings ws command
685 void session_init_databases(struct session *se)
686 {
687     se->databases = 0;
688     predef_grep_databases(se, se->service, session_init_databases_fun);
689 }
690
691 // Probably session_init_databases_fun should be refactored instead of
692 // called here.
693 static struct session_database *load_session_database(struct session *se, 
694                                                       char *id)
695 {
696     struct database *db = new_database(id, se->session_nmem);
697
698     resolve_database(se->service, db);
699
700     session_init_databases_fun((void*) se, db);
701
702     // New sdb is head of se->databases list
703     return se->databases;
704 }
705
706 // Find an existing session database. If not found, load it
707 static struct session_database *find_session_database(struct session *se, 
708                                                       char *id)
709 {
710     struct session_database *sdb;
711
712     for (sdb = se->databases; sdb; sdb = sdb->next)
713         if (!strcmp(sdb->database->url, id))
714             return sdb;
715     return load_session_database(se, id);
716 }
717
718 // Apply a session override to a database
719 void session_apply_setting(struct session *se, char *dbname, char *setting,
720                            char *value)
721 {
722     struct session_database *sdb = find_session_database(se, dbname);
723     struct conf_service *service = se->service;
724     struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
725     int offset = settings_create_offset(service, setting);
726
727     expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
728                           se->session_nmem);
729     new->precedence = 0;
730     new->target = dbname;
731     new->name = setting;
732     new->value = value;
733     new->next = sdb->settings[offset];
734     sdb->settings[offset] = new;
735
736     // Force later recompute of settings-driven data structures
737     // (happens when a search starts and client connections are prepared)
738     switch (offset)
739     {
740     case PZ_XSLT:
741         if (sdb->map)
742         {
743             sdb->map = 0;
744         }
745         break;
746     }
747 }
748
749 void destroy_session(struct session *se)
750 {
751     struct session_database *sdb;
752     session_log(se, YLOG_DEBUG, "Destroying");
753     session_use(-1);
754     session_remove_clients(se);
755
756     for (sdb = se->databases; sdb; sdb = sdb->next)
757         session_database_destroy(sdb);
758     normalize_cache_destroy(se->normalize_cache);
759     relevance_destroy(&se->relevance);
760     reclist_destroy(se->reclist);
761     nmem_destroy(se->nmem);
762     service_destroy(se->service);
763     yaz_mutex_destroy(&se->session_mutex);
764     wrbuf_destroy(se->wrbuf);
765 }
766
767 size_t session_get_memory_status(struct session *session) {
768     size_t session_nmem;
769     if (session == 0)
770         return 0;
771     session_enter(session);
772     session_nmem = nmem_total(session->nmem);
773     session_leave(session);
774     return session_nmem;
775 }
776
777
778 struct session *new_session(NMEM nmem, struct conf_service *service,
779                             unsigned session_id)
780 {
781     int i;
782     struct session *session = nmem_malloc(nmem, sizeof(*session));
783
784     char tmp_str[50];
785
786     sprintf(tmp_str, "session#%u", session_id);
787
788     session->session_id = session_id;
789     session_log(session, YLOG_DEBUG, "New");
790     session->service = service;
791     session->relevance = 0;
792     session->total_hits = 0;
793     session->total_records = 0;
794     session->number_of_warnings_unknown_elements = 0;
795     session->number_of_warnings_unknown_metadata = 0;
796     session->num_termlists = 0;
797     session->reclist = 0;
798     session->clients = 0;
799     session->session_nmem = nmem;
800     session->nmem = nmem_create();
801     session->wrbuf = wrbuf_alloc();
802     session->databases = 0;
803     for (i = 0; i <= SESSION_WATCH_MAX; i++)
804     {
805         session->watchlist[i].data = 0;
806         session->watchlist[i].fun = 0;
807     }
808     session->normalize_cache = normalize_cache_create();
809     session->session_mutex = 0;
810     pazpar2_mutex_create(&session->session_mutex, tmp_str);
811     session_use(1);
812     return session;
813 }
814
815 struct hitsbytarget *hitsbytarget(struct session *se, int *count, NMEM nmem)
816 {
817     struct hitsbytarget *res = 0;
818     struct client_list *l;
819     size_t sz = 0;
820
821     session_enter(se);
822     for (l = se->clients; l; l = l->next)
823         sz++;
824
825     res = nmem_malloc(nmem, sizeof(*res) * sz);
826     *count = 0;
827     for (l = se->clients; l; l = l->next)
828     {
829         struct client *cl = l->client;
830         WRBUF w = wrbuf_alloc();
831         const char *name = session_setting_oneval(client_get_database(cl),
832                                                   PZ_NAME);
833
834         res[*count].id = client_get_database(cl)->database->url;
835         res[*count].name = *name ? name : "Unknown";
836         res[*count].hits = client_get_hits(cl);
837         res[*count].records = client_get_num_records(cl);
838         res[*count].diagnostic = client_get_diagnostic(cl);
839         res[*count].state = client_get_state_str(cl);
840         res[*count].connected  = client_get_connection(cl) ? 1 : 0;
841         session_settings_dump(se, client_get_database(cl), w);
842         res[*count].settings_xml = w;
843         (*count)++;
844     }
845     session_leave(se);
846     return res;
847 }
848
849 struct termlist_score **termlist(struct session *se, const char *name, int *num)
850 {
851     int i;
852     struct termlist_score **tl = 0;
853
854     session_enter(se);
855     for (i = 0; i < se->num_termlists; i++)
856         if (!strcmp((const char *) se->termlists[i].name, name))
857         {
858             tl = termlist_highscore(se->termlists[i].termlist, num);
859             break;
860         }
861     session_leave(se);
862     return tl;
863 }
864
865 #ifdef MISSING_HEADERS
866 void report_nmem_stats(void)
867 {
868     size_t in_use, is_free;
869
870     nmem_get_memory_in_use(&in_use);
871     nmem_get_memory_free(&is_free);
872
873     yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld", 
874             (long) in_use, (long) is_free);
875 }
876 #endif
877
878 struct record_cluster *show_single_start(struct session *se, const char *id,
879                                          struct record_cluster **prev_r,
880                                          struct record_cluster **next_r)
881 {
882     struct record_cluster *r = 0;
883
884     session_enter(se);
885     *prev_r = 0;
886     *next_r = 0;
887     if (se->reclist)
888     {
889         reclist_enter(se->reclist);
890         while ((r = reclist_read_record(se->reclist)))
891         {
892             if (!strcmp(r->recid, id))
893             {
894                 *next_r = reclist_read_record(se->reclist);
895                 break;
896             }
897             *prev_r = r;
898         }
899         reclist_leave(se->reclist);
900     }
901     if (!r)
902         session_leave(se);
903     return r;
904 }
905
906 void show_single_stop(struct session *se, struct record_cluster *rec)
907 {
908     session_leave(se);
909 }
910
911 struct record_cluster **show_range_start(struct session *se,
912                                          struct reclist_sortparms *sp, 
913                                          int start, int *num, int *total, Odr_int *sumhits)
914 {
915     struct record_cluster **recs;
916     struct reclist_sortparms *spp;
917     int i;
918 #if USE_TIMING    
919     yaz_timing_t t = yaz_timing_create();
920 #endif
921     session_enter(se);
922     recs = nmem_malloc(se->nmem, *num * sizeof(struct record_cluster *));
923     if (!se->relevance)
924     {
925         *num = 0;
926         *total = 0;
927         *sumhits = 0;
928         recs = 0;
929     }
930     else
931     {
932         for (spp = sp; spp; spp = spp->next)
933             if (spp->type == Metadata_sortkey_relevance)
934             {
935                 relevance_prepare_read(se->relevance, se->reclist);
936                 break;
937             }
938         reclist_sort(se->reclist, sp);
939         
940         reclist_enter(se->reclist);
941         *total = reclist_get_num_records(se->reclist);
942         *sumhits = se->total_hits;
943         
944         for (i = 0; i < start; i++)
945             if (!reclist_read_record(se->reclist))
946             {
947                 *num = 0;
948                 recs = 0;
949                 break;
950             }
951         
952         for (i = 0; i < *num; i++)
953         {
954             struct record_cluster *r = reclist_read_record(se->reclist);
955             if (!r)
956             {
957                 *num = i;
958                 break;
959             }
960             recs[i] = r;
961         }
962         reclist_leave(se->reclist);
963     }
964 #if USE_TIMING
965     yaz_timing_stop(t);
966     yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f", 
967             yaz_timing_get_real(t), yaz_timing_get_user(t),
968             yaz_timing_get_sys(t));
969     yaz_timing_destroy(&t);
970 #endif
971     return recs;
972 }
973
974 void show_range_stop(struct session *se, struct record_cluster **recs)
975 {
976     session_leave(se);
977 }
978
979 void statistics(struct session *se, struct statistics *stat)
980 {
981     struct client_list *l;
982     int count = 0;
983
984     memset(stat, 0, sizeof(*stat));
985     for (l = se->clients; l; l = l->next)
986     {
987         struct client *cl = l->client;
988         if (!client_get_connection(cl))
989             stat->num_no_connection++;
990         switch (client_get_state(cl))
991         {
992         case Client_Connecting: stat->num_connecting++; break;
993         case Client_Working: stat->num_working++; break;
994         case Client_Idle: stat->num_idle++; break;
995         case Client_Failed: stat->num_failed++; break;
996         case Client_Error: stat->num_error++; break;
997         default: break;
998         }
999         count++;
1000     }
1001     stat->num_hits = se->total_hits;
1002     stat->num_records = se->total_records;
1003
1004     stat->num_clients = count;
1005 }
1006
1007 static struct record_metadata *record_metadata_init(
1008     NMEM nmem, const char *value, enum conf_metadata_type type,
1009     struct _xmlAttr *attr)
1010 {
1011     struct record_metadata *rec_md = record_metadata_create(nmem);
1012     struct record_metadata_attr **attrp = &rec_md->attributes;
1013     
1014     for (; attr; attr = attr->next)
1015     {
1016         if (attr->children && attr->children->content)
1017         {
1018             if (strcmp((const char *) attr->name, "type"))
1019             {  /* skip the "type" attribute.. Its value is already part of
1020                   the element in output (md-%s) and so repeating it here
1021                   is redundant */
1022                 *attrp = nmem_malloc(nmem, sizeof(**attrp));
1023                 (*attrp)->name =
1024                     nmem_strdup(nmem, (const char *) attr->name);
1025                 (*attrp)->value =
1026                     nmem_strdup(nmem, (const char *) attr->children->content);
1027                 attrp = &(*attrp)->next;
1028             }
1029         }
1030     }
1031     *attrp = 0;
1032
1033     if (type == Metadata_type_generic)
1034     {
1035         char *p = nmem_strdup(nmem, value);
1036
1037         p = normalize7bit_generic(p, " ,/.:([");
1038         
1039         rec_md->data.text.disp = p;
1040         rec_md->data.text.sort = 0;
1041     }
1042     else if (type == Metadata_type_year || type == Metadata_type_date)
1043     {
1044         int first, last;
1045         int longdate = 0;
1046
1047         if (type == Metadata_type_date)
1048             longdate = 1;
1049         if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
1050             return 0;
1051
1052         rec_md->data.number.min = first;
1053         rec_md->data.number.max = last;
1054     }
1055     else
1056         return 0;
1057     return rec_md;
1058 }
1059
1060 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
1061                                  struct conf_service *service, WRBUF norm_wr)
1062 {
1063     xmlNode *n;
1064     int no_found = 0;
1065     for (n = root->children; n; n = n->next)
1066     {
1067         if (n->type != XML_ELEMENT_NODE)
1068             continue;
1069         if (!strcmp((const char *) n->name, "metadata"))
1070         {
1071             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1072             if (type == NULL) {
1073                 yaz_log(YLOG_FATAL, "Missing type attribute on metadata element. Skipping!");
1074             }
1075             else if (!strcmp(name, (const char *) type))
1076             {
1077                 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
1078                 if (value)
1079                 {
1080                     const char *norm_str;
1081                     pp2_relevance_token_t prt =
1082                         pp2_relevance_tokenize(service->mergekey_pct);
1083                     
1084                     pp2_relevance_first(prt, (const char *) value, 0);
1085                     if (wrbuf_len(norm_wr) > 0)
1086                         wrbuf_puts(norm_wr, " ");
1087                     wrbuf_puts(norm_wr, name);
1088                     while ((norm_str =
1089                             pp2_relevance_token_next(prt)))
1090                     {
1091                         if (*norm_str)
1092                         {
1093                             wrbuf_puts(norm_wr, " ");
1094                             wrbuf_puts(norm_wr, norm_str);
1095                         }
1096                     }
1097                     xmlFree(value);
1098                     pp2_relevance_token_destroy(prt);
1099                     no_found++;
1100                 }
1101             }
1102             xmlFree(type);
1103         }
1104     }
1105     return no_found;
1106 }
1107
1108 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
1109                                 struct conf_service *service, NMEM nmem)
1110 {
1111     char *mergekey_norm = 0;
1112     xmlNode *root = xmlDocGetRootElement(doc);
1113     WRBUF norm_wr = wrbuf_alloc();
1114
1115     /* consider mergekey from XSL first */
1116     xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
1117     if (mergekey)
1118     {
1119         const char *norm_str;
1120         pp2_relevance_token_t prt =
1121             pp2_relevance_tokenize(service->mergekey_pct);
1122
1123         pp2_relevance_first(prt, (const char *) mergekey, 0);
1124         while ((norm_str = pp2_relevance_token_next(prt)))
1125         {
1126             if (*norm_str)
1127             {
1128                 if (wrbuf_len(norm_wr))
1129                     wrbuf_puts(norm_wr, " ");
1130                 wrbuf_puts(norm_wr, norm_str);
1131             }
1132         }
1133         pp2_relevance_token_destroy(prt);
1134         xmlFree(mergekey);
1135     }
1136     else
1137     {
1138         /* no mergekey defined in XSL. Look for mergekey metadata instead */
1139         int field_id;
1140         for (field_id = 0; field_id < service->num_metadata; field_id++)
1141         {
1142             struct conf_metadata *ser_md = &service->metadata[field_id];
1143             if (ser_md->mergekey != Metadata_mergekey_no)
1144             {
1145                 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1146                                               service, norm_wr);
1147                 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1148                 {
1149                     /* no mergekey on this one and it is required.. 
1150                        Generate unique key instead */
1151                     wrbuf_rewind(norm_wr);
1152                     break;
1153                 }
1154             }
1155         }
1156     }
1157
1158     /* generate unique key if none is not generated already or is empty */
1159     if (wrbuf_len(norm_wr) == 0)
1160     {
1161         wrbuf_printf(norm_wr, "%s-%d",
1162                      client_get_database(cl)->database->url, record_no);
1163     }
1164     if (wrbuf_len(norm_wr) > 0)
1165         mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1166     wrbuf_destroy(norm_wr);
1167     return mergekey_norm;
1168 }
1169
1170 /** \brief see if metadata for pz:recordfilter exists 
1171     \param root xml root element of normalized record
1172     \param sdb session database for client
1173     \retval 0 if there is no metadata for pz:recordfilter
1174     \retval 1 if there is metadata for pz:recordfilter
1175
1176     If there is no pz:recordfilter defined, this function returns 1
1177     as well.
1178 */
1179     
1180 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1181 {
1182     int match = 0;
1183     xmlNode *n;
1184     const char *s;
1185     s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1186
1187     if (!s || !*s)
1188         return 1;
1189
1190     for (n = root->children; n; n = n->next)
1191     {
1192         if (n->type != XML_ELEMENT_NODE)
1193             continue;
1194         if (!strcmp((const char *) n->name, "metadata"))
1195         {
1196             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1197             if (type)
1198             {
1199                 size_t len;
1200                 int substring;
1201                 const char *eq;
1202
1203                 if ((eq = strchr(s, '=')))
1204                     substring = 0;
1205                 else if ((eq = strchr(s, '~')))
1206                     substring = 1;
1207                 if (eq)
1208                     len = eq - s;
1209                 else
1210                     len = strlen(s);
1211                 if (len == strlen((const char *)type) &&
1212                     !memcmp((const char *) type, s, len))
1213                 {
1214                     xmlChar *value = xmlNodeGetContent(n);
1215                     if (value && *value)
1216                     {
1217                         if (!eq ||
1218                             (substring && strstr((const char *) value, eq+1)) ||
1219                             (!substring && !strcmp((const char *) value, eq + 1)))
1220                             match = 1;
1221                     }
1222                     xmlFree(value);
1223                 }
1224                 xmlFree(type);
1225             }
1226         }
1227     }
1228     return match;
1229 }
1230
1231
1232 static int ingest_to_cluster(struct client *cl,
1233                              xmlDoc *xdoc,
1234                              xmlNode *root,
1235                              int record_no,
1236                              const char *mergekey_norm);
1237
1238 /** \brief ingest XML record
1239     \param cl client holds the result set for record
1240     \param rec record buffer (0 terminated)
1241     \param record_no record position (1, 2, ..)
1242     \param nmem working NMEM
1243     \retval 0 OK
1244     \retval -1 failure
1245 */
1246 int ingest_record(struct client *cl, const char *rec,
1247                   int record_no, NMEM nmem)
1248 {
1249     struct session *se = client_get_session(cl);
1250     int ret = 0;
1251     struct session_database *sdb = client_get_database(cl);
1252     struct conf_service *service = se->service;
1253     xmlDoc *xdoc = normalize_record(se, sdb, service, rec, nmem);
1254     xmlNode *root;
1255     const char *mergekey_norm;
1256     
1257     if (!xdoc)
1258         return -1;
1259     
1260     root = xmlDocGetRootElement(xdoc);
1261     
1262     if (!check_record_filter(root, sdb))
1263     {
1264         session_log(se, YLOG_WARN, "Filtered out record no %d from %s",
1265                     record_no, sdb->database->url);
1266         xmlFreeDoc(xdoc);
1267         return -1;
1268     }
1269     
1270     mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem);
1271     if (!mergekey_norm)
1272     {
1273         session_log(se, YLOG_WARN, "Got no mergekey");
1274         xmlFreeDoc(xdoc);
1275         return -1;
1276     }
1277     session_enter(se);
1278     if (client_get_session(cl) == se)
1279         ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1280     session_leave(se);
1281     
1282     xmlFreeDoc(xdoc);
1283     return ret;
1284 }
1285
1286 static int ingest_to_cluster(struct client *cl,
1287                              xmlDoc *xdoc,
1288                              xmlNode *root,
1289                              int record_no,
1290                              const char *mergekey_norm)
1291 {
1292     xmlNode *n;
1293     xmlChar *type = 0;
1294     xmlChar *value = 0;
1295     struct session_database *sdb = client_get_database(cl);
1296     struct session *se = client_get_session(cl);
1297     struct conf_service *service = se->service;
1298     struct record *record = record_create(se->nmem, 
1299                                           service->num_metadata,
1300                                           service->num_sortkeys, cl,
1301                                           record_no);
1302     struct record_cluster *cluster = reclist_insert(se->reclist,
1303                                                     service, 
1304                                                     record,
1305                                                     mergekey_norm,
1306                                                     &se->total_merged);
1307
1308     const char *use_term_factor_str = session_setting_oneval(sdb, PZ_TERMLIST_TERM_FACTOR);
1309     int use_term_factor = 0;
1310     int term_factor = 1; 
1311     if (use_term_factor_str && use_term_factor_str[0] != 0)
1312        use_term_factor =  atoi(use_term_factor_str);
1313     if (use_term_factor) {
1314         int maxrecs = client_get_maxrecs(cl);
1315         int hits = (int) client_get_hits(cl);
1316         term_factor = MAX(hits, maxrecs) /  MAX(1, maxrecs);
1317         assert(term_factor >= 1);
1318         yaz_log(YLOG_DEBUG, "Using term factor: %d (%d / %d)", term_factor, MAX(hits, maxrecs), MAX(1, maxrecs));
1319     }
1320
1321     if (!cluster)
1322         return -1;
1323     if (global_parameters.dump_records)
1324         session_log(se, YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1325                     sdb->database->url, record_no);
1326     relevance_newrec(se->relevance, cluster);
1327     
1328     // now parsing XML record and adding data to cluster or record metadata
1329     for (n = root->children; n; n = n->next)
1330     {
1331         pp2_relevance_token_t prt;
1332         if (type)
1333             xmlFree(type);
1334         if (value)
1335             xmlFree(value);
1336         type = value = 0;
1337         
1338         if (n->type != XML_ELEMENT_NODE)
1339             continue;
1340         if (!strcmp((const char *) n->name, "metadata"))
1341         {
1342             struct conf_metadata *ser_md = 0;
1343             struct conf_sortkey *ser_sk = 0;
1344             struct record_metadata **wheretoput = 0;
1345             struct record_metadata *rec_md = 0;
1346             int md_field_id = -1;
1347             int sk_field_id = -1;
1348             
1349             type = xmlGetProp(n, (xmlChar *) "type");
1350             value = xmlNodeListGetString(xdoc, n->children, 1);
1351             
1352             if (!type || !value || !*value)
1353                 continue;
1354             
1355             md_field_id 
1356                 = conf_service_metadata_field_id(service, (const char *) type);
1357             if (md_field_id < 0)
1358             {
1359                 if (se->number_of_warnings_unknown_metadata == 0)
1360                 {
1361                     session_log(se, YLOG_WARN, 
1362                             "Ignoring unknown metadata element: %s", type);
1363                 }
1364                 se->number_of_warnings_unknown_metadata++;
1365                 continue;
1366             }
1367             
1368             ser_md = &service->metadata[md_field_id];
1369             
1370             if (ser_md->sortkey_offset >= 0){
1371                 sk_field_id = ser_md->sortkey_offset;
1372                 ser_sk = &service->sortkeys[sk_field_id];
1373             }
1374
1375             // non-merged metadata
1376             rec_md = record_metadata_init(se->nmem, (const char *) value,
1377                                           ser_md->type, n->properties);
1378             if (!rec_md)
1379             {
1380                 session_log(se, YLOG_WARN, "bad metadata data '%s' "
1381                             "for element '%s'", value, type);
1382                 continue;
1383             }
1384             wheretoput = &record->metadata[md_field_id];
1385             while (*wheretoput)
1386                 wheretoput = &(*wheretoput)->next;
1387             *wheretoput = rec_md;
1388
1389             // merged metadata
1390             rec_md = record_metadata_init(se->nmem, (const char *) value,
1391                                           ser_md->type, 0);
1392             wheretoput = &cluster->metadata[md_field_id];
1393
1394             // and polulate with data:
1395             // assign cluster or record based on merge action
1396             if (ser_md->merge == Metadata_merge_unique)
1397             {
1398                 struct record_metadata *mnode;
1399                 for (mnode = *wheretoput; mnode; mnode = mnode->next)
1400                     if (!strcmp((const char *) mnode->data.text.disp, 
1401                                 rec_md->data.text.disp))
1402                         break;
1403                 if (!mnode)
1404                 {
1405                     rec_md->next = *wheretoput;
1406                     *wheretoput = rec_md;
1407                 }
1408             }
1409             else if (ser_md->merge == Metadata_merge_longest)
1410             {
1411                 if (!*wheretoput 
1412                     || strlen(rec_md->data.text.disp) 
1413                     > strlen((*wheretoput)->data.text.disp))
1414                 {
1415                     *wheretoput = rec_md;
1416                     if (ser_sk)
1417                     {
1418                         const char *sort_str = 0;
1419                         int skip_article = 
1420                             ser_sk->type == Metadata_sortkey_skiparticle;
1421
1422                         if (!cluster->sortkeys[sk_field_id])
1423                             cluster->sortkeys[sk_field_id] = 
1424                                 nmem_malloc(se->nmem, 
1425                                             sizeof(union data_types));
1426                          
1427                         prt = pp2_relevance_tokenize(service->sort_pct);
1428
1429                         pp2_relevance_first(prt, rec_md->data.text.disp,
1430                                             skip_article);
1431
1432                         pp2_relevance_token_next(prt);
1433                          
1434                         sort_str = pp2_get_sort(prt);
1435                          
1436                         cluster->sortkeys[sk_field_id]->text.disp = 
1437                             rec_md->data.text.disp;
1438                         if (!sort_str)
1439                         {
1440                             sort_str = rec_md->data.text.disp;
1441                             session_log(se, YLOG_WARN, 
1442                                     "Could not make sortkey. Bug #1858");
1443                         }
1444                         cluster->sortkeys[sk_field_id]->text.sort = 
1445                             nmem_strdup(se->nmem, sort_str);
1446                         pp2_relevance_token_destroy(prt);
1447                     }
1448                 }
1449             }
1450             else if (ser_md->merge == Metadata_merge_all)
1451             {
1452                 rec_md->next = *wheretoput;
1453                 *wheretoput = rec_md;
1454             }
1455             else if (ser_md->merge == Metadata_merge_range)
1456             {
1457                 if (!*wheretoput)
1458                 {
1459                     *wheretoput = rec_md;
1460                     if (ser_sk)
1461                         cluster->sortkeys[sk_field_id] 
1462                             = &rec_md->data;
1463                 }
1464                 else
1465                 {
1466                     int this_min = rec_md->data.number.min;
1467                     int this_max = rec_md->data.number.max;
1468                     if (this_min < (*wheretoput)->data.number.min)
1469                         (*wheretoput)->data.number.min = this_min;
1470                     if (this_max > (*wheretoput)->data.number.max)
1471                         (*wheretoput)->data.number.max = this_max;
1472                 }
1473             }
1474
1475
1476             // ranking of _all_ fields enabled ... 
1477             if (ser_md->rank)
1478                 relevance_countwords(se->relevance, cluster, 
1479                                      (char *) value, ser_md->rank,
1480                                      ser_md->name);
1481
1482             // construct facets ... unless the client already has reported them
1483             if (ser_md->termlist && !client_has_facet(cl, (char *) type))
1484             {
1485
1486                 if (ser_md->type == Metadata_type_year)
1487                 {
1488                     char year[64];
1489                     sprintf(year, "%d", rec_md->data.number.max);
1490
1491                     add_facet(se, (char *) type, year, term_factor);
1492                     if (rec_md->data.number.max != rec_md->data.number.min)
1493                     {
1494                         sprintf(year, "%d", rec_md->data.number.min);
1495                         add_facet(se, (char *) type, year, term_factor);
1496                     }
1497                 }
1498                 else
1499                     add_facet(se, (char *) type, (char *) value, term_factor);
1500             }
1501
1502             // cleaning up
1503             xmlFree(type);
1504             xmlFree(value);
1505             type = value = 0;
1506         }
1507         else
1508         {
1509             if (se->number_of_warnings_unknown_elements == 0)
1510                 session_log(se, YLOG_WARN,
1511                         "Unexpected element in internal record: %s", n->name);
1512             se->number_of_warnings_unknown_elements++;
1513         }
1514     }
1515     if (type)
1516         xmlFree(type);
1517     if (value)
1518         xmlFree(value);
1519
1520     relevance_donerecord(se->relevance, cluster);
1521     se->total_records++;
1522
1523     return 0;
1524 }
1525
1526 void session_log(struct session *s, int level, const char *fmt, ...)
1527 {
1528     char buf[1024];
1529     va_list ap;
1530     va_start(ap, fmt);
1531
1532     yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
1533     yaz_log(level, "Session (%u): %s", s->session_id, buf);
1534
1535     va_end(ap);
1536 }
1537
1538 /*
1539  * Local variables:
1540  * c-basic-offset: 4
1541  * c-file-style: "Stroustrup"
1542  * indent-tabs-mode: nil
1543  * End:
1544  * vim: shiftwidth=4 tabstop=8 expandtab
1545  */
1546