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