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