src/session.c

   1 /* This file is part of Pazpar2.
   2    Copyright (C) 2006-2012 Index Data
   3
   4 Pazpar2 is free software; you can redistribute it and/or modify it under
   5 the terms of the GNU General Public License as published by the Free
   6 Software Foundation; either version 2, or (at your option) any later
   7 version.
   8
   9 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
  10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12 for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program; if not, write to the Free Software
  16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17
  18 */
  19
  20 /** \file session.c
  21     \brief high-level logic; mostly user sessions and settings
  22 */
  23
  24 #if HAVE_CONFIG_H
  25 #include <config.h>
  26 #endif
  27
  28 #include <time.h>
  29 #include <stdlib.h>
  30 #include <stdio.h>
  31 #include <string.h>
  32 #if HAVE_SYS_TIME_H
  33 #include <sys/time.h>
  34 #endif
  35 #if HAVE_UNISTD_H
  36 #include <unistd.h>
  37 #endif
  38 #ifdef WIN32
  39 #include <windows.h>
  40 #endif
  41 #include <signal.h>
  42 #include <ctype.h>
  43 #include <assert.h>
  44 #include <math.h>
  45
  46 #include <yaz/marcdisp.h>
  47 #include <yaz/comstack.h>
  48 #include <yaz/tcpip.h>
  49 #include <yaz/proto.h>
  50 #include <yaz/readconf.h>
  51 #include <yaz/pquery.h>
  52 #include <yaz/otherinfo.h>
  53 #include <yaz/yaz-util.h>
  54 #include <yaz/nmem.h>
  55 #include <yaz/query-charset.h>
  56 #include <yaz/querytowrbuf.h>
  57 #include <yaz/oid_db.h>
  58 #include <yaz/snprintf.h>
  59 #include <yaz/gettimeofday.h>
  60
  61 #define USE_TIMING 0
  62 #if USE_TIMING
  63 #include <yaz/timing.h>
  64 #endif
  65
  66 #include "ppmutex.h"
  67 #include "parameters.h"
  68 #include "session.h"
  69 #include "eventl.h"
  70 #include "http.h"
  71 #include "termlists.h"
  72 #include "reclists.h"
  73 #include "relevance.h"
  74 #include "database.h"
  75 #include "client.h"
  76 #include "settings.h"
  77 #include "normalize7bit.h"
  78
  79 #include <libxml/tree.h>
  80
  81 #define MAX_CHUNK 15
  82
  83 #define MAX(a,b) ((a)>(b)?(a):(b))
  84
  85 // Note: Some things in this structure will eventually move to configuration
  86 struct parameters global_parameters =
  87 {
  88     0,   // dump_records
  89     0,   // debug_mode
  90     0,   // predictable sessions
  91 };
  92
  93 struct client_list {
  94     struct client *client;
  95     struct client_list *next;
  96 };
  97
  98 /* session counting (1) , disable client counting (0) */
  99 static YAZ_MUTEX g_session_mutex = 0;
 100 static int no_sessions = 0;
 101 static int no_session_total = 0;
 102
 103 static int session_use(int delta)
 104 {
 105     int sessions;
 106     if (!g_session_mutex)
 107         yaz_mutex_create(&g_session_mutex);
 108     yaz_mutex_enter(g_session_mutex);
 109     no_sessions += delta;
 110     if (delta > 0)
 111         no_session_total += delta;
 112     sessions = no_sessions;
 113     yaz_mutex_leave(g_session_mutex);
 114     yaz_log(YLOG_DEBUG, "%s sessions=%d", delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), no_sessions);
 115     return sessions;
 116 }
 117
 118 int sessions_count(void)
 119 {
 120     return session_use(0);
 121 }
 122
 123 int session_count_total(void)
 124 {
 125     int total = 0;
 126     if (!g_session_mutex)
 127         return 0;
 128     yaz_mutex_enter(g_session_mutex);
 129     total = no_session_total;
 130     yaz_mutex_leave(g_session_mutex);
 131     return total;
 132 }
 133
 134 static void log_xml_doc(xmlDoc *doc)
 135 {
 136     FILE *lf = yaz_log_file();
 137     xmlChar *result = 0;
 138     int len = 0;
 139 #if LIBXML_VERSION >= 20600
 140     xmlDocDumpFormatMemory(doc, &result, &len, 1);
 141 #else
 142     xmlDocDumpMemory(doc, &result, &len);
 143 #endif
 144     if (lf && len)
 145     {
 146         (void) fwrite(result, 1, len, lf);
 147         fprintf(lf, "\n");
 148     }
 149     xmlFree(result);
 150 }
 151
 152 static void session_enter(struct session *s)
 153 {
 154     yaz_mutex_enter(s->session_mutex);
 155 }
 156
 157 static void session_leave(struct session *s)
 158 {
 159     yaz_mutex_leave(s->session_mutex);
 160 }
 161
 162 static void session_normalize_facet(struct session *s, const char *type,
 163                                     const char *value,
 164                                     WRBUF display_wrbuf,
 165                                     WRBUF facet_wrbuf)
 166 {
 167     struct conf_service *service = s->service;
 168     pp2_charset_token_t prt;
 169     const char *facet_component;
 170     int i;
 171     const char *icu_chain_id = 0;
 172
 173     for (i = 0; i < service->num_metadata; i++)
 174         if (!strcmp((service->metadata + i)->name, type))
 175             icu_chain_id = (service->metadata + i)->facetrule;
 176     if (!icu_chain_id)
 177         icu_chain_id = "facet";
 178     prt = pp2_charset_token_create(service->charsets, icu_chain_id);
 179     if (!prt)
 180     {
 181         yaz_log(YLOG_FATAL, "Unknown ICU chain '%s' for facet of type '%s'",
 182                 icu_chain_id, type);
 183         wrbuf_destroy(facet_wrbuf);
 184         wrbuf_destroy(display_wrbuf);
 185         return;
 186     }
 187     pp2_charset_token_first(prt, value, 0);
 188     while ((facet_component = pp2_charset_token_next(prt)))
 189     {
 190         const char *display_component;
 191         if (*facet_component)
 192         {
 193             if (wrbuf_len(facet_wrbuf))
 194                 wrbuf_puts(facet_wrbuf, " ");
 195             wrbuf_puts(facet_wrbuf, facet_component);
 196         }
 197         display_component = pp2_get_display(prt);
 198         if (display_component)
 199         {
 200             if (wrbuf_len(display_wrbuf))
 201                 wrbuf_puts(display_wrbuf, " ");
 202             wrbuf_puts(display_wrbuf, display_component);
 203         }
 204     }
 205     pp2_charset_token_destroy(prt);
 206 }
 207
 208 void add_facet(struct session *s, const char *type, const char *value, int count)
 209 {
 210     WRBUF facet_wrbuf = wrbuf_alloc();
 211     WRBUF display_wrbuf = wrbuf_alloc();
 212
 213     session_normalize_facet(s, type, value, display_wrbuf, facet_wrbuf);
 214
 215     if (wrbuf_len(facet_wrbuf))
 216     {
 217         int i;
 218         for (i = 0; i < s->num_termlists; i++)
 219             if (!strcmp(s->termlists[i].name, type))
 220                 break;
 221         if (i == s->num_termlists)
 222         {
 223             if (i == SESSION_MAX_TERMLISTS)
 224             {
 225                 session_log(s, YLOG_FATAL, "Too many termlists");
 226                 wrbuf_destroy(facet_wrbuf);
 227                 wrbuf_destroy(display_wrbuf);
 228                 return;
 229             }
 230
 231             s->termlists[i].name = nmem_strdup(s->nmem, type);
 232             s->termlists[i].termlist = termlist_create(s->nmem);
 233             s->num_termlists = i + 1;
 234         }
 235
 236 #if 0
 237         session_log(s, YLOG_LOG, "Facets for %s: %s norm:%s (%d)", type, value, wrbuf_cstr(facet_wrbuf), count);
 238 #endif
 239         termlist_insert(s->termlists[i].termlist, wrbuf_cstr(display_wrbuf),
 240                         wrbuf_cstr(facet_wrbuf), count);
 241     }
 242     wrbuf_destroy(facet_wrbuf);
 243     wrbuf_destroy(display_wrbuf);
 244 }
 245
 246 static xmlDoc *record_to_xml(struct session *se,
 247                              struct session_database *sdb, const char *rec)
 248 {
 249     struct database *db = sdb->database;
 250     xmlDoc *rdoc = 0;
 251
 252     rdoc = xmlParseMemory(rec, strlen(rec));
 253
 254     if (!rdoc)
 255     {
 256         session_log(se, YLOG_FATAL, "Non-wellformed XML received from %s",
 257                     db->id);
 258         return 0;
 259     }
 260
 261     if (global_parameters.dump_records)
 262     {
 263         session_log(se, YLOG_LOG, "Un-normalized record from %s", db->id);
 264         log_xml_doc(rdoc);
 265     }
 266
 267     return rdoc;
 268 }
 269
 270 #define MAX_XSLT_ARGS 16
 271
 272 // Add static values from session database settings if applicable
 273 static void insert_settings_parameters(struct session_database *sdb,
 274                                        struct conf_service *service,
 275                                        char **parms,
 276                                        NMEM nmem)
 277 {
 278     int i;
 279     int nparms = 0;
 280     int offset = 0;
 281
 282     for (i = 0; i < service->num_metadata; i++)
 283     {
 284         struct conf_metadata *md = &service->metadata[i];
 285         int setting;
 286
 287         if (md->setting == Metadata_setting_parameter &&
 288             (setting = settings_lookup_offset(service, md->name)) >= 0)
 289         {
 290             const char *val = session_setting_oneval(sdb, setting);
 291             if (val && nparms < MAX_XSLT_ARGS)
 292             {
 293                 char *buf;
 294                 int len = strlen(val);
 295                 buf = nmem_malloc(nmem, len + 3);
 296                 buf[0] = '\'';
 297                 strcpy(buf + 1, val);
 298                 buf[len+1] = '\'';
 299                 buf[len+2] = '\0';
 300                 parms[offset++] = md->name;
 301                 parms[offset++] = buf;
 302                 nparms++;
 303             }
 304         }
 305     }
 306     parms[offset] = 0;
 307 }
 308
 309 // Add static values from session database settings if applicable
 310 static void insert_settings_values(struct session_database *sdb, xmlDoc *doc,
 311     struct conf_service *service)
 312 {
 313     int i;
 314
 315     for (i = 0; i < service->num_metadata; i++)
 316     {
 317         struct conf_metadata *md = &service->metadata[i];
 318         int offset;
 319
 320         if (md->setting == Metadata_setting_postproc &&
 321             (offset = settings_lookup_offset(service, md->name)) >= 0)
 322         {
 323             const char *val = session_setting_oneval(sdb, offset);
 324             if (val)
 325             {
 326                 xmlNode *r = xmlDocGetRootElement(doc);
 327                 xmlNode *n = xmlNewTextChild(r, 0, (xmlChar *) "metadata",
 328                                              (xmlChar *) val);
 329                 xmlSetProp(n, (xmlChar *) "type", (xmlChar *) md->name);
 330             }
 331         }
 332     }
 333 }
 334
 335 static xmlDoc *normalize_record(struct session *se,
 336                                 struct session_database *sdb,
 337                                 struct conf_service *service,
 338                                 const char *rec, NMEM nmem)
 339 {
 340     xmlDoc *rdoc = record_to_xml(se, sdb, rec);
 341
 342     if (rdoc)
 343     {
 344         char *parms[MAX_XSLT_ARGS*2+1];
 345
 346         insert_settings_parameters(sdb, service, parms, nmem);
 347
 348         if (normalize_record_transform(sdb->map, &rdoc, (const char **)parms))
 349         {
 350             session_log(se, YLOG_WARN, "Normalize failed from %s",
 351                         sdb->database->id);
 352         }
 353         else
 354         {
 355             insert_settings_values(sdb, rdoc, service);
 356
 357             if (global_parameters.dump_records)
 358             {
 359                 session_log(se, YLOG_LOG, "Normalized record from %s",
 360                             sdb->database->id);
 361                 log_xml_doc(rdoc);
 362             }
 363         }
 364     }
 365     return rdoc;
 366 }
 367
 368 void session_settings_dump(struct session *se,
 369                            struct session_database *db,
 370                            WRBUF w)
 371 {
 372     if (db->settings)
 373     {
 374         int i, num = db->num_settings;
 375         for (i = 0; i < num; i++)
 376         {
 377             struct setting *s = db->settings[i];
 378             for (;s ; s = s->next)
 379             {
 380                 wrbuf_puts(w, "<set name=\"");
 381                 wrbuf_xmlputs(w, s->name);
 382                 wrbuf_puts(w, "\" value=\"");
 383                 wrbuf_xmlputs(w, s->value);
 384                 wrbuf_puts(w, "\"/>");
 385             }
 386             if (db->settings[i])
 387                 wrbuf_puts(w, "\n");
 388         }
 389     }
 390 }
 391
 392 // Retrieve first defined value for 'name' for given database.
 393 // Will be extended to take into account user associated with session
 394 const char *session_setting_oneval(struct session_database *db, int offset)
 395 {
 396     if (offset >= db->num_settings || !db->settings[offset])
 397         return "";
 398     return db->settings[offset]->value;
 399 }
 400
 401 // Prepare XSLT stylesheets for record normalization
 402 // Structures are allocated on the session_wide nmem to avoid having
 403 // to recompute this for every search. This would lead
 404 // to leaking if a single session was to repeatedly change the PZ_XSLT
 405 // setting. However, this is not a realistic use scenario.
 406 static int prepare_map(struct session *se, struct session_database *sdb)
 407 {
 408     if (sdb->settings && !sdb->map)
 409     {
 410         const char *s;
 411
 412         if (sdb->settings[PZ_XSLT] &&
 413             (s = session_setting_oneval(sdb, PZ_XSLT)))
 414         {
 415             char auto_stylesheet[256];
 416
 417             if (!strcmp(s, "auto"))
 418             {
 419                 const char *request_syntax = session_setting_oneval(
 420                     sdb, PZ_REQUESTSYNTAX);
 421                 if (request_syntax)
 422                 {
 423                     char *cp;
 424                     yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet),
 425                                  "%s.xsl", request_syntax);
 426                     for (cp = auto_stylesheet; *cp; cp++)
 427                     {
 428                         /* deliberately only consider ASCII */
 429                         if (*cp > 32 && *cp < 127)
 430                             *cp = tolower(*cp);
 431                     }
 432                     s = auto_stylesheet;
 433                 }
 434                 else
 435                 {
 436                     session_log(se, YLOG_WARN,
 437                                 "No pz:requestsyntax for auto stylesheet");
 438                 }
 439             }
 440             sdb->map = normalize_cache_get(se->normalize_cache,
 441                                            se->service, s);
 442             if (!sdb->map)
 443                 return -1;
 444         }
 445     }
 446     return 0;
 447 }
 448
 449 // called if watch should be removed because http_channel is to be destroyed
 450 static void session_watch_cancel(void *data, struct http_channel *c,
 451                                  void *data2)
 452 {
 453     struct session_watchentry *ent = data;
 454
 455     ent->fun = 0;
 456     ent->data = 0;
 457     ent->obs = 0;
 458 }
 459
 460 // set watch. Returns 0=OK, -1 if watch is already set
 461 int session_set_watch(struct session *s, int what,
 462                       session_watchfun fun, void *data,
 463                       struct http_channel *chan)
 464 {
 465     int ret;
 466     session_enter(s);
 467     if (s->watchlist[what].fun)
 468         ret = -1;
 469     else
 470     {
 471
 472         s->watchlist[what].fun = fun;
 473         s->watchlist[what].data = data;
 474         s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
 475                                                    session_watch_cancel);
 476         ret = 0;
 477     }
 478     session_leave(s);
 479     return ret;
 480 }
 481
 482 void session_alert_watch(struct session *s, int what)
 483 {
 484     assert(s);
 485     session_enter(s);
 486     if (s->watchlist[what].fun)
 487     {
 488         /* our watch is no longer associated with http_channel */
 489         void *data;
 490         session_watchfun fun;
 491
 492         http_remove_observer(s->watchlist[what].obs);
 493         fun  = s->watchlist[what].fun;
 494         data = s->watchlist[what].data;
 495
 496         /* reset watch before fun is invoked - in case fun wants to set
 497            it again */
 498         s->watchlist[what].fun = 0;
 499         s->watchlist[what].data = 0;
 500         s->watchlist[what].obs = 0;
 501
 502         session_leave(s);
 503         session_log(s, YLOG_DEBUG,
 504                     "Alert Watch: %d calling function: %p", what, fun);
 505         fun(data);
 506     }
 507     else
 508         session_leave(s);
 509 }
 510
 511 //callback for grep_databases
 512 static void select_targets_callback(struct session *se,
 513                                     struct session_database *db)
 514 {
 515     struct client *cl;
 516     struct client_list *l;
 517
 518     for (l = se->clients_cached; l; l = l->next)
 519         if (client_get_database(l->client) == db)
 520             break;
 521
 522     if (l)
 523         cl = l->client;
 524     else
 525     {
 526         cl = client_create(db->database->id);
 527         client_set_database(cl, db);
 528
 529         l = xmalloc(sizeof(*l));
 530         l->client = cl;
 531         l->next = se->clients_cached;
 532         se->clients_cached = l;
 533     }
 534     /* set session always. If may be 0 if client is not active */
 535     client_set_session(cl, se);
 536
 537     l = xmalloc(sizeof(*l));
 538     l->client = cl;
 539     l->next = se->clients_active;
 540     se->clients_active = l;
 541 }
 542
 543 static void session_reset_active_clients(struct session *se,
 544                                          struct client_list *new_list)
 545 {
 546     struct client_list *l;
 547
 548     session_enter(se);
 549     l = se->clients_active;
 550     se->clients_active = new_list;
 551     session_leave(se);
 552
 553     while (l)
 554     {
 555         struct client_list *l_next = l->next;
 556
 557         client_lock(l->client);
 558         client_set_session(l->client, 0); /* mark client inactive */
 559         client_unlock(l->client);
 560
 561         xfree(l);
 562         l = l_next;
 563     }
 564 }
 565
 566 static void session_remove_cached_clients(struct session *se)
 567 {
 568     struct client_list *l;
 569
 570     session_reset_active_clients(se, 0);
 571
 572     session_enter(se);
 573     l = se->clients_cached;
 574     se->clients_cached = 0;
 575     session_leave(se);
 576
 577     while (l)
 578     {
 579         struct client_list *l_next = l->next;
 580         client_lock(l->client);
 581         client_set_session(l->client, 0);
 582         client_set_database(l->client, 0);
 583         client_unlock(l->client);
 584         client_destroy(l->client);
 585         xfree(l);
 586         l = l_next;
 587     }
 588 }
 589
 590 // Associates a set of clients with a session;
 591 // Note: Session-databases represent databases with per-session
 592 // setting overrides
 593 static int select_targets(struct session *se, const char *filter)
 594 {
 595     return session_grep_databases(se, filter, select_targets_callback);
 596 }
 597
 598 int session_active_clients(struct session *s)
 599 {
 600     struct client_list *l;
 601     int res = 0;
 602
 603     for (l = s->clients_active; l; l = l->next)
 604         if (client_is_active(l->client))
 605             res++;
 606
 607     return res;
 608 }
 609
 610 int session_is_preferred_clients_ready(struct session *s)
 611 {
 612     struct client_list *l;
 613     int res = 0;
 614
 615     for (l = s->clients_active; l; l = l->next)
 616         if (client_is_active_preferred(l->client))
 617             res++;
 618     session_log(s, YLOG_DEBUG, "Has %d active preferred clients.", res);
 619     return res == 0;
 620 }
 621
 622 static void session_clear_set(struct session *se,
 623                               const char *sort_field, int increasing, int position)
 624 {
 625     reclist_destroy(se->reclist);
 626     se->reclist = 0;
 627     if (nmem_total(se->nmem))
 628         session_log(se, YLOG_DEBUG, "NMEN operation usage %zd",
 629                     nmem_total(se->nmem));
 630     nmem_reset(se->nmem);
 631     se->total_records = se->total_merged = 0;
 632     se->num_termlists = 0;
 633
 634     /* reset list of sorted results and clear to relevance search */
 635     se->sorted_results = nmem_malloc(se->nmem, sizeof(*se->sorted_results));
 636     se->sorted_results->field = nmem_strdup(se->nmem, sort_field);
 637     se->sorted_results->increasing = increasing;
 638     se->sorted_results->position = position;
 639     se->sorted_results->next = 0;
 640
 641     session_log(se, YLOG_DEBUG, "clear_set session_sort: field=%s increasing=%d position=%d configured",
 642                 sort_field, increasing, position);
 643
 644     se->reclist = reclist_create(se->nmem);
 645 }
 646
 647 void session_sort(struct session *se, const char *field, int increasing,
 648                   int position)
 649 {
 650     struct session_sorted_results *sr;
 651     struct client_list *l;
 652
 653     session_enter(se);
 654
 655     yaz_log(YLOG_LOG, "session_sort field=%s increasing=%d position=%d", field, increasing, position);
 656     /* see if we already have sorted for this critieria */
 657     for (sr = se->sorted_results; sr; sr = sr->next)
 658     {
 659         if (!strcmp(field, sr->field) && increasing == sr->increasing && sr->position == position)
 660             break;
 661     }
 662     if (sr)
 663     {
 664         session_log(se, YLOG_DEBUG, "search_sort: field=%s increasing=%d position=%d already fetched",
 665                     field, increasing, position);
 666         session_leave(se);
 667         return;
 668     }
 669     session_log(se, YLOG_DEBUG, "search_sort: field=%s increasing=%d position=%d must fetch",
 670                 field, increasing, position);
 671     if (position)
 672     {
 673         yaz_log(YLOG_DEBUG, "Reset results due to position");
 674         session_clear_set(se, field, increasing, position);
 675     }
 676     else {
 677         sr = nmem_malloc(se->nmem, sizeof(*sr));
 678         sr->field = nmem_strdup(se->nmem, field);
 679         sr->increasing = increasing;
 680         sr->position = position;
 681         sr->next = se->sorted_results;
 682         se->sorted_results = sr;
 683     }
 684     yaz_log(YLOG_DEBUG, "Restarting search for clients due to change in sort order");
 685
 686     for (l = se->clients_active; l; l = l->next)
 687     {
 688         struct client *cl = l->client;
 689         if (client_get_state(cl) == Client_Connecting ||
 690             client_get_state(cl) == Client_Idle ||
 691             client_get_state(cl) == Client_Working) {
 692             yaz_log(YLOG_DEBUG, "Client %s: Restarting search due to change in sort order", client_get_id(cl));
 693             client_start_search(cl);
 694         }
 695     }
 696     session_leave(se);
 697 }
 698
 699 enum pazpar2_error_code session_search(struct session *se,
 700                                        const char *query,
 701                                        const char *startrecs,
 702                                        const char *maxrecs,
 703                                        const char *filter,
 704                                        const char *limit,
 705                                        const char **addinfo,
 706                                        struct reclist_sortparms *sp)
 707 {
 708     int live_channels = 0;
 709     int no_working = 0;
 710     int no_failed_query = 0;
 711     int no_failed_limit = 0;
 712     struct client_list *l, *l0;
 713     struct timeval tval;
 714     facet_limits_t facet_limits;
 715
 716     session_log(se, YLOG_DEBUG, "Search");
 717
 718     *addinfo = 0;
 719
 720     if (se->settings_modified)
 721         session_remove_cached_clients(se);
 722     else
 723         session_reset_active_clients(se, 0);
 724
 725     session_enter(se);
 726     se->settings_modified = 0;
 727     session_clear_set(se, sp->name, sp->increasing, sp->type == Metadata_sortkey_position);
 728     relevance_destroy(&se->relevance);
 729
 730     live_channels = select_targets(se, filter);
 731     if (!live_channels)
 732     {
 733         session_leave(se);
 734         return PAZPAR2_NO_TARGETS;
 735     }
 736
 737     yaz_gettimeofday(&tval);
 738
 739     tval.tv_sec += 5;
 740
 741     facet_limits = facet_limits_create(limit);
 742     if (!facet_limits)
 743     {
 744         *addinfo = "limit";
 745         session_leave(se);
 746         return PAZPAR2_MALFORMED_PARAMETER_VALUE;
 747     }
 748
 749     l0 = se->clients_active;
 750     se->clients_active = 0;
 751     session_leave(se);
 752
 753     for (l = l0; l; l = l->next)
 754     {
 755         int parse_ret;
 756         struct client *cl = l->client;
 757
 758         if (prepare_map(se, client_get_database(cl)) < 0)
 759             continue;
 760
 761         parse_ret = client_parse_query(cl, query, facet_limits, startrecs,
 762                                        maxrecs, se->service->ccl_bibset);
 763         if (parse_ret == -1)
 764             no_failed_query++;
 765         else if (parse_ret == -2)
 766             no_failed_limit++;
 767         else if (parse_ret)
 768             no_working++; /* other error, such as bad CCL map */
 769         else
 770         {
 771             int r =
 772                 client_prep_connection(cl, se->service->z3950_operation_timeout,
 773                                        se->service->z3950_session_timeout,
 774                                        se->service->server->iochan_man,
 775                                        &tval);
 776             if (parse_ret == 1 && r == 2)
 777             {
 778                 session_log(se, YLOG_LOG, "client %s REUSE result", client_get_id(cl));
 779                 client_reingest(cl);
 780             }
 781             else if (r)
 782             {
 783                 session_log(se, YLOG_LOG, "client %s NEW search", client_get_id(cl));
 784                 client_start_search(cl);
 785             }
 786             no_working++;
 787         }
 788     }
 789     facet_limits_destroy(facet_limits);
 790     session_reset_active_clients(se, l0);
 791
 792     if (no_working == 0)
 793     {
 794         if (no_failed_query > 0)
 795         {
 796             *addinfo = "query";
 797             return PAZPAR2_MALFORMED_PARAMETER_VALUE;
 798         }
 799         else if (no_failed_limit > 0)
 800         {
 801             *addinfo = "limit";
 802             return PAZPAR2_MALFORMED_PARAMETER_VALUE;
 803         }
 804         else
 805             return PAZPAR2_NO_TARGETS;
 806     }
 807     session_log(se, YLOG_LOG, "session_start_search done");
 808     return PAZPAR2_NO_ERROR;
 809 }
 810
 811 // Creates a new session_database object for a database
 812 static void session_init_databases_fun(void *context, struct database *db)
 813 {
 814     struct session *se = (struct session *) context;
 815     struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
 816     int i;
 817
 818     new->database = db;
 819
 820     new->map = 0;
 821     assert(db->settings);
 822     new->settings = nmem_malloc(se->session_nmem,
 823                                 sizeof(struct settings *) * db->num_settings);
 824     new->num_settings = db->num_settings;
 825     for (i = 0; i < db->num_settings; i++)
 826     {
 827         struct setting *setting = db->settings[i];
 828         new->settings[i] = setting;
 829     }
 830     new->next = se->databases;
 831     se->databases = new;
 832 }
 833
 834 // Doesn't free memory associated with sdb -- nmem takes care of that
 835 static void session_database_destroy(struct session_database *sdb)
 836 {
 837     sdb->map = 0;
 838 }
 839
 840 // Initialize session_database list -- this represents this session's view
 841 // of the database list -- subject to modification by the settings ws command
 842 void session_init_databases(struct session *se)
 843 {
 844     se->databases = 0;
 845     predef_grep_databases(se, se->service, session_init_databases_fun);
 846 }
 847
 848 // Probably session_init_databases_fun should be refactored instead of
 849 // called here.
 850 static struct session_database *load_session_database(struct session *se,
 851                                                       char *id)
 852 {
 853     struct database *db = new_database_inherit_settings(id, se->session_nmem, se->service->settings);
 854     session_init_databases_fun((void*) se, db);
 855
 856     // New sdb is head of se->databases list
 857     return se->databases;
 858 }
 859
 860 // Find an existing session database. If not found, load it
 861 static struct session_database *find_session_database(struct session *se,
 862                                                       char *id)
 863 {
 864     struct session_database *sdb;
 865
 866     for (sdb = se->databases; sdb; sdb = sdb->next)
 867         if (!strcmp(sdb->database->id, id))
 868             return sdb;
 869     return load_session_database(se, id);
 870 }
 871
 872 // Apply a session override to a database
 873 void session_apply_setting(struct session *se, char *dbname, char *setting,
 874                            char *value)
 875 {
 876     struct session_database *sdb = find_session_database(se, dbname);
 877     struct conf_service *service = se->service;
 878     struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
 879     int offset = settings_create_offset(service, setting);
 880
 881     expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
 882                           se->session_nmem);
 883     new->precedence = 0;
 884     new->target = dbname;
 885     new->name = setting;
 886     new->value = value;
 887     new->next = sdb->settings[offset];
 888     sdb->settings[offset] = new;
 889
 890     se->settings_modified = 1;
 891
 892     // Force later recompute of settings-driven data structures
 893     // (happens when a search starts and client connections are prepared)
 894     switch (offset)
 895     {
 896     case PZ_XSLT:
 897         if (sdb->map)
 898         {
 899             sdb->map = 0;
 900         }
 901         break;
 902     }
 903 }
 904
 905 void session_destroy(struct session *se)
 906 {
 907     struct session_database *sdb;
 908     session_log(se, YLOG_DEBUG, "Destroying");
 909     session_use(-1);
 910     session_remove_cached_clients(se);
 911
 912     for (sdb = se->databases; sdb; sdb = sdb->next)
 913         session_database_destroy(sdb);
 914     normalize_cache_destroy(se->normalize_cache);
 915     relevance_destroy(&se->relevance);
 916     reclist_destroy(se->reclist);
 917     if (nmem_total(se->nmem))
 918         session_log(se, YLOG_DEBUG, "NMEN operation usage %zd", nmem_total(se->nmem));
 919     if (nmem_total(se->session_nmem))
 920         session_log(se, YLOG_DEBUG, "NMEN session usage %zd", nmem_total(se->session_nmem));
 921     nmem_destroy(se->nmem);
 922     service_destroy(se->service);
 923     yaz_mutex_destroy(&se->session_mutex);
 924 }
 925
 926 size_t session_get_memory_status(struct session *session) {
 927     size_t session_nmem;
 928     if (session == 0)
 929         return 0;
 930     session_enter(session);
 931     session_nmem = nmem_total(session->nmem);
 932     session_leave(session);
 933     return session_nmem;
 934 }
 935
 936
 937 struct session *new_session(NMEM nmem, struct conf_service *service,
 938                             unsigned session_id)
 939 {
 940     int i;
 941     struct session *session = nmem_malloc(nmem, sizeof(*session));
 942
 943     char tmp_str[50];
 944
 945     sprintf(tmp_str, "session#%u", session_id);
 946
 947     session->session_id = session_id;
 948     session_log(session, YLOG_DEBUG, "New");
 949     session->service = service;
 950     session->relevance = 0;
 951     session->total_records = 0;
 952     session->number_of_warnings_unknown_elements = 0;
 953     session->number_of_warnings_unknown_metadata = 0;
 954     session->num_termlists = 0;
 955     session->reclist = 0;
 956     session->clients_active = 0;
 957     session->clients_cached = 0;
 958     session->settings_modified = 0;
 959     session->session_nmem = nmem;
 960     session->nmem = nmem_create();
 961     session->databases = 0;
 962     for (i = 0; i <= SESSION_WATCH_MAX; i++)
 963     {
 964         session->watchlist[i].data = 0;
 965         session->watchlist[i].fun = 0;
 966     }
 967     session->normalize_cache = normalize_cache_create();
 968     session->session_mutex = 0;
 969     pazpar2_mutex_create(&session->session_mutex, tmp_str);
 970     session_use(1);
 971     return session;
 972 }
 973
 974 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf);
 975
 976 static struct hitsbytarget *hitsbytarget_nb(struct session *se,
 977                                             int *count, NMEM nmem)
 978 {
 979     struct hitsbytarget *res = 0;
 980     struct client_list *l;
 981     size_t sz = 0;
 982
 983     for (l = se->clients_active; l; l = l->next)
 984         sz++;
 985
 986     res = nmem_malloc(nmem, sizeof(*res) * sz);
 987     *count = 0;
 988     for (l = se->clients_active; l; l = l->next)
 989     {
 990         struct client *cl = l->client;
 991         WRBUF w = wrbuf_alloc();
 992         const char *name = session_setting_oneval(client_get_database(cl),
 993                                                   PZ_NAME);
 994
 995         res[*count].id = client_get_id(cl);
 996         res[*count].name = *name ? name : "Unknown";
 997         res[*count].hits = client_get_hits(cl);
 998         res[*count].approximation = client_get_approximation(cl);
 999         res[*count].records = client_get_num_records(cl);
1000         res[*count].filtered = client_get_num_records_filtered(cl);
1001         res[*count].diagnostic =
1002             client_get_diagnostic(cl, &res[*count].addinfo);
1003         res[*count].state = client_get_state_str(cl);
1004         res[*count].connected  = client_get_connection(cl) ? 1 : 0;
1005         session_settings_dump(se, client_get_database(cl), w);
1006         res[*count].settings_xml = nmem_strdup(nmem, wrbuf_cstr(w));
1007         wrbuf_rewind(w);
1008         wrbuf_puts(w, "");
1009         res[*count].suggestions_xml = nmem_strdup(nmem, client_get_suggestions_xml(cl, w));
1010         wrbuf_destroy(w);
1011         (*count)++;
1012     }
1013     return res;
1014 }
1015
1016 struct hitsbytarget *get_hitsbytarget(struct session *se, int *count, NMEM nmem)
1017 {
1018     struct hitsbytarget *p;
1019     session_enter(se);
1020     p = hitsbytarget_nb(se, count, nmem);
1021     session_leave(se);
1022     return p;
1023 }
1024
1025 // Compares two hitsbytarget nodes by hitcount
1026 static int cmp_ht(const void *p1, const void *p2)
1027 {
1028     const struct hitsbytarget *h1 = p1;
1029     const struct hitsbytarget *h2 = p2;
1030     return h2->hits - h1->hits;
1031 }
1032
1033 // Compares two hitsbytarget nodes by hitcount
1034 static int cmp_ht_approx(const void *p1, const void *p2)
1035 {
1036     const struct hitsbytarget *h1 = p1;
1037     const struct hitsbytarget *h2 = p2;
1038     return h2->approximation - h1->approximation;
1039 }
1040
1041 static int targets_termlist_nb(WRBUF wrbuf, struct session *se, int num,
1042                                NMEM nmem, int version)
1043 {
1044     struct hitsbytarget *ht;
1045     int count, i;
1046
1047     ht = hitsbytarget_nb(se, &count, nmem);
1048     if (version >= 2)
1049         qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht_approx);
1050     else
1051         qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
1052     for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
1053     {
1054
1055         // do only print terms which have display names
1056
1057         wrbuf_puts(wrbuf, "<term>\n");
1058
1059         wrbuf_puts(wrbuf, "<id>");
1060         wrbuf_xmlputs(wrbuf, ht[i].id);
1061         wrbuf_puts(wrbuf, "</id>\n");
1062
1063         wrbuf_puts(wrbuf, "<name>");
1064         if (!ht[i].name || !ht[i].name[0])
1065             wrbuf_xmlputs(wrbuf, "NO TARGET NAME");
1066         else
1067             wrbuf_xmlputs(wrbuf, ht[i].name);
1068         wrbuf_puts(wrbuf, "</name>\n");
1069
1070         wrbuf_printf(wrbuf, "<frequency>" ODR_INT_PRINTF "</frequency>\n",
1071                      ht[i].hits);
1072
1073         if (version >= 2) {
1074             // Should not print if we know it isn't a approximation.
1075             wrbuf_printf(wrbuf, "<approximation>" ODR_INT_PRINTF "</approximation>\n", ht[i].approximation);
1076             wrbuf_printf(wrbuf, "<records>%d</records>\n", ht[i].records - ht[i].filtered);
1077             wrbuf_printf(wrbuf, "<filtered>%d</filtered>\n", ht[i].filtered);
1078         }
1079
1080         wrbuf_puts(wrbuf, "<state>");
1081         wrbuf_xmlputs(wrbuf, ht[i].state);
1082         wrbuf_puts(wrbuf, "</state>\n");
1083
1084         wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n",
1085                      ht[i].diagnostic);
1086         wrbuf_puts(wrbuf, "</term>\n");
1087     }
1088     return count;
1089 }
1090
1091 void perform_termlist(struct http_channel *c, struct session *se,
1092                       const char *name, int num, int version)
1093 {
1094     int i, j;
1095     NMEM nmem_tmp = nmem_create();
1096     char **names;
1097     int num_names = 0;
1098
1099     if (!name)
1100         name = "*";
1101
1102     nmem_strsplit(nmem_tmp, ",", name, &names, &num_names);
1103
1104     session_enter(se);
1105
1106     for (j = 0; j < num_names; j++)
1107     {
1108         const char *tname;
1109         int must_generate_empty = 1; /* bug 5350 */
1110
1111         for (i = 0; i < se->num_termlists; i++)
1112         {
1113             tname = se->termlists[i].name;
1114             if (!strcmp(names[j], tname) || !strcmp(names[j], "*"))
1115             {
1116                 struct termlist_score **p = 0;
1117                 int len;
1118
1119                 wrbuf_puts(c->wrbuf, "<list name=\"");
1120                 wrbuf_xmlputs(c->wrbuf, tname);
1121                 wrbuf_puts(c->wrbuf, "\">\n");
1122                 must_generate_empty = 0;
1123
1124                 p = termlist_highscore(se->termlists[i].termlist, &len,
1125                                        nmem_tmp);
1126                 if (p)
1127                 {
1128                     int i;
1129                     for (i = 0; i < len && i < num; i++)
1130                     {
1131                         // prevent sending empty term elements
1132                         if (!p[i]->display_term || !p[i]->display_term[0])
1133                             continue;
1134
1135                         wrbuf_puts(c->wrbuf, "<term>");
1136                         wrbuf_puts(c->wrbuf, "<name>");
1137                         wrbuf_xmlputs(c->wrbuf, p[i]->display_term);
1138                         wrbuf_puts(c->wrbuf, "</name>");
1139
1140                         wrbuf_printf(c->wrbuf,
1141                                      "<frequency>%d</frequency>",
1142                                      p[i]->frequency);
1143                         wrbuf_puts(c->wrbuf, "</term>\n");
1144                     }
1145                 }
1146                 wrbuf_puts(c->wrbuf, "</list>\n");
1147             }
1148         }
1149         tname = "xtargets";
1150         if (!strcmp(names[j], tname) || !strcmp(names[j], "*"))
1151         {
1152             wrbuf_puts(c->wrbuf, "<list name=\"");
1153             wrbuf_xmlputs(c->wrbuf, tname);
1154             wrbuf_puts(c->wrbuf, "\">\n");
1155
1156             targets_termlist_nb(c->wrbuf, se, num, c->nmem, version);
1157             wrbuf_puts(c->wrbuf, "</list>\n");
1158             must_generate_empty = 0;
1159         }
1160         if (must_generate_empty)
1161         {
1162             wrbuf_puts(c->wrbuf, "<list name=\"");
1163             wrbuf_xmlputs(c->wrbuf, names[j]);
1164             wrbuf_puts(c->wrbuf, "\"/>\n");
1165         }
1166     }
1167     session_leave(se);
1168     nmem_destroy(nmem_tmp);
1169 }
1170
1171 #ifdef MISSING_HEADERS
1172 void report_nmem_stats(void)
1173 {
1174     size_t in_use, is_free;
1175
1176     nmem_get_memory_in_use(&in_use);
1177     nmem_get_memory_free(&is_free);
1178
1179     yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
1180             (long) in_use, (long) is_free);
1181 }
1182 #endif
1183
1184 struct record_cluster *show_single_start(struct session *se, const char *id,
1185                                          struct record_cluster **prev_r,
1186                                          struct record_cluster **next_r)
1187 {
1188     struct record_cluster *r = 0;
1189
1190     session_enter(se);
1191     *prev_r = 0;
1192     *next_r = 0;
1193     if (se->reclist)
1194     {
1195         reclist_enter(se->reclist);
1196         while ((r = reclist_read_record(se->reclist)))
1197         {
1198             if (!strcmp(r->recid, id))
1199             {
1200                 *next_r = reclist_read_record(se->reclist);
1201                 break;
1202             }
1203             *prev_r = r;
1204         }
1205         reclist_leave(se->reclist);
1206     }
1207     if (!r)
1208         session_leave(se);
1209     return r;
1210 }
1211
1212 void show_single_stop(struct session *se, struct record_cluster *rec)
1213 {
1214     session_leave(se);
1215 }
1216
1217 struct record_cluster **show_range_start(struct session *se,
1218                                          struct reclist_sortparms *sp,
1219                                          int start, int *num, int *total, Odr_int *sumhits, Odr_int *approx_hits)
1220 {
1221     struct record_cluster **recs;
1222     struct reclist_sortparms *spp;
1223     int i;
1224 #if USE_TIMING
1225     yaz_timing_t t = yaz_timing_create();
1226 #endif
1227     session_enter(se);
1228     recs = nmem_malloc(se->nmem, *num * sizeof(struct record_cluster *));
1229     if (!se->relevance)
1230     {
1231         *num = 0;
1232         *total = 0;
1233         *sumhits = 0;
1234         *approx_hits = 0;
1235         recs = 0;
1236     }
1237     else
1238     {
1239         struct client_list *l;
1240
1241         for (spp = sp; spp; spp = spp->next)
1242             if (spp->type == Metadata_sortkey_relevance)
1243             {
1244                 relevance_prepare_read(se->relevance, se->reclist);
1245                 break;
1246             }
1247         reclist_sort(se->reclist, sp);
1248
1249         reclist_enter(se->reclist);
1250         *total = reclist_get_num_records(se->reclist);
1251
1252         *sumhits = 0;
1253         *approx_hits = 0;
1254         for (l = se->clients_active; l; l = l->next) {
1255             *sumhits += client_get_hits(l->client);
1256             *approx_hits += client_get_approximation(l->client);
1257         }
1258         for (i = 0; i < start; i++)
1259             if (!reclist_read_record(se->reclist))
1260             {
1261                 *num = 0;
1262                 recs = 0;
1263                 break;
1264             }
1265
1266         for (i = 0; i < *num; i++)
1267         {
1268             struct record_cluster *r = reclist_read_record(se->reclist);
1269             if (!r)
1270             {
1271                 *num = i;
1272                 break;
1273             }
1274             recs[i] = r;
1275         }
1276         reclist_leave(se->reclist);
1277     }
1278 #if USE_TIMING
1279     yaz_timing_stop(t);
1280     yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
1281             yaz_timing_get_real(t), yaz_timing_get_user(t),
1282             yaz_timing_get_sys(t));
1283     yaz_timing_destroy(&t);
1284 #endif
1285     return recs;
1286 }
1287
1288 void show_range_stop(struct session *se, struct record_cluster **recs)
1289 {
1290     session_leave(se);
1291 }
1292
1293 void statistics(struct session *se, struct statistics *stat)
1294 {
1295     struct client_list *l;
1296     int count = 0;
1297
1298     memset(stat, 0, sizeof(*stat));
1299     stat->num_hits = 0;
1300     for (l = se->clients_active; l; l = l->next)
1301     {
1302         struct client *cl = l->client;
1303         if (!client_get_connection(cl))
1304             stat->num_no_connection++;
1305         stat->num_hits += client_get_hits(cl);
1306         switch (client_get_state(cl))
1307         {
1308         case Client_Connecting: stat->num_connecting++; break;
1309         case Client_Working: stat->num_working++; break;
1310         case Client_Idle: stat->num_idle++; break;
1311         case Client_Failed: stat->num_failed++; break;
1312         case Client_Error: stat->num_error++; break;
1313         default: break;
1314         }
1315         count++;
1316     }
1317     stat->num_records = se->total_records;
1318
1319     stat->num_clients = count;
1320 }
1321
1322 static struct record_metadata *record_metadata_init(
1323     NMEM nmem, const char *value, enum conf_metadata_type type,
1324     struct _xmlAttr *attr)
1325 {
1326     struct record_metadata *rec_md = record_metadata_create(nmem);
1327     struct record_metadata_attr **attrp = &rec_md->attributes;
1328
1329     for (; attr; attr = attr->next)
1330     {
1331         if (attr->children && attr->children->content)
1332         {
1333             if (strcmp((const char *) attr->name, "type"))
1334             {  /* skip the "type" attribute.. Its value is already part of
1335                   the element in output (md-%s) and so repeating it here
1336                   is redundant */
1337                 *attrp = nmem_malloc(nmem, sizeof(**attrp));
1338                 (*attrp)->name =
1339                     nmem_strdup(nmem, (const char *) attr->name);
1340                 (*attrp)->value =
1341                     nmem_strdup(nmem, (const char *) attr->children->content);
1342                 attrp = &(*attrp)->next;
1343             }
1344         }
1345     }
1346     *attrp = 0;
1347
1348     if (type == Metadata_type_generic)
1349     {
1350         char *p = nmem_strdup(nmem, value);
1351
1352         p = normalize7bit_generic(p, " ,/.:([");
1353
1354         rec_md->data.text.disp = p;
1355         rec_md->data.text.sort = 0;
1356     }
1357     else if (type == Metadata_type_year || type == Metadata_type_date)
1358     {
1359         int first, last;
1360         int longdate = 0;
1361
1362         if (type == Metadata_type_date)
1363             longdate = 1;
1364         if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
1365             return 0;
1366
1367         rec_md->data.number.min = first;
1368         rec_md->data.number.max = last;
1369     }
1370     else
1371         return 0;
1372     return rec_md;
1373 }
1374
1375 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
1376                                  struct conf_service *service, WRBUF norm_wr)
1377 {
1378     xmlNode *n;
1379     int no_found = 0;
1380     for (n = root->children; n; n = n->next)
1381     {
1382         if (n->type != XML_ELEMENT_NODE)
1383             continue;
1384         if (!strcmp((const char *) n->name, "metadata"))
1385         {
1386             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1387             if (type == NULL) {
1388                 yaz_log(YLOG_FATAL, "Missing type attribute on metadata element. Skipping!");
1389             }
1390             else if (!strcmp(name, (const char *) type))
1391             {
1392                 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
1393                 if (value)
1394                 {
1395                     const char *norm_str;
1396                     pp2_charset_token_t prt =
1397                         pp2_charset_token_create(service->charsets, "mergekey");
1398
1399                     pp2_charset_token_first(prt, (const char *) value, 0);
1400                     if (wrbuf_len(norm_wr) > 0)
1401                         wrbuf_puts(norm_wr, " ");
1402                     wrbuf_puts(norm_wr, name);
1403                     while ((norm_str =
1404                             pp2_charset_token_next(prt)))
1405                     {
1406                         if (*norm_str)
1407                         {
1408                             wrbuf_puts(norm_wr, " ");
1409                             wrbuf_puts(norm_wr, norm_str);
1410                         }
1411                     }
1412                     xmlFree(value);
1413                     pp2_charset_token_destroy(prt);
1414                     no_found++;
1415                 }
1416             }
1417             xmlFree(type);
1418         }
1419     }
1420     return no_found;
1421 }
1422
1423 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
1424                                 struct conf_service *service, NMEM nmem)
1425 {
1426     char *mergekey_norm = 0;
1427     xmlNode *root = xmlDocGetRootElement(doc);
1428     WRBUF norm_wr = wrbuf_alloc();
1429
1430     /* consider mergekey from XSL first */
1431     xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
1432     if (mergekey)
1433     {
1434         const char *norm_str;
1435         pp2_charset_token_t prt =
1436             pp2_charset_token_create(service->charsets, "mergekey");
1437
1438         pp2_charset_token_first(prt, (const char *) mergekey, 0);
1439         while ((norm_str = pp2_charset_token_next(prt)))
1440         {
1441             if (*norm_str)
1442             {
1443                 if (wrbuf_len(norm_wr))
1444                     wrbuf_puts(norm_wr, " ");
1445                 wrbuf_puts(norm_wr, norm_str);
1446             }
1447         }
1448         pp2_charset_token_destroy(prt);
1449         xmlFree(mergekey);
1450     }
1451     else
1452     {
1453         /* no mergekey defined in XSL. Look for mergekey metadata instead */
1454         int field_id;
1455         for (field_id = 0; field_id < service->num_metadata; field_id++)
1456         {
1457             struct conf_metadata *ser_md = &service->metadata[field_id];
1458             if (ser_md->mergekey != Metadata_mergekey_no)
1459             {
1460                 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1461                                               service, norm_wr);
1462                 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1463                 {
1464                     /* no mergekey on this one and it is required..
1465                        Generate unique key instead */
1466                     wrbuf_rewind(norm_wr);
1467                     break;
1468                 }
1469             }
1470         }
1471     }
1472
1473     /* generate unique key if none is not generated already or is empty */
1474     if (wrbuf_len(norm_wr) == 0)
1475     {
1476         wrbuf_printf(norm_wr, "position: %s-%d",
1477                      client_get_id(cl), record_no);
1478     }
1479     else
1480     {
1481         const char *lead = "content: ";
1482         wrbuf_insert(norm_wr, 0, lead, strlen(lead));
1483     }
1484     if (wrbuf_len(norm_wr) > 0)
1485         mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1486     wrbuf_destroy(norm_wr);
1487     return mergekey_norm;
1488 }
1489
1490 /** \brief see if metadata for pz:recordfilter exists
1491     \param root xml root element of normalized record
1492     \param sdb session database for client
1493     \retval 0 if there is no metadata for pz:recordfilter
1494     \retval 1 if there is metadata for pz:recordfilter
1495
1496     If there is no pz:recordfilter defined, this function returns 1
1497     as well.
1498 */
1499
1500 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1501 {
1502     int match = 0;
1503     xmlNode *n;
1504     const char *s;
1505     s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1506
1507     if (!s || !*s)
1508         return 1;
1509
1510     for (n = root->children; n; n = n->next)
1511     {
1512         if (n->type != XML_ELEMENT_NODE)
1513             continue;
1514         if (!strcmp((const char *) n->name, "metadata"))
1515         {
1516             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1517             if (type)
1518             {
1519                 size_t len;
1520                 int substring;
1521                 const char *eq;
1522
1523                 if ((eq = strchr(s, '=')))
1524                     substring = 0;
1525                 else if ((eq = strchr(s, '~')))
1526                     substring = 1;
1527                 if (eq)
1528                     len = eq - s;
1529                 else
1530                     len = strlen(s);
1531                 if (len == strlen((const char *)type) &&
1532                     !memcmp((const char *) type, s, len))
1533                 {
1534                     xmlChar *value = xmlNodeGetContent(n);
1535                     if (value && *value)
1536                     {
1537                         if (!eq ||
1538                             (substring && strstr((const char *) value, eq+1)) ||
1539                             (!substring && !strcmp((const char *) value, eq + 1)))
1540                             match = 1;
1541                     }
1542                     xmlFree(value);
1543                 }
1544                 xmlFree(type);
1545             }
1546         }
1547     }
1548     return match;
1549 }
1550
1551
1552 static int ingest_to_cluster(struct client *cl,
1553                              xmlDoc *xdoc,
1554                              xmlNode *root,
1555                              int record_no,
1556                              const char *mergekey_norm);
1557
1558 /** \brief ingest XML record
1559     \param cl client holds the result set for record
1560     \param rec record buffer (0 terminated)
1561     \param record_no record position (1, 2, ..)
1562     \param nmem working NMEM
1563     \retval 0 OK
1564     \retval -1 failure
1565     \retval -2 Filtered
1566 */
1567 int ingest_record(struct client *cl, const char *rec,
1568                   int record_no, NMEM nmem)
1569 {
1570     struct session *se = client_get_session(cl);
1571     int ret = 0;
1572     struct session_database *sdb = client_get_database(cl);
1573     struct conf_service *service = se->service;
1574     xmlDoc *xdoc = normalize_record(se, sdb, service, rec, nmem);
1575     xmlNode *root;
1576     const char *mergekey_norm;
1577
1578     if (!xdoc)
1579         return -1;
1580
1581     root = xmlDocGetRootElement(xdoc);
1582
1583     if (!check_record_filter(root, sdb))
1584     {
1585         session_log(se, YLOG_LOG, "Filtered out record no %d from %s", record_no, sdb->database->id);
1586         xmlFreeDoc(xdoc);
1587         return -2;
1588     }
1589
1590     mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem);
1591     if (!mergekey_norm)
1592     {
1593         session_log(se, YLOG_WARN, "Got no mergekey");
1594         xmlFreeDoc(xdoc);
1595         return -1;
1596     }
1597     session_enter(se);
1598     if (client_get_session(cl) == se)
1599         ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1600     session_leave(se);
1601
1602     xmlFreeDoc(xdoc);
1603     return ret;
1604 }
1605
1606 // Skip record on non-zero
1607 static int check_limit_local(struct client *cl,
1608                              struct record *record,
1609                              int record_no)
1610 {
1611     int skip_record = 0;
1612     struct session *se = client_get_session(cl);
1613     struct conf_service *service = se->service;
1614     NMEM nmem_tmp = nmem_create();
1615     struct session_database *sdb = client_get_database(cl);
1616     int l = 0;
1617     while (!skip_record)
1618     {
1619         struct conf_metadata *ser_md = 0;
1620         struct record_metadata *rec_md = 0;
1621         int md_field_id;
1622         char **values = 0;
1623         int i, num_v = 0;
1624
1625         const char *name = client_get_facet_limit_local(cl, sdb, &l, nmem_tmp, &num_v, &values);
1626         if (!name)
1627             break;
1628
1629         md_field_id = conf_service_metadata_field_id(service, name);
1630         if (md_field_id < 0)
1631         {
1632             skip_record = 1;
1633             break;
1634         }
1635         ser_md = &service->metadata[md_field_id];
1636         rec_md = record->metadata[md_field_id];
1637         yaz_log(YLOG_DEBUG, "check limit local %s", name);
1638         for (i = 0; i < num_v; )
1639         {
1640             if (rec_md)
1641             {
1642                 if (ser_md->type == Metadata_type_year
1643                     || ser_md->type == Metadata_type_date)
1644                 {
1645                     int y = atoi(values[i]);
1646                     if (y >= rec_md->data.number.min
1647                         && y <= rec_md->data.number.max)
1648                         break;
1649                 }
1650                 else
1651                 {
1652                     yaz_log(YLOG_DEBUG, "cmp: '%s' '%s'", rec_md->data.text.disp, values[i]);
1653                     if (!strcmp(rec_md->data.text.disp, values[i]))
1654                     {
1655                         // Value equals, should not be filtered.
1656                         break;
1657                     }
1658                 }
1659                 rec_md = rec_md->next;
1660             }
1661             else
1662             {
1663                 rec_md = record->metadata[md_field_id];
1664                 i++;
1665             }
1666         }
1667         // At end , not match
1668         if (i == num_v)
1669         {
1670             skip_record = 1;
1671             break;
1672         }
1673     }
1674     nmem_destroy(nmem_tmp);
1675     return skip_record;
1676 }
1677
1678 static int ingest_to_cluster(struct client *cl,
1679                              xmlDoc *xdoc,
1680                              xmlNode *root,
1681                              int record_no,
1682                              const char *mergekey_norm)
1683 {
1684     xmlNode *n;
1685     xmlChar *type = 0;
1686     xmlChar *value = 0;
1687     struct session *se = client_get_session(cl);
1688     struct conf_service *service = se->service;
1689     int term_factor = 1;
1690     struct record_cluster *cluster;
1691     struct session_database *sdb = client_get_database(cl);
1692     struct record *record = record_create(se->nmem,
1693                                           service->num_metadata,
1694                                           service->num_sortkeys, cl,
1695                                           record_no);
1696
1697     for (n = root->children; n; n = n->next)
1698     {
1699         if (type)
1700             xmlFree(type);
1701         if (value)
1702             xmlFree(value);
1703         type = value = 0;
1704
1705         if (n->type != XML_ELEMENT_NODE)
1706             continue;
1707         if (!strcmp((const char *) n->name, "metadata"))
1708         {
1709             struct conf_metadata *ser_md = 0;
1710             struct record_metadata **wheretoput = 0;
1711             struct record_metadata *rec_md = 0;
1712             int md_field_id = -1;
1713
1714             type = xmlGetProp(n, (xmlChar *) "type");
1715             value = xmlNodeListGetString(xdoc, n->children, 1);
1716
1717             if (!type || !value || !*value)
1718                 continue;
1719
1720             md_field_id
1721                 = conf_service_metadata_field_id(service, (const char *) type);
1722             if (md_field_id < 0)
1723             {
1724                 if (se->number_of_warnings_unknown_metadata == 0)
1725                 {
1726                     session_log(se, YLOG_WARN,
1727                             "Ignoring unknown metadata element: %s", type);
1728                 }
1729                 se->number_of_warnings_unknown_metadata++;
1730                 continue;
1731             }
1732
1733             ser_md = &service->metadata[md_field_id];
1734
1735             // non-merged metadata
1736             rec_md = record_metadata_init(se->nmem, (const char *) value,
1737                                           ser_md->type, n->properties);
1738             if (!rec_md)
1739             {
1740                 session_log(se, YLOG_WARN, "bad metadata data '%s' "
1741                             "for element '%s'", value, type);
1742                 continue;
1743             }
1744             wheretoput = &record->metadata[md_field_id];
1745             while (*wheretoput)
1746                 wheretoput = &(*wheretoput)->next;
1747             *wheretoput = rec_md;
1748         }
1749     }
1750
1751     if (check_limit_local(cl, record, record_no))
1752     {
1753         session_log(se, YLOG_LOG, "Facet filtered out record no %d from %s",
1754                     record_no, sdb->database->id);
1755         if (type)
1756             xmlFree(type);
1757         if (value)
1758             xmlFree(value);
1759         return -2;
1760     }
1761     cluster = reclist_insert(se->reclist, service, record,
1762                              mergekey_norm, &se->total_merged);
1763     if (!cluster)
1764         return -1;
1765
1766     {
1767         const char *use_term_factor_str =
1768             session_setting_oneval(sdb, PZ_TERMLIST_TERM_FACTOR);
1769         if (use_term_factor_str && use_term_factor_str[0] == '1')
1770         {
1771             int maxrecs = client_get_maxrecs(cl);
1772             int hits = (int) client_get_hits(cl);
1773             term_factor = MAX(hits, maxrecs) /  MAX(1, maxrecs);
1774             assert(term_factor >= 1);
1775             yaz_log(YLOG_DEBUG, "Using term factor: %d (%d / %d)", term_factor, MAX(hits, maxrecs), MAX(1, maxrecs));
1776         }
1777     }
1778
1779     if (global_parameters.dump_records)
1780         session_log(se, YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1781                     sdb->database->id, record_no);
1782
1783
1784     relevance_newrec(se->relevance, cluster);
1785
1786     // now parsing XML record and adding data to cluster or record metadata
1787     for (n = root->children; n; n = n->next)
1788     {
1789         pp2_charset_token_t prt;
1790         if (type)
1791             xmlFree(type);
1792         if (value)
1793             xmlFree(value);
1794         type = value = 0;
1795
1796         if (n->type != XML_ELEMENT_NODE)
1797             continue;
1798         if (!strcmp((const char *) n->name, "metadata"))
1799         {
1800             struct conf_metadata *ser_md = 0;
1801             struct conf_sortkey *ser_sk = 0;
1802             struct record_metadata **wheretoput = 0;
1803             struct record_metadata *rec_md = 0;
1804             int md_field_id = -1;
1805             int sk_field_id = -1;
1806             const char *rank;
1807             xmlChar *xml_rank;
1808
1809             type = xmlGetProp(n, (xmlChar *) "type");
1810             value = xmlNodeListGetString(xdoc, n->children, 1);
1811
1812             if (!type || !value || !*value)
1813                 continue;
1814
1815             md_field_id
1816                 = conf_service_metadata_field_id(service, (const char *) type);
1817             if (md_field_id < 0)
1818                 continue;
1819
1820             ser_md = &service->metadata[md_field_id];
1821
1822             if (ser_md->sortkey_offset >= 0)
1823             {
1824                 sk_field_id = ser_md->sortkey_offset;
1825                 ser_sk = &service->sortkeys[sk_field_id];
1826             }
1827
1828             // merged metadata
1829             rec_md = record_metadata_init(se->nmem, (const char *) value,
1830                                           ser_md->type, 0);
1831             if (!rec_md)
1832                 continue;
1833
1834             xml_rank = xmlGetProp(n, (xmlChar *) "rank");
1835             rank = xml_rank ? (const char *) xml_rank : ser_md->rank;
1836
1837             wheretoput = &cluster->metadata[md_field_id];
1838
1839             // and polulate with data:
1840             // assign cluster or record based on merge action
1841             if (ser_md->merge == Metadata_merge_unique)
1842             {
1843                 while (*wheretoput)
1844                 {
1845                     if (!strcmp((const char *) (*wheretoput)->data.text.disp,
1846                                 rec_md->data.text.disp))
1847                         break;
1848                     wheretoput = &(*wheretoput)->next;
1849                 }
1850                 if (!*wheretoput)
1851                     *wheretoput = rec_md;
1852             }
1853             else if (ser_md->merge == Metadata_merge_longest)
1854             {
1855                 if (!*wheretoput
1856                     || strlen(rec_md->data.text.disp)
1857                     > strlen((*wheretoput)->data.text.disp))
1858                 {
1859                     *wheretoput = rec_md;
1860                     if (ser_sk)
1861                     {
1862                         const char *sort_str = 0;
1863                         int skip_article =
1864                             ser_sk->type == Metadata_sortkey_skiparticle;
1865
1866                         if (!cluster->sortkeys[sk_field_id])
1867                             cluster->sortkeys[sk_field_id] =
1868                                 nmem_malloc(se->nmem,
1869                                             sizeof(union data_types));
1870
1871                         prt =
1872                             pp2_charset_token_create(service->charsets, "sort");
1873
1874                         pp2_charset_token_first(prt, rec_md->data.text.disp,
1875                                                 skip_article);
1876
1877                         pp2_charset_token_next(prt);
1878
1879                         sort_str = pp2_get_sort(prt);
1880
1881                         cluster->sortkeys[sk_field_id]->text.disp =
1882                             rec_md->data.text.disp;
1883                         if (!sort_str)
1884                         {
1885                             sort_str = rec_md->data.text.disp;
1886                             session_log(se, YLOG_WARN,
1887                                     "Could not make sortkey. Bug #1858");
1888                         }
1889                         cluster->sortkeys[sk_field_id]->text.sort =
1890                             nmem_strdup(se->nmem, sort_str);
1891                         pp2_charset_token_destroy(prt);
1892                     }
1893                 }
1894             }
1895             else if (ser_md->merge == Metadata_merge_all)
1896             {
1897                 while (*wheretoput)
1898                     wheretoput = &(*wheretoput)->next;
1899                 *wheretoput = rec_md;
1900             }
1901             else if (ser_md->merge == Metadata_merge_range)
1902             {
1903                 if (!*wheretoput)
1904                 {
1905                     *wheretoput = rec_md;
1906                     if (ser_sk)
1907                         cluster->sortkeys[sk_field_id]
1908                             = &rec_md->data;
1909                 }
1910                 else
1911                 {
1912                     int this_min = rec_md->data.number.min;
1913                     int this_max = rec_md->data.number.max;
1914                     if (this_min < (*wheretoput)->data.number.min)
1915                         (*wheretoput)->data.number.min = this_min;
1916                     if (this_max > (*wheretoput)->data.number.max)
1917                         (*wheretoput)->data.number.max = this_max;
1918                 }
1919             }
1920
1921             // ranking of _all_ fields enabled ...
1922             if (rank)
1923             {
1924                 relevance_countwords(se->relevance, cluster,
1925                                      (char *) value, rank, ser_md->name);
1926             }
1927
1928             // construct facets ... unless the client already has reported them
1929             if (ser_md->termlist && !client_has_facet(cl, (char *) type))
1930             {
1931                 if (ser_md->type == Metadata_type_year)
1932                 {
1933                     char year[64];
1934                     sprintf(year, "%d", rec_md->data.number.max);
1935
1936                     add_facet(se, (char *) type, year, term_factor);
1937                     if (rec_md->data.number.max != rec_md->data.number.min)
1938                     {
1939                         sprintf(year, "%d", rec_md->data.number.min);
1940                         add_facet(se, (char *) type, year, term_factor);
1941                     }
1942                 }
1943                 else
1944                     add_facet(se, (char *) type, (char *) value, term_factor);
1945             }
1946
1947             // cleaning up
1948             if (xml_rank)
1949                 xmlFree(xml_rank);
1950             xmlFree(type);
1951             xmlFree(value);
1952             type = value = 0;
1953         }
1954         else
1955         {
1956             if (se->number_of_warnings_unknown_elements == 0)
1957                 session_log(se, YLOG_WARN,
1958                         "Unexpected element in internal record: %s", n->name);
1959             se->number_of_warnings_unknown_elements++;
1960         }
1961     }
1962     if (type)
1963         xmlFree(type);
1964     if (value)
1965         xmlFree(value);
1966
1967     relevance_donerecord(se->relevance, cluster);
1968     se->total_records++;
1969
1970     return 0;
1971 }
1972
1973 void session_log(struct session *s, int level, const char *fmt, ...)
1974 {
1975     char buf[1024];
1976     va_list ap;
1977     va_start(ap, fmt);
1978
1979     yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
1980     yaz_log(level, "Session %u: %s", s->session_id, buf);
1981
1982     va_end(ap);
1983 }
1984
1985 /*
1986  * Local variables:
1987  * c-basic-offset: 4
1988  * c-file-style: "Stroustrup"
1989  * indent-tabs-mode: nil
1990  * End:
1991  * vim: shiftwidth=4 tabstop=8 expandtab
1992  */
1993