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