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)
 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->next = 0;
 639
 640     se->reclist = reclist_create(se->nmem);
 641 }
 642
 643 void session_sort(struct session *se, const char *field, int increasing,
 644                   int clear_set)
 645 {
 646     struct session_sorted_results *sr;
 647     struct client_list *l;
 648
 649     session_enter(se);
 650
 651     yaz_log(YLOG_LOG, "session_sort field=%s", field);
 652     if (clear_set)
 653     {
 654         session_clear_set(se, field, increasing);
 655     }
 656     else
 657     {
 658         /* see if we already have sorted for this critieria */
 659         for (sr = se->sorted_results; sr; sr = sr->next)
 660         {
 661             if (!strcmp(field, sr->field) && increasing == sr->increasing)
 662                 break;
 663         }
 664         if (sr)
 665         {
 666             session_log(se, YLOG_DEBUG, "search_sort: field=%s increasing=%d already fetched",
 667                         field, increasing);
 668             session_leave(se);
 669             return;
 670         }
 671         session_log(se, YLOG_DEBUG, "search_sort: field=%s increasing=%d must fetch",
 672                     field, increasing);
 673         sr = nmem_malloc(se->nmem, sizeof(*sr));
 674         sr->field = nmem_strdup(se->nmem, field);
 675         sr->increasing = increasing;
 676         sr->next = se->sorted_results;
 677         se->sorted_results = sr;
 678     }
 679
 680     for (l = se->clients_active; l; l = l->next)
 681     {
 682         struct client *cl = l->client;
 683         if (client_get_state(cl) == Client_Connecting ||
 684             client_get_state(cl) == Client_Idle ||
 685             client_get_state(cl) == Client_Working)
 686             client_start_search(cl);
 687     }
 688     session_leave(se);
 689 }
 690
 691 enum pazpar2_error_code session_search(struct session *se,
 692                                        const char *query,
 693                                        const char *startrecs,
 694                                        const char *maxrecs,
 695                                        const char *filter,
 696                                        const char *limit,
 697                                        const char **addinfo,
 698                                        const char *sort_field, int increasing)
 699 {
 700     int live_channels = 0;
 701     int no_working = 0;
 702     int no_failed_query = 0;
 703     int no_failed_limit = 0;
 704     struct client_list *l, *l0;
 705     struct timeval tval;
 706     facet_limits_t facet_limits;
 707
 708     session_log(se, YLOG_DEBUG, "Search");
 709
 710     *addinfo = 0;
 711
 712     if (se->settings_modified)
 713         session_remove_cached_clients(se);
 714     else
 715         session_reset_active_clients(se, 0);
 716
 717     session_enter(se);
 718     se->settings_modified = 0;
 719     session_clear_set(se, sort_field, increasing);
 720     relevance_destroy(&se->relevance);
 721
 722     live_channels = select_targets(se, filter);
 723     if (!live_channels)
 724     {
 725         session_leave(se);
 726         return PAZPAR2_NO_TARGETS;
 727     }
 728
 729     yaz_gettimeofday(&tval);
 730
 731     tval.tv_sec += 5;
 732
 733     facet_limits = facet_limits_create(limit);
 734     if (!facet_limits)
 735     {
 736         *addinfo = "limit";
 737         session_leave(se);
 738         return PAZPAR2_MALFORMED_PARAMETER_VALUE;
 739     }
 740
 741     l0 = se->clients_active;
 742     se->clients_active = 0;
 743     session_leave(se);
 744
 745     for (l = l0; l; l = l->next)
 746     {
 747         int parse_ret;
 748         struct client *cl = l->client;
 749
 750         if (prepare_map(se, client_get_database(cl)) < 0)
 751             continue;
 752
 753         parse_ret = client_parse_query(cl, query, facet_limits, startrecs,
 754                                        maxrecs, se->service->ccl_bibset);
 755         if (parse_ret == -1)
 756             no_failed_query++;
 757         else if (parse_ret == -2)
 758             no_failed_limit++;
 759         else
 760         {
 761             int r =
 762                 client_prep_connection(cl, se->service->z3950_operation_timeout,
 763                                        se->service->z3950_session_timeout,
 764                                        se->service->server->iochan_man,
 765                                        &tval);
 766             if (parse_ret == 1 && r == 2)
 767             {
 768                 session_log(se, YLOG_LOG, "client %s REUSE result", client_get_id(cl));
 769                 client_reingest(cl);
 770             }
 771             else if (r)
 772             {
 773                 session_log(se, YLOG_LOG, "client %s NEW search", client_get_id(cl));
 774                 client_start_search(cl);
 775             }
 776             no_working++;
 777         }
 778     }
 779     facet_limits_destroy(facet_limits);
 780     session_reset_active_clients(se, l0);
 781
 782     if (no_working == 0)
 783     {
 784         if (no_failed_query > 0)
 785         {
 786             *addinfo = "query";
 787             return PAZPAR2_MALFORMED_PARAMETER_VALUE;
 788         }
 789         else if (no_failed_limit > 0)
 790         {
 791             *addinfo = "limit";
 792             return PAZPAR2_MALFORMED_PARAMETER_VALUE;
 793         }
 794         else
 795             return PAZPAR2_NO_TARGETS;
 796     }
 797     session_log(se, YLOG_LOG, "session_start_search done");
 798     return PAZPAR2_NO_ERROR;
 799 }
 800
 801 // Creates a new session_database object for a database
 802 static void session_init_databases_fun(void *context, struct database *db)
 803 {
 804     struct session *se = (struct session *) context;
 805     struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
 806     int i;
 807
 808     new->database = db;
 809
 810     new->map = 0;
 811     assert(db->settings);
 812     new->settings = nmem_malloc(se->session_nmem,
 813                                 sizeof(struct settings *) * db->num_settings);
 814     new->num_settings = db->num_settings;
 815     for (i = 0; i < db->num_settings; i++)
 816     {
 817         struct setting *setting = db->settings[i];
 818         new->settings[i] = setting;
 819     }
 820     new->next = se->databases;
 821     se->databases = new;
 822 }
 823
 824 // Doesn't free memory associated with sdb -- nmem takes care of that
 825 static void session_database_destroy(struct session_database *sdb)
 826 {
 827     sdb->map = 0;
 828 }
 829
 830 // Initialize session_database list -- this represents this session's view
 831 // of the database list -- subject to modification by the settings ws command
 832 void session_init_databases(struct session *se)
 833 {
 834     se->databases = 0;
 835     predef_grep_databases(se, se->service, session_init_databases_fun);
 836 }
 837
 838 // Probably session_init_databases_fun should be refactored instead of
 839 // called here.
 840 static struct session_database *load_session_database(struct session *se,
 841                                                       char *id)
 842 {
 843     struct database *db = new_database_inherit_settings(id, se->session_nmem, se->service->settings);
 844     session_init_databases_fun((void*) se, db);
 845
 846     // New sdb is head of se->databases list
 847     return se->databases;
 848 }
 849
 850 // Find an existing session database. If not found, load it
 851 static struct session_database *find_session_database(struct session *se,
 852                                                       char *id)
 853 {
 854     struct session_database *sdb;
 855
 856     for (sdb = se->databases; sdb; sdb = sdb->next)
 857         if (!strcmp(sdb->database->id, id))
 858             return sdb;
 859     return load_session_database(se, id);
 860 }
 861
 862 // Apply a session override to a database
 863 void session_apply_setting(struct session *se, char *dbname, char *setting,
 864                            char *value)
 865 {
 866     struct session_database *sdb = find_session_database(se, dbname);
 867     struct conf_service *service = se->service;
 868     struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
 869     int offset = settings_create_offset(service, setting);
 870
 871     expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
 872                           se->session_nmem);
 873     new->precedence = 0;
 874     new->target = dbname;
 875     new->name = setting;
 876     new->value = value;
 877     new->next = sdb->settings[offset];
 878     sdb->settings[offset] = new;
 879
 880     se->settings_modified = 1;
 881
 882     // Force later recompute of settings-driven data structures
 883     // (happens when a search starts and client connections are prepared)
 884     switch (offset)
 885     {
 886     case PZ_XSLT:
 887         if (sdb->map)
 888         {
 889             sdb->map = 0;
 890         }
 891         break;
 892     }
 893 }
 894
 895 void session_destroy(struct session *se)
 896 {
 897     struct session_database *sdb;
 898     session_log(se, YLOG_DEBUG, "Destroying");
 899     session_use(-1);
 900     session_remove_cached_clients(se);
 901
 902     for (sdb = se->databases; sdb; sdb = sdb->next)
 903         session_database_destroy(sdb);
 904     normalize_cache_destroy(se->normalize_cache);
 905     relevance_destroy(&se->relevance);
 906     reclist_destroy(se->reclist);
 907     if (nmem_total(se->nmem))
 908         session_log(se, YLOG_DEBUG, "NMEN operation usage %zd", nmem_total(se->nmem));
 909     if (nmem_total(se->session_nmem))
 910         session_log(se, YLOG_DEBUG, "NMEN session usage %zd", nmem_total(se->session_nmem));
 911     nmem_destroy(se->nmem);
 912     service_destroy(se->service);
 913     yaz_mutex_destroy(&se->session_mutex);
 914 }
 915
 916 size_t session_get_memory_status(struct session *session) {
 917     size_t session_nmem;
 918     if (session == 0)
 919         return 0;
 920     session_enter(session);
 921     session_nmem = nmem_total(session->nmem);
 922     session_leave(session);
 923     return session_nmem;
 924 }
 925
 926
 927 struct session *new_session(NMEM nmem, struct conf_service *service,
 928                             unsigned session_id)
 929 {
 930     int i;
 931     struct session *session = nmem_malloc(nmem, sizeof(*session));
 932
 933     char tmp_str[50];
 934
 935     sprintf(tmp_str, "session#%u", session_id);
 936
 937     session->session_id = session_id;
 938     session_log(session, YLOG_DEBUG, "New");
 939     session->service = service;
 940     session->relevance = 0;
 941     session->total_records = 0;
 942     session->number_of_warnings_unknown_elements = 0;
 943     session->number_of_warnings_unknown_metadata = 0;
 944     session->num_termlists = 0;
 945     session->reclist = 0;
 946     session->clients_active = 0;
 947     session->clients_cached = 0;
 948     session->settings_modified = 0;
 949     session->session_nmem = nmem;
 950     session->nmem = nmem_create();
 951     session->databases = 0;
 952     for (i = 0; i <= SESSION_WATCH_MAX; i++)
 953     {
 954         session->watchlist[i].data = 0;
 955         session->watchlist[i].fun = 0;
 956     }
 957     session->normalize_cache = normalize_cache_create();
 958     session->session_mutex = 0;
 959     pazpar2_mutex_create(&session->session_mutex, tmp_str);
 960     session_use(1);
 961     return session;
 962 }
 963
 964 const char * client_get_suggestions_xml(struct client *cl, WRBUF wrbuf);
 965
 966 static struct hitsbytarget *hitsbytarget_nb(struct session *se,
 967                                             int *count, NMEM nmem)
 968 {
 969     struct hitsbytarget *res = 0;
 970     struct client_list *l;
 971     size_t sz = 0;
 972
 973     for (l = se->clients_active; l; l = l->next)
 974         sz++;
 975
 976     res = nmem_malloc(nmem, sizeof(*res) * sz);
 977     *count = 0;
 978     for (l = se->clients_active; l; l = l->next)
 979     {
 980         struct client *cl = l->client;
 981         WRBUF w = wrbuf_alloc();
 982         const char *name = session_setting_oneval(client_get_database(cl),
 983                                                   PZ_NAME);
 984
 985         res[*count].id = client_get_id(cl);
 986         res[*count].name = *name ? name : "Unknown";
 987         res[*count].hits = client_get_hits(cl);
 988         res[*count].approximation = client_get_approximation(cl);
 989         res[*count].records = client_get_num_records(cl);
 990         res[*count].filtered = client_get_num_records_filtered(cl);
 991         res[*count].diagnostic =
 992             client_get_diagnostic(cl, &res[*count].addinfo);
 993         res[*count].state = client_get_state_str(cl);
 994         res[*count].connected  = client_get_connection(cl) ? 1 : 0;
 995         session_settings_dump(se, client_get_database(cl), w);
 996         res[*count].settings_xml = nmem_strdup(nmem, wrbuf_cstr(w));
 997         wrbuf_rewind(w);
 998         wrbuf_puts(w, "");
 999         res[*count].suggestions_xml = nmem_strdup(nmem, client_get_suggestions_xml(cl, w));
1000         wrbuf_destroy(w);
1001         (*count)++;
1002     }
1003     return res;
1004 }
1005
1006 struct hitsbytarget *get_hitsbytarget(struct session *se, int *count, NMEM nmem)
1007 {
1008     struct hitsbytarget *p;
1009     session_enter(se);
1010     p = hitsbytarget_nb(se, count, nmem);
1011     session_leave(se);
1012     return p;
1013 }
1014
1015 // Compares two hitsbytarget nodes by hitcount
1016 static int cmp_ht(const void *p1, const void *p2)
1017 {
1018     const struct hitsbytarget *h1 = p1;
1019     const struct hitsbytarget *h2 = p2;
1020     return h2->hits - h1->hits;
1021 }
1022
1023 // Compares two hitsbytarget nodes by hitcount
1024 static int cmp_ht_approx(const void *p1, const void *p2)
1025 {
1026     const struct hitsbytarget *h1 = p1;
1027     const struct hitsbytarget *h2 = p2;
1028     return h2->approximation - h1->approximation;
1029 }
1030
1031 static int targets_termlist_nb(WRBUF wrbuf, struct session *se, int num,
1032                                NMEM nmem, int version)
1033 {
1034     struct hitsbytarget *ht;
1035     int count, i;
1036
1037     ht = hitsbytarget_nb(se, &count, nmem);
1038     if (version >= 2)
1039         qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht_approx);
1040     else
1041         qsort(ht, count, sizeof(struct hitsbytarget), cmp_ht);
1042     for (i = 0; i < count && i < num && ht[i].hits > 0; i++)
1043     {
1044
1045         // do only print terms which have display names
1046
1047         wrbuf_puts(wrbuf, "<term>\n");
1048
1049         wrbuf_puts(wrbuf, "<id>");
1050         wrbuf_xmlputs(wrbuf, ht[i].id);
1051         wrbuf_puts(wrbuf, "</id>\n");
1052
1053         wrbuf_puts(wrbuf, "<name>");
1054         if (!ht[i].name || !ht[i].name[0])
1055             wrbuf_xmlputs(wrbuf, "NO TARGET NAME");
1056         else
1057             wrbuf_xmlputs(wrbuf, ht[i].name);
1058         wrbuf_puts(wrbuf, "</name>\n");
1059
1060         wrbuf_printf(wrbuf, "<frequency>" ODR_INT_PRINTF "</frequency>\n",
1061                      ht[i].hits);
1062
1063         if (version >= 2) {
1064             // Should not print if we know it isn't a approximation.
1065             wrbuf_printf(wrbuf, "<approximation>" ODR_INT_PRINTF "</approximation>\n", ht[i].approximation);
1066             wrbuf_printf(wrbuf, "<records>%d</records>\n", ht[i].records - ht[i].filtered);
1067             wrbuf_printf(wrbuf, "<filtered>%d</filtered>\n", ht[i].filtered);
1068         }
1069
1070         wrbuf_puts(wrbuf, "<state>");
1071         wrbuf_xmlputs(wrbuf, ht[i].state);
1072         wrbuf_puts(wrbuf, "</state>\n");
1073
1074         wrbuf_printf(wrbuf, "<diagnostic>%d</diagnostic>\n",
1075                      ht[i].diagnostic);
1076         wrbuf_puts(wrbuf, "</term>\n");
1077     }
1078     return count;
1079 }
1080
1081 void perform_termlist(struct http_channel *c, struct session *se,
1082                       const char *name, int num, int version)
1083 {
1084     int i, j;
1085     NMEM nmem_tmp = nmem_create();
1086     char **names;
1087     int num_names = 0;
1088
1089     if (!name)
1090         name = "*";
1091
1092     nmem_strsplit(nmem_tmp, ",", name, &names, &num_names);
1093
1094     session_enter(se);
1095
1096     for (j = 0; j < num_names; j++)
1097     {
1098         const char *tname;
1099         int must_generate_empty = 1; /* bug 5350 */
1100
1101         for (i = 0; i < se->num_termlists; i++)
1102         {
1103             tname = se->termlists[i].name;
1104             if (!strcmp(names[j], tname) || !strcmp(names[j], "*"))
1105             {
1106                 struct termlist_score **p = 0;
1107                 int len;
1108
1109                 wrbuf_puts(c->wrbuf, "<list name=\"");
1110                 wrbuf_xmlputs(c->wrbuf, tname);
1111                 wrbuf_puts(c->wrbuf, "\">\n");
1112                 must_generate_empty = 0;
1113
1114                 p = termlist_highscore(se->termlists[i].termlist, &len,
1115                                        nmem_tmp);
1116                 if (p)
1117                 {
1118                     int i;
1119                     for (i = 0; i < len && i < num; i++)
1120                     {
1121                         // prevent sending empty term elements
1122                         if (!p[i]->display_term || !p[i]->display_term[0])
1123                             continue;
1124
1125                         wrbuf_puts(c->wrbuf, "<term>");
1126                         wrbuf_puts(c->wrbuf, "<name>");
1127                         wrbuf_xmlputs(c->wrbuf, p[i]->display_term);
1128                         wrbuf_puts(c->wrbuf, "</name>");
1129
1130                         wrbuf_printf(c->wrbuf,
1131                                      "<frequency>%d</frequency>",
1132                                      p[i]->frequency);
1133                         wrbuf_puts(c->wrbuf, "</term>\n");
1134                     }
1135                 }
1136                 wrbuf_puts(c->wrbuf, "</list>\n");
1137             }
1138         }
1139         tname = "xtargets";
1140         if (!strcmp(names[j], tname) || !strcmp(names[j], "*"))
1141         {
1142             wrbuf_puts(c->wrbuf, "<list name=\"");
1143             wrbuf_xmlputs(c->wrbuf, tname);
1144             wrbuf_puts(c->wrbuf, "\">\n");
1145
1146             targets_termlist_nb(c->wrbuf, se, num, c->nmem, version);
1147             wrbuf_puts(c->wrbuf, "</list>\n");
1148             must_generate_empty = 0;
1149         }
1150         if (must_generate_empty)
1151         {
1152             wrbuf_puts(c->wrbuf, "<list name=\"");
1153             wrbuf_xmlputs(c->wrbuf, names[j]);
1154             wrbuf_puts(c->wrbuf, "\"/>\n");
1155         }
1156     }
1157     session_leave(se);
1158     nmem_destroy(nmem_tmp);
1159 }
1160
1161 #ifdef MISSING_HEADERS
1162 void report_nmem_stats(void)
1163 {
1164     size_t in_use, is_free;
1165
1166     nmem_get_memory_in_use(&in_use);
1167     nmem_get_memory_free(&is_free);
1168
1169     yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
1170             (long) in_use, (long) is_free);
1171 }
1172 #endif
1173
1174 struct record_cluster *show_single_start(struct session *se, const char *id,
1175                                          struct record_cluster **prev_r,
1176                                          struct record_cluster **next_r)
1177 {
1178     struct record_cluster *r = 0;
1179
1180     session_enter(se);
1181     *prev_r = 0;
1182     *next_r = 0;
1183     if (se->reclist)
1184     {
1185         reclist_enter(se->reclist);
1186         while ((r = reclist_read_record(se->reclist)))
1187         {
1188             if (!strcmp(r->recid, id))
1189             {
1190                 *next_r = reclist_read_record(se->reclist);
1191                 break;
1192             }
1193             *prev_r = r;
1194         }
1195         reclist_leave(se->reclist);
1196     }
1197     if (!r)
1198         session_leave(se);
1199     return r;
1200 }
1201
1202 void show_single_stop(struct session *se, struct record_cluster *rec)
1203 {
1204     session_leave(se);
1205 }
1206
1207 struct record_cluster **show_range_start(struct session *se,
1208                                          struct reclist_sortparms *sp,
1209                                          int start, int *num, int *total, Odr_int *sumhits, Odr_int *approx_hits)
1210 {
1211     struct record_cluster **recs;
1212     struct reclist_sortparms *spp;
1213     int i;
1214 #if USE_TIMING
1215     yaz_timing_t t = yaz_timing_create();
1216 #endif
1217     session_enter(se);
1218     recs = nmem_malloc(se->nmem, *num * sizeof(struct record_cluster *));
1219     if (!se->relevance)
1220     {
1221         *num = 0;
1222         *total = 0;
1223         *sumhits = 0;
1224         *approx_hits = 0;
1225         recs = 0;
1226     }
1227     else
1228     {
1229         struct client_list *l;
1230
1231         for (spp = sp; spp; spp = spp->next)
1232             if (spp->type == Metadata_sortkey_relevance)
1233             {
1234                 relevance_prepare_read(se->relevance, se->reclist);
1235                 break;
1236             }
1237         reclist_sort(se->reclist, sp);
1238
1239         reclist_enter(se->reclist);
1240         *total = reclist_get_num_records(se->reclist);
1241
1242         *sumhits = 0;
1243         *approx_hits = 0;
1244         for (l = se->clients_active; l; l = l->next) {
1245             *sumhits += client_get_hits(l->client);
1246             *approx_hits += client_get_approximation(l->client);
1247         }
1248         for (i = 0; i < start; i++)
1249             if (!reclist_read_record(se->reclist))
1250             {
1251                 *num = 0;
1252                 recs = 0;
1253                 break;
1254             }
1255
1256         for (i = 0; i < *num; i++)
1257         {
1258             struct record_cluster *r = reclist_read_record(se->reclist);
1259             if (!r)
1260             {
1261                 *num = i;
1262                 break;
1263             }
1264             recs[i] = r;
1265         }
1266         reclist_leave(se->reclist);
1267     }
1268 #if USE_TIMING
1269     yaz_timing_stop(t);
1270     yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
1271             yaz_timing_get_real(t), yaz_timing_get_user(t),
1272             yaz_timing_get_sys(t));
1273     yaz_timing_destroy(&t);
1274 #endif
1275     return recs;
1276 }
1277
1278 void show_range_stop(struct session *se, struct record_cluster **recs)
1279 {
1280     session_leave(se);
1281 }
1282
1283 void statistics(struct session *se, struct statistics *stat)
1284 {
1285     struct client_list *l;
1286     int count = 0;
1287
1288     memset(stat, 0, sizeof(*stat));
1289     stat->num_hits = 0;
1290     for (l = se->clients_active; l; l = l->next)
1291     {
1292         struct client *cl = l->client;
1293         if (!client_get_connection(cl))
1294             stat->num_no_connection++;
1295         stat->num_hits += client_get_hits(cl);
1296         switch (client_get_state(cl))
1297         {
1298         case Client_Connecting: stat->num_connecting++; break;
1299         case Client_Working: stat->num_working++; break;
1300         case Client_Idle: stat->num_idle++; break;
1301         case Client_Failed: stat->num_failed++; break;
1302         case Client_Error: stat->num_error++; break;
1303         default: break;
1304         }
1305         count++;
1306     }
1307     stat->num_records = se->total_records;
1308
1309     stat->num_clients = count;
1310 }
1311
1312 static struct record_metadata *record_metadata_init(
1313     NMEM nmem, const char *value, enum conf_metadata_type type,
1314     struct _xmlAttr *attr)
1315 {
1316     struct record_metadata *rec_md = record_metadata_create(nmem);
1317     struct record_metadata_attr **attrp = &rec_md->attributes;
1318
1319     for (; attr; attr = attr->next)
1320     {
1321         if (attr->children && attr->children->content)
1322         {
1323             if (strcmp((const char *) attr->name, "type"))
1324             {  /* skip the "type" attribute.. Its value is already part of
1325                   the element in output (md-%s) and so repeating it here
1326                   is redundant */
1327                 *attrp = nmem_malloc(nmem, sizeof(**attrp));
1328                 (*attrp)->name =
1329                     nmem_strdup(nmem, (const char *) attr->name);
1330                 (*attrp)->value =
1331                     nmem_strdup(nmem, (const char *) attr->children->content);
1332                 attrp = &(*attrp)->next;
1333             }
1334         }
1335     }
1336     *attrp = 0;
1337
1338     if (type == Metadata_type_generic)
1339     {
1340         char *p = nmem_strdup(nmem, value);
1341
1342         p = normalize7bit_generic(p, " ,/.:([");
1343
1344         rec_md->data.text.disp = p;
1345         rec_md->data.text.sort = 0;
1346     }
1347     else if (type == Metadata_type_year || type == Metadata_type_date)
1348     {
1349         int first, last;
1350         int longdate = 0;
1351
1352         if (type == Metadata_type_date)
1353             longdate = 1;
1354         if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
1355             return 0;
1356
1357         rec_md->data.number.min = first;
1358         rec_md->data.number.max = last;
1359     }
1360     else
1361         return 0;
1362     return rec_md;
1363 }
1364
1365 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
1366                                  struct conf_service *service, WRBUF norm_wr)
1367 {
1368     xmlNode *n;
1369     int no_found = 0;
1370     for (n = root->children; n; n = n->next)
1371     {
1372         if (n->type != XML_ELEMENT_NODE)
1373             continue;
1374         if (!strcmp((const char *) n->name, "metadata"))
1375         {
1376             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1377             if (type == NULL) {
1378                 yaz_log(YLOG_FATAL, "Missing type attribute on metadata element. Skipping!");
1379             }
1380             else if (!strcmp(name, (const char *) type))
1381             {
1382                 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
1383                 if (value)
1384                 {
1385                     const char *norm_str;
1386                     pp2_charset_token_t prt =
1387                         pp2_charset_token_create(service->charsets, "mergekey");
1388
1389                     pp2_charset_token_first(prt, (const char *) value, 0);
1390                     if (wrbuf_len(norm_wr) > 0)
1391                         wrbuf_puts(norm_wr, " ");
1392                     wrbuf_puts(norm_wr, name);
1393                     while ((norm_str =
1394                             pp2_charset_token_next(prt)))
1395                     {
1396                         if (*norm_str)
1397                         {
1398                             wrbuf_puts(norm_wr, " ");
1399                             wrbuf_puts(norm_wr, norm_str);
1400                         }
1401                     }
1402                     xmlFree(value);
1403                     pp2_charset_token_destroy(prt);
1404                     no_found++;
1405                 }
1406             }
1407             xmlFree(type);
1408         }
1409     }
1410     return no_found;
1411 }
1412
1413 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
1414                                 struct conf_service *service, NMEM nmem)
1415 {
1416     char *mergekey_norm = 0;
1417     xmlNode *root = xmlDocGetRootElement(doc);
1418     WRBUF norm_wr = wrbuf_alloc();
1419
1420     /* consider mergekey from XSL first */
1421     xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
1422     if (mergekey)
1423     {
1424         const char *norm_str;
1425         pp2_charset_token_t prt =
1426             pp2_charset_token_create(service->charsets, "mergekey");
1427
1428         pp2_charset_token_first(prt, (const char *) mergekey, 0);
1429         while ((norm_str = pp2_charset_token_next(prt)))
1430         {
1431             if (*norm_str)
1432             {
1433                 if (wrbuf_len(norm_wr))
1434                     wrbuf_puts(norm_wr, " ");
1435                 wrbuf_puts(norm_wr, norm_str);
1436             }
1437         }
1438         pp2_charset_token_destroy(prt);
1439         xmlFree(mergekey);
1440     }
1441     else
1442     {
1443         /* no mergekey defined in XSL. Look for mergekey metadata instead */
1444         int field_id;
1445         for (field_id = 0; field_id < service->num_metadata; field_id++)
1446         {
1447             struct conf_metadata *ser_md = &service->metadata[field_id];
1448             if (ser_md->mergekey != Metadata_mergekey_no)
1449             {
1450                 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1451                                               service, norm_wr);
1452                 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1453                 {
1454                     /* no mergekey on this one and it is required..
1455                        Generate unique key instead */
1456                     wrbuf_rewind(norm_wr);
1457                     break;
1458                 }
1459             }
1460         }
1461     }
1462
1463     /* generate unique key if none is not generated already or is empty */
1464     if (wrbuf_len(norm_wr) == 0)
1465     {
1466         wrbuf_printf(norm_wr, "position: %s-%d",
1467                      client_get_id(cl), record_no);
1468     }
1469     else
1470     {
1471         const char *lead = "content: ";
1472         wrbuf_insert(norm_wr, 0, lead, strlen(lead));
1473     }
1474     if (wrbuf_len(norm_wr) > 0)
1475         mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1476     wrbuf_destroy(norm_wr);
1477     return mergekey_norm;
1478 }
1479
1480 /** \brief see if metadata for pz:recordfilter exists
1481     \param root xml root element of normalized record
1482     \param sdb session database for client
1483     \retval 0 if there is no metadata for pz:recordfilter
1484     \retval 1 if there is metadata for pz:recordfilter
1485
1486     If there is no pz:recordfilter defined, this function returns 1
1487     as well.
1488 */
1489
1490 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1491 {
1492     int match = 0;
1493     xmlNode *n;
1494     const char *s;
1495     s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1496
1497     if (!s || !*s)
1498         return 1;
1499
1500     for (n = root->children; n; n = n->next)
1501     {
1502         if (n->type != XML_ELEMENT_NODE)
1503             continue;
1504         if (!strcmp((const char *) n->name, "metadata"))
1505         {
1506             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1507             if (type)
1508             {
1509                 size_t len;
1510                 int substring;
1511                 const char *eq;
1512
1513                 if ((eq = strchr(s, '=')))
1514                     substring = 0;
1515                 else if ((eq = strchr(s, '~')))
1516                     substring = 1;
1517                 if (eq)
1518                     len = eq - s;
1519                 else
1520                     len = strlen(s);
1521                 if (len == strlen((const char *)type) &&
1522                     !memcmp((const char *) type, s, len))
1523                 {
1524                     xmlChar *value = xmlNodeGetContent(n);
1525                     if (value && *value)
1526                     {
1527                         if (!eq ||
1528                             (substring && strstr((const char *) value, eq+1)) ||
1529                             (!substring && !strcmp((const char *) value, eq + 1)))
1530                             match = 1;
1531                     }
1532                     xmlFree(value);
1533                 }
1534                 xmlFree(type);
1535             }
1536         }
1537     }
1538     return match;
1539 }
1540
1541
1542 static int ingest_to_cluster(struct client *cl,
1543                              xmlDoc *xdoc,
1544                              xmlNode *root,
1545                              int record_no,
1546                              const char *mergekey_norm);
1547
1548 /** \brief ingest XML record
1549     \param cl client holds the result set for record
1550     \param rec record buffer (0 terminated)
1551     \param record_no record position (1, 2, ..)
1552     \param nmem working NMEM
1553     \retval 0 OK
1554     \retval -1 failure
1555     \retval -2 Filtered
1556 */
1557 int ingest_record(struct client *cl, const char *rec,
1558                   int record_no, NMEM nmem)
1559 {
1560     struct session *se = client_get_session(cl);
1561     int ret = 0;
1562     struct session_database *sdb = client_get_database(cl);
1563     struct conf_service *service = se->service;
1564     xmlDoc *xdoc = normalize_record(se, sdb, service, rec, nmem);
1565     xmlNode *root;
1566     const char *mergekey_norm;
1567
1568     if (!xdoc)
1569         return -1;
1570
1571     root = xmlDocGetRootElement(xdoc);
1572
1573     if (!check_record_filter(root, sdb))
1574     {
1575         session_log(se, YLOG_LOG, "Filtered out record no %d from %s", record_no, sdb->database->id);
1576         xmlFreeDoc(xdoc);
1577         return -2;
1578     }
1579
1580     mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem);
1581     if (!mergekey_norm)
1582     {
1583         session_log(se, YLOG_WARN, "Got no mergekey");
1584         xmlFreeDoc(xdoc);
1585         return -1;
1586     }
1587     session_enter(se);
1588     if (client_get_session(cl) == se)
1589         ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1590     session_leave(se);
1591
1592     xmlFreeDoc(xdoc);
1593     return ret;
1594 }
1595
1596 // Skip record on non-zero
1597 static int check_limit_local(struct client *cl,
1598                              struct record *record,
1599                              int record_no)
1600 {
1601     int skip_record = 0;
1602     struct session *se = client_get_session(cl);
1603     struct conf_service *service = se->service;
1604     NMEM nmem_tmp = nmem_create();
1605     struct session_database *sdb = client_get_database(cl);
1606     int l = 0;
1607     while (!skip_record)
1608     {
1609         struct conf_metadata *ser_md = 0;
1610         struct record_metadata *rec_md = 0;
1611         int md_field_id;
1612         char **values = 0;
1613         int i, num_v = 0;
1614
1615         const char *name = client_get_facet_limit_local(cl, sdb, &l, nmem_tmp, &num_v, &values);
1616         if (!name)
1617             break;
1618
1619         md_field_id = conf_service_metadata_field_id(service, name);
1620         if (md_field_id < 0)
1621         {
1622             skip_record = 1;
1623             break;
1624         }
1625         ser_md = &service->metadata[md_field_id];
1626         rec_md = record->metadata[md_field_id];
1627         yaz_log(YLOG_DEBUG, "check limit local %s", name);
1628         for (i = 0; i < num_v; )
1629         {
1630             if (rec_md)
1631             {
1632                 if (ser_md->type == Metadata_type_year
1633                     || ser_md->type == Metadata_type_date)
1634                 {
1635                     int y = atoi(values[i]);
1636                     if (y >= rec_md->data.number.min
1637                         && y <= rec_md->data.number.max)
1638                         break;
1639                 }
1640                 else
1641                 {
1642                     yaz_log(YLOG_DEBUG, "cmp: '%s' '%s'", rec_md->data.text.disp, values[i]);
1643                     if (!strcmp(rec_md->data.text.disp, values[i]))
1644                     {
1645                         // Value equals, should not be filtered.
1646                         break;
1647                     }
1648                 }
1649                 rec_md = rec_md->next;
1650             }
1651             else
1652             {
1653                 rec_md = record->metadata[md_field_id];
1654                 i++;
1655             }
1656         }
1657         // At end , not match
1658         if (i == num_v)
1659         {
1660             skip_record = 1;
1661             break;
1662         }
1663     }
1664     nmem_destroy(nmem_tmp);
1665     return skip_record;
1666 }
1667
1668 static int ingest_to_cluster(struct client *cl,
1669                              xmlDoc *xdoc,
1670                              xmlNode *root,
1671                              int record_no,
1672                              const char *mergekey_norm)
1673 {
1674     xmlNode *n;
1675     xmlChar *type = 0;
1676     xmlChar *value = 0;
1677     struct session *se = client_get_session(cl);
1678     struct conf_service *service = se->service;
1679     int term_factor = 1;
1680     struct record_cluster *cluster;
1681     struct session_database *sdb = client_get_database(cl);
1682     struct record *record = record_create(se->nmem,
1683                                           service->num_metadata,
1684                                           service->num_sortkeys, cl,
1685                                           record_no);
1686
1687     for (n = root->children; n; n = n->next)
1688     {
1689         if (type)
1690             xmlFree(type);
1691         if (value)
1692             xmlFree(value);
1693         type = value = 0;
1694
1695         if (n->type != XML_ELEMENT_NODE)
1696             continue;
1697         if (!strcmp((const char *) n->name, "metadata"))
1698         {
1699             struct conf_metadata *ser_md = 0;
1700             struct record_metadata **wheretoput = 0;
1701             struct record_metadata *rec_md = 0;
1702             int md_field_id = -1;
1703
1704             type = xmlGetProp(n, (xmlChar *) "type");
1705             value = xmlNodeListGetString(xdoc, n->children, 1);
1706
1707             if (!type || !value || !*value)
1708                 continue;
1709
1710             md_field_id
1711                 = conf_service_metadata_field_id(service, (const char *) type);
1712             if (md_field_id < 0)
1713             {
1714                 if (se->number_of_warnings_unknown_metadata == 0)
1715                 {
1716                     session_log(se, YLOG_WARN,
1717                             "Ignoring unknown metadata element: %s", type);
1718                 }
1719                 se->number_of_warnings_unknown_metadata++;
1720                 continue;
1721             }
1722
1723             ser_md = &service->metadata[md_field_id];
1724
1725             // non-merged metadata
1726             rec_md = record_metadata_init(se->nmem, (const char *) value,
1727                                           ser_md->type, n->properties);
1728             if (!rec_md)
1729             {
1730                 session_log(se, YLOG_WARN, "bad metadata data '%s' "
1731                             "for element '%s'", value, type);
1732                 continue;
1733             }
1734             wheretoput = &record->metadata[md_field_id];
1735             while (*wheretoput)
1736                 wheretoput = &(*wheretoput)->next;
1737             *wheretoput = rec_md;
1738         }
1739     }
1740
1741     if (check_limit_local(cl, record, record_no))
1742     {
1743         session_log(se, YLOG_LOG, "Facet filtered out record no %d from %s",
1744                     record_no, sdb->database->id);
1745         if (type)
1746             xmlFree(type);
1747         if (value)
1748             xmlFree(value);
1749         return -2;
1750     }
1751     cluster = reclist_insert(se->reclist, service, record,
1752                              mergekey_norm, &se->total_merged);
1753     if (!cluster)
1754         return -1;
1755
1756     {
1757         const char *use_term_factor_str =
1758             session_setting_oneval(sdb, PZ_TERMLIST_TERM_FACTOR);
1759         if (use_term_factor_str && use_term_factor_str[0] == '1')
1760         {
1761             int maxrecs = client_get_maxrecs(cl);
1762             int hits = (int) client_get_hits(cl);
1763             term_factor = MAX(hits, maxrecs) /  MAX(1, maxrecs);
1764             assert(term_factor >= 1);
1765             yaz_log(YLOG_DEBUG, "Using term factor: %d (%d / %d)", term_factor, MAX(hits, maxrecs), MAX(1, maxrecs));
1766         }
1767     }
1768
1769     if (global_parameters.dump_records)
1770         session_log(se, YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1771                     sdb->database->id, record_no);
1772
1773
1774     relevance_newrec(se->relevance, cluster);
1775
1776     // now parsing XML record and adding data to cluster or record metadata
1777     for (n = root->children; n; n = n->next)
1778     {
1779         pp2_charset_token_t prt;
1780         if (type)
1781             xmlFree(type);
1782         if (value)
1783             xmlFree(value);
1784         type = value = 0;
1785
1786         if (n->type != XML_ELEMENT_NODE)
1787             continue;
1788         if (!strcmp((const char *) n->name, "metadata"))
1789         {
1790             struct conf_metadata *ser_md = 0;
1791             struct conf_sortkey *ser_sk = 0;
1792             struct record_metadata **wheretoput = 0;
1793             struct record_metadata *rec_md = 0;
1794             int md_field_id = -1;
1795             int sk_field_id = -1;
1796             const char *rank;
1797             xmlChar *xml_rank;
1798
1799             type = xmlGetProp(n, (xmlChar *) "type");
1800             value = xmlNodeListGetString(xdoc, n->children, 1);
1801
1802             if (!type || !value || !*value)
1803                 continue;
1804
1805             md_field_id
1806                 = conf_service_metadata_field_id(service, (const char *) type);
1807             if (md_field_id < 0)
1808                 continue;
1809
1810             ser_md = &service->metadata[md_field_id];
1811
1812             if (ser_md->sortkey_offset >= 0)
1813             {
1814                 sk_field_id = ser_md->sortkey_offset;
1815                 ser_sk = &service->sortkeys[sk_field_id];
1816             }
1817
1818             // merged metadata
1819             rec_md = record_metadata_init(se->nmem, (const char *) value,
1820                                           ser_md->type, 0);
1821             if (!rec_md)
1822                 continue;
1823
1824             xml_rank = xmlGetProp(n, (xmlChar *) "rank");
1825             rank = xml_rank ? (const char *) xml_rank : ser_md->rank;
1826
1827             wheretoput = &cluster->metadata[md_field_id];
1828
1829             // and polulate with data:
1830             // assign cluster or record based on merge action
1831             if (ser_md->merge == Metadata_merge_unique)
1832             {
1833                 while (*wheretoput)
1834                 {
1835                     if (!strcmp((const char *) (*wheretoput)->data.text.disp,
1836                                 rec_md->data.text.disp))
1837                         break;
1838                     wheretoput = &(*wheretoput)->next;
1839                 }
1840                 if (!*wheretoput)
1841                     *wheretoput = rec_md;
1842             }
1843             else if (ser_md->merge == Metadata_merge_longest)
1844             {
1845                 if (!*wheretoput
1846                     || strlen(rec_md->data.text.disp)
1847                     > strlen((*wheretoput)->data.text.disp))
1848                 {
1849                     *wheretoput = rec_md;
1850                     if (ser_sk)
1851                     {
1852                         const char *sort_str = 0;
1853                         int skip_article =
1854                             ser_sk->type == Metadata_sortkey_skiparticle;
1855
1856                         if (!cluster->sortkeys[sk_field_id])
1857                             cluster->sortkeys[sk_field_id] =
1858                                 nmem_malloc(se->nmem,
1859                                             sizeof(union data_types));
1860
1861                         prt =
1862                             pp2_charset_token_create(service->charsets, "sort");
1863
1864                         pp2_charset_token_first(prt, rec_md->data.text.disp,
1865                                                 skip_article);
1866
1867                         pp2_charset_token_next(prt);
1868
1869                         sort_str = pp2_get_sort(prt);
1870
1871                         cluster->sortkeys[sk_field_id]->text.disp =
1872                             rec_md->data.text.disp;
1873                         if (!sort_str)
1874                         {
1875                             sort_str = rec_md->data.text.disp;
1876                             session_log(se, YLOG_WARN,
1877                                     "Could not make sortkey. Bug #1858");
1878                         }
1879                         cluster->sortkeys[sk_field_id]->text.sort =
1880                             nmem_strdup(se->nmem, sort_str);
1881                         pp2_charset_token_destroy(prt);
1882                     }
1883                 }
1884             }
1885             else if (ser_md->merge == Metadata_merge_all)
1886             {
1887                 while (*wheretoput)
1888                     wheretoput = &(*wheretoput)->next;
1889                 *wheretoput = rec_md;
1890             }
1891             else if (ser_md->merge == Metadata_merge_range)
1892             {
1893                 if (!*wheretoput)
1894                 {
1895                     *wheretoput = rec_md;
1896                     if (ser_sk)
1897                         cluster->sortkeys[sk_field_id]
1898                             = &rec_md->data;
1899                 }
1900                 else
1901                 {
1902                     int this_min = rec_md->data.number.min;
1903                     int this_max = rec_md->data.number.max;
1904                     if (this_min < (*wheretoput)->data.number.min)
1905                         (*wheretoput)->data.number.min = this_min;
1906                     if (this_max > (*wheretoput)->data.number.max)
1907                         (*wheretoput)->data.number.max = this_max;
1908                 }
1909             }
1910
1911             // ranking of _all_ fields enabled ...
1912             if (rank)
1913             {
1914                 relevance_countwords(se->relevance, cluster,
1915                                      (char *) value, rank, ser_md->name);
1916             }
1917
1918             // construct facets ... unless the client already has reported them
1919             if (ser_md->termlist && !client_has_facet(cl, (char *) type))
1920             {
1921                 if (ser_md->type == Metadata_type_year)
1922                 {
1923                     char year[64];
1924                     sprintf(year, "%d", rec_md->data.number.max);
1925
1926                     add_facet(se, (char *) type, year, term_factor);
1927                     if (rec_md->data.number.max != rec_md->data.number.min)
1928                     {
1929                         sprintf(year, "%d", rec_md->data.number.min);
1930                         add_facet(se, (char *) type, year, term_factor);
1931                     }
1932                 }
1933                 else
1934                     add_facet(se, (char *) type, (char *) value, term_factor);
1935             }
1936
1937             // cleaning up
1938             if (xml_rank)
1939                 xmlFree(xml_rank);
1940             xmlFree(type);
1941             xmlFree(value);
1942             type = value = 0;
1943         }
1944         else
1945         {
1946             if (se->number_of_warnings_unknown_elements == 0)
1947                 session_log(se, YLOG_WARN,
1948                         "Unexpected element in internal record: %s", n->name);
1949             se->number_of_warnings_unknown_elements++;
1950         }
1951     }
1952     if (type)
1953         xmlFree(type);
1954     if (value)
1955         xmlFree(value);
1956
1957     relevance_donerecord(se->relevance, cluster);
1958     se->total_records++;
1959
1960     return 0;
1961 }
1962
1963 void session_log(struct session *s, int level, const char *fmt, ...)
1964 {
1965     char buf[1024];
1966     va_list ap;
1967     va_start(ap, fmt);
1968
1969     yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
1970     yaz_log(level, "Session %u: %s", s->session_id, buf);
1971
1972     va_end(ap);
1973 }
1974
1975 /*
1976  * Local variables:
1977  * c-basic-offset: 4
1978  * c-file-style: "Stroustrup"
1979  * indent-tabs-mode: nil
1980  * End:
1981  * vim: shiftwidth=4 tabstop=8 expandtab
1982  */
1983