Facets factor patch from Giannis plus logging
[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, "Session: 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                     "session_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     const char *maxrecs = session_setting_oneval(db, PZ_MAXRECS);
493     client_set_database(cl, db);
494
495     client_set_session(cl, se);
496
497     if (*maxrecs)
498         client_set_maxrecs(cl, atoi(maxrecs));
499
500     l = xmalloc(sizeof(*l));
501     l->client = cl;
502     l->next = se->clients;
503     se->clients = l;
504 }
505
506 static void session_remove_clients(struct session *se)
507 {
508     struct client_list *l;
509
510     session_enter(se);
511     l = se->clients;
512     se->clients = 0;
513     session_leave(se);
514
515     while (l)
516     {
517         struct client_list *l_next = l->next;
518         client_lock(l->client);
519         client_set_session(l->client, 0);
520         client_set_database(l->client, 0);
521         client_unlock(l->client);
522         client_destroy(l->client);
523         xfree(l);
524         l = l_next;
525     }
526 }
527
528 // Associates a set of clients with a session;
529 // Note: Session-databases represent databases with per-session 
530 // setting overrides
531 static int select_targets(struct session *se, const char *filter)
532 {
533     return session_grep_databases(se, filter, select_targets_callback);
534 }
535
536 int session_active_clients(struct session *s)
537 {
538     struct client_list *l;
539     int res = 0;
540
541     for (l = s->clients; l; l = l->next)
542         if (client_is_active(l->client))
543             res++;
544
545     return res;
546 }
547
548 int session_is_preferred_clients_ready(struct session *s)
549 {
550     struct client_list *l;
551     int res = 0;
552
553     for (l = s->clients; l; l = l->next)
554         if (client_is_active_preferred(l->client))
555             res++;
556     session_log(s, YLOG_DEBUG, "Session has %d active preferred clients.", res);
557     return res == 0;
558 }
559
560
561
562 enum pazpar2_error_code search(struct session *se,
563                                const char *query,
564                                const char *startrecs, const char *maxrecs,
565                                const char *filter,
566                                const char **addinfo)
567 {
568     int live_channels = 0;
569     int no_working = 0;
570     int no_failed = 0;
571     struct client_list *l;
572     struct timeval tval;
573
574     session_log(se, YLOG_DEBUG, "Search");
575
576     *addinfo = 0;
577
578     session_remove_clients(se);
579     
580     session_enter(se);
581     reclist_destroy(se->reclist);
582     se->reclist = 0;
583     relevance_destroy(&se->relevance);
584     nmem_reset(se->nmem);
585     se->total_records = se->total_hits = se->total_merged = 0;
586     se->num_termlists = 0;
587     live_channels = select_targets(se, filter);
588     if (!live_channels)
589     {
590         session_leave(se);
591         return PAZPAR2_NO_TARGETS;
592     }
593     se->reclist = reclist_create(se->nmem);
594
595     yaz_gettimeofday(&tval);
596     
597     tval.tv_sec += 5;
598
599     for (l = se->clients; l; l = l->next)
600     {
601         struct client *cl = l->client;
602
603         if (maxrecs)
604             client_set_maxrecs(cl, atoi(maxrecs));
605         if (startrecs)
606             client_set_startrecs(cl, atoi(startrecs));
607         if (prepare_session_database(se, client_get_database(cl)) < 0)
608             ;
609         else if (client_parse_query(cl, query) < 0)
610             no_failed++;
611         else
612         {
613             no_working++;
614             if (client_prep_connection(cl, se->service->z3950_operation_timeout,
615                                        se->service->z3950_session_timeout,
616                                        se->service->server->iochan_man,
617                                        &tval))
618                 client_start_search(cl);
619         }
620     }
621     session_leave(se);
622     if (no_working == 0)
623     {
624         if (no_failed > 0)
625         {
626             *addinfo = "query";
627             return PAZPAR2_MALFORMED_PARAMETER_VALUE;
628         }
629         else
630             return PAZPAR2_NO_TARGETS;
631     }
632     return PAZPAR2_NO_ERROR;
633 }
634
635 // Creates a new session_database object for a database
636 static void session_init_databases_fun(void *context, struct database *db)
637 {
638     struct session *se = (struct session *) context;
639     struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
640     int i;
641
642     new->database = db;
643     
644     new->map = 0;
645     assert(db->settings);
646     new->settings = nmem_malloc(se->session_nmem,
647                                 sizeof(struct settings *) * db->num_settings);
648     new->num_settings = db->num_settings;
649     for (i = 0; i < db->num_settings; i++)
650     {
651         struct setting *setting = db->settings[i];
652         new->settings[i] = setting;
653     }
654     new->next = se->databases;
655     se->databases = new;
656 }
657
658 // Doesn't free memory associated with sdb -- nmem takes care of that
659 static void session_database_destroy(struct session_database *sdb)
660 {
661     sdb->map = 0;
662 }
663
664 // Initialize session_database list -- this represents this session's view
665 // of the database list -- subject to modification by the settings ws command
666 void session_init_databases(struct session *se)
667 {
668     se->databases = 0;
669     predef_grep_databases(se, se->service, session_init_databases_fun);
670 }
671
672 // Probably session_init_databases_fun should be refactored instead of
673 // called here.
674 static struct session_database *load_session_database(struct session *se, 
675                                                       char *id)
676 {
677     struct database *db = new_database(id, se->session_nmem);
678
679     resolve_database(se->service, db);
680
681     session_init_databases_fun((void*) se, db);
682
683     // New sdb is head of se->databases list
684     return se->databases;
685 }
686
687 // Find an existing session database. If not found, load it
688 static struct session_database *find_session_database(struct session *se, 
689                                                       char *id)
690 {
691     struct session_database *sdb;
692
693     for (sdb = se->databases; sdb; sdb = sdb->next)
694         if (!strcmp(sdb->database->url, id))
695             return sdb;
696     return load_session_database(se, id);
697 }
698
699 // Apply a session override to a database
700 void session_apply_setting(struct session *se, char *dbname, char *setting,
701                            char *value)
702 {
703     struct session_database *sdb = find_session_database(se, dbname);
704     struct conf_service *service = se->service;
705     struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
706     int offset = settings_create_offset(service, setting);
707
708     expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
709                           se->session_nmem);
710     new->precedence = 0;
711     new->target = dbname;
712     new->name = setting;
713     new->value = value;
714     new->next = sdb->settings[offset];
715     sdb->settings[offset] = new;
716
717     // Force later recompute of settings-driven data structures
718     // (happens when a search starts and client connections are prepared)
719     switch (offset)
720     {
721     case PZ_XSLT:
722         if (sdb->map)
723         {
724             sdb->map = 0;
725         }
726         break;
727     }
728 }
729
730 void destroy_session(struct session *se)
731 {
732     struct session_database *sdb;
733
734     session_log(se, YLOG_DEBUG, "Pazpar2 session destroy");
735     session_remove_clients(se);
736
737     for (sdb = se->databases; sdb; sdb = sdb->next)
738         session_database_destroy(sdb);
739     normalize_cache_destroy(se->normalize_cache);
740     relevance_destroy(&se->relevance);
741     reclist_destroy(se->reclist);
742     nmem_destroy(se->nmem);
743     service_destroy(se->service);
744     yaz_mutex_destroy(&se->session_mutex);
745     wrbuf_destroy(se->wrbuf);
746 }
747
748 struct session *new_session(NMEM nmem, struct conf_service *service,
749                             unsigned session_id)
750 {
751     int i;
752     struct session *session = nmem_malloc(nmem, sizeof(*session));
753
754     char tmp_str[50];
755
756     sprintf(tmp_str, "session#%u", session_id);
757
758     session->session_id = session_id;
759     session_log(session, YLOG_DEBUG, "New session");
760     session->service = service;
761     session->relevance = 0;
762     session->total_hits = 0;
763     session->total_records = 0;
764     session->number_of_warnings_unknown_elements = 0;
765     session->number_of_warnings_unknown_metadata = 0;
766     session->num_termlists = 0;
767     session->reclist = 0;
768     session->clients = 0;
769     session->session_nmem = nmem;
770     session->nmem = nmem_create();
771     session->wrbuf = wrbuf_alloc();
772     session->databases = 0;
773     for (i = 0; i <= SESSION_WATCH_MAX; i++)
774     {
775         session->watchlist[i].data = 0;
776         session->watchlist[i].fun = 0;
777     }
778     session->normalize_cache = normalize_cache_create();
779     session->session_mutex = 0;
780     pazpar2_mutex_create(&session->session_mutex, tmp_str);
781
782     return session;
783 }
784
785 struct hitsbytarget *hitsbytarget(struct session *se, int *count, NMEM nmem)
786 {
787     struct hitsbytarget *res = 0;
788     struct client_list *l;
789     size_t sz = 0;
790
791     session_enter(se);
792     for (l = se->clients; l; l = l->next)
793         sz++;
794
795     res = nmem_malloc(nmem, sizeof(*res) * sz);
796     *count = 0;
797     for (l = se->clients; l; l = l->next)
798     {
799         struct client *cl = l->client;
800         WRBUF w = wrbuf_alloc();
801         const char *name = session_setting_oneval(client_get_database(cl),
802                                                   PZ_NAME);
803
804         res[*count].id = client_get_database(cl)->database->url;
805         res[*count].name = *name ? name : "Unknown";
806         res[*count].hits = client_get_hits(cl);
807         res[*count].records = client_get_num_records(cl);
808         res[*count].diagnostic = client_get_diagnostic(cl);
809         res[*count].state = client_get_state_str(cl);
810         res[*count].connected  = client_get_connection(cl) ? 1 : 0;
811         session_settings_dump(se, client_get_database(cl), w);
812         res[*count].settings_xml = w;
813         (*count)++;
814     }
815     session_leave(se);
816     return res;
817 }
818
819 struct termlist_score **termlist(struct session *se, const char *name, int *num)
820 {
821     int i;
822     struct termlist_score **tl = 0;
823
824     session_enter(se);
825     for (i = 0; i < se->num_termlists; i++)
826         if (!strcmp((const char *) se->termlists[i].name, name))
827         {
828             tl = termlist_highscore(se->termlists[i].termlist, num);
829             break;
830         }
831     session_leave(se);
832     return tl;
833 }
834
835 #ifdef MISSING_HEADERS
836 void report_nmem_stats(void)
837 {
838     size_t in_use, is_free;
839
840     nmem_get_memory_in_use(&in_use);
841     nmem_get_memory_free(&is_free);
842
843     yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld", 
844             (long) in_use, (long) is_free);
845 }
846 #endif
847
848 struct record_cluster *show_single_start(struct session *se, const char *id,
849                                          struct record_cluster **prev_r,
850                                          struct record_cluster **next_r)
851 {
852     struct record_cluster *r = 0;
853
854     session_enter(se);
855     *prev_r = 0;
856     *next_r = 0;
857     if (se->reclist)
858     {
859         reclist_enter(se->reclist);
860         while ((r = reclist_read_record(se->reclist)))
861         {
862             if (!strcmp(r->recid, id))
863             {
864                 *next_r = reclist_read_record(se->reclist);
865                 break;
866             }
867             *prev_r = r;
868         }
869         reclist_leave(se->reclist);
870     }
871     if (!r)
872         session_leave(se);
873     return r;
874 }
875
876 void show_single_stop(struct session *se, struct record_cluster *rec)
877 {
878     session_leave(se);
879 }
880
881 struct record_cluster **show_range_start(struct session *se,
882                                          struct reclist_sortparms *sp, 
883                                          int start, int *num, int *total, Odr_int *sumhits)
884 {
885     struct record_cluster **recs;
886     struct reclist_sortparms *spp;
887     int i;
888 #if USE_TIMING    
889     yaz_timing_t t = yaz_timing_create();
890 #endif
891     session_enter(se);
892     recs = nmem_malloc(se->nmem, *num * sizeof(struct record_cluster *));
893     if (!se->relevance)
894     {
895         *num = 0;
896         *total = 0;
897         *sumhits = 0;
898         recs = 0;
899     }
900     else
901     {
902         for (spp = sp; spp; spp = spp->next)
903             if (spp->type == Metadata_sortkey_relevance)
904             {
905                 relevance_prepare_read(se->relevance, se->reclist);
906                 break;
907             }
908         reclist_sort(se->reclist, sp);
909         
910         reclist_enter(se->reclist);
911         *total = reclist_get_num_records(se->reclist);
912         *sumhits = se->total_hits;
913         
914         for (i = 0; i < start; i++)
915             if (!reclist_read_record(se->reclist))
916             {
917                 *num = 0;
918                 recs = 0;
919                 break;
920             }
921         
922         for (i = 0; i < *num; i++)
923         {
924             struct record_cluster *r = reclist_read_record(se->reclist);
925             if (!r)
926             {
927                 *num = i;
928                 break;
929             }
930             recs[i] = r;
931         }
932         reclist_leave(se->reclist);
933     }
934 #if USE_TIMING
935     yaz_timing_stop(t);
936     yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f", 
937             yaz_timing_get_real(t), yaz_timing_get_user(t),
938             yaz_timing_get_sys(t));
939     yaz_timing_destroy(&t);
940 #endif
941     return recs;
942 }
943
944 void show_range_stop(struct session *se, struct record_cluster **recs)
945 {
946     session_leave(se);
947 }
948
949 void statistics(struct session *se, struct statistics *stat)
950 {
951     struct client_list *l;
952     int count = 0;
953
954     memset(stat, 0, sizeof(*stat));
955     for (l = se->clients; l; l = l->next)
956     {
957         struct client *cl = l->client;
958         if (!client_get_connection(cl))
959             stat->num_no_connection++;
960         switch (client_get_state(cl))
961         {
962         case Client_Connecting: stat->num_connecting++; break;
963         case Client_Working: stat->num_working++; break;
964         case Client_Idle: stat->num_idle++; break;
965         case Client_Failed: stat->num_failed++; break;
966         case Client_Error: stat->num_error++; break;
967         default: break;
968         }
969         count++;
970     }
971     stat->num_hits = se->total_hits;
972     stat->num_records = se->total_records;
973
974     stat->num_clients = count;
975 }
976
977 static struct record_metadata *record_metadata_init(
978     NMEM nmem, const char *value, enum conf_metadata_type type,
979     struct _xmlAttr *attr)
980 {
981     struct record_metadata *rec_md = record_metadata_create(nmem);
982     struct record_metadata_attr **attrp = &rec_md->attributes;
983     
984     for (; attr; attr = attr->next)
985     {
986         if (attr->children && attr->children->content)
987         {
988             if (strcmp((const char *) attr->name, "type"))
989             {  /* skip the "type" attribute.. Its value is already part of
990                   the element in output (md-%s) and so repeating it here
991                   is redundant */
992                 *attrp = nmem_malloc(nmem, sizeof(**attrp));
993                 (*attrp)->name =
994                     nmem_strdup(nmem, (const char *) attr->name);
995                 (*attrp)->value =
996                     nmem_strdup(nmem, (const char *) attr->children->content);
997                 attrp = &(*attrp)->next;
998             }
999         }
1000     }
1001     *attrp = 0;
1002
1003     if (type == Metadata_type_generic)
1004     {
1005         char *p = nmem_strdup(nmem, value);
1006
1007         p = normalize7bit_generic(p, " ,/.:([");
1008         
1009         rec_md->data.text.disp = p;
1010         rec_md->data.text.sort = 0;
1011     }
1012     else if (type == Metadata_type_year || type == Metadata_type_date)
1013     {
1014         int first, last;
1015         int longdate = 0;
1016
1017         if (type == Metadata_type_date)
1018             longdate = 1;
1019         if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
1020             return 0;
1021
1022         rec_md->data.number.min = first;
1023         rec_md->data.number.max = last;
1024     }
1025     else
1026         return 0;
1027     return rec_md;
1028 }
1029
1030 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
1031                                  struct conf_service *service, WRBUF norm_wr)
1032 {
1033     xmlNode *n;
1034     int no_found = 0;
1035     for (n = root->children; n; n = n->next)
1036     {
1037         if (n->type != XML_ELEMENT_NODE)
1038             continue;
1039         if (!strcmp((const char *) n->name, "metadata"))
1040         {
1041             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1042             if (type == NULL) {
1043                 yaz_log(YLOG_FATAL, "Missing type attribute on metadata element. Skipping!");
1044             }
1045             else if (!strcmp(name, (const char *) type))
1046             {
1047                 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
1048                 if (value)
1049                 {
1050                     const char *norm_str;
1051                     pp2_relevance_token_t prt =
1052                         pp2_relevance_tokenize(service->mergekey_pct);
1053                     
1054                     pp2_relevance_first(prt, (const char *) value, 0);
1055                     if (wrbuf_len(norm_wr) > 0)
1056                         wrbuf_puts(norm_wr, " ");
1057                     wrbuf_puts(norm_wr, name);
1058                     while ((norm_str =
1059                             pp2_relevance_token_next(prt)))
1060                     {
1061                         if (*norm_str)
1062                         {
1063                             wrbuf_puts(norm_wr, " ");
1064                             wrbuf_puts(norm_wr, norm_str);
1065                         }
1066                     }
1067                     xmlFree(value);
1068                     pp2_relevance_token_destroy(prt);
1069                     no_found++;
1070                 }
1071             }
1072             xmlFree(type);
1073         }
1074     }
1075     return no_found;
1076 }
1077
1078 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
1079                                 struct conf_service *service, NMEM nmem)
1080 {
1081     char *mergekey_norm = 0;
1082     xmlNode *root = xmlDocGetRootElement(doc);
1083     WRBUF norm_wr = wrbuf_alloc();
1084
1085     /* consider mergekey from XSL first */
1086     xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
1087     if (mergekey)
1088     {
1089         const char *norm_str;
1090         pp2_relevance_token_t prt =
1091             pp2_relevance_tokenize(service->mergekey_pct);
1092
1093         pp2_relevance_first(prt, (const char *) mergekey, 0);
1094         while ((norm_str = pp2_relevance_token_next(prt)))
1095         {
1096             if (*norm_str)
1097             {
1098                 if (wrbuf_len(norm_wr))
1099                     wrbuf_puts(norm_wr, " ");
1100                 wrbuf_puts(norm_wr, norm_str);
1101             }
1102         }
1103         pp2_relevance_token_destroy(prt);
1104         xmlFree(mergekey);
1105     }
1106     else
1107     {
1108         /* no mergekey defined in XSL. Look for mergekey metadata instead */
1109         int field_id;
1110         for (field_id = 0; field_id < service->num_metadata; field_id++)
1111         {
1112             struct conf_metadata *ser_md = &service->metadata[field_id];
1113             if (ser_md->mergekey != Metadata_mergekey_no)
1114             {
1115                 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1116                                               service, norm_wr);
1117                 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1118                 {
1119                     /* no mergekey on this one and it is required.. 
1120                        Generate unique key instead */
1121                     wrbuf_rewind(norm_wr);
1122                     break;
1123                 }
1124             }
1125         }
1126     }
1127
1128     /* generate unique key if none is not generated already or is empty */
1129     if (wrbuf_len(norm_wr) == 0)
1130     {
1131         wrbuf_printf(norm_wr, "%s-%d",
1132                      client_get_database(cl)->database->url, record_no);
1133     }
1134     if (wrbuf_len(norm_wr) > 0)
1135         mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1136     wrbuf_destroy(norm_wr);
1137     return mergekey_norm;
1138 }
1139
1140 /** \brief see if metadata for pz:recordfilter exists 
1141     \param root xml root element of normalized record
1142     \param sdb session database for client
1143     \retval 0 if there is no metadata for pz:recordfilter
1144     \retval 1 if there is metadata for pz:recordfilter
1145
1146     If there is no pz:recordfilter defined, this function returns 1
1147     as well.
1148 */
1149     
1150 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1151 {
1152     int match = 0;
1153     xmlNode *n;
1154     const char *s;
1155     s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1156
1157     if (!s || !*s)
1158         return 1;
1159
1160     for (n = root->children; n; n = n->next)
1161     {
1162         if (n->type != XML_ELEMENT_NODE)
1163             continue;
1164         if (!strcmp((const char *) n->name, "metadata"))
1165         {
1166             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1167             if (type)
1168             {
1169                 size_t len;
1170                 int substring;
1171                 const char *eq;
1172
1173                 if ((eq = strchr(s, '=')))
1174                     substring = 0;
1175                 else if ((eq = strchr(s, '~')))
1176                     substring = 1;
1177                 if (eq)
1178                     len = eq - s;
1179                 else
1180                     len = strlen(s);
1181                 if (len == strlen((const char *)type) &&
1182                     !memcmp((const char *) type, s, len))
1183                 {
1184                     xmlChar *value = xmlNodeGetContent(n);
1185                     if (value && *value)
1186                     {
1187                         if (!eq ||
1188                             (substring && strstr((const char *) value, eq+1)) ||
1189                             (!substring && !strcmp((const char *) value, eq + 1)))
1190                             match = 1;
1191                     }
1192                     xmlFree(value);
1193                 }
1194                 xmlFree(type);
1195             }
1196         }
1197     }
1198     return match;
1199 }
1200
1201
1202 static int ingest_to_cluster(struct client *cl,
1203                              xmlDoc *xdoc,
1204                              xmlNode *root,
1205                              int record_no,
1206                              const char *mergekey_norm);
1207
1208 /** \brief ingest XML record
1209     \param cl client holds the result set for record
1210     \param rec record buffer (0 terminated)
1211     \param record_no record position (1, 2, ..)
1212     \param nmem working NMEM
1213     \retval 0 OK
1214     \retval -1 failure
1215 */
1216 int ingest_record(struct client *cl, const char *rec,
1217                   int record_no, NMEM nmem)
1218 {
1219     struct session *se = client_get_session(cl);
1220     int ret = 0;
1221     struct session_database *sdb = client_get_database(cl);
1222     struct conf_service *service = se->service;
1223     xmlDoc *xdoc = normalize_record(se, sdb, service, rec, nmem);
1224     xmlNode *root;
1225     const char *mergekey_norm;
1226     
1227     if (!xdoc)
1228         return -1;
1229     
1230     root = xmlDocGetRootElement(xdoc);
1231     
1232     if (!check_record_filter(root, sdb))
1233     {
1234         session_log(se, YLOG_WARN, "Filtered out record no %d from %s",
1235                     record_no, sdb->database->url);
1236         xmlFreeDoc(xdoc);
1237         return -1;
1238     }
1239     
1240     mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem);
1241     if (!mergekey_norm)
1242     {
1243         session_log(se, YLOG_WARN, "Got no mergekey");
1244         xmlFreeDoc(xdoc);
1245         return -1;
1246     }
1247     session_enter(se);
1248     if (client_get_session(cl) == se)
1249         ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1250     session_leave(se);
1251     
1252     xmlFreeDoc(xdoc);
1253     return ret;
1254 }
1255
1256 static int ingest_to_cluster(struct client *cl,
1257                              xmlDoc *xdoc,
1258                              xmlNode *root,
1259                              int record_no,
1260                              const char *mergekey_norm)
1261 {
1262     xmlNode *n;
1263     xmlChar *type = 0;
1264     xmlChar *value = 0;
1265     struct session_database *sdb = client_get_database(cl);
1266     struct session *se = client_get_session(cl);
1267     struct conf_service *service = se->service;
1268     struct record *record = record_create(se->nmem, 
1269                                           service->num_metadata,
1270                                           service->num_sortkeys, cl,
1271                                           record_no);
1272     struct record_cluster *cluster = reclist_insert(se->reclist,
1273                                                     service, 
1274                                                     record,
1275                                                     mergekey_norm,
1276                                                     &se->total_merged);
1277
1278     const char *use_term_factor_str = session_setting_oneval(sdb, PZ_TERMLIST_TERM_FACTOR);
1279     // TODO: Work-around to default to use term factor, until other MK2 components supports it
1280     int use_term_factor = 1;
1281     int term_factor = 1; 
1282     if (use_term_factor_str && use_term_factor_str[0] != 0)
1283        use_term_factor =  atoi(use_term_factor_str);
1284     if (use_term_factor) {
1285         int maxrecs = client_get_maxrecs(cl);
1286         int hits = (int) client_get_hits(cl);
1287         term_factor = MAX(hits, maxrecs) /  MAX(1, maxrecs);
1288         assert(term_factor >= 1);
1289         yaz_log(YLOG_DEBUG, "Using term factor: %d (%d / %d)", term_factor, MAX(hits, maxrecs), MAX(1, maxrecs));
1290     }
1291
1292     if (!cluster)
1293         return -1;
1294     if (global_parameters.dump_records)
1295         session_log(se, YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1296                     sdb->database->url, record_no);
1297     relevance_newrec(se->relevance, cluster);
1298     
1299     // now parsing XML record and adding data to cluster or record metadata
1300     for (n = root->children; n; n = n->next)
1301     {
1302         pp2_relevance_token_t prt;
1303         if (type)
1304             xmlFree(type);
1305         if (value)
1306             xmlFree(value);
1307         type = value = 0;
1308         
1309         if (n->type != XML_ELEMENT_NODE)
1310             continue;
1311         if (!strcmp((const char *) n->name, "metadata"))
1312         {
1313             struct conf_metadata *ser_md = 0;
1314             struct conf_sortkey *ser_sk = 0;
1315             struct record_metadata **wheretoput = 0;
1316             struct record_metadata *rec_md = 0;
1317             int md_field_id = -1;
1318             int sk_field_id = -1;
1319             
1320             type = xmlGetProp(n, (xmlChar *) "type");
1321             value = xmlNodeListGetString(xdoc, n->children, 1);
1322             
1323             if (!type || !value || !*value)
1324                 continue;
1325             
1326             md_field_id 
1327                 = conf_service_metadata_field_id(service, (const char *) type);
1328             if (md_field_id < 0)
1329             {
1330                 if (se->number_of_warnings_unknown_metadata == 0)
1331                 {
1332                     session_log(se, YLOG_WARN, 
1333                             "Ignoring unknown metadata element: %s", type);
1334                 }
1335                 se->number_of_warnings_unknown_metadata++;
1336                 continue;
1337             }
1338             
1339             ser_md = &service->metadata[md_field_id];
1340             
1341             if (ser_md->sortkey_offset >= 0){
1342                 sk_field_id = ser_md->sortkey_offset;
1343                 ser_sk = &service->sortkeys[sk_field_id];
1344             }
1345
1346             // non-merged metadata
1347             rec_md = record_metadata_init(se->nmem, (const char *) value,
1348                                           ser_md->type, n->properties);
1349             if (!rec_md)
1350             {
1351                 session_log(se, YLOG_WARN, "bad metadata data '%s' "
1352                             "for element '%s'", value, type);
1353                 continue;
1354             }
1355             wheretoput = &record->metadata[md_field_id];
1356             while (*wheretoput)
1357                 wheretoput = &(*wheretoput)->next;
1358             *wheretoput = rec_md;
1359
1360             // merged metadata
1361             rec_md = record_metadata_init(se->nmem, (const char *) value,
1362                                           ser_md->type, 0);
1363             wheretoput = &cluster->metadata[md_field_id];
1364
1365             // and polulate with data:
1366             // assign cluster or record based on merge action
1367             if (ser_md->merge == Metadata_merge_unique)
1368             {
1369                 struct record_metadata *mnode;
1370                 for (mnode = *wheretoput; mnode; mnode = mnode->next)
1371                     if (!strcmp((const char *) mnode->data.text.disp, 
1372                                 rec_md->data.text.disp))
1373                         break;
1374                 if (!mnode)
1375                 {
1376                     rec_md->next = *wheretoput;
1377                     *wheretoput = rec_md;
1378                 }
1379             }
1380             else if (ser_md->merge == Metadata_merge_longest)
1381             {
1382                 if (!*wheretoput 
1383                     || strlen(rec_md->data.text.disp) 
1384                     > strlen((*wheretoput)->data.text.disp))
1385                 {
1386                     *wheretoput = rec_md;
1387                     if (ser_sk)
1388                     {
1389                         const char *sort_str = 0;
1390                         int skip_article = 
1391                             ser_sk->type == Metadata_sortkey_skiparticle;
1392
1393                         if (!cluster->sortkeys[sk_field_id])
1394                             cluster->sortkeys[sk_field_id] = 
1395                                 nmem_malloc(se->nmem, 
1396                                             sizeof(union data_types));
1397                          
1398                         prt = pp2_relevance_tokenize(service->sort_pct);
1399
1400                         pp2_relevance_first(prt, rec_md->data.text.disp,
1401                                             skip_article);
1402
1403                         pp2_relevance_token_next(prt);
1404                          
1405                         sort_str = pp2_get_sort(prt);
1406                          
1407                         cluster->sortkeys[sk_field_id]->text.disp = 
1408                             rec_md->data.text.disp;
1409                         if (!sort_str)
1410                         {
1411                             sort_str = rec_md->data.text.disp;
1412                             session_log(se, YLOG_WARN, 
1413                                     "Could not make sortkey. Bug #1858");
1414                         }
1415                         cluster->sortkeys[sk_field_id]->text.sort = 
1416                             nmem_strdup(se->nmem, sort_str);
1417                         pp2_relevance_token_destroy(prt);
1418                     }
1419                 }
1420             }
1421             else if (ser_md->merge == Metadata_merge_all)
1422             {
1423                 rec_md->next = *wheretoput;
1424                 *wheretoput = rec_md;
1425             }
1426             else if (ser_md->merge == Metadata_merge_range)
1427             {
1428                 if (!*wheretoput)
1429                 {
1430                     *wheretoput = rec_md;
1431                     if (ser_sk)
1432                         cluster->sortkeys[sk_field_id] 
1433                             = &rec_md->data;
1434                 }
1435                 else
1436                 {
1437                     int this_min = rec_md->data.number.min;
1438                     int this_max = rec_md->data.number.max;
1439                     if (this_min < (*wheretoput)->data.number.min)
1440                         (*wheretoput)->data.number.min = this_min;
1441                     if (this_max > (*wheretoput)->data.number.max)
1442                         (*wheretoput)->data.number.max = this_max;
1443                 }
1444             }
1445
1446
1447             // ranking of _all_ fields enabled ... 
1448             if (ser_md->rank)
1449                 relevance_countwords(se->relevance, cluster, 
1450                                      (char *) value, ser_md->rank,
1451                                      ser_md->name);
1452
1453             // construct facets ... unless the client already has reported them
1454             if (ser_md->termlist && !client_has_facet(cl, (char *) type))
1455             {
1456
1457                 if (ser_md->type == Metadata_type_year)
1458                 {
1459                     char year[64];
1460                     sprintf(year, "%d", rec_md->data.number.max);
1461
1462                     add_facet(se, (char *) type, year, term_factor);
1463                     if (rec_md->data.number.max != rec_md->data.number.min)
1464                     {
1465                         sprintf(year, "%d", rec_md->data.number.min);
1466                         add_facet(se, (char *) type, year, term_factor);
1467                     }
1468                 }
1469                 else
1470                     add_facet(se, (char *) type, (char *) value, term_factor);
1471             }
1472
1473             // cleaning up
1474             xmlFree(type);
1475             xmlFree(value);
1476             type = value = 0;
1477         }
1478         else
1479         {
1480             if (se->number_of_warnings_unknown_elements == 0)
1481                 session_log(se, YLOG_WARN,
1482                         "Unexpected element in internal record: %s", n->name);
1483             se->number_of_warnings_unknown_elements++;
1484         }
1485     }
1486     if (type)
1487         xmlFree(type);
1488     if (value)
1489         xmlFree(value);
1490
1491     relevance_donerecord(se->relevance, cluster);
1492     se->total_records++;
1493
1494     return 0;
1495 }
1496
1497 void session_log(struct session *s, int level, const char *fmt, ...)
1498 {
1499     char buf[1024];
1500     va_list ap;
1501     va_start(ap, fmt);
1502
1503     yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
1504     yaz_log(level, "%u %s", s->session_id, buf);
1505
1506     va_end(ap);
1507 }
1508
1509 /*
1510  * Local variables:
1511  * c-basic-offset: 4
1512  * c-file-style: "Stroustrup"
1513  * indent-tabs-mode: nil
1514  * End:
1515  * vim: shiftwidth=4 tabstop=8 expandtab
1516  */
1517