src/session.c

   1 /* This file is part of Pazpar2.
   2    Copyright (C) 2006-2011 Index Data
   3
   4 Pazpar2 is free software; you can redistribute it and/or modify it under
   5 the terms of the GNU General Public License as published by the Free
   6 Software Foundation; either version 2, or (at your option) any later
   7 version.
   8
   9 Pazpar2 is distributed in the hope that it will be useful, but WITHOUT ANY
  10 WARRANTY; without even the implied warranty of MERCHANTABILITY or
  11 FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
  12 for more details.
  13
  14 You should have received a copy of the GNU General Public License
  15 along with this program; if not, write to the Free Software
  16 Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
  17
  18 */
  19
  20 /** \file session.c
  21     \brief high-level logic; mostly user sessions and settings
  22 */
  23
  24 #if HAVE_CONFIG_H
  25 #include <config.h>
  26 #endif
  27
  28 #include <time.h>
  29 #include <stdlib.h>
  30 #include <stdio.h>
  31 #include <string.h>
  32 #if HAVE_SYS_TIME_H
  33 #include <sys/time.h>
  34 #endif
  35 #if HAVE_UNISTD_H
  36 #include <unistd.h>
  37 #endif
  38 #ifdef WIN32
  39 #include <windows.h>
  40 #endif
  41 #include <signal.h>
  42 #include <ctype.h>
  43 #include <assert.h>
  44 #include <math.h>
  45
  46 #include <yaz/marcdisp.h>
  47 #include <yaz/comstack.h>
  48 #include <yaz/tcpip.h>
  49 #include <yaz/proto.h>
  50 #include <yaz/readconf.h>
  51 #include <yaz/pquery.h>
  52 #include <yaz/otherinfo.h>
  53 #include <yaz/yaz-util.h>
  54 #include <yaz/nmem.h>
  55 #include <yaz/query-charset.h>
  56 #include <yaz/querytowrbuf.h>
  57 #include <yaz/oid_db.h>
  58 #include <yaz/snprintf.h>
  59 #include <yaz/gettimeofday.h>
  60
  61 #define USE_TIMING 0
  62 #if USE_TIMING
  63 #include <yaz/timing.h>
  64 #endif
  65
  66 #include "ppmutex.h"
  67 #include "parameters.h"
  68 #include "session.h"
  69 #include "eventl.h"
  70 #include "http.h"
  71 #include "termlists.h"
  72 #include "reclists.h"
  73 #include "relevance.h"
  74 #include "database.h"
  75 #include "client.h"
  76 #include "settings.h"
  77 #include "normalize7bit.h"
  78
  79 #define TERMLIST_HIGH_SCORE 25
  80
  81 #define MAX_CHUNK 15
  82
  83 #define MAX(a,b) ((a)>(b)?(a):(b))
  84
  85 // Note: Some things in this structure will eventually move to configuration
  86 struct parameters global_parameters =
  87 {
  88     0,   // dump_records
  89     0,   // debug_mode
  90     0,   // predictable sessions
  91 };
  92
  93 struct client_list {
  94     struct client *client;
  95     struct client_list *next;
  96 };
  97
  98 /* session counting (1) , disable client counting (0) */
  99 static YAZ_MUTEX g_session_mutex = 0;
 100 static int no_sessions = 0;
 101 static int no_session_total = 0;
 102
 103 static int session_use(int delta)
 104 {
 105     int sessions;
 106     if (!g_session_mutex)
 107         yaz_mutex_create(&g_session_mutex);
 108     yaz_mutex_enter(g_session_mutex);
 109     no_sessions += delta;
 110     if (delta > 0)
 111         no_session_total += delta;
 112     sessions = no_sessions;
 113     yaz_mutex_leave(g_session_mutex);
 114     yaz_log(YLOG_DEBUG, "%s sesions=%d", delta == 0 ? "" : (delta > 0 ? "INC" : "DEC"), no_sessions);
 115     return sessions;
 116 }
 117
 118 int sessions_count(void) {
 119     return session_use(0);
 120 }
 121
 122 int  session_count_total(void) {
 123     int total = 0;
 124     if (!g_session_mutex)
 125         return 0;
 126     yaz_mutex_enter(g_session_mutex);
 127     total = no_session_total;
 128     yaz_mutex_leave(g_session_mutex);
 129     return total;
 130 }
 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)
 152 {
 153     yaz_mutex_enter(s->session_mutex);
 154 }
 155
 156 static void session_leave(struct session *s)
 157 {
 158     yaz_mutex_leave(s->session_mutex);
 159 }
 160
 161 // Recursively traverse query structure to extract terms.
 162 void pull_terms(NMEM nmem, struct ccl_rpn_node *n, char **termlist, int *num)
 163 {
 164     char **words;
 165     int numwords;
 166     int i;
 167
 168     switch (n->kind)
 169     {
 170     case CCL_RPN_AND:
 171     case CCL_RPN_OR:
 172     case CCL_RPN_NOT:
 173     case CCL_RPN_PROX:
 174         pull_terms(nmem, n->u.p[0], termlist, num);
 175         pull_terms(nmem, n->u.p[1], termlist, num);
 176         break;
 177     case CCL_RPN_TERM:
 178         nmem_strsplit(nmem, " ", n->u.t.term, &words, &numwords);
 179         for (i = 0; i < numwords; i++)
 180             termlist[(*num)++] = words[i];
 181         break;
 182     default: // NOOP
 183         break;
 184     }
 185 }
 186
 187
 188 void add_facet(struct session *s, const char *type, const char *value, int count)
 189 {
 190     struct conf_service *service = s->service;
 191     pp2_relevance_token_t prt;
 192     const char *facet_component;
 193     WRBUF facet_wrbuf = wrbuf_alloc();
 194     WRBUF display_wrbuf = wrbuf_alloc();
 195     int i;
 196     const char *icu_chain_id = 0;
 197
 198     for (i = 0; i < service->num_metadata; i++)
 199         if (!strcmp((service->metadata + i)->name, type))
 200             icu_chain_id = (service->metadata + i)->icu_chain;
 201     yaz_log(YLOG_LOG, "icu_chain id=%s", icu_chain_id ? icu_chain_id : "null");
 202
 203     prt = pp2_relevance_tokenize(service->facet_pct);
 204
 205     pp2_relevance_first(prt, value, 0);
 206     while ((facet_component = pp2_relevance_token_next(prt)))
 207     {
 208         const char *display_component;
 209         if (*facet_component)
 210         {
 211             if (wrbuf_len(facet_wrbuf))
 212                 wrbuf_puts(facet_wrbuf, " ");
 213             wrbuf_puts(facet_wrbuf, facet_component);
 214         }
 215         display_component = pp2_get_display(prt);
 216         if (display_component)
 217         {
 218             if (wrbuf_len(display_wrbuf))
 219                 wrbuf_puts(display_wrbuf, " ");
 220             wrbuf_puts(display_wrbuf, display_component);
 221         }
 222     }
 223     pp2_relevance_token_destroy(prt);
 224
 225     yaz_log(YLOG_LOG, "facet norm=%s", wrbuf_cstr(facet_wrbuf));
 226     yaz_log(YLOG_LOG, "facet display=%s", wrbuf_cstr(display_wrbuf));
 227     if (wrbuf_len(facet_wrbuf))
 228     {
 229         int i;
 230         for (i = 0; i < s->num_termlists; i++)
 231             if (!strcmp(s->termlists[i].name, type))
 232                 break;
 233         if (i == s->num_termlists)
 234         {
 235             if (i == SESSION_MAX_TERMLISTS)
 236             {
 237                 session_log(s, YLOG_FATAL, "Too many termlists");
 238                 wrbuf_destroy(facet_wrbuf);
 239                 return;
 240             }
 241
 242             s->termlists[i].name = nmem_strdup(s->nmem, type);
 243             s->termlists[i].termlist
 244                 = termlist_create(s->nmem, TERMLIST_HIGH_SCORE);
 245             s->num_termlists = i + 1;
 246         }
 247
 248 #if 0
 249         session_log(s, YLOG_DEBUG, "Facets for %s: %s norm:%s (%d)", type, value, wrbuf_cstr(facet_wrbuf), count);
 250 #endif
 251         termlist_insert(s->termlists[i].termlist, wrbuf_cstr(display_wrbuf),
 252                         wrbuf_cstr(facet_wrbuf), count);
 253     }
 254     wrbuf_destroy(facet_wrbuf);
 255     wrbuf_destroy(display_wrbuf);
 256 }
 257
 258 static xmlDoc *record_to_xml(struct session *se,
 259                              struct session_database *sdb, const char *rec)
 260 {
 261     struct database *db = sdb->database;
 262     xmlDoc *rdoc = 0;
 263
 264     rdoc = xmlParseMemory(rec, strlen(rec));
 265
 266     if (!rdoc)
 267     {
 268         session_log(se, YLOG_FATAL, "Non-wellformed XML received from %s",
 269                     db->url);
 270         return 0;
 271     }
 272
 273     if (global_parameters.dump_records)
 274     {
 275         session_log(se, YLOG_LOG, "Un-normalized record from %s", db->url);
 276         log_xml_doc(rdoc);
 277     }
 278
 279     return rdoc;
 280 }
 281
 282 #define MAX_XSLT_ARGS 16
 283
 284 // Add static values from session database settings if applicable
 285 static void insert_settings_parameters(struct session_database *sdb,
 286                                        struct conf_service *service,
 287                                        char **parms,
 288                                        NMEM nmem)
 289 {
 290     int i;
 291     int nparms = 0;
 292     int offset = 0;
 293
 294     for (i = 0; i < service->num_metadata; i++)
 295     {
 296         struct conf_metadata *md = &service->metadata[i];
 297         int setting;
 298
 299         if (md->setting == Metadata_setting_parameter &&
 300             (setting = settings_lookup_offset(service, md->name)) >= 0)
 301         {
 302             const char *val = session_setting_oneval(sdb, setting);
 303             if (val && nparms < MAX_XSLT_ARGS)
 304             {
 305                 char *buf;
 306                 int len = strlen(val);
 307                 buf = nmem_malloc(nmem, len + 3);
 308                 buf[0] = '\'';
 309                 strcpy(buf + 1, val);
 310                 buf[len+1] = '\'';
 311                 buf[len+2] = '\0';
 312                 parms[offset++] = md->name;
 313                 parms[offset++] = buf;
 314                 nparms++;
 315             }
 316         }
 317     }
 318     parms[offset] = 0;
 319 }
 320
 321 // Add static values from session database settings if applicable
 322 static void insert_settings_values(struct session_database *sdb, xmlDoc *doc,
 323     struct conf_service *service)
 324 {
 325     int i;
 326
 327     for (i = 0; i < service->num_metadata; i++)
 328     {
 329         struct conf_metadata *md = &service->metadata[i];
 330         int offset;
 331
 332         if (md->setting == Metadata_setting_postproc &&
 333             (offset = settings_lookup_offset(service, md->name)) >= 0)
 334         {
 335             const char *val = session_setting_oneval(sdb, offset);
 336             if (val)
 337             {
 338                 xmlNode *r = xmlDocGetRootElement(doc);
 339                 xmlNode *n = xmlNewTextChild(r, 0, (xmlChar *) "metadata",
 340                                              (xmlChar *) val);
 341                 xmlSetProp(n, (xmlChar *) "type", (xmlChar *) md->name);
 342             }
 343         }
 344     }
 345 }
 346
 347 static xmlDoc *normalize_record(struct session *se,
 348                                 struct session_database *sdb,
 349                                 struct conf_service *service,
 350                                 const char *rec, NMEM nmem)
 351 {
 352     xmlDoc *rdoc = record_to_xml(se, sdb, rec);
 353
 354     if (rdoc)
 355     {
 356         char *parms[MAX_XSLT_ARGS*2+1];
 357
 358         insert_settings_parameters(sdb, service, parms, nmem);
 359
 360         if (normalize_record_transform(sdb->map, &rdoc, (const char **)parms))
 361         {
 362             session_log(se, YLOG_WARN, "Normalize failed from %s",
 363                         sdb->database->url);
 364         }
 365         else
 366         {
 367             insert_settings_values(sdb, rdoc, service);
 368
 369             if (global_parameters.dump_records)
 370             {
 371                 session_log(se, YLOG_LOG, "Normalized record from %s",
 372                             sdb->database->url);
 373                 log_xml_doc(rdoc);
 374             }
 375         }
 376     }
 377     return rdoc;
 378 }
 379
 380 void session_settings_dump(struct session *se,
 381                            struct session_database *db,
 382                            WRBUF w)
 383 {
 384     if (db->settings)
 385     {
 386         int i, num = db->num_settings;
 387         for (i = 0; i < num; i++)
 388         {
 389             struct setting *s = db->settings[i];
 390             for (;s ; s = s->next)
 391             {
 392                 wrbuf_puts(w, "<set name=\"");
 393                 wrbuf_xmlputs(w, s->name);
 394                 wrbuf_puts(w, "\" value=\"");
 395                 wrbuf_xmlputs(w, s->value);
 396                 wrbuf_puts(w, "\"/>");
 397             }
 398             if (db->settings[i])
 399                 wrbuf_puts(w, "\n");
 400         }
 401     }
 402 }
 403
 404 // Retrieve first defined value for 'name' for given database.
 405 // Will be extended to take into account user associated with session
 406 const char *session_setting_oneval(struct session_database *db, int offset)
 407 {
 408     if (offset >= db->num_settings || !db->settings[offset])
 409         return "";
 410     return db->settings[offset]->value;
 411 }
 412
 413 // Prepare XSLT stylesheets for record normalization
 414 // Structures are allocated on the session_wide nmem to avoid having
 415 // to recompute this for every search. This would lead
 416 // to leaking if a single session was to repeatedly change the PZ_XSLT
 417 // setting. However, this is not a realistic use scenario.
 418 static int prepare_map(struct session *se, struct session_database *sdb)
 419 {
 420     const char *s;
 421
 422     if (!sdb->settings)
 423     {
 424         session_log(se, YLOG_WARN, "No settings on %s", sdb->database->url);
 425         return -1;
 426     }
 427     if ((s = session_setting_oneval(sdb, PZ_XSLT)))
 428     {
 429         char auto_stylesheet[256];
 430
 431         if (!strcmp(s, "auto"))
 432         {
 433             const char *request_syntax = session_setting_oneval(
 434                 sdb, PZ_REQUESTSYNTAX);
 435             if (request_syntax)
 436             {
 437                 char *cp;
 438                 yaz_snprintf(auto_stylesheet, sizeof(auto_stylesheet),
 439                              "%s.xsl", request_syntax);
 440                 for (cp = auto_stylesheet; *cp; cp++)
 441                 {
 442                     /* deliberately only consider ASCII */
 443                     if (*cp > 32 && *cp < 127)
 444                         *cp = tolower(*cp);
 445                 }
 446                 s = auto_stylesheet;
 447             }
 448             else
 449             {
 450                 session_log(se, YLOG_WARN,
 451                             "No pz:requestsyntax for auto stylesheet");
 452             }
 453         }
 454         sdb->map = normalize_cache_get(se->normalize_cache,
 455                                        se->service->server->config, s);
 456         if (!sdb->map)
 457             return -1;
 458     }
 459     return 0;
 460 }
 461
 462 // This analyzes settings and recomputes any supporting data structures
 463 // if necessary.
 464 static int prepare_session_database(struct session *se,
 465                                     struct session_database *sdb)
 466 {
 467     if (!sdb->settings)
 468     {
 469         session_log(se, YLOG_WARN,
 470                 "No settings associated with %s", sdb->database->url);
 471         return -1;
 472     }
 473     if (sdb->settings[PZ_XSLT] && !sdb->map)
 474     {
 475         if (prepare_map(se, sdb) < 0)
 476             return -1;
 477     }
 478     return 0;
 479 }
 480
 481 // called if watch should be removed because http_channel is to be destroyed
 482 static void session_watch_cancel(void *data, struct http_channel *c,
 483                                  void *data2)
 484 {
 485     struct session_watchentry *ent = data;
 486
 487     ent->fun = 0;
 488     ent->data = 0;
 489     ent->obs = 0;
 490 }
 491
 492 // set watch. Returns 0=OK, -1 if watch is already set
 493 int session_set_watch(struct session *s, int what,
 494                       session_watchfun fun, void *data,
 495                       struct http_channel *chan)
 496 {
 497     int ret;
 498     session_enter(s);
 499     if (s->watchlist[what].fun)
 500         ret = -1;
 501     else
 502     {
 503
 504         s->watchlist[what].fun = fun;
 505         s->watchlist[what].data = data;
 506         s->watchlist[what].obs = http_add_observer(chan, &s->watchlist[what],
 507                                                    session_watch_cancel);
 508         ret = 0;
 509     }
 510     session_leave(s);
 511     return ret;
 512 }
 513
 514 void session_alert_watch(struct session *s, int what)
 515 {
 516     assert(s);
 517     session_enter(s);
 518     if (s->watchlist[what].fun)
 519     {
 520         /* our watch is no longer associated with http_channel */
 521         void *data;
 522         session_watchfun fun;
 523
 524         http_remove_observer(s->watchlist[what].obs);
 525         fun  = s->watchlist[what].fun;
 526         data = s->watchlist[what].data;
 527
 528         /* reset watch before fun is invoked - in case fun wants to set
 529            it again */
 530         s->watchlist[what].fun = 0;
 531         s->watchlist[what].data = 0;
 532         s->watchlist[what].obs = 0;
 533
 534         session_leave(s);
 535         session_log(s, YLOG_DEBUG,
 536                     "Alert Watch: %d calling function: %p", what, fun);
 537         fun(data);
 538     }
 539     else
 540         session_leave(s);
 541 }
 542
 543 //callback for grep_databases
 544 static void select_targets_callback(void *context, struct session_database *db)
 545 {
 546     struct session *se = (struct session*) context;
 547     struct client *cl = client_create();
 548     struct client_list *l;
 549     client_set_database(cl, db);
 550
 551     client_set_session(cl, se);
 552
 553     l = xmalloc(sizeof(*l));
 554     l->client = cl;
 555     l->next = se->clients;
 556     se->clients = l;
 557 }
 558
 559 static void session_remove_clients(struct session *se)
 560 {
 561     struct client_list *l;
 562
 563     session_enter(se);
 564     l = se->clients;
 565     se->clients = 0;
 566     session_leave(se);
 567
 568     while (l)
 569     {
 570         struct client_list *l_next = l->next;
 571         client_lock(l->client);
 572         client_set_session(l->client, 0);
 573         client_set_database(l->client, 0);
 574         client_unlock(l->client);
 575         client_destroy(l->client);
 576         xfree(l);
 577         l = l_next;
 578     }
 579 }
 580
 581 // Associates a set of clients with a session;
 582 // Note: Session-databases represent databases with per-session
 583 // setting overrides
 584 static int select_targets(struct session *se, const char *filter)
 585 {
 586     return session_grep_databases(se, filter, select_targets_callback);
 587 }
 588
 589 int session_active_clients(struct session *s)
 590 {
 591     struct client_list *l;
 592     int res = 0;
 593
 594     for (l = s->clients; l; l = l->next)
 595         if (client_is_active(l->client))
 596             res++;
 597
 598     return res;
 599 }
 600
 601 int session_is_preferred_clients_ready(struct session *s)
 602 {
 603     struct client_list *l;
 604     int res = 0;
 605
 606     for (l = s->clients; l; l = l->next)
 607         if (client_is_active_preferred(l->client))
 608             res++;
 609     session_log(s, YLOG_DEBUG, "Has %d active preferred clients.", res);
 610     return res == 0;
 611 }
 612
 613 enum pazpar2_error_code search(struct session *se,
 614                                const char *query,
 615                                const char *startrecs, const char *maxrecs,
 616                                const char *filter,
 617                                const char *limit,
 618                                const char **addinfo)
 619 {
 620     int live_channels = 0;
 621     int no_working = 0;
 622     int no_failed = 0;
 623     struct client_list *l;
 624     struct timeval tval;
 625     facet_limits_t facet_limits;
 626
 627     session_log(se, YLOG_DEBUG, "Search");
 628
 629     *addinfo = 0;
 630
 631     session_remove_clients(se);
 632
 633     session_enter(se);
 634     reclist_destroy(se->reclist);
 635     se->reclist = 0;
 636     relevance_destroy(&se->relevance);
 637     nmem_reset(se->nmem);
 638     se->total_records = se->total_hits = se->total_merged = 0;
 639     se->num_termlists = 0;
 640     live_channels = select_targets(se, filter);
 641     if (!live_channels)
 642     {
 643         session_leave(se);
 644         return PAZPAR2_NO_TARGETS;
 645     }
 646     se->reclist = reclist_create(se->nmem);
 647
 648     yaz_gettimeofday(&tval);
 649
 650     tval.tv_sec += 5;
 651
 652     facet_limits = facet_limits_create(limit);
 653     if (!facet_limits)
 654     {
 655         *addinfo = "limit";
 656         session_leave(se);
 657         return PAZPAR2_MALFORMED_PARAMETER_VALUE;
 658     }
 659     for (l = se->clients; l; l = l->next)
 660     {
 661         struct client *cl = l->client;
 662
 663         if (maxrecs)
 664             client_set_maxrecs(cl, atoi(maxrecs));
 665         if (startrecs)
 666             client_set_startrecs(cl, atoi(startrecs));
 667         if (prepare_session_database(se, client_get_database(cl)) < 0)
 668             ;
 669         else if (client_parse_query(cl, query, facet_limits) < 0)
 670             no_failed++;
 671         else
 672         {
 673             no_working++;
 674             if (client_prep_connection(cl, se->service->z3950_operation_timeout,
 675                                        se->service->z3950_session_timeout,
 676                                        se->service->server->iochan_man,
 677                                        &tval))
 678                 client_start_search(cl);
 679         }
 680     }
 681     facet_limits_destroy(facet_limits);
 682     session_leave(se);
 683     if (no_working == 0)
 684     {
 685         if (no_failed > 0)
 686         {
 687             *addinfo = "query";
 688             return PAZPAR2_MALFORMED_PARAMETER_VALUE;
 689         }
 690         else
 691             return PAZPAR2_NO_TARGETS;
 692     }
 693     return PAZPAR2_NO_ERROR;
 694 }
 695
 696 // Creates a new session_database object for a database
 697 static void session_init_databases_fun(void *context, struct database *db)
 698 {
 699     struct session *se = (struct session *) context;
 700     struct session_database *new = nmem_malloc(se->session_nmem, sizeof(*new));
 701     int i;
 702
 703     new->database = db;
 704
 705     new->map = 0;
 706     assert(db->settings);
 707     new->settings = nmem_malloc(se->session_nmem,
 708                                 sizeof(struct settings *) * db->num_settings);
 709     new->num_settings = db->num_settings;
 710     for (i = 0; i < db->num_settings; i++)
 711     {
 712         struct setting *setting = db->settings[i];
 713         new->settings[i] = setting;
 714     }
 715     new->next = se->databases;
 716     se->databases = new;
 717 }
 718
 719 // Doesn't free memory associated with sdb -- nmem takes care of that
 720 static void session_database_destroy(struct session_database *sdb)
 721 {
 722     sdb->map = 0;
 723 }
 724
 725 // Initialize session_database list -- this represents this session's view
 726 // of the database list -- subject to modification by the settings ws command
 727 void session_init_databases(struct session *se)
 728 {
 729     se->databases = 0;
 730     predef_grep_databases(se, se->service, session_init_databases_fun);
 731 }
 732
 733 // Probably session_init_databases_fun should be refactored instead of
 734 // called here.
 735 static struct session_database *load_session_database(struct session *se,
 736                                                       char *id)
 737 {
 738     struct database *db = new_database(id, se->session_nmem);
 739
 740     resolve_database(se->service, db);
 741
 742     session_init_databases_fun((void*) se, db);
 743
 744     // New sdb is head of se->databases list
 745     return se->databases;
 746 }
 747
 748 // Find an existing session database. If not found, load it
 749 static struct session_database *find_session_database(struct session *se,
 750                                                       char *id)
 751 {
 752     struct session_database *sdb;
 753
 754     for (sdb = se->databases; sdb; sdb = sdb->next)
 755         if (!strcmp(sdb->database->url, id))
 756             return sdb;
 757     return load_session_database(se, id);
 758 }
 759
 760 // Apply a session override to a database
 761 void session_apply_setting(struct session *se, char *dbname, char *setting,
 762                            char *value)
 763 {
 764     struct session_database *sdb = find_session_database(se, dbname);
 765     struct conf_service *service = se->service;
 766     struct setting *new = nmem_malloc(se->session_nmem, sizeof(*new));
 767     int offset = settings_create_offset(service, setting);
 768
 769     expand_settings_array(&sdb->settings, &sdb->num_settings, offset,
 770                           se->session_nmem);
 771     new->precedence = 0;
 772     new->target = dbname;
 773     new->name = setting;
 774     new->value = value;
 775     new->next = sdb->settings[offset];
 776     sdb->settings[offset] = new;
 777
 778     // Force later recompute of settings-driven data structures
 779     // (happens when a search starts and client connections are prepared)
 780     switch (offset)
 781     {
 782     case PZ_XSLT:
 783         if (sdb->map)
 784         {
 785             sdb->map = 0;
 786         }
 787         break;
 788     }
 789 }
 790
 791 void session_destroy(struct session *se) {
 792     struct session_database *sdb;
 793     session_log(se, YLOG_DEBUG, "Destroying");
 794     session_use(-1);
 795     session_remove_clients(se);
 796
 797     for (sdb = se->databases; sdb; sdb = sdb->next)
 798         session_database_destroy(sdb);
 799     normalize_cache_destroy(se->normalize_cache);
 800     relevance_destroy(&se->relevance);
 801     reclist_destroy(se->reclist);
 802     nmem_destroy(se->nmem);
 803     service_destroy(se->service);
 804     yaz_mutex_destroy(&se->session_mutex);
 805 }
 806
 807 /* Depreciated: use session_destroy */
 808 void destroy_session(struct session *se)
 809 {
 810     session_destroy(se);
 811 }
 812
 813 size_t session_get_memory_status(struct session *session) {
 814     size_t session_nmem;
 815     if (session == 0)
 816         return 0;
 817     session_enter(session);
 818     session_nmem = nmem_total(session->nmem);
 819     session_leave(session);
 820     return session_nmem;
 821 }
 822
 823
 824 struct session *new_session(NMEM nmem, struct conf_service *service,
 825                             unsigned session_id)
 826 {
 827     int i;
 828     struct session *session = nmem_malloc(nmem, sizeof(*session));
 829
 830     char tmp_str[50];
 831
 832     sprintf(tmp_str, "session#%u", session_id);
 833
 834     session->session_id = session_id;
 835     session_log(session, YLOG_DEBUG, "New");
 836     session->service = service;
 837     session->relevance = 0;
 838     session->total_hits = 0;
 839     session->total_records = 0;
 840     session->number_of_warnings_unknown_elements = 0;
 841     session->number_of_warnings_unknown_metadata = 0;
 842     session->num_termlists = 0;
 843     session->reclist = 0;
 844     session->clients = 0;
 845     session->session_nmem = nmem;
 846     session->nmem = nmem_create();
 847     session->databases = 0;
 848     for (i = 0; i <= SESSION_WATCH_MAX; i++)
 849     {
 850         session->watchlist[i].data = 0;
 851         session->watchlist[i].fun = 0;
 852     }
 853     session->normalize_cache = normalize_cache_create();
 854     session->session_mutex = 0;
 855     pazpar2_mutex_create(&session->session_mutex, tmp_str);
 856     session_use(1);
 857     return session;
 858 }
 859
 860 struct hitsbytarget *hitsbytarget(struct session *se, int *count, NMEM nmem)
 861 {
 862     struct hitsbytarget *res = 0;
 863     struct client_list *l;
 864     size_t sz = 0;
 865
 866     session_enter(se);
 867     for (l = se->clients; l; l = l->next)
 868         sz++;
 869
 870     res = nmem_malloc(nmem, sizeof(*res) * sz);
 871     *count = 0;
 872     for (l = se->clients; l; l = l->next)
 873     {
 874         struct client *cl = l->client;
 875         WRBUF w = wrbuf_alloc();
 876         const char *name = session_setting_oneval(client_get_database(cl),
 877                                                   PZ_NAME);
 878
 879         res[*count].id = client_get_database(cl)->database->url;
 880         res[*count].name = *name ? name : "Unknown";
 881         res[*count].hits = client_get_hits(cl);
 882         res[*count].records = client_get_num_records(cl);
 883         res[*count].diagnostic = client_get_diagnostic(cl);
 884         res[*count].state = client_get_state_str(cl);
 885         res[*count].connected  = client_get_connection(cl) ? 1 : 0;
 886         session_settings_dump(se, client_get_database(cl), w);
 887         res[*count].settings_xml = nmem_strdup(nmem, wrbuf_cstr(w));
 888         wrbuf_destroy(w);
 889         (*count)++;
 890     }
 891     session_leave(se);
 892     return res;
 893 }
 894
 895 struct termlist_score **get_termlist_score(struct session *se,
 896                                            const char *name, int *num)
 897 {
 898     int i;
 899     struct termlist_score **tl = 0;
 900
 901     session_enter(se);
 902     for (i = 0; i < se->num_termlists; i++)
 903         if (!strcmp((const char *) se->termlists[i].name, name))
 904         {
 905             tl = termlist_highscore(se->termlists[i].termlist, num);
 906             break;
 907         }
 908     session_leave(se);
 909     return tl;
 910 }
 911
 912 #ifdef MISSING_HEADERS
 913 void report_nmem_stats(void)
 914 {
 915     size_t in_use, is_free;
 916
 917     nmem_get_memory_in_use(&in_use);
 918     nmem_get_memory_free(&is_free);
 919
 920     yaz_log(YLOG_LOG, "nmem stat: use=%ld free=%ld",
 921             (long) in_use, (long) is_free);
 922 }
 923 #endif
 924
 925 struct record_cluster *show_single_start(struct session *se, const char *id,
 926                                          struct record_cluster **prev_r,
 927                                          struct record_cluster **next_r)
 928 {
 929     struct record_cluster *r = 0;
 930
 931     session_enter(se);
 932     *prev_r = 0;
 933     *next_r = 0;
 934     if (se->reclist)
 935     {
 936         reclist_enter(se->reclist);
 937         while ((r = reclist_read_record(se->reclist)))
 938         {
 939             if (!strcmp(r->recid, id))
 940             {
 941                 *next_r = reclist_read_record(se->reclist);
 942                 break;
 943             }
 944             *prev_r = r;
 945         }
 946         reclist_leave(se->reclist);
 947     }
 948     if (!r)
 949         session_leave(se);
 950     return r;
 951 }
 952
 953 void show_single_stop(struct session *se, struct record_cluster *rec)
 954 {
 955     session_leave(se);
 956 }
 957
 958 struct record_cluster **show_range_start(struct session *se,
 959                                          struct reclist_sortparms *sp,
 960                                          int start, int *num, int *total, Odr_int *sumhits)
 961 {
 962     struct record_cluster **recs;
 963     struct reclist_sortparms *spp;
 964     int i;
 965 #if USE_TIMING
 966     yaz_timing_t t = yaz_timing_create();
 967 #endif
 968     session_enter(se);
 969     recs = nmem_malloc(se->nmem, *num * sizeof(struct record_cluster *));
 970     if (!se->relevance)
 971     {
 972         *num = 0;
 973         *total = 0;
 974         *sumhits = 0;
 975         recs = 0;
 976     }
 977     else
 978     {
 979         for (spp = sp; spp; spp = spp->next)
 980             if (spp->type == Metadata_sortkey_relevance)
 981             {
 982                 relevance_prepare_read(se->relevance, se->reclist);
 983                 break;
 984             }
 985         reclist_sort(se->reclist, sp);
 986
 987         reclist_enter(se->reclist);
 988         *total = reclist_get_num_records(se->reclist);
 989         *sumhits = se->total_hits;
 990
 991         for (i = 0; i < start; i++)
 992             if (!reclist_read_record(se->reclist))
 993             {
 994                 *num = 0;
 995                 recs = 0;
 996                 break;
 997             }
 998
 999         for (i = 0; i < *num; i++)
1000         {
1001             struct record_cluster *r = reclist_read_record(se->reclist);
1002             if (!r)
1003             {
1004                 *num = i;
1005                 break;
1006             }
1007             recs[i] = r;
1008         }
1009         reclist_leave(se->reclist);
1010     }
1011 #if USE_TIMING
1012     yaz_timing_stop(t);
1013     yaz_log(YLOG_LOG, "show %6.5f %3.2f %3.2f",
1014             yaz_timing_get_real(t), yaz_timing_get_user(t),
1015             yaz_timing_get_sys(t));
1016     yaz_timing_destroy(&t);
1017 #endif
1018     return recs;
1019 }
1020
1021 void show_range_stop(struct session *se, struct record_cluster **recs)
1022 {
1023     session_leave(se);
1024 }
1025
1026 void statistics(struct session *se, struct statistics *stat)
1027 {
1028     struct client_list *l;
1029     int count = 0;
1030
1031     memset(stat, 0, sizeof(*stat));
1032     for (l = se->clients; l; l = l->next)
1033     {
1034         struct client *cl = l->client;
1035         if (!client_get_connection(cl))
1036             stat->num_no_connection++;
1037         switch (client_get_state(cl))
1038         {
1039         case Client_Connecting: stat->num_connecting++; break;
1040         case Client_Working: stat->num_working++; break;
1041         case Client_Idle: stat->num_idle++; break;
1042         case Client_Failed: stat->num_failed++; break;
1043         case Client_Error: stat->num_error++; break;
1044         default: break;
1045         }
1046         count++;
1047     }
1048     stat->num_hits = se->total_hits;
1049     stat->num_records = se->total_records;
1050
1051     stat->num_clients = count;
1052 }
1053
1054 static struct record_metadata *record_metadata_init(
1055     NMEM nmem, const char *value, enum conf_metadata_type type,
1056     struct _xmlAttr *attr)
1057 {
1058     struct record_metadata *rec_md = record_metadata_create(nmem);
1059     struct record_metadata_attr **attrp = &rec_md->attributes;
1060
1061     for (; attr; attr = attr->next)
1062     {
1063         if (attr->children && attr->children->content)
1064         {
1065             if (strcmp((const char *) attr->name, "type"))
1066             {  /* skip the "type" attribute.. Its value is already part of
1067                   the element in output (md-%s) and so repeating it here
1068                   is redundant */
1069                 *attrp = nmem_malloc(nmem, sizeof(**attrp));
1070                 (*attrp)->name =
1071                     nmem_strdup(nmem, (const char *) attr->name);
1072                 (*attrp)->value =
1073                     nmem_strdup(nmem, (const char *) attr->children->content);
1074                 attrp = &(*attrp)->next;
1075             }
1076         }
1077     }
1078     *attrp = 0;
1079
1080     if (type == Metadata_type_generic)
1081     {
1082         char *p = nmem_strdup(nmem, value);
1083
1084         p = normalize7bit_generic(p, " ,/.:([");
1085
1086         rec_md->data.text.disp = p;
1087         rec_md->data.text.sort = 0;
1088     }
1089     else if (type == Metadata_type_year || type == Metadata_type_date)
1090     {
1091         int first, last;
1092         int longdate = 0;
1093
1094         if (type == Metadata_type_date)
1095             longdate = 1;
1096         if (extract7bit_dates((char *) value, &first, &last, longdate) < 0)
1097             return 0;
1098
1099         rec_md->data.number.min = first;
1100         rec_md->data.number.max = last;
1101     }
1102     else
1103         return 0;
1104     return rec_md;
1105 }
1106
1107 static int get_mergekey_from_doc(xmlDoc *doc, xmlNode *root, const char *name,
1108                                  struct conf_service *service, WRBUF norm_wr)
1109 {
1110     xmlNode *n;
1111     int no_found = 0;
1112     for (n = root->children; n; n = n->next)
1113     {
1114         if (n->type != XML_ELEMENT_NODE)
1115             continue;
1116         if (!strcmp((const char *) n->name, "metadata"))
1117         {
1118             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1119             if (type == NULL) {
1120                 yaz_log(YLOG_FATAL, "Missing type attribute on metadata element. Skipping!");
1121             }
1122             else if (!strcmp(name, (const char *) type))
1123             {
1124                 xmlChar *value = xmlNodeListGetString(doc, n->children, 1);
1125                 if (value)
1126                 {
1127                     const char *norm_str;
1128                     pp2_relevance_token_t prt =
1129                         pp2_relevance_tokenize(service->mergekey_pct);
1130
1131                     pp2_relevance_first(prt, (const char *) value, 0);
1132                     if (wrbuf_len(norm_wr) > 0)
1133                         wrbuf_puts(norm_wr, " ");
1134                     wrbuf_puts(norm_wr, name);
1135                     while ((norm_str =
1136                             pp2_relevance_token_next(prt)))
1137                     {
1138                         if (*norm_str)
1139                         {
1140                             wrbuf_puts(norm_wr, " ");
1141                             wrbuf_puts(norm_wr, norm_str);
1142                         }
1143                     }
1144                     xmlFree(value);
1145                     pp2_relevance_token_destroy(prt);
1146                     no_found++;
1147                 }
1148             }
1149             xmlFree(type);
1150         }
1151     }
1152     return no_found;
1153 }
1154
1155 static const char *get_mergekey(xmlDoc *doc, struct client *cl, int record_no,
1156                                 struct conf_service *service, NMEM nmem)
1157 {
1158     char *mergekey_norm = 0;
1159     xmlNode *root = xmlDocGetRootElement(doc);
1160     WRBUF norm_wr = wrbuf_alloc();
1161
1162     /* consider mergekey from XSL first */
1163     xmlChar *mergekey = xmlGetProp(root, (xmlChar *) "mergekey");
1164     if (mergekey)
1165     {
1166         const char *norm_str;
1167         pp2_relevance_token_t prt =
1168             pp2_relevance_tokenize(service->mergekey_pct);
1169
1170         pp2_relevance_first(prt, (const char *) mergekey, 0);
1171         while ((norm_str = pp2_relevance_token_next(prt)))
1172         {
1173             if (*norm_str)
1174             {
1175                 if (wrbuf_len(norm_wr))
1176                     wrbuf_puts(norm_wr, " ");
1177                 wrbuf_puts(norm_wr, norm_str);
1178             }
1179         }
1180         pp2_relevance_token_destroy(prt);
1181         xmlFree(mergekey);
1182     }
1183     else
1184     {
1185         /* no mergekey defined in XSL. Look for mergekey metadata instead */
1186         int field_id;
1187         for (field_id = 0; field_id < service->num_metadata; field_id++)
1188         {
1189             struct conf_metadata *ser_md = &service->metadata[field_id];
1190             if (ser_md->mergekey != Metadata_mergekey_no)
1191             {
1192                 int r = get_mergekey_from_doc(doc, root, ser_md->name,
1193                                               service, norm_wr);
1194                 if (r == 0 && ser_md->mergekey == Metadata_mergekey_required)
1195                 {
1196                     /* no mergekey on this one and it is required..
1197                        Generate unique key instead */
1198                     wrbuf_rewind(norm_wr);
1199                     break;
1200                 }
1201             }
1202         }
1203     }
1204
1205     /* generate unique key if none is not generated already or is empty */
1206     if (wrbuf_len(norm_wr) == 0)
1207     {
1208         wrbuf_printf(norm_wr, "%s-%d",
1209                      client_get_database(cl)->database->url, record_no);
1210     }
1211     if (wrbuf_len(norm_wr) > 0)
1212         mergekey_norm = nmem_strdup(nmem, wrbuf_cstr(norm_wr));
1213     wrbuf_destroy(norm_wr);
1214     return mergekey_norm;
1215 }
1216
1217 /** \brief see if metadata for pz:recordfilter exists
1218     \param root xml root element of normalized record
1219     \param sdb session database for client
1220     \retval 0 if there is no metadata for pz:recordfilter
1221     \retval 1 if there is metadata for pz:recordfilter
1222
1223     If there is no pz:recordfilter defined, this function returns 1
1224     as well.
1225 */
1226
1227 static int check_record_filter(xmlNode *root, struct session_database *sdb)
1228 {
1229     int match = 0;
1230     xmlNode *n;
1231     const char *s;
1232     s = session_setting_oneval(sdb, PZ_RECORDFILTER);
1233
1234     if (!s || !*s)
1235         return 1;
1236
1237     for (n = root->children; n; n = n->next)
1238     {
1239         if (n->type != XML_ELEMENT_NODE)
1240             continue;
1241         if (!strcmp((const char *) n->name, "metadata"))
1242         {
1243             xmlChar *type = xmlGetProp(n, (xmlChar *) "type");
1244             if (type)
1245             {
1246                 size_t len;
1247                 int substring;
1248                 const char *eq;
1249
1250                 if ((eq = strchr(s, '=')))
1251                     substring = 0;
1252                 else if ((eq = strchr(s, '~')))
1253                     substring = 1;
1254                 if (eq)
1255                     len = eq - s;
1256                 else
1257                     len = strlen(s);
1258                 if (len == strlen((const char *)type) &&
1259                     !memcmp((const char *) type, s, len))
1260                 {
1261                     xmlChar *value = xmlNodeGetContent(n);
1262                     if (value && *value)
1263                     {
1264                         if (!eq ||
1265                             (substring && strstr((const char *) value, eq+1)) ||
1266                             (!substring && !strcmp((const char *) value, eq + 1)))
1267                             match = 1;
1268                     }
1269                     xmlFree(value);
1270                 }
1271                 xmlFree(type);
1272             }
1273         }
1274     }
1275     return match;
1276 }
1277
1278
1279 static int ingest_to_cluster(struct client *cl,
1280                              xmlDoc *xdoc,
1281                              xmlNode *root,
1282                              int record_no,
1283                              const char *mergekey_norm);
1284
1285 /** \brief ingest XML record
1286     \param cl client holds the result set for record
1287     \param rec record buffer (0 terminated)
1288     \param record_no record position (1, 2, ..)
1289     \param nmem working NMEM
1290     \retval 0 OK
1291     \retval -1 failure
1292     \retval -2 Filtered
1293 */
1294 int ingest_record(struct client *cl, const char *rec,
1295                   int record_no, NMEM nmem)
1296 {
1297     struct session *se = client_get_session(cl);
1298     int ret = 0;
1299     struct session_database *sdb = client_get_database(cl);
1300     struct conf_service *service = se->service;
1301     xmlDoc *xdoc = normalize_record(se, sdb, service, rec, nmem);
1302     xmlNode *root;
1303     const char *mergekey_norm;
1304
1305     if (!xdoc)
1306         return -1;
1307
1308     root = xmlDocGetRootElement(xdoc);
1309
1310     if (!check_record_filter(root, sdb))
1311     {
1312         session_log(se, YLOG_LOG, "Filtered out record no %d from %s",
1313                     record_no, sdb->database->url);
1314         xmlFreeDoc(xdoc);
1315         return -2;
1316     }
1317
1318     mergekey_norm = get_mergekey(xdoc, cl, record_no, service, nmem);
1319     if (!mergekey_norm)
1320     {
1321         session_log(se, YLOG_WARN, "Got no mergekey");
1322         xmlFreeDoc(xdoc);
1323         return -1;
1324     }
1325     session_enter(se);
1326     if (client_get_session(cl) == se)
1327         ret = ingest_to_cluster(cl, xdoc, root, record_no, mergekey_norm);
1328     session_leave(se);
1329
1330     xmlFreeDoc(xdoc);
1331     return ret;
1332 }
1333
1334 static int ingest_to_cluster(struct client *cl,
1335                              xmlDoc *xdoc,
1336                              xmlNode *root,
1337                              int record_no,
1338                              const char *mergekey_norm)
1339 {
1340     xmlNode *n;
1341     xmlChar *type = 0;
1342     xmlChar *value = 0;
1343     struct session_database *sdb = client_get_database(cl);
1344     struct session *se = client_get_session(cl);
1345     struct conf_service *service = se->service;
1346     struct record *record = record_create(se->nmem,
1347                                           service->num_metadata,
1348                                           service->num_sortkeys, cl,
1349                                           record_no);
1350     struct record_cluster *cluster = reclist_insert(se->reclist,
1351                                                     service,
1352                                                     record,
1353                                                     mergekey_norm,
1354                                                     &se->total_merged);
1355
1356     const char *use_term_factor_str = session_setting_oneval(sdb, PZ_TERMLIST_TERM_FACTOR);
1357     int use_term_factor = 0;
1358     int term_factor = 1;
1359     if (use_term_factor_str && use_term_factor_str[0] != 0)
1360        use_term_factor =  atoi(use_term_factor_str);
1361     if (use_term_factor) {
1362         int maxrecs = client_get_maxrecs(cl);
1363         int hits = (int) client_get_hits(cl);
1364         term_factor = MAX(hits, maxrecs) /  MAX(1, maxrecs);
1365         assert(term_factor >= 1);
1366         yaz_log(YLOG_DEBUG, "Using term factor: %d (%d / %d)", term_factor, MAX(hits, maxrecs), MAX(1, maxrecs));
1367     }
1368
1369     if (!cluster)
1370         return -1;
1371     if (global_parameters.dump_records)
1372         session_log(se, YLOG_LOG, "Cluster id %s from %s (#%d)", cluster->recid,
1373                     sdb->database->url, record_no);
1374     relevance_newrec(se->relevance, cluster);
1375
1376     // now parsing XML record and adding data to cluster or record metadata
1377     for (n = root->children; n; n = n->next)
1378     {
1379         pp2_relevance_token_t prt;
1380         if (type)
1381             xmlFree(type);
1382         if (value)
1383             xmlFree(value);
1384         type = value = 0;
1385
1386         if (n->type != XML_ELEMENT_NODE)
1387             continue;
1388         if (!strcmp((const char *) n->name, "metadata"))
1389         {
1390             struct conf_metadata *ser_md = 0;
1391             struct conf_sortkey *ser_sk = 0;
1392             struct record_metadata **wheretoput = 0;
1393             struct record_metadata *rec_md = 0;
1394             int md_field_id = -1;
1395             int sk_field_id = -1;
1396
1397             type = xmlGetProp(n, (xmlChar *) "type");
1398             value = xmlNodeListGetString(xdoc, n->children, 1);
1399
1400             if (!type || !value || !*value)
1401                 continue;
1402
1403             md_field_id
1404                 = conf_service_metadata_field_id(service, (const char *) type);
1405             if (md_field_id < 0)
1406             {
1407                 if (se->number_of_warnings_unknown_metadata == 0)
1408                 {
1409                     session_log(se, YLOG_WARN,
1410                             "Ignoring unknown metadata element: %s", type);
1411                 }
1412                 se->number_of_warnings_unknown_metadata++;
1413                 continue;
1414             }
1415
1416             ser_md = &service->metadata[md_field_id];
1417
1418             if (ser_md->sortkey_offset >= 0){
1419                 sk_field_id = ser_md->sortkey_offset;
1420                 ser_sk = &service->sortkeys[sk_field_id];
1421             }
1422
1423             // non-merged metadata
1424             rec_md = record_metadata_init(se->nmem, (const char *) value,
1425                                           ser_md->type, n->properties);
1426             if (!rec_md)
1427             {
1428                 session_log(se, YLOG_WARN, "bad metadata data '%s' "
1429                             "for element '%s'", value, type);
1430                 continue;
1431             }
1432             wheretoput = &record->metadata[md_field_id];
1433             while (*wheretoput)
1434                 wheretoput = &(*wheretoput)->next;
1435             *wheretoput = rec_md;
1436
1437             // merged metadata
1438             rec_md = record_metadata_init(se->nmem, (const char *) value,
1439                                           ser_md->type, 0);
1440             wheretoput = &cluster->metadata[md_field_id];
1441
1442             // and polulate with data:
1443             // assign cluster or record based on merge action
1444             if (ser_md->merge == Metadata_merge_unique)
1445             {
1446                 struct record_metadata *mnode;
1447                 for (mnode = *wheretoput; mnode; mnode = mnode->next)
1448                     if (!strcmp((const char *) mnode->data.text.disp,
1449                                 rec_md->data.text.disp))
1450                         break;
1451                 if (!mnode)
1452                 {
1453                     rec_md->next = *wheretoput;
1454                     *wheretoput = rec_md;
1455                 }
1456             }
1457             else if (ser_md->merge == Metadata_merge_longest)
1458             {
1459                 if (!*wheretoput
1460                     || strlen(rec_md->data.text.disp)
1461                     > strlen((*wheretoput)->data.text.disp))
1462                 {
1463                     *wheretoput = rec_md;
1464                     if (ser_sk)
1465                     {
1466                         const char *sort_str = 0;
1467                         int skip_article =
1468                             ser_sk->type == Metadata_sortkey_skiparticle;
1469
1470                         if (!cluster->sortkeys[sk_field_id])
1471                             cluster->sortkeys[sk_field_id] =
1472                                 nmem_malloc(se->nmem,
1473                                             sizeof(union data_types));
1474
1475                         prt = pp2_relevance_tokenize(service->sort_pct);
1476
1477                         pp2_relevance_first(prt, rec_md->data.text.disp,
1478                                             skip_article);
1479
1480                         pp2_relevance_token_next(prt);
1481
1482                         sort_str = pp2_get_sort(prt);
1483
1484                         cluster->sortkeys[sk_field_id]->text.disp =
1485                             rec_md->data.text.disp;
1486                         if (!sort_str)
1487                         {
1488                             sort_str = rec_md->data.text.disp;
1489                             session_log(se, YLOG_WARN,
1490                                     "Could not make sortkey. Bug #1858");
1491                         }
1492                         cluster->sortkeys[sk_field_id]->text.sort =
1493                             nmem_strdup(se->nmem, sort_str);
1494                         pp2_relevance_token_destroy(prt);
1495                     }
1496                 }
1497             }
1498             else if (ser_md->merge == Metadata_merge_all)
1499             {
1500                 rec_md->next = *wheretoput;
1501                 *wheretoput = rec_md;
1502             }
1503             else if (ser_md->merge == Metadata_merge_range)
1504             {
1505                 if (!*wheretoput)
1506                 {
1507                     *wheretoput = rec_md;
1508                     if (ser_sk)
1509                         cluster->sortkeys[sk_field_id]
1510                             = &rec_md->data;
1511                 }
1512                 else
1513                 {
1514                     int this_min = rec_md->data.number.min;
1515                     int this_max = rec_md->data.number.max;
1516                     if (this_min < (*wheretoput)->data.number.min)
1517                         (*wheretoput)->data.number.min = this_min;
1518                     if (this_max > (*wheretoput)->data.number.max)
1519                         (*wheretoput)->data.number.max = this_max;
1520                 }
1521             }
1522
1523
1524             // ranking of _all_ fields enabled ...
1525             if (ser_md->rank)
1526                 relevance_countwords(se->relevance, cluster,
1527                                      (char *) value, ser_md->rank,
1528                                      ser_md->name);
1529
1530             // construct facets ... unless the client already has reported them
1531             if (ser_md->termlist && !client_has_facet(cl, (char *) type))
1532             {
1533                 if (ser_md->type == Metadata_type_year)
1534                 {
1535                     char year[64];
1536                     sprintf(year, "%d", rec_md->data.number.max);
1537
1538                     add_facet(se, (char *) type, year, term_factor);
1539                     if (rec_md->data.number.max != rec_md->data.number.min)
1540                     {
1541                         sprintf(year, "%d", rec_md->data.number.min);
1542                         add_facet(se, (char *) type, year, term_factor);
1543                     }
1544                 }
1545                 else
1546                     add_facet(se, (char *) type, (char *) value, term_factor);
1547             }
1548
1549             // cleaning up
1550             xmlFree(type);
1551             xmlFree(value);
1552             type = value = 0;
1553         }
1554         else
1555         {
1556             if (se->number_of_warnings_unknown_elements == 0)
1557                 session_log(se, YLOG_WARN,
1558                         "Unexpected element in internal record: %s", n->name);
1559             se->number_of_warnings_unknown_elements++;
1560         }
1561     }
1562     if (type)
1563         xmlFree(type);
1564     if (value)
1565         xmlFree(value);
1566
1567     relevance_donerecord(se->relevance, cluster);
1568     se->total_records++;
1569
1570     return 0;
1571 }
1572
1573 void session_log(struct session *s, int level, const char *fmt, ...)
1574 {
1575     char buf[1024];
1576     va_list ap;
1577     va_start(ap, fmt);
1578
1579     yaz_vsnprintf(buf, sizeof(buf)-30, fmt, ap);
1580     yaz_log(level, "Session (%u): %s", s->session_id, buf);
1581
1582     va_end(ap);
1583 }
1584
1585 /*
1586  * Local variables:
1587  * c-basic-offset: 4
1588  * c-file-style: "Stroustrup"
1589  * indent-tabs-mode: nil
1590  * End:
1591  * vim: shiftwidth=4 tabstop=8 expandtab
1592  */
1593