src/session.c

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