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