src/session.c

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