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