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