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