Merge branch 'master' into session_lock
[pazpar2-moved-to-github.git] / src / session.c
1 /* This file is part of Pazpar2.
2    Copyright (C) 2006-2013 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
60 #define USE_TIMING 0
61 #if USE_TIMING
62 #include <yaz/timing.h>
63 #endif
64
65 #include "ppmutex.h"
66 #include "parameters.h"
67 #include "session.h"
68 #include "eventl.h"
69 #include "http.h"
70 #include "termlists.h"
71 #include "reclists.h"
72 #include "relevance.h"
73 #include "database.h"
74 #include "client.h"
75 #include "settings.h"
76 #include "normalize7bit.h"
77
78 #include <libxml/tree.h>
79
80 #define MAX_CHUNK 15
81
82 #define MAX(a,b) ((a)>(b)?(a):(b))
83
84 // Note: Some things in this structure will eventually move to configuration
85 struct parameters global_parameters =
86 {
87     0,   // dump_records
88     0,   // debug_mode
89     0,   // predictable sessions
90 };
91
92 struct client_list {
93     struct client *client;
94     struct client_list *next;
95 };
96
97 /* session counting (1) , disable client counting (0) */
98 static YAZ_MUTEX g_session_mutex = 0;
99 static int no_sessions = 0;
100 static int no_session_total = 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     if (delta > 0)
110         no_session_total += delta;
111     sessions = no_sessions;
112     yaz_mutex_leave(g_session_mutex);
113     yaz_log(YLOG_DEBUG, "%s sessions=%d", delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), no_sessions);
114     return sessions;
115 }
116
117 int sessions_count(void)
118 {
119     return session_use(0);
120 }
121
122 int session_count_total(void)
123 {
124     int total = 0;
125     if (!g_session_mutex)
126         return 0;
127     yaz_mutex_enter(g_session_mutex);
128     total = no_session_total;
129     yaz_mutex_leave(g_session_mutex);
130     return total;
131 }
132
133 static void log_xml_doc(xmlDoc *doc)
134 {
135     FILE *lf = yaz_log_file();
136     xmlChar *result = 0;
137     int len = 0;
138 #if LIBXML_VERSION >= 20600
139     xmlDocDumpFormatMemory(doc, &result, &len, 1);
140 #else
141     xmlDocDumpMemory(doc, &result, &len);
142 #endif
143     if (lf && len)
144     {
145         (void) fwrite(result, 1, len, lf);
146         fprintf(lf, "\n");
147     }
148     xmlFree(result);
149 }
150
151 void session_enter_ro(struct session *s, const char *caller)
152 {
153     assert(s);
154     if (caller)
155         session_log(s, YLOG_LOG, "Session read lock by %s", caller);
156     pazpar2_lock_rdwr_rlock(&s->lock);
157 }
158
159 void session_enter_rw(struct session *s, const char *caller)
160 {
161     assert(s);
162     if (caller)
163         session_log(s, YLOG_LOG, "Session write lock by %s", caller);
164     pazpar2_lock_rdwr_wlock(&s->lock);
165 }
166
167 void session_upgrade(struct session *s, const char *caller)
168 {
169     assert(s);
170     if (caller)
171         session_log(s, YLOG_LOG, "Session upgrade lock by %s", caller);
172     pazpar2_lock_rdwr_upgrade(&s->lock);
173 }
174
175 void session_leave_ro(struct session *s, const char *caller)
176 {
177     assert(s);
178     if (caller)
179         session_log(s, YLOG_LOG, "Session read unlock by %s", caller);
180     pazpar2_lock_rdwr_runlock(&s->lock);
181 }
182
183 void session_leave_rw(struct session *s, const char *caller)
184 {
185     assert(s);
186     if (caller)
187         session_log(s, YLOG_LOG, "Session write unlock by %s", caller);
188     pazpar2_lock_rdwr_wunlock(&s->lock);
189 }
190
191 void session_downgrade(struct session *s, const char *caller)
192 {
193     assert(s);
194     if (caller)
195         session_log(s, YLOG_LOG, "Session write unlock by %s", caller);
196     pazpar2_lock_rdwr_downgrade(&s->lock);
197 }
198
199 static void session_normalize_facet(struct session *s, const char *type,
200                                     const char *value,
201                                     WRBUF display_wrbuf,
202                                     WRBUF facet_wrbuf)
203 {
204     struct conf_service *service = s->service;
205     pp2_charset_token_t prt;
206     const char *facet_component;
207     int i;
208     const char *icu_chain_id = 0;
209
210     for (i = 0; i < service->num_metadata; i++)
211         if (!strcmp((service->metadata + i)->name, type))
212             icu_chain_id = (service->metadata + i)->facetrule;
213     if (!icu_chain_id)
214         icu_chain_id = "facet";
215     prt = pp2_charset_token_create(service->charsets, icu_chain_id);
216     if (!prt)
217     {
218         yaz_log(YLOG_FATAL, "Unknown ICU chain '%s' for facet of type '%s'",
219                 icu_chain_id, type);
220         wrbuf_destroy(facet_wrbuf);
221         wrbuf_destroy(display_wrbuf);
222         return;
223     }
224     pp2_charset_token_first(prt, value, 0);
225     while ((facet_component = pp2_charset_token_next(prt)))
226     {
227         const char *display_component;
228         if (*facet_component)
229         {
230             if (wrbuf_len(facet_wrbuf))
231                 wrbuf_puts(facet_wrbuf, " ");
232             wrbuf_puts(facet_wrbuf, facet_component);
233         }
234         display_component = pp2_get_display(prt);
235         if (display_component)
236         {
237             if (wrbuf_len(display_wrbuf))
238                 wrbuf_puts(display_wrbuf, " ");
239             wrbuf_puts(display_wrbuf, display_component);
240         }
241     }
242     pp2_charset_token_destroy(prt);
243 }
244
245 void add_facet(struct session *s, const char *type, const char *value, int count)
246 {
247     WRBUF facet_wrbuf = wrbuf_alloc();
248     WRBUF display_wrbuf = wrbuf_alloc();
249
250     session_normalize_facet(s, type, value, display_wrbuf, facet_wrbuf);
251
252     if (wrbuf_len(facet_wrbuf))
253     {
254         int i;
255         for (i = 0; i < s->num_termlists; i++)
256             if (!strcmp(s->termlists[i].name, type))
257                 break;
258         if (i == s->num_termlists)
259         {
260             if (i == SESSION_MAX_TERMLISTS)
261             {
262                 session_log(s, YLOG_FATAL, "Too many termlists");
263                 wrbuf_destroy(facet_wrbuf);
264                 wrbuf_destroy(display_wrbuf);
265                 return;
266             }
267
268             s->termlists[i].name = nmem_strdup(s->nmem, type);
269             s->termlists[i].termlist = termlist_create(s->nmem);
270             s->num_termlists = i + 1;
271         }
272
273 #if 0
274         session_log(s, YLOG_LOG, "Facets for %s: %s norm:%s (%d)", type, value, wrbuf_cstr(facet_wrbuf), count);
275 #endif
276         termlist_insert(s->termlists[i].termlist, wrbuf_cstr(display_wrbuf),
277                         wrbuf_cstr(facet_wrbuf), count);
278     }
279     wrbuf_destroy(facet_wrbuf);
280     wrbuf_destroy(display_wrbuf);
281 }
282
283 static xmlDoc *record_to_xml(struct session *se,
284                              struct session_database *sdb, const char *rec)
285 {
286     struct database *db = sdb->database;
287     xmlDoc *rdoc = 0;
288
289     rdoc = xmlParseMemory(rec, strlen(rec));
290
291     if (!rdoc)
292     {
293         session_log(se, YLOG_WARN, "Non-wellformed XML");
294         return 0;
295     }
296
297     if (global_parameters.dump_records)
298     {
299         session_log(se, YLOG_LOG, "Un-normalized record from %s", db->id);
300         log_xml_doc(rdoc);
301     }
302
303     return rdoc;
304 }
305
306 #define MAX_XSLT_ARGS 16
307
308 // Add static values from session database settings if applicable
309 static void insert_settings_parameters(struct session_database *sdb,
310                                        struct conf_service *service,
311                                        char **parms,
312                                        NMEM nmem)
313 {
314     int i;
315     int nparms = 0;
316     int offset = 0;
317
318     for (i = 0; i < service->num_metadata; i++)
319     {
320         struct conf_metadata *md = &service->metadata[i];
321         int setting;
322
323         if (md->setting == Metadata_setting_parameter &&
324             (setting = settings_lookup_offset(service, md->name)) >= 0)
325         {
326             const char *val = session_setting_oneval(sdb, setting);
327             if (val && nparms < MAX_XSLT_ARGS)
328             {
329                 char *buf;
330                 int len = strlen(val);
331                 buf = nmem_malloc(nmem, len + 3);
332                 buf[0] = '\'';
333                 strcpy(buf + 1, val);
334                 buf[len+1] = '\'';
335                 buf[len+2] = '\0';
336                 parms[offset++] = md->name;
337                 parms[offset++] = buf;
338                 nparms++;
339             }
340         }
341     }
342     parms[offset] = 0;
343 }
344
345 // Add static values from session database settings if applicable
346 static void insert_settings_values(struct session_database *sdb, xmlDoc *doc,
347     struct conf_service *service)
348 {
349     int i;
350
351     for (i = 0; i < service->num_metadata; i++)
352     {
353         struct conf_metadata *md = &service->metadata[i];
354         int offset;
355
356         if (md->setting == Metadata_setting_postproc &&
357             (offset = settings_lookup_offset(service, md->name)) >= 0)
358         {
359             const char *val = session_setting_oneval(sdb, offset);
360             if (val)
361             {
362                 xmlNode *r = xmlDocGetRootElement(doc);
363                 xmlNode *n = xmlNewTextChild(r, 0, (xmlChar *) "metadata",
364                                              (xmlChar *) val);
365                 xmlSetProp(n, (xmlChar *) "type", (xmlChar *) md->name);
366             }
367         }
368     }
369 }
370
371 static xmlDoc *normalize_record(struct session *se,
372                                 struct session_database *sdb,
373                                 struct conf_service *service,
374                                 const char *rec, NMEM nmem)
375 {
376     xmlDoc *rdoc = record_to_xml(se, sdb, rec);
377
378     if (rdoc)
379     {
380         char *parms[MAX_XSLT_ARGS*2+1];
381
382         insert_settings_parameters(sdb, service, parms, nmem);
383
384         if (normalize_record_transform(sdb->map, &rdoc, (const char **)parms))
385         {
386             session_log(se, YLOG_WARN, "Normalize failed");
387         }
388         else
389         {
390             insert_settings_values(sdb, rdoc, service);
391
392             if (global_parameters.dump_records)
393             {
394                 session_log(se, YLOG_LOG, "Normalized record from %s",
395                             sdb->database->id);
396                 log_xml_doc(rdoc);
397             }
398         }
399     }
400     return rdoc;
401 }
402
403 void session_settings_dump(struct session *se,
404                            struct session_database *db,
405                            WRBUF w)
406 {
407     if (db->settings)
408     {
409         int i, num = db->num_settings;
410         for (i = 0; i < num; i++)
411         {
412             struct setting *s = db->settings[i];
413             for (;s ; s = s->next)
414             {
415                 wrbuf_puts(w, "<set name=\"");
416                 wrbuf_xmlputs(w, s->name);
417                 wrbuf_puts(w, "\" value=\"");
418                 wrbuf_xmlputs(w, s->value);
419                 wrbuf_puts(w, "\"/>");
420             }
421             if (db->settings[i])
422                 wrbuf_puts(w, "\n");
423         }
424     }
425 }
426
427 // Retrieve first defined value for 'name' for given database.
428 // Will be extended to take into account user associated with session
429 const char *session_setting_oneval(struct session_database *db, int offset)
430 {
431     if (offset >= db->num_settings || !db->settings[offset])
432         return "";
433     return db->settings[offset]->value;
434 }
435
436 // Prepare XSLT stylesheets for record normalization
437 // Structures are allocated on the session_wide nmem to avoid having
438 // to recompute this for every search. This would lead
439 // to leaking if a single session was to repeatedly change the PZ_XSLT
440 // setting. However, this is not a realistic use scenario.
441 static int prepare_map(struct session *se, struct session_database *sdb)
442 {
443     if (sdb->settings && !sdb->map)
444     {
445         const char *s;
446
447         if (sdb->settings[PZ_XSLT] &&
448             (s = session_setting_oneval(sdb, PZ_XSLT)))
449         {
450             char auto_stylesheet[256];
451
452             if (!strcmp(s, "auto"))
453             {
454                 const char *request_syntax = session_setting_oneval(
455                     sdb, PZ_REQUESTSYNTAX);
456                 if (request_syntax)
457                 {
458                     char *cp;
459                     yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet),
460                                  "%s.xsl", request_syntax);
461                     for (cp = auto_stylesheet; *cp; cp++)
462                     {
463                         /* deliberately only consider ASCII */
464                         if (*cp > 32 && *cp < 127)
465                             *cp = tolower(*cp);
466                     }
467                     s = auto_stylesheet;
468                 }
469                 else
470                 {
471                     session_log(se, YLOG_WARN,
472                                 "No pz:requestsyntax for auto stylesheet");
473                 }
474             }
475             sdb->map = normalize_cache_get(se->normalize_cache,
476                                            se->service, s);
477             if (!sdb->map)
478                 return -1;
479         }
480     }
481     return 0;
482 }
483
484 // called if watch should be removed because http_channel is to be destroyed
485 static void session_watch_cancel(void *data, struct http_channel *c,
486                                  void *data2)
487 {
488     struct session_watchentry *ent = data;
489
490     ent->fun = 0;
491     ent->data = 0;
492     ent->obs = 0;
493 }
494
495 // set watch. Returns 0=OK, -1 if watch is already set
496 int session_set_watch(struct session *s, int what,
497                       session_watchfun fun, void *data,
498                       struct http_channel *chan)
499 {
500     int ret;
501     if (s->watchlist[what].fun)
502         ret = -1;
503     else
504     {
505
506         s->watchlist[what].fun = fun;
507         s->watchlist[what].data = data;
508         s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
509                                                    session_watch_cancel);
510         ret = 0;
511     }
512     return ret;
513 }
514
515 void session_alert_watch(struct session *s, int what)
516 {
517     assert(s);
518     if (s->watchlist[what].fun)
519     {
520         /* our watch is no longer associated with http_channel */
521         void *data;
522         session_watchfun fun;
523
524         http_remove_observer(s->watchlist[what].obs);
525         fun  = s->watchlist[what].fun;
526         data = s->watchlist[what].data;
527
528         /* reset watch before fun is invoked - in case fun wants to set
529            it again */
530         s->watchlist[what].fun = 0;
531         s->watchlist[what].data = 0;
532         s->watchlist[what].obs = 0;
533
534         session_log(s, YLOG_DEBUG,
535                     "Alert Watch: %d calling function: %p", what, fun);
536         fun(data);
537     }
538 }
539
540 //callback for grep_databases
541 static void select_targets_callback(struct session *se,
542                                     struct session_database *db)
543 {
544     struct client *cl;
545     struct client_list *l;
546
547     for (l = se->clients_cached; l; l = l->next)
548         if (client_get_database(l->client) == db)
549             break;
550
551     if (l)
552         cl = l->client;
553     else
554     {
555         cl = client_create(db->database->id);
556         client_set_database(cl, db);
557
558         l = xmalloc(sizeof(*l));
559         l->client = cl;
560         l->next = se->clients_cached;
561         se->clients_cached = l;
562     }
563     /* set session always. If may be 0 if client is not active */
564     client_set_session(cl, se);
565
566     l = xmalloc(sizeof(*l));
567     l->client = cl;
568     l->next = se->clients_active;
569     se->clients_active = l;
570 }
571
572 static void session_reset_active_clients(struct session *se,
573                                          struct client_list *new_list)
574 {
575     struct client_list *l;
576
577     l = se->clients_active;
578     se->clients_active = new_list;
579
580     while (l)
581     {
582         struct client_list *l_next = l->next;
583
584         client_set_session(l->client, 0); /* mark client inactive */
585
586         xfree(l);
587         l = l_next;
588     }
589 }
590
591 static void session_remove_cached_clients(struct session *se)
592 {
593     struct client_list *l;
594
595     session_reset_active_clients(se, 0);
596
597     l = se->clients_cached;
598     se->clients_cached = 0;
599
600     while (l)
601     {
602         struct client_list *l_next = l->next;
603         client_set_session(l->client, 0);
604         client_set_database(l->client, 0);
605         client_destroy(l->client);
606         xfree(l);
607         l = l_next;
608     }
609 }
610
611 // Associates a set of clients with a session;
612 // Note: Session-databases represent databases with per-session
613 // setting overrides
614 static int select_targets(struct session *se, const char *filter)
615 {
616     return session_grep_databases(se, filter, select_targets_callback);
617 }
618
619 int session_active_clients(struct session *s)
620 {
621     struct client_list *l;
622     int res = 0;
623
624     for (l = s->clients_active; l; l = l->next)
625         if (client_is_active(l->client))
626             res++;
627
628     return res;
629 }
630
631 int session_is_preferred_clients_ready(struct session *s)
632 {
633     struct client_list *l;
634     int res = 0;
635
636     for (l = s->clients_active; l; l = l->next)
637         if (client_is_active_preferred(l->client))
638             res++;
639     session_log(s, YLOG_DEBUG, "Has %d active preferred clients.", res);
640     return res == 0;
641 }
642
643 static void session_clear_set(struct session *se, struct reclist_sortparms *sp)
644 {
645     reclist_destroy(se->reclist);
646     se->reclist = 0;
647     if (nmem_total(se->nmem))
648         session_log(se, YLOG_DEBUG, "NMEN operation usage %zd",
649                     nmem_total(se->nmem));
650     nmem_reset(se->nmem);
651     se->total_records = se->total_merged = 0;
652     se->num_termlists = 0;
653
654     /* reset list of sorted results and clear to relevance search */
655     se->sorted_results = nmem_malloc(se->nmem, sizeof(*se->sorted_results));
656     se->sorted_results->name = nmem_strdup(se->nmem, sp->name);
657     se->sorted_results->increasing = sp->increasing;
658     se->sorted_results->type = sp->type;
659     se->sorted_results->next = 0;
660
661     session_log(se, YLOG_DEBUG, "clear_set session_sort: field=%s increasing=%d type=%d configured",
662             sp->name, sp->increasing, sp->type);
663
664     se->reclist = reclist_create(se->nmem);
665 }
666
667 static void session_sort_unlocked(struct session *se,
668                                   struct reclist_sortparms *sp)
669 {
670     struct reclist_sortparms *sr;
671     struct client_list *l;
672     const char *field = sp->name;
673     int increasing = sp->increasing;
674     int type  = sp->type;
675     int clients_research = 0;
676
677     yaz_log(YLOG_DEBUG, "session_sort field=%s increasing=%d type=%d", field, increasing, type);
678     /* see if we already have sorted for this criteria */
679     for (sr = se->sorted_results; sr; sr = sr->next)
680     {
681         if (!reclist_sortparms_cmp(sr,sp))
682             break;
683     }
684     if (sr)
685     {
686         session_log(se, YLOG_DEBUG, "search_sort: field=%s increasing=%d type=%d already fetched",
687                     field, increasing, type);
688         return;
689     }
690     session_log(se, YLOG_DEBUG, "search_sort: field=%s increasing=%d type=%d must fetch",
691                     field, increasing, type);
692
693     // We need to reset reclist on every sort that changes the records, not just for position
694     // So if just one client requires new searching, we need to clear set.
695     // Ask each of the client if sorting requires re-search due to native sort
696     // If it does it will require us to
697     for (l = se->clients_active; l; l = l->next)
698     {
699         struct client *cl = l->client;
700         // Assume no re-search is required.
701         client_parse_init(cl, 1);
702         clients_research += client_parse_sort(cl, sp);
703     }
704     if (clients_research) {
705         yaz_log(YLOG_DEBUG, "Reset results due to %d clients researching", clients_research);
706         session_clear_set(se, sp);
707     }
708     else {
709         // A new sorting based on same record set
710         sr = nmem_malloc(se->nmem, sizeof(*sr));
711         sr->name = nmem_strdup(se->nmem, field);
712         sr->increasing = increasing;
713         sr->type = type;
714         sr->next = se->sorted_results;
715         se->sorted_results = sr;
716         session_log(se, YLOG_DEBUG, "No research/ingesting done");
717         return ;
718     }
719     session_log(se, YLOG_DEBUG, "Re- search/ingesting for clients due to change in sort order");
720
721     for (l = se->clients_active; l; l = l->next)
722     {
723         struct client *cl = l->client;
724         if (client_get_state(cl) == Client_Connecting ||
725             client_get_state(cl) == Client_Idle ||
726             client_get_state(cl) == Client_Working) {
727             client_start_search(cl);
728         }
729         else {
730             yaz_log(YLOG_DEBUG, "Client %s: No re-start/ingest in show. Wrong client state: %d",
731                         client_get_id(cl), client_get_state(cl));
732         }
733
734     }
735 }
736
737 void session_sort(struct session *se, struct reclist_sortparms *sp)
738 {
739     session_enter_rw(se, "session_sort");
740     session_sort_unlocked(se, sp);
741     session_leave_rw(se, "session_sort");
742 }
743
744 static
745 enum pazpar2_error_code session_search_unlocked(struct session *se,
746                                                 const char *query,
747                                                 const char *startrecs,
748                                                 const char *maxrecs,
749                                                 const char *filter,
750                                                 const char *limit,
751                                                 const char **addinfo,
752                                                 struct reclist_sortparms *sp)
753 {
754     int live_channels = 0;
755     int no_working = 0;
756     int no_failed_query = 0;
757     int no_failed_limit = 0;
758     struct client_list *l, *l0;
759
760     session_log(se, YLOG_DEBUG, "Search");
761
762     *addinfo = 0;
763
764     if (se->settings_modified)
765         session_remove_cached_clients(se);
766     else
767         session_reset_active_clients(se, 0);
768
769     se->settings_modified = 0;
770
771     session_clear_set(se, sp);
772     relevance_destroy(&se->relevance);
773
774     live_channels = select_targets(se, filter);
775     if (!live_channels)
776         return PAZPAR2_NO_TARGETS;
777
778     facet_limits_destroy(se->facet_limits);
779     se->facet_limits = facet_limits_create(limit);
780     if (!se->facet_limits)
781     {
782         *addinfo = "limit";
783         return PAZPAR2_MALFORMED_PARAMETER_VALUE;
784     }
785
786     l0 = se->clients_active;
787     se->clients_active = 0;
788
789     for (l = l0; l; l = l->next)
790     {
791         int parse_ret;
792         struct client *cl = l->client;
793         client_parse_init(cl, 1);
794         if (prepare_map(se, client_get_database(cl)) < 0)
795             continue;
796
797         parse_ret = client_parse_query(cl, query, se->facet_limits);
798         if (parse_ret == -1)
799             no_failed_query++;
800         else if (parse_ret == -2)
801             no_failed_limit++;
802         else if (parse_ret < 0)
803             no_working++; /* other error, such as bad CCL map */
804         else
805         {
806             client_parse_range(cl, startrecs, maxrecs);
807             client_parse_sort(cl, sp);
808             client_start_search(cl);
809             no_working++;
810         }
811     }
812     session_reset_active_clients(se, l0);
813
814     if (no_working == 0)
815     {
816         if (no_failed_query > 0)
817         {
818             *addinfo = "query";
819             return PAZPAR2_MALFORMED_PARAMETER_VALUE;
820         }
821         else if (no_failed_limit > 0)
822         {
823             *addinfo = "limit";
824             return PAZPAR2_MALFORMED_PARAMETER_VALUE;
825         }
826         else
827             return PAZPAR2_NO_TARGETS;
828     }
829     return PAZPAR2_NO_ERROR;
830 }
831
832 enum pazpar2_error_code session_search(struct session *se,
833                                        const char *query,
834                                        const char *startrecs,
835                                        const char *maxrecs,
836                                        const char *filter,
837                                        const char *limit,
838                                        const char **addinfo,
839                                        struct reclist_sortparms *sp)
840 {
841     enum pazpar2_error_code c;
842     session_enter_rw(se, "session_search");
843     c = session_search_unlocked(se, query, startrecs, maxrecs, filter,
844                                 limit, addinfo, sp);
845     session_leave_rw(se, "session_search");
846     return c;
847 }
848
849 // Creates a new session_database object for a database
850 static void session_init_databases_fun(void *context, struct database *db)
851 {
852     struct session *se = (struct session *) context;
853     struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
854     int i;
855
856     new->database = db;
857
858     new->map = 0;
859     assert(db->settings);
860     new->settings = nmem_malloc(se->session_nmem,
861                                 sizeof(struct settings *) * db->num_settings);
862     new->num_settings = db->num_settings;
863     for (i = 0; i < db->num_settings; i++)
864     {
865         struct setting *setting = db->settings[i];
866         new->settings[i] = setting;
867     }
868     new->next = se->databases;
869     se->databases = new;
870 }
871
872 // Doesn't free memory associated with sdb -- nmem takes care of that
873 static void session_database_destroy(struct session_database *sdb)
874 {
875     sdb->map = 0;
876 }
877
878 // Initialize session_database list -- this represents this session's view
879 // of the database list -- subject to modification by the settings ws command
880 void session_init_databases(struct session *se)
881 {
882     se->databases = 0;
883     predef_grep_databases(se, se->service, session_init_databases_fun);
884 }
885
886 // Probably session_init_databases_fun should be refactored instead of
887 // called here.
888 static struct session_database *load_session_database(struct session *se,
889                                                       char *id)
890 {
891     struct database *db = new_database_inherit_settings(id, se->session_nmem, se->service->settings);
892     session_init_databases_fun((void*) se, db);
893
894     // New sdb is head of se->databases list
895     return se->databases;
896 }
897
898 // Find an existing session database. If not found, load it
899 static struct session_database *find_session_database(struct session *se,
900                                                       char *id)
901 {
902     struct session_database *sdb;
903
904     for (sdb = se->databases; sdb; sdb = sdb->next)
905         if (!strcmp(sdb->database->id, id))
906             return sdb;
907     return load_session_database(se, id);
908 }
909
910 // Apply a session override to a database
911 void session_apply_setting(struct session *se, char *dbname, char *setting,
912                            char *value)
913 {
914     struct session_database *sdb = find_session_database(se, dbname);
915     struct conf_service *service = se->service;
916     struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
917     int offset = settings_create_offset(service, setting);
918
919     expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
920                           se->session_nmem);
921     new->precedence = 0;
922     new->target = dbname;
923     new->name = setting;
924     new->value = value;
925     new->next = sdb->settings[offset];
926     sdb->settings[offset] = new;
927
928     se->settings_modified = 1;
929
930     // Force later recompute of settings-driven data structures
931     // (happens when a search starts and client connections are prepared)
932     switch (offset)
933     {
934     case PZ_XSLT:
935         if (sdb->map)
936         {
937             sdb->map = 0;
938         }
939         break;
940     }
941 }
942
943 void session_destroy(struct session *se)
944 {
945     struct session_database *sdb;
946
947     session_enter_rw(se, "session_destroy");
948     session_log(se, YLOG_DEBUG, "Destroying");
949     session_use(-1);
950     session_remove_cached_clients(se);
951
952     for (sdb = se->databases; sdb; sdb = sdb->next)
953         session_database_destroy(sdb);
954     normalize_cache_destroy(se->normalize_cache);
955     relevance_destroy(&se->relevance);
956     reclist_destroy(se->reclist);
957     if (nmem_total(se->nmem))
958         session_log(se, YLOG_DEBUG, "NMEN operation usage %zd", nmem_total(se->nmem));
959     if (nmem_total(se->session_nmem))
960         session_log(se, YLOG_DEBUG, "NMEN session usage %zd", nmem_total(se->session_nmem));
961     facet_limits_destroy(se->facet_limits);
962     nmem_destroy(se->nmem);
963     service_destroy(se->service);
964
965     session_leave_rw(se, "session_destroy");
966     pazpar2_lock_rdwr_destroy(&se->lock);
967 }
968
969 size_t session_get_memory_status(struct session *session) {
970     size_t session_nmem;
971     if (session == 0)
972         return 0;
973     session_enter_ro(session, "session_get_memory_status");
974     session_nmem = nmem_total(session->nmem);
975     session_leave_ro(session, "session_get_memory_status");
976     return session_nmem;
977 }
978
979
980 struct session *session_create(NMEM nmem, struct conf_service *service,
981                                unsigned session_id)
982 {
983     int i;
984     struct session *session = nmem_malloc(nmem, sizeof(*session));
985
986     char tmp_str[50];
987
988     sprintf(tmp_str, "session#%u", session_id);
989
990     session->session_id = session_id;
991     session_log(session, YLOG_LOG, "new");
992     session->service = service;
993     session->relevance = 0;
994     session->total_records = 0;
995     session->number_of_warnings_unknown_elements = 0;
996     session->number_of_warnings_unknown_metadata = 0;
997     session->num_termlists = 0;
998     session->reclist = 0;
999     session->clients_active = 0;
1000     session->clients_cached = 0;
1001     session->settings_modified = 0;
1002     session->session_nmem = nmem;
1003     session->nmem = nmem_create();
1004     session->databases = 0;
1005     session->sorted_results = 0;
1006     session->facet_limits = 0;
1007
1008     for (i = 0; i <= SESSION_WATCH_MAX; i++)
1009     {
1010         session->watchlist[i].data = 0;
1011         session->watchlist[i].fun = 0;
1012     }
1013     session->normalize_cache = normalize_cache_create();
1014
1015     pazpar2_lock_rdwr_init(&session->lock);
1016
1017     session_use(1);
1018     return session;
1019 }
1020
1021 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf);
1022
1023 static struct hitsbytarget *hitsbytarget_nb(struct session *se,
1024                                             int *count, NMEM nmem)
1025 {
1026     struct hitsbytarget *res = 0;
1027     struct client_list *l;
1028     size_t sz = 0;
1029
1030     for (l = se->clients_active; l; l = l->next)
1031         sz++;
1032
1033     res = nmem_malloc(nmem, sizeof(*res) * sz);
1034     *count = 0;
1035     for (l = se->clients_active; l; l = l->next)
1036     {
1037         struct client *cl = l->client;
1038         WRBUF w = wrbuf_alloc();
1039         const char *name = session_setting_oneval(client_get_database(cl),
1040                                                   PZ_NAME);
1041
1042         res[*count].id = client_get_id(cl);
1043         res[*count].name = *name ? name : "Unknown";
1044         res[*count].hits = client_get_hits(cl);
1045         res[*count].approximation = client_get_approximation(cl);
1046         res[*count].records = client_get_num_records(cl);
1047         res[*count].filtered = client_get_num_records_filtered(cl);
1048         res[*count].diagnostic =
1049             client_get_diagnostic(cl, &res[*count].message,
1050                                   &res[*count].addinfo);
1051         res[*count].state = client_get_state_str(cl);
1052         res[*count].connected  = client_get_connection(cl) ? 1 : 0;
1053         session_settings_dump(se, client_get_database(cl), w);
1054         res[*count].settings_xml = nmem_strdup(nmem, wrbuf_cstr(w));
1055         wrbuf_rewind(w);
1056         wrbuf_puts(w, "");
1057         res[*count].suggestions_xml = nmem_strdup(nmem, client_get_suggestions_xml(cl, w));
1058         wrbuf_destroy(w);
1059         (*count)++;
1060     }
1061     return res;
1062 }
1063
1064 struct hitsbytarget *get_hitsbytarget(struct session *se, int *count, NMEM nmem)
1065 {
1066     struct hitsbytarget *p;
1067     p = hitsbytarget_nb(se, count, nmem);
1068     return p;
1069 }
1070
1071 // Compares two hitsbytarget nodes by hitcount
1072 static int cmp_ht(const void *p1, const void *p2)
1073 {
1074     const struct hitsbytarget *h1 = p1;
1075     const struct hitsbytarget *h2 = p2;
1076     return h2->hits - h1->hits;
1077 }
1078
1079 // Compares two hitsbytarget nodes by hitcount
1080 static int cmp_ht_approx(const void *p1, const void *p2)
1081 {
1082     const struct hitsbytarget *h1 = p1;
1083     const struct hitsbytarget *h2 = p2;
1084     return h2->approximation - h1->approximation;
1085 }
1086
1087 static int targets_termlist_nb(WRBUF wrbuf, struct session *se, int num,
1088                                NMEM nmem, int version)
1089 {
1090     struct hitsbytarget *ht;
1091     int count, i;
1092
1093     ht = hitsbytarget_nb(se, &count, nmem);
1094     if (version >= 2)
1095         qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht_approx);
1096     else
1097         qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
1098     for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
1099     {
1100
1101         // do only print terms which have display names
1102
1103         wrbuf_puts(wrbuf, "<term>\n");
1104
1105         wrbuf_puts(wrbuf, "<id>");
1106         wrbuf_xmlputs(wrbuf, ht[i].id);
1107         wrbuf_puts(wrbuf, "</id>\n");
1108
1109         wrbuf_puts(wrbuf, "<name>");
1110         if (!ht[i].name || !ht[i].name[0])
1111             wrbuf_xmlputs(wrbuf, "NO TARGET NAME");
1112         else
1113             wrbuf_xmlputs(wrbuf, ht[i].name);
1114         wrbuf_puts(wrbuf, "</name>\n");
1115
1116         wrbuf_printf(wrbuf, "<frequency>" ODR_INT_PRINTF "</frequency>\n",
1117                      ht[i].hits);
1118
1119         if (version >= 2) {
1120             // Should not print if we know it isn't a approximation.
1121             wrbuf_printf(wrbuf, "<approximation>" ODR_INT_PRINTF "</approximation>\n", ht[i].approximation);
1122             wrbuf_printf(wrbuf, "<records>%d</records>\n", ht[i].records - ht[i].filtered);
1123             wrbuf_printf(wrbuf, "<filtered>%d</filtered>\n", ht[i].filtered);
1124         }
1125
1126         wrbuf_puts(wrbuf, "<state>");
1127         wrbuf_xmlputs(wrbuf, ht[i].state);
1128         wrbuf_puts(wrbuf, "</state>\n");
1129
1130         wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n",
1131                      ht[i].diagnostic);
1132         wrbuf_puts(wrbuf, "</term>\n");
1133     }
1134     return count;
1135 }
1136
1137 void perform_termlist(struct http_channel *c, struct session *se,
1138                       const char *name, int num, int version)
1139 {
1140     int i, j;
1141     NMEM nmem_tmp = nmem_create();
1142     char **names;
1143     int num_names = 0;
1144
1145     if (!name)
1146         name = "*";
1147
1148     nmem_strsplit(nmem_tmp, ",", name, &names, &num_names);
1149
1150     session_enter_ro(se, "perform_termlist");
1151
1152     for (j = 0; j < num_names; j++)
1153     {
1154         const char *tname;
1155         int must_generate_empty = 1; /* bug 5350 */
1156
1157         for (i = 0; i < se->num_termlists; i++)
1158         {
1159             tname = se->termlists[i].name;
1160             if (!strcmp(names[j], tname) || !strcmp(names[j], "*"))
1161             {
1162                 struct termlist_score **p = 0;
1163                 int len;
1164
1165                 wrbuf_puts(c->wrbuf, "<list name=\"");
1166                 wrbuf_xmlputs(c->wrbuf, tname);
1167                 wrbuf_puts(c->wrbuf, "\">\n");
1168                 must_generate_empty = 0;
1169
1170                 p = termlist_highscore(se->termlists[i].termlist, &len,
1171                                        nmem_tmp);
1172                 if (p)
1173                 {
1174                     int i;
1175                     for (i = 0; i < len && i < num; i++)
1176                     {
1177                         // prevent sending empty term elements
1178                         if (!p[i]->display_term || !p[i]->display_term[0])
1179                             continue;
1180
1181                         wrbuf_puts(c->wrbuf, "<term>");
1182                         wrbuf_puts(c->wrbuf, "<name>");
1183                         wrbuf_xmlputs(c->wrbuf, p[i]->display_term);
1184                         wrbuf_puts(c->wrbuf, "</name>");
1185
1186                         wrbuf_printf(c->wrbuf,
1187                                      "<frequency>%d</frequency>",
1188                                      p[i]->frequency);
1189                         wrbuf_puts(c->wrbuf, "</term>\n");
1190                     }
1191                 }
1192                 wrbuf_puts(c->wrbuf, "</list>\n");
1193             }
1194         }
1195         tname = "xtargets";
1196         if (!strcmp(names[j], tname) || !strcmp(names[j], "*"))
1197         {
1198             wrbuf_puts(c->wrbuf, "<list name=\"");
1199             wrbuf_xmlputs(c->wrbuf, tname);
1200             wrbuf_puts(c->wrbuf, "\">\n");
1201
1202             targets_termlist_nb(c->wrbuf, se, num, c->nmem, version);
1203             wrbuf_puts(c->wrbuf, "</list>\n");
1204             must_generate_empty = 0;
1205         }
1206         if (must_generate_empty)
1207         {
1208             wrbuf_puts(c->wrbuf, "<list name=\"");
1209             wrbuf_xmlputs(c->wrbuf, names[j]);
1210             wrbuf_puts(c->wrbuf, "\"/>\n");
1211         }
1212     }
1213     session_leave_ro(se, "perform_termlist");
1214     nmem_destroy(nmem_tmp);
1215 }
1216
1217 #ifdef MISSING_HEADERS
1218 void report_nmem_stats(void)
1219 {
1220     size_t in_use, is_free;
1221
1222     nmem_get_memory_in_use(&in_use);
1223     nmem_get_memory_free(&is_free);
1224
1225     yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
1226             (long) in_use, (long) is_free);
1227 }
1228 #endif
1229
1230 struct record_cluster *show_single_start(struct session *se, const char *id,
1231                                          struct record_cluster **prev_r,
1232                                          struct record_cluster **next_r)
1233 {
1234     struct record_cluster *r = 0;
1235
1236     session_enter_ro(se, "show_single_start");
1237     *prev_r = 0;
1238     *next_r = 0;
1239     if (se->reclist)
1240     {
1241         reclist_limit(se->reclist, se);
1242
1243         reclist_enter(se->reclist);
1244         while ((r = reclist_read_record(se->reclist)))
1245         {
1246             if (!strcmp(r->recid, id))
1247             {
1248                 *next_r = reclist_read_record(se->reclist);
1249                 break;
1250             }
1251             *prev_r = r;
1252         }
1253         reclist_leave(se->reclist);
1254     }
1255     if (!r)
1256         session_leave_ro(se, "show_single_start");
1257     return r;
1258 }
1259
1260 void show_single_stop(struct session *se, struct record_cluster *rec)
1261 {
1262     session_leave_ro(se, "show_single_stop");
1263 }
1264
1265
1266 int session_fetch_more(struct session *se)
1267 {
1268     struct client_list *l;
1269     int ret = 0;
1270
1271     for (l = se->clients_active; l; l = l->next)
1272     {
1273         struct client *cl = l->client;
1274         if (client_get_state(cl) == Client_Idle)
1275         {
1276             if (client_fetch_more(cl))
1277             {
1278                 session_log(se, YLOG_LOG, "%s: more to fetch",
1279                             client_get_id(cl));
1280                 ret = 1;
1281             }
1282             else
1283             {
1284                 session_log(se, YLOG_LOG, "%s: no more to fetch",
1285                             client_get_id(cl));
1286             }
1287         }
1288         else
1289         {
1290             session_log(se, YLOG_LOG, "%s: no fetch due to state=%s",
1291                         client_get_id(cl), client_get_state_str(cl));
1292         }
1293
1294     }
1295     return ret;
1296 }
1297
1298 struct record_cluster **show_range_start(struct session *se,
1299                                          struct reclist_sortparms *sp,
1300                                          int start, int *num, int *total,
1301                                          Odr_int *sumhits, Odr_int *approx_hits,
1302                                          void (*show_records_ready)(void *data),
1303                                          struct http_channel *chan)
1304 {
1305     struct record_cluster **recs = 0;
1306     struct reclist_sortparms *spp;
1307     struct client_list *l;
1308     int i;
1309 #if USE_TIMING
1310     yaz_timing_t t = yaz_timing_create();
1311 #endif
1312     *sumhits = 0;
1313     *approx_hits = 0;
1314     *total = 0;
1315     reclist_limit(se->reclist, se);
1316     if (se->relevance)
1317     {
1318         for (spp = sp; spp; spp = spp->next)
1319             if (spp->type == Metadata_sortkey_relevance)
1320             {
1321                 relevance_prepare_read(se->relevance, se->reclist);
1322                 break;
1323             }
1324         for (l = se->clients_active; l; l = l->next) {
1325             *sumhits += client_get_hits(l->client);
1326             *approx_hits += client_get_approximation(l->client);
1327         }
1328     }
1329     reclist_sort(se->reclist, sp);
1330
1331     reclist_enter(se->reclist);
1332     *total = reclist_get_num_records(se->reclist);
1333
1334     for (l = se->clients_active; l; l = l->next)
1335         client_update_show_stat(l->client, 0);
1336
1337     for (i = 0; i < start; i++)
1338     {
1339         struct record_cluster *r = reclist_read_record(se->reclist);
1340         if (!r)
1341         {
1342             *num = 0;
1343             break;
1344         }
1345         else
1346         {
1347             struct record *rec = r->records;
1348             for (;rec; rec = rec->next)
1349                 client_update_show_stat(rec->client, 1);
1350         }
1351     }
1352     if (*num > 0)
1353         recs =
1354             nmem_malloc(se->nmem, *num * sizeof(struct record_cluster *));
1355     for (i = 0; i < *num; i++)
1356     {
1357         struct record_cluster *r = reclist_read_record(se->reclist);
1358         if (!r)
1359         {
1360             *num = i;
1361             break;
1362         }
1363         else
1364         {
1365             struct record *rec = r->records;
1366             for (;rec; rec = rec->next)
1367                 client_update_show_stat(rec->client, 1);
1368             recs[i] = r;
1369         }
1370     }
1371     reclist_leave(se->reclist);
1372 #if USE_TIMING
1373     yaz_timing_stop(t);
1374     yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
1375             yaz_timing_get_real(t), yaz_timing_get_user(t),
1376             yaz_timing_get_sys(t));
1377     yaz_timing_destroy(&t);
1378 #endif
1379
1380     if (!session_fetch_more(se))
1381         session_log(se, YLOG_LOG, "can not fetch more");
1382     else
1383     {
1384         session_log(se, YLOG_LOG, "fetching more in progress");
1385         if (session_set_watch(se, SESSION_WATCH_SHOW,
1386                               show_records_ready, chan, chan))
1387         {
1388             session_log(se, YLOG_WARN, "Ignoring show block");
1389         }
1390         else
1391         {
1392             show_range_stop(se, recs);
1393             session_log(se, YLOG_LOG, "session watch OK");
1394             return 0;
1395         }
1396     }
1397     return recs;
1398 }
1399
1400 void show_range_stop(struct session *se, struct record_cluster **recs)
1401 {
1402 }
1403
1404 void statistics(struct session *se, struct statistics *stat)
1405 {
1406     struct client_list *l;
1407     int count = 0;
1408
1409     memset(stat, 0, sizeof(*stat));
1410     stat->num_hits = 0;
1411     for (l = se->clients_active; l; l = l->next)
1412     {
1413         struct client *cl = l->client;
1414         if (!client_get_connection(cl))
1415             stat->num_no_connection++;
1416         stat->num_hits += client_get_hits(cl);
1417         switch (client_get_state(cl))
1418         {
1419         case Client_Connecting: stat->num_connecting++; break;
1420         case Client_Working: stat->num_working++; break;
1421         case Client_Idle: stat->num_idle++; break;
1422         case Client_Failed: stat->num_failed++; break;
1423         case Client_Error: stat->num_error++; break;
1424         default: break;
1425         }
1426         count++;
1427     }
1428     stat->num_records = se->total_records;
1429
1430     stat->num_clients = count;
1431 }
1432
1433 static struct record_metadata *record_metadata_init(
1434     NMEM nmem, const char *value, enum conf_metadata_type type,
1435     struct _xmlAttr *attr)
1436 {
1437     struct record_metadata *rec_md = record_metadata_create(nmem);
1438     struct record_metadata_attr **attrp = &rec_md->attributes;
1439
1440     for (; attr; attr = attr->next)
1441     {
1442         if (attr->children && attr->children->content)
1443         {
1444             if (strcmp((const char *) attr->name, "type"))
1445             {  /* skip the "type" attribute.. Its value is already part of
1446                   the element in output (md-%s) and so repeating it here
1447                   is redundant */
1448                 *attrp = nmem_malloc(nmem, sizeof(**attrp));
1449                 (*attrp)->name =
1450                     nmem_strdup(nmem, (const char *) attr->name);
1451                 (*attrp)->value =
1452                     nmem_strdup(nmem, (const char *) attr->children->content);
1453                 attrp = &(*attrp)->next;
1454             }
1455         }
1456     }
1457     *attrp = 0;
1458
1459     if (type == Metadata_type_generic)
1460     {
1461         char *p = nmem_strdup(nmem, value);
1462
1463         p = normalize7bit_generic(p, " ,/.:([");
1464
1465         rec_md->data.text.disp = p;
1466         rec_md->data.text.sort = 0;
1467     }
1468     else if (type == Metadata_type_year || type == Metadata_type_date)
1469     {
1470         int first, last;
1471         int longdate = 0;
1472
1473         if (type == Metadata_type_date)
1474             longdate = 1;
1475         if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
1476             return 0;
1477
1478         rec_md->data.number.min = first;
1479         rec_md->data.number.max = last;
1480     }
1481     else
1482         return 0;
1483     return rec_md;
1484 }
1485
1486 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
1487                                  struct conf_service *service, WRBUF norm_wr)
1488 {
1489     xmlNode *n;
1490     int no_found = 0;
1491     for (n = root->children; n; n = n->next)
1492     {
1493         if (n->type != XML_ELEMENT_NODE)
1494             continue;
1495         if (!strcmp((const char *) n->name, "metadata"))
1496         {
1497             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1498             if (type == NULL) {
1499                 yaz_log(YLOG_FATAL, "Missing type attribute on metadata element. Skipping!");
1500             }
1501             else if (!strcmp(name, (const char *) type))
1502             {
1503                 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
1504                 if (value)
1505                 {
1506                     const char *norm_str;
1507                     pp2_charset_token_t prt =
1508                         pp2_charset_token_create(service->charsets, "mergekey");
1509
1510                     pp2_charset_token_first(prt, (const char *) value, 0);
1511                     if (wrbuf_len(norm_wr) > 0)
1512                         wrbuf_puts(norm_wr, " ");
1513                     wrbuf_puts(norm_wr, name);
1514                     while ((norm_str =
1515                             pp2_charset_token_next(prt)))
1516                     {
1517                         if (*norm_str)
1518                         {
1519                             wrbuf_puts(norm_wr, " ");
1520                             wrbuf_puts(norm_wr, norm_str);
1521                         }
1522                     }
1523                     xmlFree(value);
1524                     pp2_charset_token_destroy(prt);
1525                     no_found++;
1526                 }
1527             }
1528             xmlFree(type);
1529         }
1530     }
1531     return no_found;
1532 }
1533
1534 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
1535                                 struct conf_service *service, NMEM nmem)
1536 {
1537     char *mergekey_norm = 0;
1538     xmlNode *root = xmlDocGetRootElement(doc);
1539     WRBUF norm_wr = wrbuf_alloc();
1540
1541     /* consider mergekey from XSL first */
1542     xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
1543     if (mergekey)
1544     {
1545         const char *norm_str;
1546         pp2_charset_token_t prt =
1547             pp2_charset_token_create(service->charsets, "mergekey");
1548
1549         pp2_charset_token_first(prt, (const char *) mergekey, 0);
1550         while ((norm_str = pp2_charset_token_next(prt)))
1551         {
1552             if (*norm_str)
1553             {
1554                 if (wrbuf_len(norm_wr))
1555                     wrbuf_puts(norm_wr, " ");
1556                 wrbuf_puts(norm_wr, norm_str);
1557             }
1558         }
1559         pp2_charset_token_destroy(prt);
1560         xmlFree(mergekey);
1561     }
1562     else
1563     {
1564         /* no mergekey defined in XSL. Look for mergekey metadata instead */
1565         int field_id;
1566         for (field_id = 0; field_id < service->num_metadata; field_id++)
1567         {
1568             struct conf_metadata *ser_md = &service->metadata[field_id];
1569             if (ser_md->mergekey != Metadata_mergekey_no)
1570             {
1571                 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1572                                               service, norm_wr);
1573                 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1574                 {
1575                     /* no mergekey on this one and it is required..
1576                        Generate unique key instead */
1577                     wrbuf_rewind(norm_wr);
1578                     break;
1579                 }
1580             }
1581         }
1582     }
1583
1584     /* generate unique key if none is not generated already or is empty */
1585     if (wrbuf_len(norm_wr) == 0)
1586     {
1587         wrbuf_printf(norm_wr, "position: %s-%d",
1588                      client_get_id(cl), record_no);
1589     }
1590     else
1591     {
1592         const char *lead = "content: ";
1593         wrbuf_insert(norm_wr, 0, lead, strlen(lead));
1594     }
1595     if (wrbuf_len(norm_wr) > 0)
1596         mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1597     wrbuf_destroy(norm_wr);
1598     return mergekey_norm;
1599 }
1600
1601 /** \brief see if metadata for pz:recordfilter exists
1602     \param root xml root element of normalized record
1603     \param sdb session database for client
1604     \retval 0 if there is no metadata for pz:recordfilter
1605     \retval 1 if there is metadata for pz:recordfilter
1606
1607     If there is no pz:recordfilter defined, this function returns 1
1608     as well.
1609 */
1610
1611 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1612 {
1613     int match = 0;
1614     xmlNode *n;
1615     const char *s;
1616     s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1617
1618     if (!s || !*s)
1619         return 1;
1620
1621     for (n = root->children; n; n = n->next)
1622     {
1623         if (n->type != XML_ELEMENT_NODE)
1624             continue;
1625         if (!strcmp((const char *) n->name, "metadata"))
1626         {
1627             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1628             if (type)
1629             {
1630                 size_t len;
1631                 int substring;
1632                 const char *eq;
1633
1634                 if ((eq = strchr(s, '=')))
1635                     substring = 0;
1636                 else if ((eq = strchr(s, '~')))
1637                     substring = 1;
1638                 if (eq)
1639                     len = eq - s;
1640                 else
1641                     len = strlen(s);
1642                 if (len == strlen((const char *)type) &&
1643                     !memcmp((const char *) type, s, len))
1644                 {
1645                     xmlChar *value = xmlNodeGetContent(n);
1646                     if (value && *value)
1647                     {
1648                         if (!eq ||
1649                             (substring && strstr((const char *) value, eq+1)) ||
1650                             (!substring && !strcmp((const char *) value, eq + 1)))
1651                             match = 1;
1652                     }
1653                     xmlFree(value);
1654                 }
1655                 xmlFree(type);
1656             }
1657         }
1658     }
1659     return match;
1660 }
1661
1662
1663 static int ingest_to_cluster(struct client *cl,
1664                              xmlDoc *xdoc,
1665                              xmlNode *root,
1666                              int record_no,
1667                              const char *mergekey_norm);
1668
1669 /** \brief ingest XML record
1670     \param cl client holds the result set for record
1671     \param rec record buffer (0 terminated)
1672     \param record_no record position (1, 2, ..)
1673     \param nmem working NMEM
1674     \retval 0 OK
1675     \retval -1 failure
1676     \retval -2 Filtered
1677 */
1678 int ingest_record(struct client *cl, const char *rec,
1679                   int record_no, NMEM nmem)
1680 {
1681     struct session *se = client_get_session(cl);
1682     int ret = 0;
1683     struct session_database *sdb = client_get_database(cl);
1684     struct conf_service *service = se->service;
1685     xmlDoc *xdoc = normalize_record(se, sdb, service, rec, nmem);
1686     xmlNode *root;
1687     const char *mergekey_norm;
1688
1689     if (!xdoc)
1690         return -1;
1691
1692     root = xmlDocGetRootElement(xdoc);
1693
1694     if (!check_record_filter(root, sdb))
1695     {
1696         session_log(se, YLOG_LOG, "Filtered out record no %d from %s", record_no, sdb->database->id);
1697         xmlFreeDoc(xdoc);
1698         return -2;
1699     }
1700
1701     mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem);
1702     if (!mergekey_norm)
1703     {
1704         session_log(se, YLOG_WARN, "Got no mergekey");
1705         xmlFreeDoc(xdoc);
1706         return -1;
1707     }
1708     assert(client_get_session(cl) == se);
1709
1710     ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1711
1712     xmlFreeDoc(xdoc);
1713     return ret;
1714 }
1715
1716 //    struct conf_metadata *ser_md = &service->metadata[md_field_id];
1717 //    struct record_metadata *rec_md = record->metadata[md_field_id];
1718 static int match_metadata_local(struct conf_metadata *ser_md,
1719                                 struct record_metadata *rec_md0,
1720                                 char **values, int num_v)
1721 {
1722     int i;
1723     struct record_metadata *rec_md = rec_md0;
1724     for (i = 0; i < num_v; )
1725     {
1726         if (rec_md)
1727         {
1728             if (ser_md->type == Metadata_type_year
1729                 || ser_md->type == Metadata_type_date)
1730             {
1731                 int y = atoi(values[i]);
1732                 if (y >= rec_md->data.number.min
1733                     && y <= rec_md->data.number.max)
1734                     break;
1735             }
1736             else
1737             {
1738                 yaz_log(YLOG_DEBUG, "cmp: '%s' '%s'", rec_md->data.text.disp, values[i]);
1739                 if (!strcmp(rec_md->data.text.disp, values[i]))
1740                 {
1741                     // Value equals, should not be filtered.
1742                     break;
1743                 }
1744             }
1745             rec_md = rec_md->next;
1746         }
1747         else
1748         {
1749             rec_md = rec_md0;
1750             i++;
1751         }
1752     }
1753     return i < num_v ? 1 : 0;
1754 }
1755
1756 int session_check_cluster_limit(struct session *se, struct record_cluster *rec)
1757 {
1758     int i;
1759     struct conf_service *service = se->service;
1760     int ret = 1;
1761     const char *name;
1762     const char *value;
1763     NMEM nmem_tmp = nmem_create();
1764
1765     for (i = 0; (name = facet_limits_get(se->facet_limits, i, &value)); i++)
1766     {
1767         int j;
1768         for (j = 0; j < service->num_metadata; j++)
1769         {
1770             struct conf_metadata *md = service->metadata + j;
1771             if (!strcmp(md->name, name) && md->limitcluster)
1772             {
1773                 char **values = 0;
1774                 int num = 0;
1775                 int md_field_id =
1776                     conf_service_metadata_field_id(service,
1777                                                    md->limitcluster);
1778
1779                 if (md_field_id < 0)
1780                 {
1781                     ret = 0;
1782                     break;
1783                 }
1784
1785                 nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
1786                                       &num, 1, '\\', 1);
1787
1788                 if (!match_metadata_local(&service->metadata[md_field_id],
1789                                           rec->metadata[md_field_id],
1790                                           values, num))
1791                 {
1792                     ret = 0;
1793                     break;
1794                 }
1795             }
1796         }
1797     }
1798     nmem_destroy(nmem_tmp);
1799     return ret;
1800 }
1801
1802 // Skip record on non-zero
1803 static int check_limit_local(struct client *cl,
1804                              struct record *record,
1805                              int record_no)
1806 {
1807     int skip_record = 0;
1808     struct session *se = client_get_session(cl);
1809     struct conf_service *service = se->service;
1810     NMEM nmem_tmp = nmem_create();
1811     struct session_database *sdb = client_get_database(cl);
1812     int l = 0;
1813     while (!skip_record)
1814     {
1815         int md_field_id;
1816         char **values = 0;
1817         int num_v = 0;
1818         const char *name =
1819             client_get_facet_limit_local(cl, sdb, &l, nmem_tmp,
1820                                          &num_v, &values);
1821         if (!name)
1822             break;
1823
1824         if (!strcmp(name, "*"))
1825         {
1826             for (md_field_id = 0; md_field_id < service->num_metadata;
1827                  md_field_id++)
1828             {
1829                 if (match_metadata_local(
1830                         &service->metadata[md_field_id],
1831                         record->metadata[md_field_id],
1832                         values, num_v))
1833                     break;
1834             }
1835             if (md_field_id == service->num_metadata)
1836                 skip_record = 1;
1837         }
1838         else
1839         {
1840             md_field_id = conf_service_metadata_field_id(service, name);
1841             if (md_field_id < 0)
1842             {
1843                 skip_record = 1;
1844                 break;
1845             }
1846             if (!match_metadata_local(
1847                     &service->metadata[md_field_id],
1848                     record->metadata[md_field_id],
1849                     values, num_v))
1850             {
1851                 skip_record = 1;
1852             }
1853         }
1854     }
1855     nmem_destroy(nmem_tmp);
1856     return skip_record;
1857 }
1858
1859 static int ingest_to_cluster(struct client *cl,
1860                              xmlDoc *xdoc,
1861                              xmlNode *root,
1862                              int record_no,
1863                              const char *mergekey_norm)
1864 {
1865     xmlNode *n;
1866     xmlChar *type = 0;
1867     xmlChar *value = 0;
1868     struct session *se = client_get_session(cl);
1869     struct conf_service *service = se->service;
1870     int term_factor = 1;
1871     struct record_cluster *cluster;
1872     struct record_metadata **metadata0;
1873     struct session_database *sdb = client_get_database(cl);
1874     struct record *record = record_create(se->nmem,
1875                                           service->num_metadata,
1876                                           service->num_sortkeys, cl,
1877                                           record_no);
1878
1879     for (n = root->children; n; n = n->next)
1880     {
1881         if (type)
1882             xmlFree(type);
1883         if (value)
1884             xmlFree(value);
1885         type = value = 0;
1886
1887         if (n->type != XML_ELEMENT_NODE)
1888             continue;
1889         if (!strcmp((const char *) n->name, "metadata"))
1890         {
1891             struct conf_metadata *ser_md = 0;
1892             struct record_metadata **wheretoput = 0;
1893             struct record_metadata *rec_md = 0;
1894             int md_field_id = -1;
1895
1896             type = xmlGetProp(n, (xmlChar *) "type");
1897             value = xmlNodeListGetString(xdoc, n->children, 1);
1898
1899             if (!type || !value || !*value)
1900                 continue;
1901
1902             md_field_id
1903                 = conf_service_metadata_field_id(service, (const char *) type);
1904             if (md_field_id < 0)
1905             {
1906                 if (se->number_of_warnings_unknown_metadata == 0)
1907                 {
1908                     session_log(se, YLOG_WARN,
1909                             "Ignoring unknown metadata element: %s", type);
1910                 }
1911                 se->number_of_warnings_unknown_metadata++;
1912                 continue;
1913             }
1914
1915             ser_md = &service->metadata[md_field_id];
1916
1917             // non-merged metadata
1918             rec_md = record_metadata_init(se->nmem, (const char *) value,
1919                                           ser_md->type, n->properties);
1920             if (!rec_md)
1921             {
1922                 session_log(se, YLOG_WARN, "bad metadata data '%s' "
1923                             "for element '%s'", value, type);
1924                 continue;
1925             }
1926             wheretoput = &record->metadata[md_field_id];
1927             while (*wheretoput)
1928                 wheretoput = &(*wheretoput)->next;
1929             *wheretoput = rec_md;
1930         }
1931     }
1932
1933     if (check_limit_local(cl, record, record_no))
1934     {
1935         session_log(se, YLOG_LOG, "Facet filtered out record no %d from %s",
1936                     record_no, sdb->database->id);
1937         if (type)
1938             xmlFree(type);
1939         if (value)
1940             xmlFree(value);
1941         return -2;
1942     }
1943     cluster = reclist_insert(se->reclist, service, record,
1944                              mergekey_norm, &se->total_merged);
1945     if (!cluster)
1946         return 0; // complete match with existing record
1947
1948     {
1949         const char *use_term_factor_str =
1950             session_setting_oneval(sdb, PZ_TERMLIST_TERM_FACTOR);
1951         if (use_term_factor_str && use_term_factor_str[0] == '1')
1952         {
1953             int maxrecs = client_get_maxrecs(cl);
1954             int hits = (int) client_get_hits(cl);
1955             term_factor = MAX(hits, maxrecs) /  MAX(1, maxrecs);
1956             assert(term_factor >= 1);
1957             yaz_log(YLOG_DEBUG, "Using term factor: %d (%d / %d)", term_factor, MAX(hits, maxrecs), MAX(1, maxrecs));
1958         }
1959     }
1960
1961     if (global_parameters.dump_records)
1962         session_log(se, YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1963                     sdb->database->id, record_no);
1964
1965
1966     relevance_newrec(se->relevance, cluster);
1967
1968     // original metadata, to check if first existence of a field
1969     metadata0 = xmalloc(sizeof(*metadata0) * service->num_metadata);
1970     memcpy(metadata0, cluster->metadata,
1971            sizeof(*metadata0) * service->num_metadata);
1972
1973     // now parsing XML record and adding data to cluster or record metadata
1974     for (n = root->children; n; n = n->next)
1975     {
1976         pp2_charset_token_t prt;
1977         if (type)
1978             xmlFree(type);
1979         if (value)
1980             xmlFree(value);
1981         type = value = 0;
1982
1983         if (n->type != XML_ELEMENT_NODE)
1984             continue;
1985         if (!strcmp((const char *) n->name, "metadata"))
1986         {
1987             struct conf_metadata *ser_md = 0;
1988             struct conf_sortkey *ser_sk = 0;
1989             struct record_metadata **wheretoput = 0;
1990             struct record_metadata *rec_md = 0;
1991             int md_field_id = -1;
1992             int sk_field_id = -1;
1993             const char *rank;
1994             xmlChar *xml_rank;
1995
1996             type = xmlGetProp(n, (xmlChar *) "type");
1997             value = xmlNodeListGetString(xdoc, n->children, 1);
1998
1999             if (!type || !value || !*value)
2000                 continue;
2001
2002             md_field_id
2003                 = conf_service_metadata_field_id(service, (const char *) type);
2004             if (md_field_id < 0)
2005                 continue;
2006
2007             ser_md = &service->metadata[md_field_id];
2008
2009             if (ser_md->sortkey_offset >= 0)
2010             {
2011                 sk_field_id = ser_md->sortkey_offset;
2012                 ser_sk = &service->sortkeys[sk_field_id];
2013             }
2014
2015             // merged metadata
2016             rec_md = record_metadata_init(se->nmem, (const char *) value,
2017                                           ser_md->type, 0);
2018
2019             // see if the field was not in cluster already (from beginning)
2020
2021             if (!rec_md)
2022                 continue;
2023
2024             xml_rank = xmlGetProp(n, (xmlChar *) "rank");
2025             rank = xml_rank ? (const char *) xml_rank : ser_md->rank;
2026
2027             wheretoput = &cluster->metadata[md_field_id];
2028
2029             if (ser_md->merge == Metadata_merge_first)
2030             {
2031                 if (!metadata0[md_field_id])
2032                 {
2033                     while (*wheretoput)
2034                         wheretoput = &(*wheretoput)->next;
2035                     *wheretoput = rec_md;
2036                 }
2037             }
2038             else if (ser_md->merge == Metadata_merge_unique)
2039             {
2040                 while (*wheretoput)
2041                 {
2042                     if (!strcmp((const char *) (*wheretoput)->data.text.disp,
2043                                 rec_md->data.text.disp))
2044                         break;
2045                     wheretoput = &(*wheretoput)->next;
2046                 }
2047                 if (!*wheretoput)
2048                     *wheretoput = rec_md;
2049             }
2050             else if (ser_md->merge == Metadata_merge_longest)
2051             {
2052                 if (!*wheretoput
2053                     || strlen(rec_md->data.text.disp)
2054                     > strlen((*wheretoput)->data.text.disp))
2055                 {
2056                     *wheretoput = rec_md;
2057                     if (ser_sk)
2058                     {
2059                         const char *sort_str = 0;
2060                         int skip_article =
2061                             ser_sk->type == Metadata_sortkey_skiparticle;
2062
2063                         if (!cluster->sortkeys[sk_field_id])
2064                             cluster->sortkeys[sk_field_id] =
2065                                 nmem_malloc(se->nmem,
2066                                             sizeof(union data_types));
2067
2068                         prt =
2069                             pp2_charset_token_create(service->charsets, "sort");
2070
2071                         pp2_charset_token_first(prt, rec_md->data.text.disp,
2072                                                 skip_article);
2073
2074                         pp2_charset_token_next(prt);
2075
2076                         sort_str = pp2_get_sort(prt);
2077
2078                         cluster->sortkeys[sk_field_id]->text.disp =
2079                             rec_md->data.text.disp;
2080                         if (!sort_str)
2081                         {
2082                             sort_str = rec_md->data.text.disp;
2083                             session_log(se, YLOG_WARN,
2084                                     "Could not make sortkey. Bug #1858");
2085                         }
2086                         cluster->sortkeys[sk_field_id]->text.sort =
2087                             nmem_strdup(se->nmem, sort_str);
2088                         pp2_charset_token_destroy(prt);
2089                     }
2090                 }
2091             }
2092             else if (ser_md->merge == Metadata_merge_all)
2093             {
2094                 while (*wheretoput)
2095                     wheretoput = &(*wheretoput)->next;
2096                 *wheretoput = rec_md;
2097             }
2098             else if (ser_md->merge == Metadata_merge_range)
2099             {
2100                 if (!*wheretoput)
2101                 {
2102                     *wheretoput = rec_md;
2103                     if (ser_sk)
2104                         cluster->sortkeys[sk_field_id]
2105                             = &rec_md->data;
2106                 }
2107                 else
2108                 {
2109                     int this_min = rec_md->data.number.min;
2110                     int this_max = rec_md->data.number.max;
2111                     if (this_min < (*wheretoput)->data.number.min)
2112                         (*wheretoput)->data.number.min = this_min;
2113                     if (this_max > (*wheretoput)->data.number.max)
2114                         (*wheretoput)->data.number.max = this_max;
2115                 }
2116             }
2117
2118             // ranking of _all_ fields enabled ...
2119             if (rank)
2120             {
2121                 relevance_countwords(se->relevance, cluster,
2122                                      (char *) value, rank, ser_md->name);
2123             }
2124
2125             // construct facets ... unless the client already has reported them
2126             if (ser_md->termlist && !client_has_facet(cl, (char *) type))
2127             {
2128                 if (ser_md->type == Metadata_type_year)
2129                 {
2130                     char year[64];
2131                     sprintf(year, "%d", rec_md->data.number.max);
2132
2133                     add_facet(se, (char *) type, year, term_factor);
2134                     if (rec_md->data.number.max != rec_md->data.number.min)
2135                     {
2136                         sprintf(year, "%d", rec_md->data.number.min);
2137                         add_facet(se, (char *) type, year, term_factor);
2138                     }
2139                 }
2140                 else
2141                     add_facet(se, (char *) type, (char *) value, term_factor);
2142             }
2143
2144             // cleaning up
2145             if (xml_rank)
2146                 xmlFree(xml_rank);
2147             xmlFree(type);
2148             xmlFree(value);
2149             type = value = 0;
2150         }
2151         else
2152         {
2153             if (se->number_of_warnings_unknown_elements == 0)
2154                 session_log(se, YLOG_WARN,
2155                         "Unexpected element in internal record: %s", n->name);
2156             se->number_of_warnings_unknown_elements++;
2157         }
2158     }
2159     if (type)
2160         xmlFree(type);
2161     if (value)
2162         xmlFree(value);
2163
2164     xfree(metadata0);
2165     relevance_donerecord(se->relevance, cluster);
2166     se->total_records++;
2167
2168     return 0;
2169 }
2170
2171 void session_log(struct session *s, int level, const char *fmt, ...)
2172 {
2173     char buf[1024];
2174     va_list ap;
2175     va_start(ap, fmt);
2176
2177     yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
2178     yaz_log(level, "Session %u: %s", s->session_id, buf);
2179
2180     va_end(ap);
2181 }
2182
2183 /*
2184  * Local variables:
2185  * c-basic-offset: 4
2186  * c-file-style: "Stroustrup"
2187  * indent-tabs-mode: nil
2188  * End:
2189  * vim: shiftwidth=4 tabstop=8 expandtab
2190  */
2191