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