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