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