Dynamic mergekey PAZ-868
[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     /* reset list of sorted results and clear to relevance search */
635     se->sorted_results = nmem_malloc(se->nmem, sizeof(*se->sorted_results));
636     se->sorted_results->name = nmem_strdup(se->nmem, sp->name);
637     se->sorted_results->increasing = sp->increasing;
638     se->sorted_results->type = sp->type;
639     se->sorted_results->next = 0;
640
641     session_log(se, YLOG_DEBUG, "clear_set session_sort: field=%s increasing=%d type=%d configured",
642             sp->name, sp->increasing, sp->type);
643
644     se->reclist = reclist_create(se->nmem);
645 }
646
647 static void session_sort_unlocked(struct session *se,
648                                   struct reclist_sortparms *sp,
649                                   const char *mergekey)
650 {
651     struct reclist_sortparms *sr;
652     struct client_list *l;
653     const char *field = sp->name;
654     int increasing = sp->increasing;
655     int type  = sp->type;
656     int clients_research = 0;
657
658     session_log(se, YLOG_DEBUG, "session_sort field=%s increasing=%d type=%d",
659                 field, increasing, type);
660
661     if (!mergekey ||
662         (se->mergekey && !strcmp(se->mergekey, mergekey)))
663     {
664         /* mergekey unchanged.. */
665         /* see if we already have sorted for this criteria */
666         for (sr = se->sorted_results; sr; sr = sr->next)
667         {
668             if (!reclist_sortparms_cmp(sr, sp))
669                 break;
670         }
671         if (sr)
672         {
673             session_log(se, YLOG_DEBUG, "search_sort: field=%s increasing=%d type=%d already fetched",
674                         field, increasing, type);
675             return;
676         }
677         session_log(se, YLOG_DEBUG, "search_sort: field=%s increasing=%d type=%d must fetch",
678                     field, increasing, type);
679     }
680     else
681     {
682         /* new mergekey must research/reingest anyway */
683         assert(mergekey);
684         xfree(se->mergekey);
685         se->mergekey = *mergekey ? xstrdup(mergekey) : 0;
686         clients_research = 1;
687
688         session_log(se, YLOG_DEBUG, "search_sort: new mergekey = %s",
689                     mergekey);
690     }
691
692     // We need to reset reclist on every sort that changes the records, not just for position
693     // So if just one client requires new searching, we need to clear set.
694     // Ask each of the client if sorting requires re-search due to native sort
695     // If it does it will require us to
696     for (l = se->clients_active; l; l = l->next)
697     {
698         struct client *cl = l->client;
699         // Assume no re-search is required.
700         client_parse_init(cl, 1);
701         clients_research += client_parse_sort(cl, sp);
702     }
703     if (clients_research) {
704         session_log(se, YLOG_DEBUG,
705                     "Reset results due to %d clients researching",
706                     clients_research);
707         session_clear_set(se, sp);
708     }
709     else {
710         // A new sorting based on same record set
711         sr = nmem_malloc(se->nmem, sizeof(*sr));
712         sr->name = nmem_strdup(se->nmem, field);
713         sr->increasing = increasing;
714         sr->type = type;
715         sr->next = se->sorted_results;
716         se->sorted_results = sr;
717         session_log(se, YLOG_DEBUG, "No research/ingesting done");
718         return ;
719     }
720     session_log(se, YLOG_DEBUG, "Re- search/ingesting for clients due to change in sort order");
721
722     for (l = se->clients_active; l; l = l->next)
723     {
724         struct client *cl = l->client;
725         if (client_get_state(cl) == Client_Connecting ||
726             client_get_state(cl) == Client_Idle ||
727             client_get_state(cl) == Client_Working) {
728             client_start_search(cl);
729         }
730         else {
731             session_log(se, YLOG_DEBUG,
732                         "Client %s: No re-start/ingest in show. Wrong client state: %d",
733                         client_get_id(cl), client_get_state(cl));
734         }
735
736     }
737 }
738
739 void session_sort(struct session *se, struct reclist_sortparms *sp,
740                   const char *mergekey)
741 {
742     //session_enter(se, "session_sort");
743     session_sort_unlocked(se, sp, mergekey);
744     //session_leave(se, "session_sort");
745 }
746
747
748 enum pazpar2_error_code session_search(struct session *se,
749                                        const char *query,
750                                        const char *startrecs,
751                                        const char *maxrecs,
752                                        const char *filter,
753                                        const char *limit,
754                                        const char **addinfo,
755                                        struct reclist_sortparms *sp)
756 {
757     int live_channels = 0;
758     int no_working = 0;
759     int no_failed_query = 0;
760     int no_failed_limit = 0;
761     struct client_list *l, *l0;
762
763     session_log(se, YLOG_DEBUG, "Search");
764
765     *addinfo = 0;
766
767     if (se->settings_modified) {
768         session_remove_cached_clients(se);
769     }
770     else
771         session_reset_active_clients(se, 0);
772
773     session_enter(se, "session_search");
774     se->settings_modified = 0;
775
776     session_clear_set(se, sp);
777     relevance_destroy(&se->relevance);
778
779     live_channels = select_targets(se, filter);
780     if (!live_channels)
781     {
782         session_leave(se, "session_search");
783         return PAZPAR2_NO_TARGETS;
784     }
785
786     facet_limits_destroy(se->facet_limits);
787     se->facet_limits = facet_limits_create(limit);
788     if (!se->facet_limits)
789     {
790         *addinfo = "limit";
791         session_leave(se, "session_search");
792         return PAZPAR2_MALFORMED_PARAMETER_VALUE;
793     }
794
795     l0 = se->clients_active;
796     se->clients_active = 0;
797     session_leave(se, "session_search");
798
799     for (l = l0; l; l = l->next)
800     {
801         int parse_ret;
802         struct client *cl = l->client;
803         client_parse_init(cl, 1);
804         if (prepare_map(se, client_get_database(cl)) < 0)
805             continue;
806
807         parse_ret = client_parse_query(cl, query, se->facet_limits);
808         if (parse_ret == -1)
809             no_failed_query++;
810         else if (parse_ret == -2)
811             no_failed_limit++;
812         else if (parse_ret < 0)
813             no_working++; /* other error, such as bad CCL map */
814         else
815         {
816             client_parse_range(cl, startrecs, maxrecs);
817             client_parse_sort(cl, sp);
818             client_start_search(cl);
819             no_working++;
820         }
821     }
822     session_reset_active_clients(se, l0);
823
824     if (no_working == 0)
825     {
826         if (no_failed_query > 0)
827         {
828             *addinfo = "query";
829             return PAZPAR2_MALFORMED_PARAMETER_VALUE;
830         }
831         else if (no_failed_limit > 0)
832         {
833             *addinfo = "limit";
834             return PAZPAR2_MALFORMED_PARAMETER_VALUE;
835         }
836         else
837             return PAZPAR2_NO_TARGETS;
838     }
839     session_log(se, YLOG_LOG, "session_start_search done");
840     return PAZPAR2_NO_ERROR;
841 }
842
843 // Creates a new session_database object for a database
844 static void session_init_databases_fun(void *context, struct database *db)
845 {
846     struct session *se = (struct session *) context;
847     struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
848     int i;
849
850     new->database = db;
851
852     new->map = 0;
853     assert(db->settings);
854     new->settings = nmem_malloc(se->session_nmem,
855                                 sizeof(struct settings *) * db->num_settings);
856     new->num_settings = db->num_settings;
857     for (i = 0; i < db->num_settings; i++)
858     {
859         struct setting *setting = db->settings[i];
860         new->settings[i] = setting;
861     }
862     new->next = se->databases;
863     se->databases = new;
864 }
865
866 // Doesn't free memory associated with sdb -- nmem takes care of that
867 static void session_database_destroy(struct session_database *sdb)
868 {
869     sdb->map = 0;
870 }
871
872 // Initialize session_database list -- this represents this session's view
873 // of the database list -- subject to modification by the settings ws command
874 void session_init_databases(struct session *se)
875 {
876     se->databases = 0;
877     predef_grep_databases(se, se->service, session_init_databases_fun);
878 }
879
880 // Probably session_init_databases_fun should be refactored instead of
881 // called here.
882 static struct session_database *load_session_database(struct session *se,
883                                                       char *id)
884 {
885     struct database *db = new_database_inherit_settings(id, se->session_nmem, se->service->settings);
886     session_init_databases_fun((void*) se, db);
887
888     // New sdb is head of se->databases list
889     return se->databases;
890 }
891
892 // Find an existing session database. If not found, load it
893 static struct session_database *find_session_database(struct session *se,
894                                                       char *id)
895 {
896     struct session_database *sdb;
897
898     for (sdb = se->databases; sdb; sdb = sdb->next)
899         if (!strcmp(sdb->database->id, id))
900             return sdb;
901     return load_session_database(se, id);
902 }
903
904 // Apply a session override to a database
905 void session_apply_setting(struct session *se, char *dbname, char *setting,
906                            char *value)
907 {
908     struct session_database *sdb = find_session_database(se, dbname);
909     struct conf_service *service = se->service;
910     struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
911     int offset = settings_create_offset(service, setting);
912
913     expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
914                           se->session_nmem);
915     new->precedence = 0;
916     new->target = dbname;
917     new->name = setting;
918     new->value = value;
919     new->next = sdb->settings[offset];
920     sdb->settings[offset] = new;
921
922     se->settings_modified = 1;
923
924     // Force later recompute of settings-driven data structures
925     // (happens when a search starts and client connections are prepared)
926     switch (offset)
927     {
928     case PZ_XSLT:
929         if (sdb->map)
930         {
931             sdb->map = 0;
932         }
933         break;
934     }
935 }
936
937 void session_destroy(struct session *se)
938 {
939     struct session_database *sdb;
940     session_log(se, YLOG_DEBUG, "Destroying");
941     session_use(-1);
942     session_remove_cached_clients(se);
943
944     for (sdb = se->databases; sdb; sdb = sdb->next)
945         session_database_destroy(sdb);
946     normalize_cache_destroy(se->normalize_cache);
947     relevance_destroy(&se->relevance);
948     reclist_destroy(se->reclist);
949     xfree(se->mergekey);
950     if (nmem_total(se->nmem))
951         session_log(se, YLOG_DEBUG, "NMEN operation usage %zd", nmem_total(se->nmem));
952     if (nmem_total(se->session_nmem))
953         session_log(se, YLOG_DEBUG, "NMEN session usage %zd", nmem_total(se->session_nmem));
954     facet_limits_destroy(se->facet_limits);
955     nmem_destroy(se->nmem);
956     service_destroy(se->service);
957     yaz_mutex_destroy(&se->session_mutex);
958 }
959
960 size_t session_get_memory_status(struct session *session) {
961     size_t session_nmem;
962     if (session == 0)
963         return 0;
964     session_enter(session, "session_get_memory_status");
965     session_nmem = nmem_total(session->nmem);
966     session_leave(session, "session_get_memory_status");
967     return session_nmem;
968 }
969
970
971 struct session *new_session(NMEM nmem, struct conf_service *service,
972                             unsigned session_id)
973 {
974     int i;
975     struct session *session = nmem_malloc(nmem, sizeof(*session));
976
977     char tmp_str[50];
978
979     sprintf(tmp_str, "session#%u", session_id);
980
981     session->session_id = session_id;
982     session_log(session, YLOG_DEBUG, "New");
983     session->service = service;
984     session->relevance = 0;
985     session->total_records = 0;
986     session->number_of_warnings_unknown_elements = 0;
987     session->number_of_warnings_unknown_metadata = 0;
988     session->num_termlists = 0;
989     session->reclist = reclist_create(nmem);
990     session->clients_active = 0;
991     session->clients_cached = 0;
992     session->settings_modified = 0;
993     session->session_nmem = nmem;
994     session->nmem = nmem_create();
995     session->databases = 0;
996     session->sorted_results = 0;
997     session->facet_limits = 0;
998     session->mergekey = 0;
999
1000     for (i = 0; i <= SESSION_WATCH_MAX; i++)
1001     {
1002         session->watchlist[i].data = 0;
1003         session->watchlist[i].fun = 0;
1004     }
1005     session->normalize_cache = normalize_cache_create();
1006     session->session_mutex = 0;
1007     pazpar2_mutex_create(&session->session_mutex, tmp_str);
1008     session_use(1);
1009     return session;
1010 }
1011
1012 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf);
1013
1014 static struct hitsbytarget *hitsbytarget_nb(struct session *se,
1015                                             int *count, NMEM nmem)
1016 {
1017     struct hitsbytarget *res = 0;
1018     struct client_list *l;
1019     size_t sz = 0;
1020
1021     for (l = se->clients_active; l; l = l->next)
1022         sz++;
1023
1024     res = nmem_malloc(nmem, sizeof(*res) * sz);
1025     *count = 0;
1026     for (l = se->clients_active; l; l = l->next)
1027     {
1028         struct client *cl = l->client;
1029         WRBUF w = wrbuf_alloc();
1030         const char *name = session_setting_oneval(client_get_database(cl),
1031                                                   PZ_NAME);
1032
1033         res[*count].id = client_get_id(cl);
1034         res[*count].name = *name ? name : "Unknown";
1035         res[*count].hits = client_get_hits(cl);
1036         res[*count].approximation = client_get_approximation(cl);
1037         res[*count].records = client_get_num_records(cl);
1038         res[*count].filtered = client_get_num_records_filtered(cl);
1039         res[*count].diagnostic =
1040             client_get_diagnostic(cl, &res[*count].message,
1041                                   &res[*count].addinfo);
1042         res[*count].state = client_get_state_str(cl);
1043         res[*count].connected  = client_get_connection(cl) ? 1 : 0;
1044         session_settings_dump(se, client_get_database(cl), w);
1045         res[*count].settings_xml = nmem_strdup(nmem, wrbuf_cstr(w));
1046         wrbuf_rewind(w);
1047         wrbuf_puts(w, "");
1048         res[*count].suggestions_xml = nmem_strdup(nmem, client_get_suggestions_xml(cl, w));
1049         wrbuf_destroy(w);
1050         (*count)++;
1051     }
1052     return res;
1053 }
1054
1055 struct hitsbytarget *get_hitsbytarget(struct session *se, int *count, NMEM nmem)
1056 {
1057     struct hitsbytarget *p;
1058     session_enter(se, "get_hitsbytarget");
1059     p = hitsbytarget_nb(se, count, nmem);
1060     session_leave(se, "get_hitsbytarget");
1061     return p;
1062 }
1063
1064 // Compares two hitsbytarget nodes by hitcount
1065 static int cmp_ht(const void *p1, const void *p2)
1066 {
1067     const struct hitsbytarget *h1 = p1;
1068     const struct hitsbytarget *h2 = p2;
1069     return h2->hits - h1->hits;
1070 }
1071
1072 // Compares two hitsbytarget nodes by hitcount
1073 static int cmp_ht_approx(const void *p1, const void *p2)
1074 {
1075     const struct hitsbytarget *h1 = p1;
1076     const struct hitsbytarget *h2 = p2;
1077     return h2->approximation - h1->approximation;
1078 }
1079
1080 static int targets_termlist_nb(WRBUF wrbuf, struct session *se, int num,
1081                                NMEM nmem, int version)
1082 {
1083     struct hitsbytarget *ht;
1084     int count, i;
1085
1086     ht = hitsbytarget_nb(se, &count, nmem);
1087     if (version >= 2)
1088         qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht_approx);
1089     else
1090         qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
1091     for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
1092     {
1093
1094         // do only print terms which have display names
1095
1096         wrbuf_puts(wrbuf, "<term>\n");
1097
1098         wrbuf_puts(wrbuf, "<id>");
1099         wrbuf_xmlputs(wrbuf, ht[i].id);
1100         wrbuf_puts(wrbuf, "</id>\n");
1101
1102         wrbuf_puts(wrbuf, "<name>");
1103         if (!ht[i].name || !ht[i].name[0])
1104             wrbuf_xmlputs(wrbuf, "NO TARGET NAME");
1105         else
1106             wrbuf_xmlputs(wrbuf, ht[i].name);
1107         wrbuf_puts(wrbuf, "</name>\n");
1108
1109         wrbuf_printf(wrbuf, "<frequency>" ODR_INT_PRINTF "</frequency>\n",
1110                      ht[i].hits);
1111
1112         if (version >= 2) {
1113             // Should not print if we know it isn't a approximation.
1114             wrbuf_printf(wrbuf, "<approximation>" ODR_INT_PRINTF "</approximation>\n", ht[i].approximation);
1115             wrbuf_printf(wrbuf, "<records>%d</records>\n", ht[i].records - ht[i].filtered);
1116             wrbuf_printf(wrbuf, "<filtered>%d</filtered>\n", ht[i].filtered);
1117         }
1118
1119         wrbuf_puts(wrbuf, "<state>");
1120         wrbuf_xmlputs(wrbuf, ht[i].state);
1121         wrbuf_puts(wrbuf, "</state>\n");
1122
1123         wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n",
1124                      ht[i].diagnostic);
1125         wrbuf_puts(wrbuf, "</term>\n");
1126     }
1127     return count;
1128 }
1129
1130 void perform_termlist(struct http_channel *c, struct session *se,
1131                       const char *name, int num, int version)
1132 {
1133     int i, j;
1134     NMEM nmem_tmp = nmem_create();
1135     char **names;
1136     int num_names = 0;
1137
1138     if (!name)
1139         name = "*";
1140
1141     nmem_strsplit(nmem_tmp, ",", name, &names, &num_names);
1142
1143     session_enter(se, "perform_termlist");
1144
1145     for (j = 0; j < num_names; j++)
1146     {
1147         const char *tname;
1148         int must_generate_empty = 1; /* bug 5350 */
1149
1150         for (i = 0; i < se->num_termlists; i++)
1151         {
1152             tname = se->termlists[i].name;
1153             if (!strcmp(names[j], tname) || !strcmp(names[j], "*"))
1154             {
1155                 struct termlist_score **p = 0;
1156                 int len;
1157
1158                 wrbuf_puts(c->wrbuf, "<list name=\"");
1159                 wrbuf_xmlputs(c->wrbuf, tname);
1160                 wrbuf_puts(c->wrbuf, "\">\n");
1161                 must_generate_empty = 0;
1162
1163                 p = termlist_highscore(se->termlists[i].termlist, &len,
1164                                        nmem_tmp);
1165                 if (p)
1166                 {
1167                     int i;
1168                     for (i = 0; i < len && i < num; i++)
1169                     {
1170                         // prevent sending empty term elements
1171                         if (!p[i]->display_term || !p[i]->display_term[0])
1172                             continue;
1173
1174                         wrbuf_puts(c->wrbuf, "<term>");
1175                         wrbuf_puts(c->wrbuf, "<name>");
1176                         wrbuf_xmlputs(c->wrbuf, p[i]->display_term);
1177                         wrbuf_puts(c->wrbuf, "</name>");
1178
1179                         wrbuf_printf(c->wrbuf,
1180                                      "<frequency>%d</frequency>",
1181                                      p[i]->frequency);
1182                         wrbuf_puts(c->wrbuf, "</term>\n");
1183                     }
1184                 }
1185                 wrbuf_puts(c->wrbuf, "</list>\n");
1186             }
1187         }
1188         tname = "xtargets";
1189         if (!strcmp(names[j], tname) || !strcmp(names[j], "*"))
1190         {
1191             wrbuf_puts(c->wrbuf, "<list name=\"");
1192             wrbuf_xmlputs(c->wrbuf, tname);
1193             wrbuf_puts(c->wrbuf, "\">\n");
1194
1195             targets_termlist_nb(c->wrbuf, se, num, c->nmem, version);
1196             wrbuf_puts(c->wrbuf, "</list>\n");
1197             must_generate_empty = 0;
1198         }
1199         if (must_generate_empty)
1200         {
1201             wrbuf_puts(c->wrbuf, "<list name=\"");
1202             wrbuf_xmlputs(c->wrbuf, names[j]);
1203             wrbuf_puts(c->wrbuf, "\"/>\n");
1204         }
1205     }
1206     session_leave(se, "perform_termlist");
1207     nmem_destroy(nmem_tmp);
1208 }
1209
1210 #ifdef MISSING_HEADERS
1211 void report_nmem_stats(void)
1212 {
1213     size_t in_use, is_free;
1214
1215     nmem_get_memory_in_use(&in_use);
1216     nmem_get_memory_free(&is_free);
1217
1218     yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
1219             (long) in_use, (long) is_free);
1220 }
1221 #endif
1222
1223 struct record_cluster *show_single_start(struct session *se, const char *id,
1224                                          struct record_cluster **prev_r,
1225                                          struct record_cluster **next_r)
1226 {
1227     struct record_cluster *r = 0;
1228
1229     session_enter(se, "show_single_start");
1230     *prev_r = 0;
1231     *next_r = 0;
1232     reclist_limit(se->reclist, se);
1233
1234     reclist_enter(se->reclist);
1235     while ((r = reclist_read_record(se->reclist)))
1236     {
1237         if (!strcmp(r->recid, id))
1238         {
1239             *next_r = reclist_read_record(se->reclist);
1240             break;
1241         }
1242         *prev_r = r;
1243     }
1244     reclist_leave(se->reclist);
1245     if (!r)
1246         session_leave(se, "show_single_start");
1247     return r;
1248 }
1249
1250 void show_single_stop(struct session *se, struct record_cluster *rec)
1251 {
1252     session_leave(se, "show_single_stop");
1253 }
1254
1255
1256 int session_fetch_more(struct session *se)
1257 {
1258     struct client_list *l;
1259     int ret = 0;
1260
1261     for (l = se->clients_active; l; l = l->next)
1262     {
1263         struct client *cl = l->client;
1264         if (client_get_state(cl) == Client_Idle)
1265         {
1266             if (client_fetch_more(cl))
1267             {
1268                 session_log(se, YLOG_LOG, "%s: more to fetch",
1269                             client_get_id(cl));
1270                 ret = 1;
1271             }
1272             else
1273             {
1274                 session_log(se, YLOG_LOG, "%s: no more to fetch",
1275                             client_get_id(cl));
1276             }
1277         }
1278         else
1279         {
1280             session_log(se, YLOG_LOG, "%s: no fetch due to state=%s",
1281                         client_get_id(cl), client_get_state_str(cl));
1282         }
1283
1284     }
1285     return ret;
1286 }
1287
1288 struct record_cluster **show_range_start(struct session *se,
1289                                          struct reclist_sortparms *sp,
1290                                          int start, int *num, int *total,
1291                                          Odr_int *sumhits, Odr_int *approx_hits,
1292                                          void (*show_records_ready)(void *data),
1293                                          struct http_channel *chan)
1294 {
1295     struct record_cluster **recs = 0;
1296     struct reclist_sortparms *spp;
1297     struct client_list *l;
1298     int i;
1299 #if USE_TIMING
1300     yaz_timing_t t = yaz_timing_create();
1301 #endif
1302     session_enter(se, "show_range_start");
1303     *sumhits = 0;
1304     *approx_hits = 0;
1305     *total = 0;
1306     reclist_limit(se->reclist, se);
1307     if (se->relevance)
1308     {
1309         for (spp = sp; spp; spp = spp->next)
1310             if (spp->type == Metadata_sortkey_relevance)
1311             {
1312                 relevance_prepare_read(se->relevance, se->reclist);
1313                 break;
1314             }
1315         for (l = se->clients_active; l; l = l->next) {
1316             *sumhits += client_get_hits(l->client);
1317             *approx_hits += client_get_approximation(l->client);
1318         }
1319     }
1320     reclist_sort(se->reclist, sp);
1321
1322     reclist_enter(se->reclist);
1323     *total = reclist_get_num_records(se->reclist);
1324
1325     for (l = se->clients_active; l; l = l->next)
1326         client_update_show_stat(l->client, 0);
1327
1328     for (i = 0; i < start; i++)
1329     {
1330         struct record_cluster *r = reclist_read_record(se->reclist);
1331         if (!r)
1332         {
1333             *num = 0;
1334             break;
1335         }
1336         else
1337         {
1338             struct record *rec = r->records;
1339             for (;rec; rec = rec->next)
1340                 client_update_show_stat(rec->client, 1);
1341         }
1342     }
1343     recs = nmem_malloc(se->nmem, (*num > 0 ? *num : 1) * sizeof(*recs));
1344     for (i = 0; i < *num; i++)
1345     {
1346         struct record_cluster *r = reclist_read_record(se->reclist);
1347         if (!r)
1348         {
1349             *num = i;
1350             break;
1351         }
1352         else
1353         {
1354             struct record *rec = r->records;
1355             for (;rec; rec = rec->next)
1356                 client_update_show_stat(rec->client, 1);
1357             recs[i] = r;
1358         }
1359     }
1360     reclist_leave(se->reclist);
1361 #if USE_TIMING
1362     yaz_timing_stop(t);
1363     session_log(se, YLOG_LOG, "show %6.5f %3.2f %3.2f",
1364             yaz_timing_get_real(t), yaz_timing_get_user(t),
1365             yaz_timing_get_sys(t));
1366     yaz_timing_destroy(&t);
1367 #endif
1368
1369     if (!session_fetch_more(se))
1370         session_log(se, YLOG_LOG, "can not fetch more");
1371     else
1372     {
1373         show_range_stop(se, recs);
1374         session_log(se, YLOG_LOG, "fetching more in progress");
1375         if (session_set_watch(se, SESSION_WATCH_SHOW,
1376                               show_records_ready, chan, chan))
1377         {
1378             session_log(se, YLOG_WARN, "Ignoring show block");
1379             session_enter(se, "show_range_start");
1380         }
1381         else
1382         {
1383             session_log(se, YLOG_LOG, "session watch OK");
1384             return 0;
1385         }
1386     }
1387     return recs;
1388 }
1389
1390 void show_range_stop(struct session *se, struct record_cluster **recs)
1391 {
1392     session_leave(se, "show_range_stop");
1393 }
1394
1395 void statistics(struct session *se, struct statistics *stat)
1396 {
1397     struct client_list *l;
1398     int count = 0;
1399
1400     memset(stat, 0, sizeof(*stat));
1401     stat->num_hits = 0;
1402     for (l = se->clients_active; l; l = l->next)
1403     {
1404         struct client *cl = l->client;
1405         if (!client_get_connection(cl))
1406             stat->num_no_connection++;
1407         stat->num_hits += client_get_hits(cl);
1408         switch (client_get_state(cl))
1409         {
1410         case Client_Connecting: stat->num_connecting++; break;
1411         case Client_Working: stat->num_working++; break;
1412         case Client_Idle: stat->num_idle++; break;
1413         case Client_Failed: stat->num_failed++; break;
1414         case Client_Error: stat->num_error++; break;
1415         default: break;
1416         }
1417         count++;
1418     }
1419     stat->num_records = se->total_records;
1420
1421     stat->num_clients = count;
1422 }
1423
1424 static struct record_metadata *record_metadata_init(
1425     NMEM nmem, const char *value, enum conf_metadata_type type,
1426     struct _xmlAttr *attr)
1427 {
1428     struct record_metadata *rec_md = record_metadata_create(nmem);
1429     struct record_metadata_attr **attrp = &rec_md->attributes;
1430
1431     for (; attr; attr = attr->next)
1432     {
1433         if (attr->children && attr->children->content)
1434         {
1435             if (strcmp((const char *) attr->name, "type")
1436                 && strcmp((const char *) attr->name, "empty"))
1437             {  /* skip the "type" + "empty" attribute..
1438                   The "Type" is already part of the element in output
1439                   (md-%s) and so repeating it here is redundant */
1440                 *attrp = nmem_malloc(nmem, sizeof(**attrp));
1441                 (*attrp)->name =
1442                     nmem_strdup(nmem, (const char *) attr->name);
1443                 (*attrp)->value =
1444                     nmem_strdup(nmem, (const char *) attr->children->content);
1445                 attrp = &(*attrp)->next;
1446             }
1447         }
1448     }
1449     *attrp = 0;
1450
1451     if (type == Metadata_type_generic)
1452     {
1453         char *p = nmem_strdup(nmem, value);
1454
1455         p = normalize7bit_generic(p, " ,/.:([");
1456
1457         rec_md->data.text.disp = p;
1458         rec_md->data.text.sort = 0;
1459     }
1460     else if (type == Metadata_type_year || type == Metadata_type_date)
1461     {
1462         int first, last;
1463         int longdate = 0;
1464
1465         if (type == Metadata_type_date)
1466             longdate = 1;
1467         if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
1468             return 0;
1469
1470         rec_md->data.number.min = first;
1471         rec_md->data.number.max = last;
1472     }
1473     else
1474         return 0;
1475     return rec_md;
1476 }
1477
1478 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
1479                                  struct conf_service *service, WRBUF norm_wr)
1480 {
1481     xmlNode *n;
1482     int no_found = 0;
1483     for (n = root->children; n; n = n->next)
1484     {
1485         if (n->type != XML_ELEMENT_NODE)
1486             continue;
1487         if (!strcmp((const char *) n->name, "metadata"))
1488         {
1489             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1490             if (type == NULL) {
1491                 yaz_log(YLOG_FATAL, "Missing type attribute on metadata element. Skipping!");
1492             }
1493             else if (!strcmp(name, (const char *) type))
1494             {
1495                 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
1496                 if (value)
1497                 {
1498                     const char *norm_str;
1499                     pp2_charset_token_t prt =
1500                         pp2_charset_token_create(service->charsets, "mergekey");
1501
1502                     pp2_charset_token_first(prt, (const char *) value, 0);
1503                     if (wrbuf_len(norm_wr) > 0)
1504                         wrbuf_puts(norm_wr, " ");
1505                     wrbuf_puts(norm_wr, name);
1506                     while ((norm_str =
1507                             pp2_charset_token_next(prt)))
1508                     {
1509                         if (*norm_str)
1510                         {
1511                             wrbuf_puts(norm_wr, " ");
1512                             wrbuf_puts(norm_wr, norm_str);
1513                         }
1514                     }
1515                     xmlFree(value);
1516                     pp2_charset_token_destroy(prt);
1517                     no_found++;
1518                 }
1519             }
1520             xmlFree(type);
1521         }
1522     }
1523     return no_found;
1524 }
1525
1526 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
1527                                 struct conf_service *service, NMEM nmem,
1528                                 const char *session_mergekey)
1529 {
1530     char *mergekey_norm = 0;
1531     xmlNode *root = xmlDocGetRootElement(doc);
1532     WRBUF norm_wr = wrbuf_alloc();
1533     xmlChar *mergekey;
1534
1535     if (session_mergekey)
1536     {
1537         int i, num = 0;
1538         char **values = 0;
1539         nmem_strsplit_escape2(nmem, ",", session_mergekey, &values,
1540                               &num, 1, '\\', 1);
1541
1542         for (i = 0; i < num; i++)
1543             get_mergekey_from_doc(doc, root, values[i], service, norm_wr);
1544     }
1545     else if ((mergekey = xmlGetProp(root, (xmlChar *) "mergekey")))
1546     {
1547         const char *norm_str;
1548         pp2_charset_token_t prt =
1549             pp2_charset_token_create(service->charsets, "mergekey");
1550
1551         pp2_charset_token_first(prt, (const char *) mergekey, 0);
1552         while ((norm_str = pp2_charset_token_next(prt)))
1553         {
1554             if (*norm_str)
1555             {
1556                 if (wrbuf_len(norm_wr))
1557                     wrbuf_puts(norm_wr, " ");
1558                 wrbuf_puts(norm_wr, norm_str);
1559             }
1560         }
1561         pp2_charset_token_destroy(prt);
1562         xmlFree(mergekey);
1563     }
1564     else
1565     {
1566         /* no mergekey defined in XSL. Look for mergekey metadata instead */
1567         int field_id;
1568         for (field_id = 0; field_id < service->num_metadata; field_id++)
1569         {
1570             struct conf_metadata *ser_md = &service->metadata[field_id];
1571             if (ser_md->mergekey != Metadata_mergekey_no)
1572             {
1573                 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1574                                               service, norm_wr);
1575                 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1576                 {
1577                     /* no mergekey on this one and it is required..
1578                        Generate unique key instead */
1579                     wrbuf_rewind(norm_wr);
1580                     break;
1581                 }
1582             }
1583         }
1584     }
1585
1586     /* generate unique key if none is not generated already or is empty */
1587     if (wrbuf_len(norm_wr) == 0)
1588     {
1589         wrbuf_printf(norm_wr, "position: %s-%d",
1590                      client_get_id(cl), record_no);
1591     }
1592     else
1593     {
1594         const char *lead = "content: ";
1595         wrbuf_insert(norm_wr, 0, lead, strlen(lead));
1596     }
1597     if (wrbuf_len(norm_wr) > 0)
1598         mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1599     wrbuf_destroy(norm_wr);
1600     return mergekey_norm;
1601 }
1602
1603 /** \brief see if metadata for pz:recordfilter exists
1604     \param root xml root element of normalized record
1605     \param sdb session database for client
1606     \retval 0 if there is no metadata for pz:recordfilter
1607     \retval 1 if there is metadata for pz:recordfilter
1608
1609     If there is no pz:recordfilter defined, this function returns 1
1610     as well.
1611 */
1612
1613 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1614 {
1615     int match = 0;
1616     xmlNode *n;
1617     const char *s;
1618     s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1619
1620     if (!s || !*s)
1621         return 1;
1622
1623     for (n = root->children; n; n = n->next)
1624     {
1625         if (n->type != XML_ELEMENT_NODE)
1626             continue;
1627         if (!strcmp((const char *) n->name, "metadata"))
1628         {
1629             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1630             if (type)
1631             {
1632                 size_t len;
1633                 int substring;
1634                 const char *eq;
1635
1636                 if ((eq = strchr(s, '=')))
1637                     substring = 0;
1638                 else if ((eq = strchr(s, '~')))
1639                     substring = 1;
1640                 if (eq)
1641                     len = eq - s;
1642                 else
1643                     len = strlen(s);
1644                 if (len == strlen((const char *)type) &&
1645                     !memcmp((const char *) type, s, len))
1646                 {
1647                     xmlChar *value = xmlNodeGetContent(n);
1648                     if (value && *value)
1649                     {
1650                         if (!eq ||
1651                             (substring && strstr((const char *) value, eq+1)) ||
1652                             (!substring && !strcmp((const char *) value, eq + 1)))
1653                             match = 1;
1654                     }
1655                     xmlFree(value);
1656                 }
1657                 xmlFree(type);
1658             }
1659         }
1660     }
1661     return match;
1662 }
1663
1664
1665 static int ingest_to_cluster(struct client *cl,
1666                              xmlDoc *xdoc,
1667                              xmlNode *root,
1668                              int record_no,
1669                              const char *mergekey_norm);
1670
1671 /** \brief ingest XML record
1672     \param cl client holds the result set for record
1673     \param rec record buffer (0 terminated)
1674     \param record_no record position (1, 2, ..)
1675     \param nmem working NMEM
1676     \retval 0 OK
1677     \retval -1 failure
1678     \retval -2 Filtered
1679 */
1680 int ingest_record(struct client *cl, const char *rec,
1681                   int record_no, NMEM nmem)
1682 {
1683     struct session *se = client_get_session(cl);
1684     int ret = 0;
1685     struct session_database *sdb = client_get_database(cl);
1686     struct conf_service *service = se->service;
1687     xmlDoc *xdoc = normalize_record(se, sdb, service, rec, nmem);
1688     xmlNode *root;
1689     const char *mergekey_norm;
1690
1691     if (!xdoc)
1692         return -1;
1693
1694     root = xmlDocGetRootElement(xdoc);
1695
1696     if (!check_record_filter(root, sdb))
1697     {
1698         session_log(se, YLOG_LOG, "Filtered out record no %d from %s", record_no, sdb->database->id);
1699         xmlFreeDoc(xdoc);
1700         return -2;
1701     }
1702
1703     mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem,
1704         se->mergekey);
1705     if (!mergekey_norm)
1706     {
1707         session_log(se, YLOG_WARN, "Got no mergekey");
1708         xmlFreeDoc(xdoc);
1709         return -1;
1710     }
1711     session_enter(se, "ingest_record");
1712     if (client_get_session(cl) == se && se->relevance)
1713         ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1714     session_leave(se, "ingest_record");
1715
1716     xmlFreeDoc(xdoc);
1717     return ret;
1718 }
1719
1720 //    struct conf_metadata *ser_md = &service->metadata[md_field_id];
1721 //    struct record_metadata *rec_md = record->metadata[md_field_id];
1722 static int match_metadata_local(struct conf_metadata *ser_md,
1723                                 struct record_metadata *rec_md0,
1724                                 char **values, int num_v)
1725 {
1726     int i;
1727     struct record_metadata *rec_md = rec_md0;
1728     for (i = 0; i < num_v; )
1729     {
1730         if (rec_md)
1731         {
1732             if (ser_md->type == Metadata_type_year
1733                 || ser_md->type == Metadata_type_date)
1734             {
1735                 int y = atoi(values[i]);
1736                 if (y >= rec_md->data.number.min
1737                     && y <= rec_md->data.number.max)
1738                     break;
1739             }
1740             else
1741             {
1742                 yaz_log(YLOG_DEBUG, "cmp: '%s' '%s'", rec_md->data.text.disp, values[i]);
1743                 if (!strcmp(rec_md->data.text.disp, values[i]))
1744                 {
1745                     // Value equals, should not be filtered.
1746                     break;
1747                 }
1748             }
1749             rec_md = rec_md->next;
1750         }
1751         else
1752         {
1753             rec_md = rec_md0;
1754             i++;
1755         }
1756     }
1757     return i < num_v ? 1 : 0;
1758 }
1759
1760 int session_check_cluster_limit(struct session *se, struct record_cluster *rec)
1761 {
1762     int i;
1763     struct conf_service *service = se->service;
1764     int ret = 1;
1765     const char *name;
1766     const char *value;
1767     NMEM nmem_tmp = nmem_create();
1768
1769     for (i = 0; (name = facet_limits_get(se->facet_limits, i, &value)); i++)
1770     {
1771         int j;
1772         for (j = 0; j < service->num_metadata; j++)
1773         {
1774             struct conf_metadata *md = service->metadata + j;
1775             if (!strcmp(md->name, name) && md->limitcluster)
1776             {
1777                 char **values = 0;
1778                 int num = 0;
1779                 int md_field_id =
1780                     conf_service_metadata_field_id(service,
1781                                                    md->limitcluster);
1782
1783                 if (md_field_id < 0)
1784                 {
1785                     ret = 0;
1786                     break;
1787                 }
1788
1789                 nmem_strsplit_escape2(nmem_tmp, "|", value, &values,
1790                                       &num, 1, '\\', 1);
1791
1792                 if (!match_metadata_local(&service->metadata[md_field_id],
1793                                           rec->metadata[md_field_id],
1794                                           values, num))
1795                 {
1796                     ret = 0;
1797                     break;
1798                 }
1799             }
1800         }
1801     }
1802     nmem_destroy(nmem_tmp);
1803     return ret;
1804 }
1805
1806 // Skip record on non-zero
1807 static int check_limit_local(struct client *cl,
1808                              struct record *record,
1809                              int record_no)
1810 {
1811     int skip_record = 0;
1812     struct session *se = client_get_session(cl);
1813     struct conf_service *service = se->service;
1814     NMEM nmem_tmp = nmem_create();
1815     struct session_database *sdb = client_get_database(cl);
1816     int l = 0;
1817     while (!skip_record)
1818     {
1819         int md_field_id;
1820         char **values = 0;
1821         int num_v = 0;
1822         const char *name =
1823             client_get_facet_limit_local(cl, sdb, &l, nmem_tmp,
1824                                          &num_v, &values);
1825         if (!name)
1826             break;
1827
1828         if (!strcmp(name, "*"))
1829         {
1830             for (md_field_id = 0; md_field_id < service->num_metadata;
1831                  md_field_id++)
1832             {
1833                 if (match_metadata_local(
1834                         &service->metadata[md_field_id],
1835                         record->metadata[md_field_id],
1836                         values, num_v))
1837                     break;
1838             }
1839             if (md_field_id == service->num_metadata)
1840                 skip_record = 1;
1841         }
1842         else
1843         {
1844             md_field_id = conf_service_metadata_field_id(service, name);
1845             if (md_field_id < 0)
1846             {
1847                 skip_record = 1;
1848                 break;
1849             }
1850             if (!match_metadata_local(
1851                     &service->metadata[md_field_id],
1852                     record->metadata[md_field_id],
1853                     values, num_v))
1854             {
1855                 skip_record = 1;
1856             }
1857         }
1858     }
1859     nmem_destroy(nmem_tmp);
1860     return skip_record;
1861 }
1862
1863 static int ingest_to_cluster(struct client *cl,
1864                              xmlDoc *xdoc,
1865                              xmlNode *root,
1866                              int record_no,
1867                              const char *mergekey_norm)
1868 {
1869     xmlNode *n;
1870     xmlChar *type = 0;
1871     xmlChar *value = 0;
1872     struct session *se = client_get_session(cl);
1873     struct conf_service *service = se->service;
1874     int term_factor = 1;
1875     struct record_cluster *cluster;
1876     struct record_metadata **metadata0;
1877     struct session_database *sdb = client_get_database(cl);
1878     struct record *record = record_create(se->nmem,
1879                                           service->num_metadata,
1880                                           service->num_sortkeys, cl,
1881                                           record_no);
1882
1883     for (n = root->children; n; n = n->next)
1884     {
1885         if (type)
1886             xmlFree(type);
1887         if (value)
1888             xmlFree(value);
1889         type = value = 0;
1890
1891         if (n->type != XML_ELEMENT_NODE)
1892             continue;
1893         if (!strcmp((const char *) n->name, "metadata"))
1894         {
1895             struct conf_metadata *ser_md = 0;
1896             struct record_metadata **wheretoput = 0;
1897             struct record_metadata *rec_md = 0;
1898             int md_field_id = -1;
1899
1900             type = xmlGetProp(n, (xmlChar *) "type");
1901             value = xmlNodeListGetString(xdoc, n->children, 1);
1902             if (!type)
1903                 continue;
1904             if (!value || !*value)
1905             {
1906                 xmlChar *empty = xmlGetProp(n, (xmlChar *) "empty");
1907                 if (!empty)
1908                     continue;
1909                 if (value)
1910                     xmlFree(value);
1911                 value = empty;
1912             }
1913             md_field_id
1914                 = conf_service_metadata_field_id(service, (const char *) type);
1915             if (md_field_id < 0)
1916             {
1917                 if (se->number_of_warnings_unknown_metadata == 0)
1918                 {
1919                     session_log(se, YLOG_WARN,
1920                             "Ignoring unknown metadata element: %s", type);
1921                 }
1922                 se->number_of_warnings_unknown_metadata++;
1923                 continue;
1924             }
1925
1926             ser_md = &service->metadata[md_field_id];
1927
1928             // non-merged metadata
1929             rec_md = record_metadata_init(se->nmem, (const char *) value,
1930                                           ser_md->type, n->properties);
1931             if (!rec_md)
1932             {
1933                 session_log(se, YLOG_WARN, "bad metadata data '%s' "
1934                             "for element '%s'", value, type);
1935                 continue;
1936             }
1937             wheretoput = &record->metadata[md_field_id];
1938             while (*wheretoput)
1939                 wheretoput = &(*wheretoput)->next;
1940             *wheretoput = rec_md;
1941         }
1942     }
1943
1944     if (check_limit_local(cl, record, record_no))
1945     {
1946         session_log(se, YLOG_LOG, "Facet filtered out record no %d from %s",
1947                     record_no, sdb->database->id);
1948         if (type)
1949             xmlFree(type);
1950         if (value)
1951             xmlFree(value);
1952         return -2;
1953     }
1954     cluster = reclist_insert(se->reclist, service, record,
1955                              mergekey_norm, &se->total_merged);
1956     if (!cluster)
1957         return 0; // complete match with existing record
1958
1959     {
1960         const char *use_term_factor_str =
1961             session_setting_oneval(sdb, PZ_TERMLIST_TERM_FACTOR);
1962         if (use_term_factor_str && use_term_factor_str[0] == '1')
1963         {
1964             int maxrecs = client_get_maxrecs(cl);
1965             int hits = (int) client_get_hits(cl);
1966             term_factor = MAX(hits, maxrecs) /  MAX(1, maxrecs);
1967             assert(term_factor >= 1);
1968             session_log(se, YLOG_DEBUG, "Using term factor: %d (%d / %d)",
1969                         term_factor, MAX(hits, maxrecs), MAX(1, maxrecs));
1970         }
1971     }
1972
1973     if (global_parameters.dump_records)
1974         session_log(se, YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1975                     sdb->database->id, record_no);
1976
1977
1978     relevance_newrec(se->relevance, cluster);
1979
1980     // original metadata, to check if first existence of a field
1981     metadata0 = xmalloc(sizeof(*metadata0) * service->num_metadata);
1982     memcpy(metadata0, cluster->metadata,
1983            sizeof(*metadata0) * service->num_metadata);
1984
1985     // now parsing XML record and adding data to cluster or record metadata
1986     for (n = root->children; n; n = n->next)
1987     {
1988         pp2_charset_token_t prt;
1989         if (type)
1990             xmlFree(type);
1991         if (value)
1992             xmlFree(value);
1993         type = value = 0;
1994
1995         if (n->type != XML_ELEMENT_NODE)
1996             continue;
1997         if (!strcmp((const char *) n->name, "metadata"))
1998         {
1999             struct conf_metadata *ser_md = 0;
2000             struct conf_sortkey *ser_sk = 0;
2001             struct record_metadata **wheretoput = 0;
2002             struct record_metadata *rec_md = 0;
2003             int md_field_id = -1;
2004             int sk_field_id = -1;
2005             const char *rank;
2006             xmlChar *xml_rank;
2007
2008             type = xmlGetProp(n, (xmlChar *) "type");
2009             value = xmlNodeListGetString(xdoc, n->children, 1);
2010
2011             if (!type || !value || !*value)
2012                 continue;
2013
2014             md_field_id
2015                 = conf_service_metadata_field_id(service, (const char *) type);
2016             if (md_field_id < 0)
2017                 continue;
2018
2019             ser_md = &service->metadata[md_field_id];
2020
2021             if (ser_md->sortkey_offset >= 0)
2022             {
2023                 sk_field_id = ser_md->sortkey_offset;
2024                 ser_sk = &service->sortkeys[sk_field_id];
2025             }
2026
2027             // merged metadata
2028             rec_md = record_metadata_init(se->nmem, (const char *) value,
2029                                           ser_md->type, 0);
2030
2031             // see if the field was not in cluster already (from beginning)
2032
2033             if (!rec_md)
2034                 continue;
2035
2036             xml_rank = xmlGetProp(n, (xmlChar *) "rank");
2037             rank = xml_rank ? (const char *) xml_rank : ser_md->rank;
2038
2039             wheretoput = &cluster->metadata[md_field_id];
2040
2041             if (ser_md->merge == Metadata_merge_first)
2042             {
2043                 if (!metadata0[md_field_id])
2044                 {
2045                     while (*wheretoput)
2046                         wheretoput = &(*wheretoput)->next;
2047                     *wheretoput = rec_md;
2048                 }
2049             }
2050             else if (ser_md->merge == Metadata_merge_unique)
2051             {
2052                 while (*wheretoput)
2053                 {
2054                     if (!strcmp((const char *) (*wheretoput)->data.text.disp,
2055                                 rec_md->data.text.disp))
2056                         break;
2057                     wheretoput = &(*wheretoput)->next;
2058                 }
2059                 if (!*wheretoput)
2060                     *wheretoput = rec_md;
2061             }
2062             else if (ser_md->merge == Metadata_merge_longest)
2063             {
2064                 if (!*wheretoput
2065                     || strlen(rec_md->data.text.disp)
2066                     > strlen((*wheretoput)->data.text.disp))
2067                 {
2068                     *wheretoput = rec_md;
2069                     if (ser_sk)
2070                     {
2071                         const char *sort_str = 0;
2072                         int skip_article =
2073                             ser_sk->type == Metadata_sortkey_skiparticle;
2074
2075                         if (!cluster->sortkeys[sk_field_id])
2076                             cluster->sortkeys[sk_field_id] =
2077                                 nmem_malloc(se->nmem,
2078                                             sizeof(union data_types));
2079
2080                         prt =
2081                             pp2_charset_token_create(service->charsets, "sort");
2082
2083                         pp2_charset_token_first(prt, rec_md->data.text.disp,
2084                                                 skip_article);
2085
2086                         pp2_charset_token_next(prt);
2087
2088                         sort_str = pp2_get_sort(prt);
2089
2090                         cluster->sortkeys[sk_field_id]->text.disp =
2091                             rec_md->data.text.disp;
2092                         if (!sort_str)
2093                         {
2094                             sort_str = rec_md->data.text.disp;
2095                             session_log(se, YLOG_WARN,
2096                                     "Could not make sortkey. Bug #1858");
2097                         }
2098                         cluster->sortkeys[sk_field_id]->text.sort =
2099                             nmem_strdup(se->nmem, sort_str);
2100                         pp2_charset_token_destroy(prt);
2101                     }
2102                 }
2103             }
2104             else if (ser_md->merge == Metadata_merge_all)
2105             {
2106                 while (*wheretoput)
2107                     wheretoput = &(*wheretoput)->next;
2108                 *wheretoput = rec_md;
2109             }
2110             else if (ser_md->merge == Metadata_merge_range)
2111             {
2112                 if (!*wheretoput)
2113                 {
2114                     *wheretoput = rec_md;
2115                     if (ser_sk)
2116                         cluster->sortkeys[sk_field_id]
2117                             = &rec_md->data;
2118                 }
2119                 else
2120                 {
2121                     int this_min = rec_md->data.number.min;
2122                     int this_max = rec_md->data.number.max;
2123                     if (this_min < (*wheretoput)->data.number.min)
2124                         (*wheretoput)->data.number.min = this_min;
2125                     if (this_max > (*wheretoput)->data.number.max)
2126                         (*wheretoput)->data.number.max = this_max;
2127                 }
2128             }
2129
2130             // ranking of _all_ fields enabled ...
2131             if (rank)
2132             {
2133                 relevance_countwords(se->relevance, cluster,
2134                                      (char *) value, rank, ser_md->name);
2135             }
2136
2137             // construct facets ... unless the client already has reported them
2138             if (ser_md->termlist && !client_has_facet(cl, (char *) type))
2139             {
2140                 if (ser_md->type == Metadata_type_year)
2141                 {
2142                     char year[64];
2143                     sprintf(year, "%d", rec_md->data.number.max);
2144
2145                     add_facet(se, (char *) type, year, term_factor);
2146                     if (rec_md->data.number.max != rec_md->data.number.min)
2147                     {
2148                         sprintf(year, "%d", rec_md->data.number.min);
2149                         add_facet(se, (char *) type, year, term_factor);
2150                     }
2151                 }
2152                 else
2153                     add_facet(se, (char *) type, (char *) value, term_factor);
2154             }
2155
2156             // cleaning up
2157             if (xml_rank)
2158                 xmlFree(xml_rank);
2159             xmlFree(type);
2160             xmlFree(value);
2161             type = value = 0;
2162         }
2163         else
2164         {
2165             if (se->number_of_warnings_unknown_elements == 0)
2166                 session_log(se, YLOG_WARN,
2167                         "Unexpected element in internal record: %s", n->name);
2168             se->number_of_warnings_unknown_elements++;
2169         }
2170     }
2171     if (type)
2172         xmlFree(type);
2173     if (value)
2174         xmlFree(value);
2175
2176     xfree(metadata0);
2177     relevance_donerecord(se->relevance, cluster);
2178     se->total_records++;
2179
2180     return 0;
2181 }
2182
2183 void session_log(struct session *s, int level, const char *fmt, ...)
2184 {
2185     char buf[1024];
2186     va_list ap;
2187     va_start(ap, fmt);
2188
2189     yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
2190     yaz_log(level, "Session %u: %s", s ? s->session_id : 0, buf);
2191
2192     va_end(ap);
2193 }
2194
2195 /*
2196  * Local variables:
2197  * c-basic-offset: 4
2198  * c-file-style: "Stroustrup"
2199  * indent-tabs-mode: nil
2200  * End:
2201  * vim: shiftwidth=4 tabstop=8 expandtab
2202  */
2203