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